include/trace/define_trace.h

   1 /*
   2  * Trace files that want to automate creationg of all tracepoints defined
   3  * in their file should include this file. The following are macros that the
   4  * trace file may define:
   5  *
   6  * TRACE_SYSTEM defines the system the tracepoint is for
   7  *
   8  * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
   9  *     This macro may be defined to tell define_trace.h what file to include.
  10  *     Note, leave off the ".h".
  11  *
  12  * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
  13  *     then this macro can define the path to use. Note, the path is relative to
  14  *     define_trace.h, not the file including it. Full path names for out of tree
  15  *     modules must be used.
  16  */
  17
  18 #ifdef CREATE_TRACE_POINTS
  19
  20 /* Prevent recursion */
  21 #undef CREATE_TRACE_POINTS
  22
  23 #include <linux/stringify.h>
  24 /*
  25  * module.h includes tracepoints, and because ftrace.h
  26  * used to pull in module.h via this path:
  27  *  trace/ftrace.h -> linux/ftrace_event.h -> linux/perf_event.h ->
  28  *  linux/ftrace.h -> linux/module.h
  29  * we must include module.h here before we play with any of
  30  * the TRACE_EVENT() macros, otherwise the tracepoints included
  31  * by module.h may break the build.
  32  */
  33 #include <linux/module.h>
  34
  35 #undef TRACE_EVENT
  36 #define TRACE_EVENT(name, proto, args, tstruct, assign, print)  \
  37         DEFINE_TRACE(name)
  38
  39 #undef TRACE_EVENT_CONDITION
  40 #define TRACE_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
  41         TRACE_EVENT(name,                                               \
  42                 PARAMS(proto),                                          \
  43                 PARAMS(args),                                           \
  44                 PARAMS(tstruct),                                        \
  45                 PARAMS(assign),                                         \
  46                 PARAMS(print))
  47
  48 #undef TRACE_EVENT_FN
  49 #define TRACE_EVENT_FN(name, proto, args, tstruct,              \
  50                 assign, print, reg, unreg)                      \
  51         DEFINE_TRACE_FN(name, reg, unreg)
  52
  53 #undef DEFINE_EVENT
  54 #define DEFINE_EVENT(template, name, proto, args) \
  55         DEFINE_TRACE(name)
  56
  57 #undef DEFINE_EVENT_PRINT
  58 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)  \
  59         DEFINE_TRACE(name)
  60
  61 #undef DEFINE_EVENT_CONDITION
  62 #define DEFINE_EVENT_CONDITION(template, name, proto, args, cond) \
  63         DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
  64
  65 #undef DECLARE_TRACE
  66 #define DECLARE_TRACE(name, proto, args)        \
  67         DEFINE_TRACE(name)
  68
  69 #undef TRACE_INCLUDE
  70 #undef __TRACE_INCLUDE
  71
  72 #ifndef TRACE_INCLUDE_FILE
  73 # define TRACE_INCLUDE_FILE TRACE_SYSTEM
  74 # define UNDEF_TRACE_INCLUDE_FILE
  75 #endif
  76
  77 #ifndef TRACE_INCLUDE_PATH
  78 # define __TRACE_INCLUDE(system) <trace/events/system.h>
  79 # define UNDEF_TRACE_INCLUDE_PATH
  80 #else
  81 # define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
  82 #endif
  83
  84 # define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
  85
  86 /* Let the trace headers be reread */
  87 #define TRACE_HEADER_MULTI_READ
  88
  89 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
  90
  91 /* Make all open coded DECLARE_TRACE nops */
  92 #undef DECLARE_TRACE
  93 #define DECLARE_TRACE(name, proto, args)
  94
  95 #ifdef CONFIG_EVENT_TRACING
  96 #include <trace/ftrace.h>
  97 #endif
  98
  99 #undef TRACE_EVENT
 100 #undef TRACE_EVENT_FN
 101 #undef TRACE_EVENT_CONDITION
 102 #undef DECLARE_EVENT_CLASS
 103 #undef DEFINE_EVENT
 104 #undef DEFINE_EVENT_PRINT
 105 #undef DEFINE_EVENT_CONDITION
 106 #undef TRACE_HEADER_MULTI_READ
 107 #undef DECLARE_TRACE
 108
 109 /* Only undef what we defined in this file */
 110 #ifdef UNDEF_TRACE_INCLUDE_FILE
 111 # undef TRACE_INCLUDE_FILE
 112 # undef UNDEF_TRACE_INCLUDE_FILE
 113 #endif
 114
 115 #ifdef UNDEF_TRACE_INCLUDE_PATH
 116 # undef TRACE_INCLUDE_PATH
 117 # undef UNDEF_TRACE_INCLUDE_PATH
 118 #endif
 119
 120 /* We may be processing more files */
 121 #define CREATE_TRACE_POINTS
 122
 123 #endif /* CREATE_TRACE_POINTS */