2 * Code markup for dynamic and static tracing.
4 * See Documentation/marker.txt.
6 * (C) Copyright 2006 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
7 * (C) Copyright 2009 Pierre-Marc Fournier <pierre-marc dot fournier at polymtl dot ca>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 //ust// #include <linux/types.h>
29 #include <ust/immediate.h>
30 //ust// #include <linux/ltt-channels.h>
31 #include <ust/kernelcompat.h>
32 #include <kcompat/list.h>
33 #include <ust/processor.h>
35 //ust// struct module;
36 //ust// struct task_struct;
40 * marker_probe_func - Type of a marker probe function
42 * @probe_private: probe private data
43 * @call_private: call site private data
45 * @args: variable argument list pointer. Use a pointer to overcome C's
46 * inability to pass this around as a pointer in a portable manner in
47 * the callee otherwise.
49 * Type of marker probe functions. They receive the mdata and need to parse the
50 * format string to recover the variable argument list.
52 typedef void marker_probe_func(const struct marker
*mdata
,
53 void *probe_private
, struct registers
*regs
, void *call_private
,
54 const char *fmt
, va_list *args
);
56 struct marker_probe_closure
{
57 marker_probe_func
*func
; /* Callback */
58 void *probe_private
; /* Private probe data */
62 const char *channel
; /* Name of channel where to send data */
63 const char *name
; /* Marker name */
64 const char *format
; /* Marker format string, describing the
65 * variable argument list.
67 DEFINE_IMV(char, state
);/* Immediate value state. */
68 char ptype
; /* probe type : 0 : single, 1 : multi */
70 u16 channel_id
; /* Numeric channel identifier, dynamic */
71 u16 event_id
; /* Numeric event identifier, dynamic */
72 void (*call
)(const struct marker
*mdata
, void *call_private
, struct registers
*regs
, ...);
73 struct marker_probe_closure single
;
74 struct marker_probe_closure
*multi
;
75 const char *tp_name
; /* Optional tracepoint name */
76 void *tp_cb
; /* Optional tracepoint callback */
77 void *location
; /* Address of marker in code */
78 } __attribute__((aligned(8)));
80 #define CONFIG_MARKERS
83 #define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format) \
84 static const char __mstrtab_##channel##_##name[] \
85 __attribute__((section("__markers_strings"))) \
86 = #channel "\0" #name "\0" format; \
87 struct registers regs; \
88 static struct marker __mark_##channel##_##name \
89 __attribute__((section("__markers"), aligned(8))) = \
90 { __mstrtab_##channel##_##name, \
91 &__mstrtab_##channel##_##name[sizeof(#channel)], \
92 &__mstrtab_##channel##_##name[sizeof(#channel) + \
94 0, 0, 0, 0, marker_probe_cb, \
95 { __mark_empty_function, NULL}, \
96 NULL, tp_name_str, tp_cb, NULL }; \
97 save_ip(channel,name); \
101 #define DEFINE_MARKER(channel, name, format) \
102 _DEFINE_MARKER(channel, name, NULL, NULL, format)
104 #define DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format) \
105 _DEFINE_MARKER(channel, name, #tp_name, tp_cb, format)
108 * Make sure the alignment of the structure in the __markers section will
109 * not add unwanted padding between the beginning of the section and the
110 * structure. Force alignment to the same alignment as the section start.
112 * The "generic" argument controls which marker enabling mechanism must be used.
113 * If generic is true, a variable read is used.
114 * If generic is false, immediate values are used.
116 #define __trace_mark(generic, channel, name, call_private, format, args...) \
118 DEFINE_MARKER(channel, name, format); \
119 __mark_check_format(format, ## args); \
121 if (unlikely(imv_read( \
122 __mark_##channel##_##name.state))) \
123 (*__mark_##channel##_##name.call) \
124 (&__mark_##channel##_##name, \
125 call_private, ®s, ## args); \
127 if (unlikely(_imv_read( \
128 __mark_##channel##_##name.state))) \
129 (*__mark_##channel##_##name.call) \
130 (&__mark_##channel##_##name, \
131 call_private, ®s, ## args); \
135 #define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, \
138 void __check_tp_type(void) \
140 register_trace_##tp_name(tp_cb); \
142 DEFINE_MARKER_TP(channel, name, tp_name, tp_cb, format);\
143 __mark_check_format(format, ## args); \
144 (*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \
145 call_private, ®s, ## args); \
148 extern void marker_update_probe_range(struct marker
*begin
,
151 #define GET_MARKER(channel, name) (__mark_##channel##_##name)
153 #else /* !CONFIG_MARKERS */
154 #define DEFINE_MARKER(channel, name, tp_name, tp_cb, format)
155 #define __trace_mark(generic, channel, name, call_private, format, args...) \
156 __mark_check_format(format, ## args)
157 #define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, \
160 void __check_tp_type(void) \
162 register_trace_##tp_name(tp_cb); \
164 __mark_check_format(format, ## args); \
166 static inline void marker_update_probe_range(struct marker
*begin
,
169 #define GET_MARKER(channel, name)
170 #endif /* CONFIG_MARKERS */
173 * trace_mark - Marker using code patching
174 * @channel: marker channel (where to send the data), not quoted.
175 * @name: marker name, not quoted.
176 * @format: format string
177 * @args...: variable argument list
179 * Places a marker using optimized code patching technique (imv_read())
180 * to be enabled when immediate values are present.
182 #define trace_mark(channel, name, format, args...) \
183 __trace_mark(0, channel, name, NULL, format, ## args)
186 * _trace_mark - Marker using variable read
187 * @channel: marker channel (where to send the data), not quoted.
188 * @name: marker name, not quoted.
189 * @format: format string
190 * @args...: variable argument list
192 * Places a marker using a standard memory read (_imv_read()) to be
193 * enabled. Should be used for markers in code paths where instruction
194 * modification based enabling is not welcome. (__init and __exit functions,
195 * lockdep, some traps, printk).
197 #define _trace_mark(channel, name, format, args...) \
198 __trace_mark(1, channel, name, NULL, format, ## args)
201 * trace_mark_tp - Marker in a tracepoint callback
202 * @channel: marker channel (where to send the data), not quoted.
203 * @name: marker name, not quoted.
204 * @tp_name: tracepoint name, not quoted.
205 * @tp_cb: tracepoint callback. Should have an associated global symbol so it
206 * is not optimized away by the compiler (should not be static).
207 * @format: format string
208 * @args...: variable argument list
210 * Places a marker in a tracepoint callback.
212 #define trace_mark_tp(channel, name, tp_name, tp_cb, format, args...) \
213 __trace_mark_tp(channel, name, NULL, tp_name, tp_cb, format, ## args)
216 * MARK_NOARGS - Format string for a marker with no argument.
218 #define MARK_NOARGS " "
220 extern void lock_markers(void);
221 extern void unlock_markers(void);
223 extern void markers_compact_event_ids(void);
225 /* To be used for string format validity checking with gcc */
226 static inline void __printf(1, 2) ___mark_check_format(const char *fmt
, ...)
230 #define __mark_check_format(format, args...) \
233 ___mark_check_format(format, ## args); \
236 extern marker_probe_func __mark_empty_function
;
238 extern void marker_probe_cb(const struct marker
*mdata
,
239 void *call_private
, struct registers
*regs
, ...);
242 * Connect a probe to a marker.
243 * private data pointer must be a valid allocated memory address, or NULL.
245 extern int marker_probe_register(const char *channel
, const char *name
,
246 const char *format
, marker_probe_func
*probe
, void *probe_private
);
249 * Returns the private data given to marker_probe_register.
251 extern int marker_probe_unregister(const char *channel
, const char *name
,
252 marker_probe_func
*probe
, void *probe_private
);
254 * Unregister a marker by providing the registered private data.
256 extern int marker_probe_unregister_private_data(marker_probe_func
*probe
,
257 void *probe_private
);
259 extern void *marker_get_private_data(const char *channel
, const char *name
,
260 marker_probe_func
*probe
, int num
);
263 * marker_synchronize_unregister must be called between the last marker probe
264 * unregistration and the first one of
265 * - the end of module exit function
266 * - the free of any resource used by the probes
267 * to ensure the code and data are valid for any possibly running probes.
269 #define marker_synchronize_unregister() synchronize_sched()
272 //ust// struct module *module;
274 struct marker
*marker
;
277 extern void marker_iter_start(struct marker_iter
*iter
);
278 extern void marker_iter_next(struct marker_iter
*iter
);
279 extern void marker_iter_stop(struct marker_iter
*iter
);
280 extern void marker_iter_reset(struct marker_iter
*iter
);
281 extern int marker_get_iter_range(struct marker
**marker
, struct marker
*begin
,
284 extern void marker_update_process(void);
285 extern int is_marker_enabled(const char *channel
, const char *name
);
287 //ust// #ifdef CONFIG_MARKERS_USERSPACE
288 //ust// extern void exit_user_markers(struct task_struct *p);
290 //ust// static inline void exit_user_markers(struct task_struct *p)
296 struct marker
*marker
;
301 struct marker
*markers_start
;
302 #ifdef CONFIG_UST_GDB_INTEGRATION
303 struct marker_addr
*markers_addr_start
;
306 struct list_head list
;
309 extern int marker_register_lib(struct marker
*markers_start
,
310 struct marker_addr
*marker_addr_start
,
313 #ifdef CONFIG_UST_GDB_INTEGRATION
316 extern struct marker __start___markers[] __attribute__((weak, visibility("hidden"))); \
317 extern struct marker __stop___markers[] __attribute__((weak, visibility("hidden"))); \
318 extern struct marker_addr __start___marker_addr[] __attribute__((weak, visibility("hidden"))); \
319 extern struct marker_addr __stop___marker_addr[] __attribute__((weak, visibility("hidden"))); \
321 static void __attribute__((constructor)) __markers__init(void) \
323 marker_register_lib(__start___markers, __start___marker_addr, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker)); \
326 extern void marker_set_new_marker_cb(void (*cb
)(struct marker
*));
327 extern void init_markers(void);
329 #else /* CONFIG_UST_GDB_INTEGRATION */
332 extern struct marker __start___markers[] __attribute__((weak, visibility("hidden"))); \
333 extern struct marker __stop___markers[] __attribute__((weak, visibility("hidden"))); \
335 static void __attribute__((constructor)) __markers__init(void) \
337 marker_register_lib(__start___markers, NULL, (((long)__stop___markers)-((long)__start___markers))/sizeof(struct marker)); \
340 extern void marker_set_new_marker_cb(void (*cb
)(struct marker
*));
341 extern void init_markers(void);
343 #endif /* CONFIG_UST_GDB_INTEGRATION */
345 #endif /* _UST_MARKER_H */