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 //ust// #include <linux/types.h>
  29 #include <ust/immediate.h>
  30 //ust// #include <linux/ltt-channels.h>
  31 #include <ust/kernelcompat.h>
  32 #include <kcompat/list.h>
  33 #include <ust/processor.h>
  34
  35 //ust// struct module;
  36 //ust// struct task_struct;
  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 CONFIG_MARKERS
  81 #ifdef CONFIG_MARKERS
  82
  83 #define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format)       \
  84                 static const char __mstrtab_##channel##_##name[]        \
  85                 __attribute__((section("__markers_strings")))           \
  86                 = #channel "\0" #name "\0" format;                      \
  87                 struct registers regs;                                  \
  88                 static struct marker __mark_##channel##_##name          \
  89                 __attribute__((section("__markers"), aligned(8))) =     \
  90                 { __mstrtab_##channel##_##name,                         \
  91                   &__mstrtab_##channel##_##name[sizeof(#channel)],      \
  92                   &__mstrtab_##channel##_##name[sizeof(#channel) +      \
  93                                                 sizeof(#name)],         \
  94                   0, 0, 0, 0, marker_probe_cb,                          \
  95                   { __mark_empty_function, NULL},                       \
  96                   NULL, tp_name_str, tp_cb, NULL };                     \
  97                 save_ip(channel,name);                                  \
  98                 save_registers(&regs)
  99
 100
 101 #define DEFINE_MARKER(channel, name, format)                            \
 102                 _DEFINE_MARKER(channel, name, NULL, NULL, format)
 103
 104 #define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format)         \
 105                 _DEFINE_MARKER(channel, name, #tp_name, tp_cb, format)
 106
 107 /*
 108  * Make sure the alignment of the structure in the __markers section will
 109  * not add unwanted padding between the beginning of the section and the
 110  * structure. Force alignment to the same alignment as the section start.
 111  *
 112  * The "generic" argument controls which marker enabling mechanism must be used.
 113  * If generic is true, a variable read is used.
 114  * If generic is false, immediate values are used.
 115  */
 116 #define __trace_mark(generic, channel, name, call_private, format, args...) \
 117         do {                                                            \
 118                 DEFINE_MARKER(channel, name, format);                   \
 119                 __mark_check_format(format, ## args);                   \
 120                 if (!generic) {                                         \
 121                         if (unlikely(imv_read(                          \
 122                                         __mark_##channel##_##name.state))) \
 123                                 (*__mark_##channel##_##name.call)       \
 124                                         (&__mark_##channel##_##name,    \
 125                                         call_private, &regs, ## args);          \
 126                 } else {                                                \
 127                         if (unlikely(_imv_read(                         \
 128                                         __mark_##channel##_##name.state))) \
 129                                 (*__mark_##channel##_##name.call)       \
 130                                         (&__mark_##channel##_##name,    \
 131                                         call_private, &regs, ## args);          \
 132                 }                                                       \
 133         } while (0)
 134
 135 #define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb,    \
 136                         format, args...)                                \
 137         do {                                                            \
 138                 void __check_tp_type(void)                              \
 139                 {                                                       \
 140                         register_trace_##tp_name(tp_cb);                \
 141                 }                                                       \
 142                 DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
 143                 __mark_check_format(format, ## args);                   \
 144                 (*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \
 145                         call_private, &regs, ## args);                          \
 146         } while (0)
 147
 148 extern void marker_update_probe_range(struct marker *begin,
 149         struct marker *end);
 150
 151 #define GET_MARKER(channel, name)       (__mark_##channel##_##name)
 152
 153 #else /* !CONFIG_MARKERS */
 154 #define DEFINE_MARKER(channel, name, tp_name, tp_cb, format)
 155 #define __trace_mark(generic, channel, name, call_private, format, args...) \
 156                 __mark_check_format(format, ## args)
 157 #define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb,    \
 158                 format, args...)                                        \
 159         do {                                                            \
 160                 void __check_tp_type(void)                              \
 161                 {                                                       \
 162                         register_trace_##tp_name(tp_cb);                \
 163                 }                                                       \
 164                 __mark_check_format(format, ## args);                   \
 165         } while (0)
 166 static inline void marker_update_probe_range(struct marker *begin,
 167         struct marker *end)
 168 { }
 169 #define GET_MARKER(channel, name)
 170 #endif /* CONFIG_MARKERS */
 171
 172 /**
 173  * trace_mark - Marker using code patching
 174  * @channel: marker channel (where to send the data), not quoted.
 175  * @name: marker name, not quoted.
 176  * @format: format string
 177  * @args...: variable argument list
 178  *
 179  * Places a marker using optimized code patching technique (imv_read())
 180  * to be enabled when immediate values are present.
 181  */
 182 #define trace_mark(channel, name, format, args...) \
 183         __trace_mark(0, channel, name, NULL, format, ## args)
 184
 185 /**
 186  * _trace_mark - Marker using variable read
 187  * @channel: marker channel (where to send the data), not quoted.
 188  * @name: marker name, not quoted.
 189  * @format: format string
 190  * @args...: variable argument list
 191  *
 192  * Places a marker using a standard memory read (_imv_read()) to be
 193  * enabled. Should be used for markers in code paths where instruction
 194  * modification based enabling is not welcome. (__init and __exit functions,
 195  * lockdep, some traps, printk).
 196  */
 197 #define _trace_mark(channel, name, format, args...) \
 198         __trace_mark(1, channel, name, NULL, format, ## args)
 199
 200 /**
 201  * trace_mark_tp - Marker in a tracepoint callback
 202  * @channel: marker channel (where to send the data), not quoted.
 203  * @name: marker name, not quoted.
 204  * @tp_name: tracepoint name, not quoted.
 205  * @tp_cb: tracepoint callback. Should have an associated global symbol so it
 206  *         is not optimized away by the compiler (should not be static).
 207  * @format: format string
 208  * @args...: variable argument list
 209  *
 210  * Places a marker in a tracepoint callback.
 211  */
 212 #define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...)   \
 213         __trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)
 214
 215 /**
 216  * MARK_NOARGS - Format string for a marker with no argument.
 217  */
 218 #define MARK_NOARGS " "
 219
 220 extern void lock_markers(void);
 221 extern void unlock_markers(void);
 222
 223 extern void markers_compact_event_ids(void);
 224
 225 /* To be used for string format validity checking with gcc */
 226 static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
 227 {
 228 }
 229
 230 #define __mark_check_format(format, args...)                            \
 231         do {                                                            \
 232                 if (0)                                                  \
 233                         ___mark_check_format(format, ## args);          \
 234         } while (0)
 235
 236 extern marker_probe_func __mark_empty_function;
 237
 238 extern void marker_probe_cb(const struct marker *mdata,
 239         void *call_private, struct registers *regs, ...);
 240
 241 /*
 242  * Connect a probe to a marker.
 243  * private data pointer must be a valid allocated memory address, or NULL.
 244  */
 245 extern int marker_probe_register(const char *channel, const char *name,
 246         const char *format, marker_probe_func *probe, void *probe_private);
 247
 248 /*
 249  * Returns the private data given to marker_probe_register.
 250  */
 251 extern int marker_probe_unregister(const char *channel, const char *name,
 252         marker_probe_func *probe, void *probe_private);
 253 /*
 254  * Unregister a marker by providing the registered private data.
 255  */
 256 extern int marker_probe_unregister_private_data(marker_probe_func *probe,
 257         void *probe_private);
 258
 259 extern void *marker_get_private_data(const char *channel, const char *name,
 260         marker_probe_func *probe, int num);
 261
 262 /*
 263  * marker_synchronize_unregister must be called between the last marker probe
 264  * unregistration and the first one of
 265  * - the end of module exit function
 266  * - the free of any resource used by the probes
 267  * to ensure the code and data are valid for any possibly running probes.
 268  */
 269 #define marker_synchronize_unregister() synchronize_sched()
 270
 271 struct marker_iter {
 272 //ust// struct module *module;
 273         struct lib *lib;
 274         struct marker *marker;
 275 };
 276
 277 extern void marker_iter_start(struct marker_iter *iter);
 278 extern void marker_iter_next(struct marker_iter *iter);
 279 extern void marker_iter_stop(struct marker_iter *iter);
 280 extern void marker_iter_reset(struct marker_iter *iter);
 281 extern int marker_get_iter_range(struct marker **marker, struct marker *begin,
 282         struct marker *end);
 283
 284 extern void marker_update_process(void);
 285 extern int is_marker_enabled(const char *channel, const char *name);
 286
 287 //ust// #ifdef CONFIG_MARKERS_USERSPACE
 288 //ust// extern void exit_user_markers(struct task_struct *p);
 289 //ust// #else
 290 //ust// static inline void exit_user_markers(struct task_struct *p)
 291 //ust// {
 292 //ust// }
 293 //ust// #endif
 294
 295 struct marker_addr {
 296         struct marker *marker;
 297         void *addr;
 298 };
 299
 300 struct lib {
 301         struct marker *markers_start;
 302 #ifdef CONFIG_UST_GDB_INTEGRATION
 303         struct marker_addr *markers_addr_start;
 304 #endif
 305         int markers_count;
 306         struct list_head list;
 307 };
 308
 309 extern int marker_register_lib(struct marker *markers_start,
 310                                struct marker_addr *marker_addr_start,
 311                                int markers_count);
 312
 313 #ifdef CONFIG_UST_GDB_INTEGRATION
 314
 315 #define MARKER_LIB                                                      \
 316         extern struct marker __start___markers[] __attribute__((weak, visibility("hidden"))); \
 317         extern struct marker __stop___markers[] __attribute__((weak, visibility("hidden"))); \
 318         extern struct marker_addr __start___marker_addr[] __attribute__((weak, visibility("hidden"))); \
 319         extern struct marker_addr __stop___marker_addr[] __attribute__((weak, visibility("hidden"))); \
 320                                                                         \
 321         static void __attribute__((constructor)) __markers__init(void)  \
 322         {                                                               \
 323                 marker_register_lib(__start___markers, __start___marker_addr, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker)); \
 324         }
 325
 326 extern void marker_set_new_marker_cb(void (*cb)(struct marker *));
 327 extern void init_markers(void);
 328
 329 #else /* CONFIG_UST_GDB_INTEGRATION */
 330
 331 #define MARKER_LIB                                                      \
 332         extern struct marker __start___markers[] __attribute__((weak, visibility("hidden"))); \
 333         extern struct marker __stop___markers[] __attribute__((weak, visibility("hidden"))); \
 334                                                                         \
 335         static void __attribute__((constructor)) __markers__init(void)  \
 336         {                                                               \
 337                 marker_register_lib(__start___markers, NULL, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker)); \
 338         }
 339
 340 extern void marker_set_new_marker_cb(void (*cb)(struct marker *));
 341 extern void init_markers(void);
 342
 343 #endif /* CONFIG_UST_GDB_INTEGRATION */
 344
 345 #endif /* _UST_MARKER_H */