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_probe_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_probe_unregister(provider_name, event_name, func, data);           \
 231 }
 232
 233 extern int lttng_ust_tracepoint_probe_register(const char *provider_name, const char *event_name,
 234                 void (*func)(void), void *data, const char *signature);
 235 extern int lttng_ust_tracepoint_probe_unregister(const char *provider_name, const char *event_name,
 236                 void (*func)(void), void *data);
 237
 238 /*
 239  * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
 240  * shared across objects in a module/main executable.
 241  *
 242  * IMPORTANT: this structure is part of the ABI between instrumented
 243  * applications and UST. Fields need to be only added at the end, never
 244  * reordered, never removed.
 245  *
 246  * The field @struct_size should be used to determine the size of the
 247  * structure. It should be queried before using additional fields added
 248  * at the end of the structure.
 249  */
 250 struct lttng_ust_tracepoint_dlopen {
 251         uint32_t struct_size;
 252
 253         void *liblttngust_handle;
 254
 255         int (*lttng_ust_tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start,
 256                 int tracepoints_count);
 257         int (*lttng_ust_tracepoint_unregister_lib)(struct lttng_ust_tracepoint * const *tracepoints_start);
 258         void (*rcu_read_lock_sym)(void);
 259         void (*rcu_read_unlock_sym)(void);
 260         void *(*rcu_dereference_sym)(void *p);
 261
 262         /* End of base ABI. Fields below should be used after checking struct_size. */
 263 };
 264
 265 extern struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen;
 266 extern struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr;
 267
 268 /*
 269  * These weak symbols, the constructor, and destructor take care of
 270  * registering only _one_ instance of the tracepoints per shared-ojbect
 271  * (or for the whole main program).
 272  */
 273 int lttng_ust_tracepoint_registered
 274         __attribute__((weak, visibility("hidden")));
 275 int lttng_ust_tracepoint_ptrs_registered
 276         __attribute__((weak, visibility("hidden")));
 277 struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen
 278                 __attribute__((weak, visibility("hidden"))) = {
 279         .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen),
 280 };
 281 /*
 282  * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
 283  * 4.8 and prior does not have the same behavior for symbol scoping on
 284  * 32-bit powerpc depending on the object size: symbols for objects of 8
 285  * bytes or less have the same address throughout a module, whereas they
 286  * have different addresses between compile units for objects larger
 287  * than 8 bytes. Add this pointer indirection to ensure that the symbol
 288  * scoping match that of the other weak hidden symbols found in this
 289  * header.
 290  */
 291 struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr
 292         __attribute__((weak, visibility("hidden")));
 293
 294 /*
 295  * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared
 296  * across objects in a module/main executable. The callbacks are used to
 297  * control and check if the destructors should be executed.
 298  *
 299  * IMPORTANT: this structure is part of the ABI between instrumented
 300  * applications and UST. Fields need to be only added at the end, never
 301  * reordered, never removed.
 302  *
 303  * The field @struct_size should be used to determine the size of the
 304  * structure. It should be queried before using additional fields added
 305  * at the end of the structure.
 306  */
 307 struct lttng_ust_tracepoint_destructors_syms {
 308         uint32_t struct_size;
 309
 310         void (*tracepoint_disable_destructors)(void);
 311         int (*tracepoint_get_destructors_state)(void);
 312
 313         /* End of base ABI. Fields below should be used after checking struct_size. */
 314 };
 315
 316 extern struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms;
 317 extern struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr;
 318
 319 struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms
 320         __attribute__((weak, visibility("hidden"))) = {
 321         .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms),
 322 };
 323 struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr
 324         __attribute__((weak, visibility("hidden")));
 325
 326 static inline void tracepoint_disable_destructors(void)
 327 {
 328         if (!lttng_ust_tracepoint_dlopen_ptr)
 329                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 330         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 331                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 332         if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
 333                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors)
 334                 lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors();
 335 }
 336
 337 #ifndef _LGPL_SOURCE
 338 static inline void
 339 lttng_ust_tracepoint__init_urcu_sym(void)
 340         lttng_ust_notrace;
 341 static inline void
 342 lttng_ust_tracepoint__init_urcu_sym(void)
 343 {
 344         if (!lttng_ust_tracepoint_dlopen_ptr)
 345                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 346         /*
 347          * Symbols below are needed by tracepoint call sites and probe
 348          * providers.
 349          */
 350         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym)
 351                 lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym =
 352                         URCU_FORCE_CAST(void (*)(void),
 353                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 354                                         "lttng_ust_tp_rcu_read_lock"));
 355         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym)
 356                 lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym =
 357                         URCU_FORCE_CAST(void (*)(void),
 358                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 359                                         "lttng_ust_tp_rcu_read_unlock"));
 360         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym)
 361                 lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym =
 362                         URCU_FORCE_CAST(void *(*)(void *p),
 363                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 364                                         "lttng_ust_tp_rcu_dereference_sym"));
 365 }
 366 #else
 367 static inline void
 368 lttng_ust_tracepoint__init_urcu_sym(void)
 369         lttng_ust_notrace;
 370 static inline void
 371 lttng_ust_tracepoint__init_urcu_sym(void)
 372 {
 373 }
 374 #endif
 375
 376 static void
 377 lttng_ust__tracepoints__init(void)
 378         lttng_ust_notrace __attribute__((constructor));
 379 static void
 380 lttng_ust__tracepoints__init(void)
 381 {
 382         if (lttng_ust_tracepoint_registered++) {
 383                 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 384                         return;
 385                 lttng_ust_tracepoint__init_urcu_sym();
 386                 return;
 387         }
 388
 389         if (!lttng_ust_tracepoint_dlopen_ptr)
 390                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 391         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 392                 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
 393                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 394         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 395                 return;
 396         lttng_ust_tracepoint__init_urcu_sym();
 397 }
 398
 399 static void
 400 lttng_ust__tracepoints__destroy(void)
 401         lttng_ust_notrace __attribute__((destructor));
 402 static void
 403 lttng_ust__tracepoints__destroy(void)
 404 {
 405         int ret;
 406
 407         if (--lttng_ust_tracepoint_registered)
 408                 return;
 409         if (!lttng_ust_tracepoint_dlopen_ptr)
 410                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 411         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 412                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 413         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 414                 return;
 415         if (lttng_ust_tracepoint_ptrs_registered)
 416                 return;
 417         /*
 418          * Lookup if destructors must be executed using the new method.
 419          */
 420         if (lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 421                 && !lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) {
 422                 /*
 423                  * The tracepoint_get_destructors_state symbol was found with
 424                  * dlsym but its returned value is 0 meaning that destructors
 425                  * must not be executed.
 426                  */
 427                 return;
 428         }
 429         ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
 430         if (ret) {
 431                 fprintf(stderr, "Error (%d) in dlclose\n", ret);
 432                 abort();
 433         }
 434         memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
 435 }
 436
 437 #if LTTNG_UST_COMPAT_API(0)
 438 # if defined(TRACEPOINT_DEFINE) && !defined(LTTNG_UST_TRACEPOINT_DEFINE)
 439 #  define LTTNG_UST_TRACEPOINT_DEFINE
 440 # endif
 441 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 442
 443 #ifdef LTTNG_UST_TRACEPOINT_DEFINE
 444
 445 /*
 446  * These weak symbols, the constructor, and destructor take care of
 447  * registering only _one_ instance of the tracepoints per shared-ojbect
 448  * (or for the whole main program).
 449  */
 450 extern struct lttng_ust_tracepoint * const __start_lttng_ust_tracepoints_ptrs[]
 451         __attribute__((weak, visibility("hidden")));
 452 extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[]
 453         __attribute__((weak, visibility("hidden")));
 454
 455 /*
 456  * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
 457  * unresolved symbol that requires the provider to be linked in. When
 458  * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
 459  * unresolved symbol that depends on having the provider linked in,
 460  * otherwise the linker complains. This deals with use of static
 461  * libraries, ensuring that the linker does not remove the provider
 462  * object from the executable.
 463  */
 464
 465 #if LTTNG_UST_COMPAT_API(0)
 466 # if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE)
 467 #  define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 468 # endif
 469 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 470
 471 #ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 472 #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)   NULL
 473 #else   /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 474 #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)   &lttng_ust_tracepoint_provider_##provider
 475 #endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 476
 477 /*
 478  * Note: to allow PIC code, we need to allow the linker to update the pointers
 479  * in the lttng_ust_tracepoints_ptrs section.
 480  * Therefore, this section is _not_ const (read-only).
 481  */
 482 #define LTTNG_UST__TP_EXTRACT_STRING(...)       #__VA_ARGS__
 483
 484 #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)                           \
 485         lttng_ust_tracepoint_validate_name_len(_provider, _name);               \
 486         extern int lttng_ust_tracepoint_provider_##_provider                    \
 487                 LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY;           \
 488         static const char lttng_ust_tp_provider_strtab_##_provider##___##_name[]        \
 489                 __attribute__((section("lttng_ust_tracepoints_strings"))) =             \
 490                         #_provider;                                             \
 491         static const char lttng_ust_tp_name_strtab_##_provider##___##_name[]            \
 492                 __attribute__((section("lttng_ust_tracepoints_strings"))) =             \
 493                         #_name;                                                 \
 494         struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name        \
 495                 __attribute__((section("lttng_ust_tracepoints")))               \
 496                 LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY = {                 \
 497                         sizeof(struct lttng_ust_tracepoint),                    \
 498                         lttng_ust_tp_provider_strtab_##_provider##___##_name,           \
 499                         lttng_ust_tp_name_strtab_##_provider##___##_name,               \
 500                         0,                                                      \
 501                         NULL,                                                   \
 502                         LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider),         \
 503                         LTTNG_UST__TP_EXTRACT_STRING(_args),                    \
 504                 };                                                              \
 505         static struct lttng_ust_tracepoint *                                    \
 506                 lttng_ust_tracepoint_ptr_##_provider##___##_name                        \
 507                 __attribute__((section("lttng_ust_tracepoints_ptrs"), used))            \
 508                 __lttng_ust_variable_attribute_no_sanitize_address =            \
 509                         &lttng_ust_tracepoint_##_provider##___##_name;
 510
 511 static void
 512 lttng_ust__tracepoints__ptrs_init(void)
 513         lttng_ust_notrace __attribute__((constructor));
 514 static void
 515 lttng_ust__tracepoints__ptrs_init(void)
 516 {
 517         if (lttng_ust_tracepoint_ptrs_registered++)
 518                 return;
 519         if (!lttng_ust_tracepoint_dlopen_ptr)
 520                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 521         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 522                 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
 523                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 524         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 525                 return;
 526         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 527                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 528         lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib =
 529                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int),
 530                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 531                                         "lttng_ust_tracepoint_register_lib"));
 532         lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib =
 533                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *),
 534                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 535                                         "lttng_ust_tracepoint_unregister_lib"));
 536         lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors =
 537                 URCU_FORCE_CAST(void (*)(void),
 538                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 539                                         "lttng_ust_tp_disable_destructors"));
 540         lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state =
 541                 URCU_FORCE_CAST(int (*)(void),
 542                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 543                                         "lttng_ust_tp_get_destructors_state"));
 544         lttng_ust_tracepoint__init_urcu_sym();
 545         if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib) {
 546                 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib(__start_lttng_ust_tracepoints_ptrs,
 547                                 __stop_lttng_ust_tracepoints_ptrs -
 548                                 __start_lttng_ust_tracepoints_ptrs);
 549         }
 550 }
 551
 552 static void
 553 lttng_ust__tracepoints__ptrs_destroy(void)
 554         lttng_ust_notrace __attribute__((destructor));
 555 static void
 556 lttng_ust__tracepoints__ptrs_destroy(void)
 557 {
 558         int ret;
 559
 560         if (--lttng_ust_tracepoint_ptrs_registered)
 561                 return;
 562         if (!lttng_ust_tracepoint_dlopen_ptr)
 563                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 564         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 565                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 566         if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib)
 567                 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib(__start_lttng_ust_tracepoints_ptrs);
 568         if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
 569                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 570                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()
 571                         && !lttng_ust_tracepoint_ptrs_registered) {
 572                 ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
 573                 if (ret) {
 574                         fprintf(stderr, "Error (%d) in dlclose\n", ret);
 575                         abort();
 576                 }
 577                 memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
 578         }
 579 }
 580
 581 #else /* LTTNG_UST_TRACEPOINT_DEFINE */
 582
 583 #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)
 584
 585 #endif /* #else LTTNG_UST_TRACEPOINT_DEFINE */
 586
 587 #if LTTNG_UST_COMPAT_API(0)
 588 #define tracepoint                      lttng_ust_tracepoint
 589 #define do_tracepoint                   lttng_ust_do_tracepoint
 590 #define tracepoint_enabled              lttng_ust_tracepoint_enabled
 591 #define TP_ARGS                         LTTNG_UST_TP_ARGS
 592 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 593
 594 #ifdef __cplusplus
 595 }
 596 #endif
 597
 598 #endif /* _LTTNG_UST_TRACEPOINT_H */
 599
 600 /* The following declarations must be outside re-inclusion protection. */
 601
 602 /*
 603  * LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION: Define this before including
 604  * a tracepoint instrumentation header to hide symbols associated with
 605  * tracepoint module instrumentation. This is useful if all compile
 606  * units using the lttng_ust_tracepoint(),
 607  * lttng_ust_tracepoint_enabled() and lttng_ust_do_tracepoint() macros
 608  * is within the same module as the compile unit including the
 609  * tracepoint header after defining LTTNG_UST_TRACEPOINT_DEFINE.
 610  */
 611
 612 #undef LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY
 613 #ifdef LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION
 614 #define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY             __attribute__((visibility("hidden")))
 615 #else
 616 #define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY             __attribute__((visibility("default")))
 617 #endif
 618
 619 /*
 620  * LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION: Define this before
 621  * including a tracepoint instrumentation header to hide symbols
 622  * associated with the tracepoint provider. This is useful if the
 623  * tracepoint definition (including the header after defining
 624  * LTTNG_UST_TRACEPOINT_DEFINE) is in the same module as the provider
 625  * (including the header after defining
 626  * LTTNG_UST_TRACEPOINT_CREATE_PROBES).
 627  */
 628 #undef LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY
 629 #ifdef LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION
 630 #define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY    __attribute__((visibility("hidden")))
 631 #else
 632 #define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY    __attribute__((visibility("default")))
 633 #endif
 634
 635 #ifndef LTTNG_UST_TRACEPOINT_ENUM
 636
 637 /*
 638  * Tracepoint Enumerations
 639  *
 640  * The enumeration is a mapping between an integer, or range of integers, and
 641  * a string. It can be used to have a more compact trace in cases where the
 642  * possible values for a field are limited:
 643  *
 644  * An example:
 645  *
 646  * LTTNG_UST_TRACEPOINT_ENUM(someproject_component, enumname,
 647  *      LTTNG_UST_TP_ENUM_VALUES(
 648  *              lttng_ust_field_enum_value("even", 0)
 649  *              lttng_ust_field_enum_value("uneven", 1)
 650  *              lttng_ust_field_enum_range("twoto4", 2, 4)
 651  *              lttng_ust_field_enum_value("five", 5)
 652  *      )
 653  * )
 654  *
 655  * Where "someproject_component" is the name of the component this enumeration
 656  * belongs to and "enumname" identifies this enumeration. Inside the
 657  * LTTNG_UST_TP_ENUM_VALUES macro is the actual mapping. Each string value can map
 658  * to either a single value with lttng_ust_field_enum_value or a range of values
 659  * with lttng_ust_field_enum_range.
 660  *
 661  * Enumeration ranges may overlap, but the behavior is implementation-defined,
 662  * each trace reader will handle overlapping as it wishes.
 663  *
 664  * That enumeration can then be used in a field inside the TP_FIELD macro using
 665  * the following line:
 666  *
 667  * lttng_ust_field_enum(someproject_component, enumname, enumtype, enumfield, enumval)
 668  *
 669  * Where "someproject_component" and "enumname" match those in the
 670  * LTTNG_UST_TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type
 671  * backing the enumeration, "enumfield" is the name of the field and
 672  * "enumval" is the value.
 673  */
 674
 675 #define LTTNG_UST_TRACEPOINT_ENUM(provider, name, values)
 676
 677 #if LTTNG_UST_COMPAT_API(0)
 678 #define TRACEPOINT_ENUM         LTTNG_UST_TRACEPOINT_ENUM
 679 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 680
 681 #endif /* #ifndef LTTNG_UST_TRACEPOINT_ENUM */
 682
 683 #ifndef LTTNG_UST_TRACEPOINT_EVENT
 684
 685 /*
 686  * How to use the LTTNG_UST_TRACEPOINT_EVENT macro:
 687  *
 688  * An example:
 689  *
 690  * LTTNG_UST_TRACEPOINT_EVENT(someproject_component, event_name,
 691  *
 692  *     * LTTNG_UST_TP_ARGS takes from 0 to 10 "type, field_name" pairs *
 693  *
 694  *     LTTNG_UST_TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
 695  *             long *, arg4, size_t, arg4_len),
 696  *
 697  *      * LTTNG_UST_TP_FIELDS describes the event payload layout in the trace *
 698  *
 699  *     LTTNG_UST_TP_FIELDS(
 700  *         * Integer, printed in base 10 *
 701  *         lttng_ust_field_integer(int, field_a, arg0)
 702  *
 703  *         * Integer, printed with 0x base 16 *
 704  *         lttng_ust_field_integer_hex(unsigned long, field_d, arg1)
 705  *
 706  *         * Enumeration *
 707  *         lttng_ust_field_enum(someproject_component, enum_name, int, field_e, arg0)
 708  *
 709  *         * Array Sequence, printed as UTF8-encoded array of bytes *
 710  *         lttng_ust_field_array_text(char, field_b, string, FIXED_LEN)
 711  *         lttng_ust_field_sequence_text(char, field_c, string, size_t, strlen)
 712  *
 713  *         * String, printed as UTF8-encoded string *
 714  *         lttng_ust_field_string(field_e, string)
 715  *
 716  *         * Array sequence of signed integer values *
 717  *         lttng_ust_field_array(long, field_f, arg4, FIXED_LEN4)
 718  *         lttng_ust_field_sequence(long, field_g, arg4, size_t, arg4_len)
 719  *     )
 720  * )
 721  *
 722  * More detailed explanation:
 723  *
 724  * The name of the tracepoint is expressed as a tuple with the provider
 725  * and name arguments.
 726  *
 727  * The provider and name should be a proper C99 identifier.
 728  * The "provider" and "name" MUST follow these rules to ensure no
 729  * namespace clash occurs:
 730  *
 731  * For projects (applications and libraries) for which an entity
 732  * specific to the project controls the source code and thus its
 733  * tracepoints (typically with a scope larger than a single company):
 734  *
 735  * either:
 736  *   project_component, event
 737  * or:
 738  *   project, event
 739  *
 740  * Where "project" is the name of the project,
 741  *       "component" is the name of the project component (which may
 742  *       include several levels of sub-components, e.g.
 743  *       ...component_subcomponent_...) where the tracepoint is located
 744  *       (optional),
 745  *       "event" is the name of the tracepoint event.
 746  *
 747  * For projects issued from a single company wishing to advertise that
 748  * the company controls the source code and thus the tracepoints, the
 749  * "com_" prefix should be used:
 750  *
 751  * either:
 752  *   com_company_project_component, event
 753  * or:
 754  *   com_company_project, event
 755  *
 756  * Where "company" is the name of the company,
 757  *       "project" is the name of the project,
 758  *       "component" is the name of the project component (which may
 759  *       include several levels of sub-components, e.g.
 760  *       ...component_subcomponent_...) where the tracepoint is located
 761  *       (optional),
 762  *       "event" is the name of the tracepoint event.
 763  *
 764  * the provider:event identifier is limited to 127 characters.
 765  */
 766
 767 #define LTTNG_UST_TRACEPOINT_EVENT(provider, name, args, fields)                        \
 768         LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))               \
 769         LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
 770
 771 #define LTTNG_UST_TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
 772
 773 #define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)    \
 774         LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))               \
 775         LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
 776
 777 #if LTTNG_UST_COMPAT_API(0)
 778 #define TRACEPOINT_EVENT                LTTNG_UST_TRACEPOINT_EVENT
 779 #define TRACEPOINT_EVENT_CLASS          LTTNG_UST_TRACEPOINT_EVENT_CLASS
 780 #define TRACEPOINT_EVENT_INSTANCE       LTTNG_UST_TRACEPOINT_EVENT_INSTANCE
 781 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 782
 783 #endif /* #ifndef LTTNG_UST_TRACEPOINT_EVENT */
 784
 785 #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL
 786
 787 /*
 788  * Tracepoint Loglevels
 789  *
 790  * Typical use of these loglevels:
 791  *
 792  * The loglevels go from 0 to 14. Higher numbers imply the most
 793  * verbosity (higher event throughput expected.
 794  *
 795  * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
 796  * semantic. Loglevels 7 through 13 offer more fine-grained selection of
 797  * debug information.
 798  *
 799  * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG           0
 800  * system is unusable
 801  *
 802  * LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT           1
 803  * action must be taken immediately
 804  *
 805  * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT            2
 806  * critical conditions
 807  *
 808  * LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR             3
 809  * error conditions
 810  *
 811  * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING         4
 812  * warning conditions
 813  *
 814  * LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE          5
 815  * normal, but significant, condition
 816  *
 817  * LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO            6
 818  * informational message
 819  *
 820  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM    7
 821  * debug information with system-level scope (set of programs)
 822  *
 823  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM   8
 824  * debug information with program-level scope (set of processes)
 825  *
 826  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS   9
 827  * debug information with process-level scope (set of modules)
 828  *
 829  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE    10
 830  * debug information with module (executable/library) scope (set of units)
 831  *
 832  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT      11
 833  * debug information with compilation unit scope (set of functions)
 834  *
 835  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION  12
 836  * debug information with function-level scope
 837  *
 838  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE      13
 839  * debug information with line-level scope (LTTNG_UST_TRACEPOINT_EVENT default)
 840  *
 841  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG           14
 842  * debug-level message
 843  *
 844  * Declare tracepoint loglevels for tracepoints. A LTTNG_UST_TRACEPOINT_EVENT
 845  * should be declared prior to the the LTTNG_UST_TRACEPOINT_LOGLEVEL for a given
 846  * tracepoint name. The first field is the provider name, the second
 847  * field is the name of the tracepoint, the third field is the loglevel
 848  * name.
 849  *
 850  *      LTTNG_UST_TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
 851  *              < loglevel_name >)
 852  *
 853  * The LTTNG_UST_TRACEPOINT_PROVIDER must be already declared before declaring a
 854  * LTTNG_UST_TRACEPOINT_LOGLEVEL.
 855  */
 856
 857 enum {
 858         LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG             = 0,
 859         LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT             = 1,
 860         LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT              = 2,
 861         LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR               = 3,
 862         LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING           = 4,
 863         LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE            = 5,
 864         LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO              = 6,
 865         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM      = 7,
 866         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM     = 8,
 867         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS     = 9,
 868         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE      = 10,
 869         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT        = 11,
 870         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION    = 12,
 871         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE        = 13,
 872         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG             = 14,
 873 };
 874
 875 #define LTTNG_UST_TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 876
 877 #if LTTNG_UST_COMPAT_API(0)
 878 #define TRACEPOINT_LOGLEVEL     LTTNG_UST_TRACEPOINT_LOGLEVEL
 879
 880 #define TRACE_EMERG             LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG
 881 #define TRACE_ALERT             LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT
 882 #define TRACE_CRIT              LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT
 883 #define TRACE_ERR               LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR
 884 #define TRACE_WARNING           LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING
 885 #define TRACE_NOTICE            LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE
 886 #define TRACE_INFO              LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO
 887 #define TRACE_DEBUG_SYSTEM      LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM
 888 #define TRACE_DEBUG_PROGRAM     LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM
 889 #define TRACE_DEBUG_PROCESS     LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS
 890 #define TRACE_DEBUG_MODULE      LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE
 891 #define TRACE_DEBUG_UNIT        LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT
 892 #define TRACE_DEBUG_FUNCTION    LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION
 893 #define TRACE_DEBUG_LINE        LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE
 894 #define TRACE_DEBUG             LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG
 895 #endif
 896
 897 #endif /* #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL */
 898
 899 #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
 900
 901 #define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
 902
 903 #if LTTNG_UST_COMPAT_API(0)
 904 #define TRACEPOINT_MODEL_EMF_URI LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
 905 #endif
 906
 907 #endif /* #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI */