probes/define_trace.h

   1 /*
   2  * define_trace.h
   3  *
   4  * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
   5  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; only
  10  * version 2.1 of the License.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /*
  23  * Trace files that want to automate creationg of all tracepoints defined
  24  * in their file should include this file. The following are macros that the
  25  * trace file may define:
  26  *
  27  * TRACE_SYSTEM defines the system the tracepoint is for
  28  *
  29  * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
  30  *     This macro may be defined to tell define_trace.h what file to include.
  31  *     Note, leave off the ".h".
  32  *
  33  * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
  34  *     then this macro can define the path to use. Note, the path is relative to
  35  *     define_trace.h, not the file including it. Full path names for out of tree
  36  *     modules must be used.
  37  */
  38
  39 #ifdef CREATE_TRACE_POINTS
  40
  41 /* Prevent recursion */
  42 #undef CREATE_TRACE_POINTS
  43
  44 #include <linux/stringify.h>
  45
  46 #undef LTTNG_TRACEPOINT_EVENT_MAP
  47 #define LTTNG_TRACEPOINT_EVENT_MAP(name, map, proto, args, tstruct, assign, print)
  48
  49 #undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
  50 #define LTTNG_TRACEPOINT_EVENT_MAP_NOARGS(name, map, tstruct, assign, print)
  51
  52 #undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
  53 #define LTTNG_TRACEPOINT_EVENT_CONDITION_MAP(name, map, proto, args, cond, tstruct, assign, print) \
  54         LTTNG_TRACEPOINT_EVENT(name,                                    \
  55                 PARAMS(proto),                                          \
  56                 PARAMS(args),                                           \
  57                 PARAMS(tstruct),                                        \
  58                 PARAMS(assign),                                         \
  59                 PARAMS(print))
  60
  61 #undef LTTNG_TRACEPOINT_EVENT_FN_MAP
  62 #define LTTNG_TRACEPOINT_EVENT_FN_MAP(name, map, proto, args, tstruct,  \
  63                 assign, print, reg, unreg)
  64
  65 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
  66 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP(template, name, map, proto, args)
  67
  68 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
  69 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP(template, name, map, proto, args, print)
  70
  71 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
  72 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP(template, name, map, proto, args, cond) \
  73         LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))
  74
  75 #undef LTTNG_TRACEPOINT_EVENT
  76 #define LTTNG_TRACEPOINT_EVENT(name, proto, args, tstruct, assign, print)
  77
  78 #undef LTTNG_TRACEPOINT_EVENT_CONDITION
  79 #define LTTNG_TRACEPOINT_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
  80         LTTNG_TRACEPOINT_EVENT(name,                                    \
  81                 PARAMS(proto),                                          \
  82                 PARAMS(args),                                           \
  83                 PARAMS(tstruct),                                        \
  84                 PARAMS(assign),                                         \
  85                 PARAMS(print))
  86
  87 #undef LTTNG_TRACEPOINT_EVENT_CODE
  88 #define LTTNG_TRACEPOINT_EVENT_CODE(name, proto, args, _locvar, _code, tstruct, assign, print)
  89
  90 #undef LTTNG_TRACEPOINT_EVENT_FN
  91 #define LTTNG_TRACEPOINT_EVENT_FN(name, proto, args, tstruct,           \
  92                 assign, print, reg, unreg)
  93
  94 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE
  95 #define LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, proto, args)
  96
  97 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
  98 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS(template, name)
  99
 100 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
 101 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS(template, name, map)
 102
 103 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
 104 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT(template, name, proto, args, print)
 105
 106 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
 107 #define LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION(template, name, proto, args, cond) \
 108         LTTNG_TRACEPOINT_EVENT_INSTANCE(template, name, PARAMS(proto), PARAMS(args))
 109
 110 #undef TRACE_INCLUDE
 111 #undef __TRACE_INCLUDE
 112
 113 #ifndef TRACE_INCLUDE_FILE
 114 # define TRACE_INCLUDE_FILE TRACE_SYSTEM
 115 # define UNDEF_TRACE_INCLUDE_FILE
 116 #endif
 117
 118 #ifndef TRACE_INCLUDE_PATH
 119 # define __TRACE_INCLUDE(system) <trace/events/system.h>
 120 # define UNDEF_TRACE_INCLUDE_PATH
 121 #else
 122 # define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
 123 #endif
 124
 125 # define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
 126
 127 /* Let the trace headers be reread */
 128 #define TRACE_HEADER_MULTI_READ
 129
 130 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 131
 132 /* Make all open coded DECLARE_TRACE nops */
 133 #undef DECLARE_TRACE
 134 #define DECLARE_TRACE(name, proto, args)
 135
 136 #ifdef LTTNG_PACKAGE_BUILD
 137 #include "lttng-events.h"
 138 #endif
 139
 140 #undef LTTNG_TRACEPOINT_EVENT
 141 #undef LTTNG_TRACEPOINT_EVENT_FN
 142 #undef LTTNG_TRACEPOINT_EVENT_CONDITION
 143 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE
 144 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT
 145 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION
 146 #undef LTTNG_TRACEPOINT_EVENT_MAP
 147 #undef LTTNG_TRACEPOINT_EVENT_FN_MAP
 148 #undef LTTNG_TRACEPOINT_EVENT_CONDITION_MAP
 149 #undef LTTNG_TRACEPOINT_EVENT_CLASS
 150 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP
 151 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_PRINT_MAP
 152 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_CONDITION_MAP
 153 #undef LTTNG_TRACEPOINT_EVENT_CODE
 154 #undef LTTNG_TRACEPOINT_EVENT_MAP_NOARGS
 155 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_NOARGS
 156 #undef LTTNG_TRACEPOINT_EVENT_INSTANCE_MAP_NOARGS
 157 #undef TRACE_HEADER_MULTI_READ
 158
 159 /* Only undef what we defined in this file */
 160 #ifdef UNDEF_TRACE_INCLUDE_FILE
 161 # undef TRACE_INCLUDE_FILE
 162 # undef UNDEF_TRACE_INCLUDE_FILE
 163 #endif
 164
 165 #ifdef UNDEF_TRACE_INCLUDE_PATH
 166 # undef TRACE_INCLUDE_PATH
 167 # undef UNDEF_TRACE_INCLUDE_PATH
 168 #endif
 169
 170 /*
 171  * We want to re-include lttng-tracepoint-event.h for a following probe.
 172  */
 173 #undef LTTNG_TRACEPOINT_EVENT_H
 174
 175 /* We may be processing more files */
 176 #define CREATE_TRACE_POINTS
 177
 178 #endif /* CREATE_TRACE_POINTS */