Markers: API change: rename trace_mark() to ust_marker()
[ust.git] / include / ust / marker.h
1 /*
2 * Code markup for dynamic and static tracing.
3 *
4 * See Documentation/marker.txt.
5 *
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>
8 *
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.
13 *
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.
18 *
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
22 */
23
24 #ifndef _UST_MARKER_H
25 #define _UST_MARKER_H
26
27 #include <stdarg.h>
28 #include <ust/immediate.h>
29 #include <ust/core.h>
30 #include <urcu/list.h>
31 #include <ust/processor.h>
32 #include <ust/kcompat/kcompat.h>
33 #include <ust/kcompat/stringify.h>
34
35 #include <bits/wordsize.h>
36
37 struct marker;
38
39 /**
40 * marker_probe_func - Type of a marker probe function
41 * @mdata: marker data
42 * @probe_private: probe private data
43 * @call_private: call site private data
44 * @fmt: format string
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.
48 *
49 * Type of marker probe functions. They receive the mdata and need to parse the
50 * format string to recover the variable argument list.
51 */
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);
55
56 struct marker_probe_closure {
57 marker_probe_func *func; /* Callback */
58 void *probe_private; /* Private probe data */
59 };
60
61 struct marker {
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.
66 */
67 DEFINE_IMV(char, state);/* Immediate value state. */
68 char ptype; /* probe type : 0 : single, 1 : multi */
69 /* Probe wrapper */
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 };
79
80 #define GET_MARKER(name) (__mark_ust_##name)
81
82 #define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format, unique, m) \
83 struct registers __marker_regs; \
84 \
85 /* This next asm has to be a basic inline asm (no input/output/clobber), \
86 * because it must not require %-sign escaping, as we most certainly \
87 * have some %-signs in the format string. \
88 */ \
89 asm volatile ( \
90 /* We only define these symbols if they have not yet been defined. Indeed, \
91 * if two markers with the same channel/name are on the same line, they \
92 * will try to create the same symbols, resulting in a conflict. This \
93 * is not unusual as it can be the result of function inlining. \
94 */ \
95 ".ifndef __mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) "\n\t" \
96 /*".section __markers_strings\n\t"*/ \
97 ".section __markers_strings,\"aw\"\n\t" \
98 "__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ":\n\t" \
99 ".string \"" __stringify(channel) "\"\n\t" \
100 "__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ":\n\t" \
101 ".string \"" __stringify(name) "\"\n\t" \
102 "__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ":\n\t" \
103 ".string " "\"" format "\"" "\n\t" \
104 ".previous\n\t" \
105 ".endif\n\t" \
106 ); \
107 asm volatile ( \
108 /*".section __markers\n\t"*/ \
109 ".section __markers,\"aw\"\n\t" \
110 "2:\n\t" \
111 _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ")\n\t" /* channel string */ \
112 _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ")\n\t" /* name string */ \
113 _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ")\n\t" /* format string */ \
114 ".byte 0\n\t" /* state imv */ \
115 ".byte 0\n\t" /* ptype */ \
116 ".hword 0\n\t" /* channel_id */ \
117 ".hword 0\n\t" /* event_id */ \
118 ".balign " __stringify(__WORDSIZE) " / 8\n\t" /* alignment */ \
119 _ASM_PTR "(marker_probe_cb)\n\t" /* call */ \
120 _ASM_PTR "(__mark_empty_function)\n\t" /* marker_probe_closure single.field1 */ \
121 _ASM_PTR "0\n\t" /* marker_probe_closure single.field2 */ \
122 _ASM_PTR "0\n\t" /* marker_probe_closure *multi */ \
123 _ASM_PTR "0\n\t" /* tp_name */ \
124 _ASM_PTR "0\n\t" /* tp_cb */ \
125 _ASM_PTR "(1f)\n\t" /* location */ \
126 ".previous\n\t" \
127 /*".section __markers_ptrs\n\t"*/ \
128 ".section __markers_ptrs,\"a\"\n\t" \
129 _ASM_PTR "(2b)\n\t" \
130 ".previous\n\t" \
131 "1:\n\t" \
132 ARCH_COPY_ADDR("%[outptr]") \
133 : [outptr] "=r" (m) ); \
134 \
135 save_registers(&__marker_regs)
136
137
138 #define DEFINE_MARKER(name, format, unique, m) \
139 _DEFINE_MARKER(ust, name, NULL, NULL, format, unique, m)
140
141 #define DEFINE_MARKER_TP(name, tp_name, tp_cb, format) \
142 _DEFINE_MARKER_TP(ust, name, #tp_name, tp_cb, format)
143
144 #define _DEFINE_MARKER_TP(channel, name, tp_name_str, tp_cb, format) \
145 static const char __mstrtab_##channel##_##name[] \
146 __attribute__((section("__markers_strings"))) \
147 = #channel "\0" #name "\0" format; \
148 static struct marker __mark_##channel##_##name \
149 __attribute__((section("__markers"))) = \
150 { __mstrtab_##channel##_##name, \
151 &__mstrtab_##channel##_##name[sizeof(#channel)], \
152 &__mstrtab_##channel##_##name[sizeof(#channel) + sizeof(#name)], \
153 0, 0, 0, 0, marker_probe_cb, \
154 { __mark_empty_function, NULL}, \
155 NULL, tp_name_str, tp_cb }; \
156 static struct marker * const __mark_ptr_##channel##_##name \
157 __attribute__((used, section("__markers_ptrs"))) = \
158 &__mark_##channel##_##name;
159
160 /*
161 * Make sure the alignment of the structure in the __markers section will
162 * not add unwanted padding between the beginning of the section and the
163 * structure. Force alignment to the same alignment as the section start.
164 *
165 * The "generic" argument controls which marker enabling mechanism must be used.
166 * If generic is true, a variable read is used.
167 * If generic is false, immediate values are used.
168 */
169
170 #define __ust_marker(generic, channel, name, call_private, format, args...) \
171 __ust_marker_counter(generic, channel, name, __LINE__, call_private, format, ## args)
172
173 #define __ust_marker_counter(generic, channel, name, unique, call_private, format, args...) \
174 do { \
175 struct marker *__marker_counter_ptr; \
176 _DEFINE_MARKER(channel, name, NULL, NULL, format, unique, __marker_counter_ptr); \
177 __mark_check_format(format, ## args); \
178 if (!generic) { \
179 if (unlikely(imv_read(__marker_counter_ptr->state))) \
180 (__marker_counter_ptr->call)(__marker_counter_ptr, call_private, &__marker_regs, ## args); \
181 } else { \
182 if (unlikely(_imv_read(__marker_counter_ptr->state))) \
183 (__marker_counter_ptr->call)(__marker_counter_ptr, call_private, &__marker_regs, ## args); \
184 } \
185 } while (0)
186
187 #define __ust_marker_tp(channel, name, call_private, tp_name, tp_cb, format, args...) \
188 __ust_marker_tp_counter(channel, name, __LINE__, call_private, tp_name, tp_cb, format, ## args)
189
190 #define __ust_marker_tp_counter(channel, name, unique, call_private, tp_name, tp_cb, format, args...) \
191 do { \
192 struct registers __marker_regs; \
193 void __check_tp_type(void) \
194 { \
195 register_trace_##tp_name(tp_cb, call_private); \
196 } \
197 _DEFINE_MARKER_TP(channel, name, #tp_name, tp_cb, format); \
198 __mark_check_format(format, ## args); \
199 (*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \
200 call_private, &__marker_regs, ## args); \
201 } while (0)
202
203 extern void marker_update_probe_range(struct marker * const *begin,
204 struct marker * const *end);
205
206 /**
207 * ust_marker - Marker using code patching
208 * @name: marker name, not quoted.
209 * @format: format string
210 * @args...: variable argument list
211 *
212 * Places a marker using optimized code patching technique (imv_read())
213 * to be enabled when immediate values are present.
214 */
215 #define ust_marker(name, format, args...) \
216 __ust_marker(0, ust, name, NULL, format, ## args)
217
218 /**
219 * _ust_marker - Marker using variable read
220 * @name: marker name, not quoted.
221 * @format: format string
222 * @args...: variable argument list
223 *
224 * Places a marker using a standard memory read (_imv_read()) to be
225 * enabled. Should be used for markers in code paths where instruction
226 * modification based enabling is not welcome.
227 */
228 #define _ust_marker(name, format, args...) \
229 __ust_marker(1, ust, name, NULL, format, ## args)
230
231 /**
232 * ust_marker_tp - Marker in a tracepoint callback
233 * @name: marker name, not quoted.
234 * @tp_name: tracepoint name, not quoted.
235 * @tp_cb: tracepoint callback. Should have an associated global symbol so it
236 * is not optimized away by the compiler (should not be static).
237 * @format: format string
238 * @args...: variable argument list
239 *
240 * Places a marker in a tracepoint callback.
241 */
242 #define ust_marker_tp(name, tp_name, tp_cb, format, args...) \
243 __ust_marker_tp(ust, name, NULL, tp_name, tp_cb, format, ## args)
244
245 /**
246 * MARK_NOARGS - Format string for a marker with no argument.
247 */
248 #define MARK_NOARGS " "
249
250 extern void lock_markers(void);
251 extern void unlock_markers(void);
252
253 extern void markers_compact_event_ids(void);
254
255 /* To be used for string format validity checking with gcc */
256 static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...)
257 {
258 }
259
260 #define __mark_check_format(format, args...) \
261 do { \
262 if (0) \
263 ___mark_check_format(format, ## args); \
264 } while (0)
265
266 extern marker_probe_func __mark_empty_function;
267
268 extern void marker_probe_cb(const struct marker *mdata,
269 void *call_private, struct registers *regs, ...);
270
271 /*
272 * Connect a probe to a marker.
273 * private data pointer must be a valid allocated memory address, or NULL.
274 */
275 extern int marker_probe_register(const char *channel, const char *name,
276 const char *format, marker_probe_func *probe, void *probe_private);
277
278 /*
279 * Returns the private data given to marker_probe_register.
280 */
281 extern int marker_probe_unregister(const char *channel, const char *name,
282 marker_probe_func *probe, void *probe_private);
283 /*
284 * Unregister a marker by providing the registered private data.
285 */
286 extern int marker_probe_unregister_private_data(marker_probe_func *probe,
287 void *probe_private);
288
289 extern void *marker_get_private_data(const char *channel, const char *name,
290 marker_probe_func *probe, int num);
291
292 /*
293 * marker_synchronize_unregister must be called between the last marker probe
294 * unregistration and the first one of
295 * - the end of module exit function
296 * - the free of any resource used by the probes
297 * to ensure the code and data are valid for any possibly running probes.
298 */
299 #define marker_synchronize_unregister() synchronize_sched()
300
301 struct marker_iter {
302 //ust// struct module *module;
303 struct lib *lib;
304 struct marker * const *marker;
305 };
306
307 extern void marker_iter_start(struct marker_iter *iter);
308 extern void marker_iter_next(struct marker_iter *iter);
309 extern void marker_iter_stop(struct marker_iter *iter);
310 extern void marker_iter_reset(struct marker_iter *iter);
311 extern int marker_get_iter_range(struct marker * const **marker, struct marker * const *begin,
312 struct marker * const *end);
313
314 extern void marker_update_process(void);
315 extern int is_marker_enabled(const char *channel, const char *name);
316
317 //ust// #ifdef CONFIG_MARKERS_USERSPACE
318 //ust// extern void exit_user_markers(struct task_struct *p);
319 //ust// #else
320 //ust// static inline void exit_user_markers(struct task_struct *p)
321 //ust// {
322 //ust// }
323 //ust// #endif
324
325 struct marker_addr {
326 struct marker *marker;
327 void *addr;
328 };
329
330 struct lib {
331 struct marker * const *markers_start;
332 #ifdef CONFIG_UST_GDB_INTEGRATION
333 struct marker_addr *markers_addr_start;
334 #endif
335 int markers_count;
336 struct cds_list_head list;
337 };
338
339 extern int marker_register_lib(struct marker * const *markers_start, int markers_count);
340 extern int marker_unregister_lib(struct marker * const *markers_start);
341
342 #define MARKER_LIB \
343 extern struct marker * const __start___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
344 extern struct marker * const __stop___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \
345 static struct marker * const __mark_ptr_dummy \
346 __attribute__((used, section("__markers_ptrs"))) = NULL;\
347 \
348 static void __attribute__((constructor)) __markers__init(void) \
349 { \
350 marker_register_lib(__start___markers_ptrs, \
351 __stop___markers_ptrs \
352 - __start___markers_ptrs); \
353 } \
354 \
355 static void __attribute__((destructor)) __markers__destroy(void)\
356 { \
357 marker_unregister_lib(__start___markers_ptrs); \
358 }
359
360 extern void marker_set_new_marker_cb(void (*cb)(struct marker *));
361 extern void init_markers(void);
362
363 #endif /* _UST_MARKER_H */
This page took 0.040508 seconds and 4 git commands to generate.