SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/marker.h

   1 #ifndef _LINUX_MARKER_H
   2 #define _LINUX_MARKER_H
   3
   4 /*
   5  * Code markup for dynamic and static tracing.
   6  *
   7  * See Documentation/marker.txt.
   8  *
   9  * (C) Copyright 2006 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
  10  *
  11  * This file is released under the GPLv2.
  12  * See the file COPYING for more details.
  13  */
  14
  15 #include <linux/types.h>
  16 #include <linux/rcupdate.h>
  17
  18 struct module;
  19 struct marker;
  20
  21 /**
  22  * marker_probe_func - Type of a marker probe function
  23  * @probe_private: probe private data
  24  * @call_private: call site private data
  25  * @fmt: format string
  26  * @args: variable argument list pointer. Use a pointer to overcome C's
  27  *        inability to pass this around as a pointer in a portable manner in
  28  *        the callee otherwise.
  29  *
  30  * Type of marker probe functions. They receive the mdata and need to parse the
  31  * format string to recover the variable argument list.
  32  */
  33 typedef void marker_probe_func(void *probe_private, void *call_private,
  34                 const char *fmt, va_list *args);
  35
  36 struct marker_probe_closure {
  37         marker_probe_func *func;        /* Callback */
  38         void *probe_private;            /* Private probe data */
  39 };
  40
  41 struct marker {
  42         const char *name;       /* Marker name */
  43         const char *format;     /* Marker format string, describing the
  44                                  * variable argument list.
  45                                  */
  46         char state;             /* Marker state. */
  47         char ptype;             /* probe type : 0 : single, 1 : multi */
  48                                 /* Probe wrapper */
  49         void (*call)(const struct marker *mdata, void *call_private, ...);
  50         struct marker_probe_closure single;
  51         struct marker_probe_closure *multi;
  52 } __attribute__((aligned(8)));
  53
  54 #ifdef CONFIG_MARKERS
  55
  56 /*
  57  * Note : the empty asm volatile with read constraint is used here instead of a
  58  * "used" attribute to fix a gcc 4.1.x bug.
  59  * Make sure the alignment of the structure in the __markers section will
  60  * not add unwanted padding between the beginning of the section and the
  61  * structure. Force alignment to the same alignment as the section start.
  62  *
  63  * The "generic" argument controls which marker enabling mechanism must be used.
  64  * If generic is true, a variable read is used.
  65  * If generic is false, immediate values are used.
  66  */
  67 #define __trace_mark(generic, name, call_private, format, args...)      \
  68         do {                                                            \
  69                 static const char __mstrtab_##name[]                    \
  70                 __attribute__((section("__markers_strings")))           \
  71                 = #name "\0" format;                                    \
  72                 static struct marker __mark_##name                      \
  73                 __attribute__((section("__markers"), aligned(8))) =     \
  74                 { __mstrtab_##name, &__mstrtab_##name[sizeof(#name)],   \
  75                 0, 0, marker_probe_cb,                                  \
  76                 { __mark_empty_function, NULL}, NULL };                 \
  77                 __mark_check_format(format, ## args);                   \
  78                 if (unlikely(__mark_##name.state)) {                    \
  79                         (*__mark_##name.call)                           \
  80                                 (&__mark_##name, call_private, ## args);\
  81                 }                                                       \
  82         } while (0)
  83
  84 extern void marker_update_probe_range(struct marker *begin,
  85         struct marker *end);
  86 #else /* !CONFIG_MARKERS */
  87 #define __trace_mark(generic, name, call_private, format, args...) \
  88                 __mark_check_format(format, ## args)
  89 static inline void marker_update_probe_range(struct marker *begin,
  90         struct marker *end)
  91 { }
  92 #endif /* CONFIG_MARKERS */
  93
  94 /**
  95  * trace_mark - Marker using code patching
  96  * @name: marker name, not quoted.
  97  * @format: format string
  98  * @args...: variable argument list
  99  *
 100  * Places a marker using optimized code patching technique (imv_read())
 101  * to be enabled when immediate values are present.
 102  */
 103 #define trace_mark(name, format, args...) \
 104         __trace_mark(0, name, NULL, format, ## args)
 105
 106 /**
 107  * _trace_mark - Marker using variable read
 108  * @name: marker name, not quoted.
 109  * @format: format string
 110  * @args...: variable argument list
 111  *
 112  * Places a marker using a standard memory read (_imv_read()) to be
 113  * enabled. Should be used for markers in code paths where instruction
 114  * modification based enabling is not welcome. (__init and __exit functions,
 115  * lockdep, some traps, printk).
 116  */
 117 #define _trace_mark(name, format, args...) \
 118         __trace_mark(1, name, NULL, format, ## args)
 119
 120 /**
 121  * MARK_NOARGS - Format string for a marker with no argument.
 122  */
 123 #define MARK_NOARGS " "
 124
 125 /* To be used for string format validity checking with gcc */
 126 static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
 127 {
 128 }
 129
 130 #define __mark_check_format(format, args...)                            \
 131         do {                                                            \
 132                 if (0)                                                  \
 133                         ___mark_check_format(format, ## args);          \
 134         } while (0)
 135
 136 extern marker_probe_func __mark_empty_function;
 137
 138 extern void marker_probe_cb(const struct marker *mdata,
 139         void *call_private, ...);
 140 extern void marker_probe_cb_noarg(const struct marker *mdata,
 141         void *call_private, ...);
 142
 143 /*
 144  * Connect a probe to a marker.
 145  * private data pointer must be a valid allocated memory address, or NULL.
 146  */
 147 extern int marker_probe_register(const char *name, const char *format,
 148                                 marker_probe_func *probe, void *probe_private);
 149
 150 /*
 151  * Returns the private data given to marker_probe_register.
 152  */
 153 extern int marker_probe_unregister(const char *name,
 154         marker_probe_func *probe, void *probe_private);
 155 /*
 156  * Unregister a marker by providing the registered private data.
 157  */
 158 extern int marker_probe_unregister_private_data(marker_probe_func *probe,
 159         void *probe_private);
 160
 161 extern void *marker_get_private_data(const char *name, marker_probe_func *probe,
 162         int num);
 163
 164 /*
 165  * marker_synchronize_unregister must be called between the last marker probe
 166  * unregistration and the end of module exit to make sure there is no caller
 167  * executing a probe when it is freed.
 168  */
 169 static inline void marker_synchronize_unregister(void)
 170 {
 171         synchronize_sched();
 172 }
 173
 174 #endif