include/ust/marker.h

   1 /*
   2  * Code markup for dynamic and static tracing.
   3  *
   4  * See Documentation/marker.txt.
   5  *
   6  * (C) Copyright 2006 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
   7  * (C) Copyright 2009 Pierre-Marc Fournier <pierre-marc dot fournier at polymtl dot ca>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  22  */
  23
  24 #ifndef _UST_MARKER_H
  25 #define _UST_MARKER_H
  26
  27 #include <stdarg.h>
  28 #include <ust/immediate.h>
  29 #include <ust/core.h>
  30 #include <urcu/list.h>
  31 #include <ust/processor.h>
  32 #include <ust/kcompat/kcompat.h>
  33 #include <ust/kcompat/stringify.h>
  34
  35 #include <bits/wordsize.h>
  36
  37 struct marker;
  38
  39 /**
  40  * marker_probe_func - Type of a marker probe function
  41  * @mdata: marker data
  42  * @probe_private: probe private data
  43  * @call_private: call site private data
  44  * @fmt: format string
  45  * @args: variable argument list pointer. Use a pointer to overcome C's
  46  *        inability to pass this around as a pointer in a portable manner in
  47  *        the callee otherwise.
  48  *
  49  * Type of marker probe functions. They receive the mdata and need to parse the
  50  * format string to recover the variable argument list.
  51  */
  52 typedef void marker_probe_func(const struct marker *mdata,
  53                 void *probe_private, struct registers *regs, void *call_private,
  54                 const char *fmt, va_list *args);
  55
  56 struct marker_probe_closure {
  57         marker_probe_func *func;        /* Callback */
  58         void *probe_private;            /* Private probe data */
  59 };
  60
  61 struct marker {
  62         const char *channel;    /* Name of channel where to send data */
  63         const char *name;       /* Marker name */
  64         const char *format;     /* Marker format string, describing the
  65                                  * variable argument list.
  66                                  */
  67         DEFINE_IMV(char, state);/* Immediate value state. */
  68         char ptype;             /* probe type : 0 : single, 1 : multi */
  69                                 /* Probe wrapper */
  70         u16 channel_id;         /* Numeric channel identifier, dynamic */
  71         u16 event_id;           /* Numeric event identifier, dynamic */
  72         void (*call)(const struct marker *mdata, void *call_private, struct registers *regs, ...);
  73         struct marker_probe_closure single;
  74         struct marker_probe_closure *multi;
  75         const char *tp_name;    /* Optional tracepoint name */
  76         void *tp_cb;            /* Optional tracepoint callback */
  77         void *location;         /* Address of marker in code */
  78 } __attribute__((aligned(8)));
  79
  80 #define GET_MARKER(channel, name)       (__mark_##channel##_##name)
  81
  82 #define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format, unique, m)                    \
  83                 struct registers regs;                                                          \
  84                                                                                                 \
  85                 /* This next asm has to be a basic inline asm (no input/output/clobber),        \
  86                  * because it must not require %-sign escaping, as we most certainly            \
  87                  * have some %-signs in the format string.                                      \
  88                  */                                                                             \
  89                 asm volatile (                                                                  \
  90                         /* We only define these symbols if they have not yet been defined. Indeed, \
  91                          * if two markers with the same channel/name are on the same line, they \
  92                          * will try to create the same symbols, resulting in a conflict. This   \
  93                          * is not unusual as it can be the result of function inlining.         \
  94                          */                                                                     \
  95                         ".ifndef __mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) "\n\t"  \
  96                         /*".section __markers_strings\n\t"*/                                    \
  97                         ".section __markers_strings,\"aw\",@progbits\n\t"                               \
  98                         "__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ":\n\t" \
  99                         ".string \"" __stringify(channel) "\"\n\t"                                      \
 100                         "__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ":\n\t"    \
 101                         ".string \"" __stringify(name) "\"\n\t"                                         \
 102                         "__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ":\n\t"  \
 103                         ".string " "\"" format "\"" "\n\t"                                              \
 104                         ".previous\n\t"                                                         \
 105                         ".endif\n\t"                                                            \
 106                 );                                                                              \
 107                 asm volatile (                                                                  \
 108                         /*".section __markers\n\t"*/ \
 109                         ".section __markers,\"aw\",@progbits\n\t"                                       \
 110                         ".balign 8\n\t"                                                         \
 111                         "2:\n\t" \
 112                         _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ")\n\t" /* channel string */ \
 113                         _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ")\n\t" /* name string */ \
 114                         _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ")\n\t" /* format string */ \
 115                         ".byte 0\n\t" /* state imv */                                           \
 116                         ".byte 0\n\t" /* ptype */                                                       \
 117                         ".word 0\n\t" /* channel_id */                                          \
 118                         ".word 0\n\t" /* event_id */                                            \
 119                         ".balign " __stringify(__WORDSIZE) " / 8\n\t" /* alignment */                   \
 120                         _ASM_PTR "(marker_probe_cb)\n\t" /* call */                             \
 121                         _ASM_PTR "(__mark_empty_function)\n\t" /* marker_probe_closure single.field1 */ \
 122                         _ASM_PTR "0\n\t" /* marker_probe_closure single.field2 */                       \
 123                         _ASM_PTR "0\n\t" /* marker_probe_closure *multi */                              \
 124                         _ASM_PTR "0\n\t" /* tp_name */                                          \
 125                         _ASM_PTR "0\n\t" /* tp_cb */                                            \
 126                         _ASM_PTR "(1f)\n\t" /* location */                                              \
 127                         ".previous\n\t"                                                         \
 128                         "1:\n\t"                                                                        \
 129                         ARCH_COPY_ADDR("%[outptr]")                                             \
 130                 : [outptr] "=r" (m) );                                                          \
 131                                                                                                 \
 132                 save_registers(&regs)
 133
 134
 135 #define DEFINE_MARKER(channel, name, format, unique, m)                         \
 136                 _DEFINE_MARKER(channel, name, NULL, NULL, format, unique, m)
 137
 138 #define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format)         \
 139                 _DEFINE_MARKER_TP(channel, name, #tp_name, tp_cb, format)
 140
 141 #define _DEFINE_MARKER_TP(channel, name, tp_name_str, tp_cb, format) \
 142                 static const char __mstrtab_##channel##_##name[]        \
 143                 __attribute__((section("__markers_strings")))           \
 144                 = #channel "\0" #name "\0" format;                      \
 145                 static struct marker GET_MARKER(channel, name)          \
 146                 __attribute__((section("__markers"), aligned(8))) =     \
 147                 { __mstrtab_##channel##_##name,                         \
 148                         &__mstrtab_##channel##_##name[sizeof(#channel)],        \
 149                         &__mstrtab_##channel##_##name[sizeof(#channel) + sizeof(#name)],                \
 150                         0, 0, 0, 0, marker_probe_cb,                            \
 151                         { __mark_empty_function, NULL},                 \
 152                         NULL, tp_name_str, tp_cb }
 153
 154 /*
 155  * Make sure the alignment of the structure in the __markers section will
 156  * not add unwanted padding between the beginning of the section and the
 157  * structure. Force alignment to the same alignment as the section start.
 158  *
 159  * The "generic" argument controls which marker enabling mechanism must be used.
 160  * If generic is true, a variable read is used.
 161  * If generic is false, immediate values are used.
 162  */
 163
 164 #define __trace_mark(generic, channel, name, call_private, format, args...) \
 165         __trace_mark_counter(generic, channel, name, __LINE__, call_private, format, ## args)
 166
 167 #define __trace_mark_counter(generic, channel, name, unique, call_private, format, args...) \
 168         do {                                                            \
 169                 struct marker *m;                                       \
 170                 DEFINE_MARKER(channel, name, format, unique, m);                        \
 171                 __mark_check_format(format, ## args);                   \
 172                 if (!generic) {                                         \
 173                         if (unlikely(imv_read(m->state))) \
 174                                 (m->call)(m, call_private, &regs, ## args);             \
 175                 } else {                                                \
 176                         if (unlikely(_imv_read(m->state))) \
 177                                 (m->call)(m, call_private, &regs, ## args);             \
 178                 }                                                       \
 179         } while (0)
 180
 181 #define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, format, args...) \
 182         __trace_mark_tp_counter(channel, name, __LINE__, call_private, tp_name, tp_cb, format, ## args)
 183
 184 #define __trace_mark_tp_counter(channel, name, unique, call_private, tp_name, tp_cb, format, args...) \
 185         do {                                                            \
 186                 struct registers regs;                                                          \
 187                 void __check_tp_type(void)                              \
 188                 {                                                       \
 189                         register_trace_##tp_name(tp_cb, call_private);          \
 190                 }                                                       \
 191                 DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
 192                 __mark_check_format(format, ## args);                   \
 193                 (*GET_MARKER(channel, name).call)(&GET_MARKER(channel, name), \
 194                         call_private, &regs, ## args);                          \
 195         } while (0)
 196
 197 extern void marker_update_probe_range(struct marker *begin,
 198         struct marker *end);
 199
 200 /**
 201  * trace_mark - Marker using code patching
 202  * @channel: marker channel (where to send the data), not quoted.
 203  * @name: marker name, not quoted.
 204  * @format: format string
 205  * @args...: variable argument list
 206  *
 207  * Places a marker using optimized code patching technique (imv_read())
 208  * to be enabled when immediate values are present.
 209  */
 210 #define trace_mark(channel, name, format, args...) \
 211         __trace_mark(0, channel, name, NULL, format, ## args)
 212
 213 /**
 214  * _trace_mark - Marker using variable read
 215  * @channel: marker channel (where to send the data), not quoted.
 216  * @name: marker name, not quoted.
 217  * @format: format string
 218  * @args...: variable argument list
 219  *
 220  * Places a marker using a standard memory read (_imv_read()) to be
 221  * enabled. Should be used for markers in code paths where instruction
 222  * modification based enabling is not welcome.
 223  */
 224 #define _trace_mark(channel, name, format, args...) \
 225         __trace_mark(1, channel, name, NULL, format, ## args)
 226
 227 /**
 228  * trace_mark_tp - Marker in a tracepoint callback
 229  * @channel: marker channel (where to send the data), not quoted.
 230  * @name: marker name, not quoted.
 231  * @tp_name: tracepoint name, not quoted.
 232  * @tp_cb: tracepoint callback. Should have an associated global symbol so it
 233  *         is not optimized away by the compiler (should not be static).
 234  * @format: format string
 235  * @args...: variable argument list
 236  *
 237  * Places a marker in a tracepoint callback.
 238  */
 239 #define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...)   \
 240         __trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)
 241
 242 /**
 243  * MARK_NOARGS - Format string for a marker with no argument.
 244  */
 245 #define MARK_NOARGS " "
 246
 247 extern void lock_markers(void);
 248 extern void unlock_markers(void);
 249
 250 extern void markers_compact_event_ids(void);
 251
 252 /* To be used for string format validity checking with gcc */
 253 static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
 254 {
 255 }
 256
 257 #define __mark_check_format(format, args...)                            \
 258         do {                                                            \
 259                 if (0)                                                  \
 260                         ___mark_check_format(format, ## args);          \
 261         } while (0)
 262
 263 extern marker_probe_func __mark_empty_function;
 264
 265 extern void marker_probe_cb(const struct marker *mdata,
 266         void *call_private, struct registers *regs, ...);
 267
 268 /*
 269  * Connect a probe to a marker.
 270  * private data pointer must be a valid allocated memory address, or NULL.
 271  */
 272 extern int marker_probe_register(const char *channel, const char *name,
 273         const char *format, marker_probe_func *probe, void *probe_private);
 274
 275 /*
 276  * Returns the private data given to marker_probe_register.
 277  */
 278 extern int marker_probe_unregister(const char *channel, const char *name,
 279         marker_probe_func *probe, void *probe_private);
 280 /*
 281  * Unregister a marker by providing the registered private data.
 282  */
 283 extern int marker_probe_unregister_private_data(marker_probe_func *probe,
 284         void *probe_private);
 285
 286 extern void *marker_get_private_data(const char *channel, const char *name,
 287         marker_probe_func *probe, int num);
 288
 289 /*
 290  * marker_synchronize_unregister must be called between the last marker probe
 291  * unregistration and the first one of
 292  * - the end of module exit function
 293  * - the free of any resource used by the probes
 294  * to ensure the code and data are valid for any possibly running probes.
 295  */
 296 #define marker_synchronize_unregister() synchronize_sched()
 297
 298 struct marker_iter {
 299 //ust// struct module *module;
 300         struct lib *lib;
 301         struct marker *marker;
 302 };
 303
 304 extern void marker_iter_start(struct marker_iter *iter);
 305 extern void marker_iter_next(struct marker_iter *iter);
 306 extern void marker_iter_stop(struct marker_iter *iter);
 307 extern void marker_iter_reset(struct marker_iter *iter);
 308 extern int marker_get_iter_range(struct marker **marker, struct marker *begin,
 309         struct marker *end);
 310
 311 extern void marker_update_process(void);
 312 extern int is_marker_enabled(const char *channel, const char *name);
 313
 314 //ust// #ifdef CONFIG_MARKERS_USERSPACE
 315 //ust// extern void exit_user_markers(struct task_struct *p);
 316 //ust// #else
 317 //ust// static inline void exit_user_markers(struct task_struct *p)
 318 //ust// {
 319 //ust// }
 320 //ust// #endif
 321
 322 struct marker_addr {
 323         struct marker *marker;
 324         void *addr;
 325 };
 326
 327 struct lib {
 328         struct marker *markers_start;
 329 #ifdef CONFIG_UST_GDB_INTEGRATION
 330         struct marker_addr *markers_addr_start;
 331 #endif
 332         int markers_count;
 333         struct cds_list_head list;
 334 };
 335
 336 extern int marker_register_lib(struct marker *markers_start, int markers_count);
 337 extern int marker_unregister_lib(struct marker *markers_start);
 338
 339 #define MARKER_LIB                                                      \
 340         extern struct marker __start___markers[] __attribute__((weak, visibility("hidden"))); \
 341         extern struct marker __stop___markers[] __attribute__((weak, visibility("hidden"))); \
 342                                                                         \
 343         static void __attribute__((constructor)) __markers__init(void)  \
 344         {                                                               \
 345                 marker_register_lib(__start___markers, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker)); \
 346         } \
 347         \
 348         static void __attribute__((destructor)) __markers__destroy(void)        \
 349         {                                                               \
 350                 marker_unregister_lib(__start___markers); \
 351         }
 352
 353 extern void marker_set_new_marker_cb(void (*cb)(struct marker *));
 354 extern void init_markers(void);
 355
 356 #endif /* _UST_MARKER_H */