include/trace/define_trace.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Trace files that want to automate creation of all tracepoints defined
   4  * in their file should include this file. The following are macros that the
   5  * trace file may define:
   6  *
   7  * TRACE_SYSTEM defines the system the tracepoint is for
   8  *
   9  * TRACE_INCLUDE_FILE if the file name is something other than TRACE_SYSTEM.h
  10  *     This macro may be defined to tell define_trace.h what file to include.
  11  *     Note, leave off the ".h".
  12  *
  13  * TRACE_INCLUDE_PATH if the path is something other than core kernel include/trace
  14  *     then this macro can define the path to use. Note, the path is relative to
  15  *     define_trace.h, not the file including it. Full path names for out of tree
  16  *     modules must be used.
  17  */
  18
  19 #ifdef CREATE_TRACE_POINTS
  20
  21 /* Prevent recursion */
  22 #undef CREATE_TRACE_POINTS
  23
  24 #include <linux/stringify.h>
  25
  26 #undef TRACE_EVENT
  27 #define TRACE_EVENT(name, proto, args, tstruct, assign, print)  \
  28         DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
  29
  30 #undef TRACE_EVENT_CONDITION
  31 #define TRACE_EVENT_CONDITION(name, proto, args, cond, tstruct, assign, print) \
  32         TRACE_EVENT(name,                                               \
  33                 PARAMS(proto),                                          \
  34                 PARAMS(args),                                           \
  35                 PARAMS(tstruct),                                        \
  36                 PARAMS(assign),                                         \
  37                 PARAMS(print))
  38
  39 #undef TRACE_EVENT_FN
  40 #define TRACE_EVENT_FN(name, proto, args, tstruct,              \
  41                 assign, print, reg, unreg)                      \
  42         DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
  43
  44 #undef TRACE_EVENT_FN_COND
  45 #define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct,           \
  46                 assign, print, reg, unreg)                      \
  47         DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
  48
  49 #undef TRACE_EVENT_SYSCALL
  50 #define TRACE_EVENT_SYSCALL(name, proto, args, struct, assign, print, reg, unreg) \
  51         DEFINE_TRACE_SYSCALL(name, reg, unreg, PARAMS(proto), PARAMS(args))
  52
  53 #undef TRACE_EVENT_NOP
  54 #define TRACE_EVENT_NOP(name, proto, args, struct, assign, print)
  55
  56 #undef DEFINE_EVENT_NOP
  57 #define DEFINE_EVENT_NOP(template, name, proto, args)
  58
  59 #undef DEFINE_EVENT
  60 #define DEFINE_EVENT(template, name, proto, args) \
  61         DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
  62
  63 #undef DEFINE_EVENT_FN
  64 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
  65         DEFINE_TRACE_FN(name, reg, unreg, PARAMS(proto), PARAMS(args))
  66
  67 #undef DEFINE_EVENT_PRINT
  68 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)  \
  69         DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
  70
  71 #undef DEFINE_EVENT_CONDITION
  72 #define DEFINE_EVENT_CONDITION(template, name, proto, args, cond) \
  73         DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
  74
  75 #undef DECLARE_TRACE
  76 #define DECLARE_TRACE(name, proto, args)        \
  77         DEFINE_TRACE(name, PARAMS(proto), PARAMS(args))
  78
  79 /* If requested, create helpers for calling these tracepoints from Rust. */
  80 #ifdef CREATE_RUST_TRACE_POINTS
  81 #undef DEFINE_RUST_DO_TRACE
  82 #define DEFINE_RUST_DO_TRACE(name, proto, args) \
  83         __DEFINE_RUST_DO_TRACE(name, PARAMS(proto), PARAMS(args))
  84 #endif
  85
  86 #undef TRACE_INCLUDE
  87 #undef __TRACE_INCLUDE
  88
  89 #ifndef TRACE_INCLUDE_FILE
  90 # define TRACE_INCLUDE_FILE TRACE_SYSTEM
  91 # define UNDEF_TRACE_INCLUDE_FILE
  92 #endif
  93
  94 #ifndef TRACE_INCLUDE_PATH
  95 # define __TRACE_INCLUDE(system) <trace/events/system.h>
  96 # define UNDEF_TRACE_INCLUDE_PATH
  97 #else
  98 # define __TRACE_INCLUDE(system) __stringify(TRACE_INCLUDE_PATH/system.h)
  99 #endif
 100
 101 # define TRACE_INCLUDE(system) __TRACE_INCLUDE(system)
 102
 103 /* Let the trace headers be reread */
 104 #define TRACE_HEADER_MULTI_READ
 105
 106 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 107
 108 /* Make all open coded DECLARE_TRACE nops */
 109 #undef DECLARE_TRACE
 110 #define DECLARE_TRACE(name, proto, args)
 111
 112 #ifdef TRACEPOINTS_ENABLED
 113 #include <trace/trace_events.h>
 114 #include <trace/perf.h>
 115 #include <trace/bpf_probe.h>
 116 #endif
 117
 118 #undef TRACE_EVENT
 119 #undef TRACE_EVENT_FN
 120 #undef TRACE_EVENT_FN_COND
 121 #undef TRACE_EVENT_SYSCALL
 122 #undef TRACE_EVENT_CONDITION
 123 #undef TRACE_EVENT_NOP
 124 #undef DEFINE_EVENT_NOP
 125 #undef DECLARE_EVENT_CLASS
 126 #undef DEFINE_EVENT
 127 #undef DEFINE_EVENT_FN
 128 #undef DEFINE_EVENT_PRINT
 129 #undef DEFINE_EVENT_CONDITION
 130 #undef TRACE_HEADER_MULTI_READ
 131 #undef DECLARE_TRACE
 132
 133 /* Only undef what we defined in this file */
 134 #ifdef UNDEF_TRACE_INCLUDE_FILE
 135 # undef TRACE_INCLUDE_FILE
 136 # undef UNDEF_TRACE_INCLUDE_FILE
 137 #endif
 138
 139 #ifdef UNDEF_TRACE_INCLUDE_PATH
 140 # undef TRACE_INCLUDE_PATH
 141 # undef UNDEF_TRACE_INCLUDE_PATH
 142 #endif
 143
 144 #ifdef CREATE_RUST_TRACE_POINTS
 145 # undef DEFINE_RUST_DO_TRACE
 146 # define DEFINE_RUST_DO_TRACE(name, proto, args)
 147 #endif
 148
 149 /* We may be processing more files */
 150 #define CREATE_TRACE_POINTS
 151
 152 #endif /* CREATE_TRACE_POINTS */