2 * If TRACE_SYSTEM is defined, that will be the directory created
3 * in the ftrace directory under /sys/kernel/debug/tracing/events/<system>
5 * The define_trace.h below will also look for a file name of
6 * TRACE_SYSTEM.h where TRACE_SYSTEM is what is defined here.
7 * In this case, it would look for sample.h
9 * If the header name will be different than the system name
10 * (as in this case), then you can override the header name that
11 * define_trace.h will look up by defining TRACE_INCLUDE_FILE
13 * This file is called trace-events-sample.h but we want the system
14 * to be called "sample". Therefore we must define the name of this
17 * #define TRACE_INCLUDE_FILE trace-events-sample
19 * As we do an the bottom of this file.
21 * Notice that TRACE_SYSTEM should be defined outside of #if
22 * protection, just like TRACE_INCLUDE_FILE.
25 #define TRACE_SYSTEM sep
28 * Notice that this file is not protected like a normal header.
29 * We also must allow for rereading of this file. The
31 * || defined(TRACE_HEADER_MULTI_READ)
33 * serves this purpose.
35 #if !defined(_TRACE_SEP_EVENTS_H) || defined(TRACE_HEADER_MULTI_READ)
36 #define _TRACE_SEP_EVENTS_H
39 #define SEP_TRACE_FUNC_IN() trace_sep_func_start(__func__, 0)
40 #define SEP_TRACE_FUNC_OUT(branch) trace_sep_func_end(__func__, branch)
41 #define SEP_TRACE_EVENT(branch) trace_sep_misc_event(__func__, branch)
43 #define SEP_TRACE_FUNC_IN()
44 #define SEP_TRACE_FUNC_OUT(branch)
45 #define SEP_TRACE_EVENT(branch)
50 * All trace headers should include tracepoint.h, until we finally
51 * make it into a standard header.
53 #include <linux/tracepoint.h>
56 * Since use str*cpy in header file, better to include string.h, directly.
58 #include <linux/string.h>
61 * The TRACE_EVENT macro is broken up into 5 parts.
63 * name: name of the trace point. This is also how to enable the tracepoint.
64 * A function called trace_foo_bar() will be created.
66 * proto: the prototype of the function trace_foo_bar()
67 * Here it is trace_foo_bar(char *foo, int bar).
69 * args: must match the arguments in the prototype.
70 * Here it is simply "foo, bar".
72 * struct: This defines the way the data will be stored in the ring buffer.
73 * There are currently two types of elements. __field and __array.
74 * a __field is broken up into (type, name). Where type can be any
76 * For an array. there are three fields. (type, name, size). The
77 * type of elements in the array, the name of the field and the size
80 * __array( char, foo, 10) is the same as saying char foo[10].
82 * fast_assign: This is a C like function that is used to store the items
83 * into the ring buffer.
85 * printk: This is a way to print out the data in pretty print. This is
86 * useful if the system crashes and you are logging via a serial line,
87 * the data can be printed to the console using this "printk" method.
89 * Note, that for both the assign and the printk, __entry is the handler
90 * to the data structure in the ring buffer, and is defined by the
93 TRACE_EVENT(sep_func_start
,
95 TP_PROTO(const char *name
, int branch
),
97 TP_ARGS(name
, branch
),
100 __array(char, name
, 20)
105 strlcpy(__entry
->name
, name
, 20);
106 __entry
->branch
= branch
;
109 TP_printk("func_start %s %d", __entry
->name
, __entry
->branch
)
112 TRACE_EVENT(sep_func_end
,
114 TP_PROTO(const char *name
, int branch
),
116 TP_ARGS(name
, branch
),
119 __array(char, name
, 20)
124 strlcpy(__entry
->name
, name
, 20);
125 __entry
->branch
= branch
;
128 TP_printk("func_end %s %d", __entry
->name
, __entry
->branch
)
131 TRACE_EVENT(sep_misc_event
,
133 TP_PROTO(const char *name
, int branch
),
135 TP_ARGS(name
, branch
),
138 __array(char, name
, 20)
143 strlcpy(__entry
->name
, name
, 20);
144 __entry
->branch
= branch
;
147 TP_printk("misc_event %s %d", __entry
->name
, __entry
->branch
)
153 /***** NOTICE! The #if protection ends here. *****/
157 * There are several ways I could have done this. If I left out the
158 * TRACE_INCLUDE_PATH, then it would default to the kernel source
159 * include/trace/events directory.
161 * I could specify a path from the define_trace.h file back to this
164 * #define TRACE_INCLUDE_PATH ../../samples/trace_events
166 * But the safest and easiest way to simply make it use the directory
167 * that the file is in is to add in the Makefile:
169 * CFLAGS_trace-events-sample.o := -I$(src)
171 * This will make sure the current path is part of the include
172 * structure for our file so that define_trace.h can find it.
174 * I could have made only the top level directory the include:
176 * CFLAGS_trace-events-sample.o := -I$(PWD)
178 * And then let the path to this directory be the TRACE_INCLUDE_PATH:
180 * #define TRACE_INCLUDE_PATH samples/trace_events
182 * But then if something defines "samples" or "trace_events" as a macro
183 * then we could risk that being converted too, and give us an unexpected
186 #undef TRACE_INCLUDE_PATH
187 #undef TRACE_INCLUDE_FILE
188 #define TRACE_INCLUDE_PATH .
190 * TRACE_INCLUDE_FILE is not needed if the filename and TRACE_SYSTEM are equal
192 #define TRACE_INCLUDE_FILE sep_trace_events
193 #include <trace/define_trace.h>
This page took 0.069602 seconds and 6 git commands to generate.