X-Git-Url: https://git.lttng.org/?p=ust.git;a=blobdiff_plain;f=include%2Fust%2Fmarker.h;h=dbdbbe09f75bea1ddbedf8a4f00cb94205070c63;hp=da738d1f3254f67b566df5c54d1800ef161216f1;hb=2874fee50444405591974a7166313063b315efe1;hpb=37ee34e4d9b9363c758aa43255d71661900e89b0 diff --git a/include/ust/marker.h b/include/ust/marker.h index da738d1..dbdbbe0 100644 --- a/include/ust/marker.h +++ b/include/ust/marker.h @@ -1,3 +1,6 @@ +#ifndef _UST_MARKER_H +#define _UST_MARKER_H + /* * Code markup for dynamic and static tracing. * @@ -5,11 +8,12 @@ * * (C) Copyright 2006 Mathieu Desnoyers * (C) Copyright 2009 Pierre-Marc Fournier + * (C) Copyright 2011 Mathieu Desnoyers * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. + * License as published by the Free Software Foundation; + * version 2.1 of the License. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -21,23 +25,17 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef _UST_MARKER_H -#define _UST_MARKER_H - #include -#include -#include -#include -#include -#include -#include - +#include +#include #include +#include -struct marker; +struct ust_marker; +struct ust_marker_probe_array; /** - * marker_probe_func - Type of a marker probe function + * ust_marker_probe_func - Type of a marker probe function * @mdata: marker data * @probe_private: probe private data * @call_private: call site private data @@ -49,315 +47,169 @@ struct marker; * Type of marker probe functions. They receive the mdata and need to parse the * format string to recover the variable argument list. */ -typedef void marker_probe_func(const struct marker *mdata, - void *probe_private, struct registers *regs, void *call_private, +typedef void ust_marker_probe_func(const struct ust_marker *mdata, + void *probe_private, void *call_private, const char *fmt, va_list *args); -struct marker_probe_closure { - marker_probe_func *func; /* Callback */ +struct ust_marker_probe_closure { + ust_marker_probe_func *func; /* Callback */ void *probe_private; /* Private probe data */ }; -struct marker { +struct ust_marker { const char *channel; /* Name of channel where to send data */ const char *name; /* Marker name */ const char *format; /* Marker format string, describing the * variable argument list. */ - DEFINE_IMV(char, state);/* Immediate value state. */ + char state; /* State. */ char ptype; /* probe type : 0 : single, 1 : multi */ /* Probe wrapper */ - u16 channel_id; /* Numeric channel identifier, dynamic */ - u16 event_id; /* Numeric event identifier, dynamic */ - void (*call)(const struct marker *mdata, void *call_private, struct registers *regs, ...); - struct marker_probe_closure single; - struct marker_probe_closure *multi; + uint16_t channel_id; /* Numeric channel identifier, dynamic */ + uint16_t event_id; /* Numeric event identifier, dynamic */ + void (*call)(const struct ust_marker *mdata, void *call_private, ...); + struct ust_marker_probe_closure single; + struct ust_marker_probe_array *multi; const char *tp_name; /* Optional tracepoint name */ void *tp_cb; /* Optional tracepoint callback */ - void *location; /* Address of marker in code */ }; -#define GET_MARKER(name) (__mark_ust_##name) - -#define _DEFINE_MARKER(channel, name, tp_name_str, tp_cb, format, unique, m) \ - struct registers __marker_regs; \ - \ - /* This next asm has to be a basic inline asm (no input/output/clobber), \ - * because it must not require %-sign escaping, as we most certainly \ - * have some %-signs in the format string. \ - */ \ - asm volatile ( \ - /* We only define these symbols if they have not yet been defined. Indeed, \ - * if two markers with the same channel/name are on the same line, they \ - * will try to create the same symbols, resulting in a conflict. This \ - * is not unusual as it can be the result of function inlining. \ - */ \ - ".ifndef __mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) "\n\t" \ - /*".section __markers_strings\n\t"*/ \ - ".section __markers_strings,\"aw\"\n\t" \ - "__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ":\n\t" \ - ".string \"" __stringify(channel) "\"\n\t" \ - "__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ":\n\t" \ - ".string \"" __stringify(name) "\"\n\t" \ - "__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ":\n\t" \ - ".string " "\"" format "\"" "\n\t" \ - ".previous\n\t" \ - ".endif\n\t" \ - ); \ - asm volatile ( \ - /*".section __markers\n\t"*/ \ - ".section __markers,\"aw\"\n\t" \ - "2:\n\t" \ - _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_channel_" __stringify(unique) ")\n\t" /* channel string */ \ - _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_name_" __stringify(unique) ")\n\t" /* name string */ \ - _ASM_PTR "(__mstrtab_" __stringify(channel) "_" __stringify(name) "_format_" __stringify(unique) ")\n\t" /* format string */ \ - ".byte 0\n\t" /* state imv */ \ - ".byte 0\n\t" /* ptype */ \ - ".hword 0\n\t" /* channel_id */ \ - ".hword 0\n\t" /* event_id */ \ - ".balign " __stringify(__WORDSIZE) " / 8\n\t" /* alignment */ \ - _ASM_PTR "(marker_probe_cb)\n\t" /* call */ \ - _ASM_PTR "(__mark_empty_function)\n\t" /* marker_probe_closure single.field1 */ \ - _ASM_PTR "0\n\t" /* marker_probe_closure single.field2 */ \ - _ASM_PTR "0\n\t" /* marker_probe_closure *multi */ \ - _ASM_PTR "0\n\t" /* tp_name */ \ - _ASM_PTR "0\n\t" /* tp_cb */ \ - _ASM_PTR "(1f)\n\t" /* location */ \ - ".previous\n\t" \ - /*".section __markers_ptrs\n\t"*/ \ - ".section __markers_ptrs,\"a\"\n\t" \ - _ASM_PTR "(2b)\n\t" \ - ".previous\n\t" \ - "1:\n\t" \ - ARCH_COPY_ADDR("%[outptr]") \ - : [outptr] "=r" (m) ); \ - \ - save_registers(&__marker_regs) - - -#define DEFINE_MARKER(name, format, unique, m) \ - _DEFINE_MARKER(ust, name, NULL, NULL, format, unique, m) - -#define DEFINE_MARKER_TP(name, tp_name, tp_cb, format) \ - _DEFINE_MARKER_TP(ust, name, #tp_name, tp_cb, format) +/* + * We keep the "channel" as internal field for marker.c *only*. It will be + * removed soon. + */ -#define _DEFINE_MARKER_TP(channel, name, tp_name_str, tp_cb, format) \ +/* + * __ust_marker_ptrs section is not const (read-only) because it needs to be + * read-write to let the linker apply relocations and keep the object PIC. + */ +#define _DEFINE_UST_MARKER(channel, name, tp_name_str, tp_cb, format) \ static const char __mstrtab_##channel##_##name[] \ - __attribute__((section("__markers_strings"))) \ + __attribute__((section("__ust_markers_strings"))) \ = #channel "\0" #name "\0" format; \ - static struct marker __mark_##channel##_##name \ - __attribute__((section("__markers"))) = \ + static struct ust_marker __ust_marker_def_##name \ + __attribute__((section("__ust_markers"))) = \ { __mstrtab_##channel##_##name, \ - &__mstrtab_##channel##_##name[sizeof(#channel)], \ - &__mstrtab_##channel##_##name[sizeof(#channel) + sizeof(#name)], \ - 0, 0, 0, 0, marker_probe_cb, \ - { __mark_empty_function, NULL}, \ - NULL, tp_name_str, tp_cb }; \ - static struct marker * const __mark_ptr_##channel##_##name \ - __attribute__((used, section("__markers_ptrs"))) = \ - &__mark_##channel##_##name; + &__mstrtab_##channel##_##name[sizeof(#channel)], \ + &__mstrtab_##channel##_##name[sizeof(#channel) + \ + sizeof(#name)], \ + 0, 0, 0, 0, ust_marker_probe_cb, \ + { __ust_marker_empty_function, NULL}, \ + NULL, tp_name_str, tp_cb }; \ + static struct ust_marker * __ust_marker_ptr_##name \ + __attribute__((used, section("__ust_marker_ptrs"))) = \ + &__ust_marker_def_##name /* - * Make sure the alignment of the structure in the __markers section will + * Make sure the alignment of the structure in the __ust_marker section will * not add unwanted padding between the beginning of the section and the * structure. Force alignment to the same alignment as the section start. - * - * The "generic" argument controls which marker enabling mechanism must be used. - * If generic is true, a variable read is used. - * If generic is false, immediate values are used. */ -#define __trace_mark(generic, channel, name, call_private, format, args...) \ - __trace_mark_counter(generic, channel, name, __LINE__, call_private, format, ## args) - -#define __trace_mark_counter(generic, channel, name, unique, call_private, format, args...) \ +#define __ust_marker(channel, name, call_private, format, args...) \ do { \ - struct marker *__marker_counter_ptr; \ - _DEFINE_MARKER(channel, name, NULL, NULL, format, unique, __marker_counter_ptr); \ - __mark_check_format(format, ## args); \ - if (!generic) { \ - if (unlikely(imv_read(__marker_counter_ptr->state))) \ - (__marker_counter_ptr->call)(__marker_counter_ptr, call_private, &__marker_regs, ## args); \ - } else { \ - if (unlikely(_imv_read(__marker_counter_ptr->state))) \ - (__marker_counter_ptr->call)(__marker_counter_ptr, call_private, &__marker_regs, ## args); \ - } \ + _DEFINE_UST_MARKER(channel, name, NULL, NULL, format); \ + __ust_marker_check_format(format, ## args); \ + if (__builtin_expect(!!(__ust_marker_def_##name.state), 0)) \ + (__ust_marker_def_##name.call) \ + (&__ust_marker_def_##name, call_private,\ + ## args); \ } while (0) -#define __trace_mark_tp(channel, name, call_private, tp_name, tp_cb, format, args...) \ - __trace_mark_tp_counter(channel, name, __LINE__, call_private, tp_name, tp_cb, format, ## args) - -#define __trace_mark_tp_counter(channel, name, unique, call_private, tp_name, tp_cb, format, args...) \ - do { \ - struct registers __marker_regs; \ - void __check_tp_type(void) \ - { \ - register_trace_##tp_name(tp_cb, call_private); \ - } \ - _DEFINE_MARKER_TP(channel, name, #tp_name, tp_cb, format); \ - __mark_check_format(format, ## args); \ - (*__mark_##channel##_##name.call)(&__mark_##channel##_##name, \ - call_private, &__marker_regs, ## args); \ - } while (0) - -extern void marker_update_probe_range(struct marker * const *begin, - struct marker * const *end); - -/** - * trace_mark - Marker using code patching - * @name: marker name, not quoted. - * @format: format string - * @args...: variable argument list - * - * Places a marker using optimized code patching technique (imv_read()) - * to be enabled when immediate values are present. - */ -#define trace_mark(name, format, args...) \ - __trace_mark(0, ust, name, NULL, format, ## args) - -/** - * _trace_mark - Marker using variable read - * @name: marker name, not quoted. - * @format: format string - * @args...: variable argument list - * - * Places a marker using a standard memory read (_imv_read()) to be - * enabled. Should be used for markers in code paths where instruction - * modification based enabling is not welcome. - */ -#define _trace_mark(name, format, args...) \ - __trace_mark(1, ust, name, NULL, format, ## args) - /** - * trace_mark_tp - Marker in a tracepoint callback + * ust_marker - Marker using code patching * @name: marker name, not quoted. - * @tp_name: tracepoint name, not quoted. - * @tp_cb: tracepoint callback. Should have an associated global symbol so it - * is not optimized away by the compiler (should not be static). * @format: format string * @args...: variable argument list * - * Places a marker in a tracepoint callback. + * Places a marker at caller site. */ -#define trace_mark_tp(name, tp_name, tp_cb, format, args...) \ - __trace_mark_tp(ust, name, NULL, tp_name, tp_cb, format, ## args) +#define ust_marker(name, format, args...) \ + __ust_marker(ust, name, NULL, format, ## args) /** - * MARK_NOARGS - Format string for a marker with no argument. + * UST_MARKER_NOARGS - Format string for a marker with no argument. */ -#define MARK_NOARGS " " - -extern void lock_markers(void); -extern void unlock_markers(void); - -extern void markers_compact_event_ids(void); +#define UST_MARKER_NOARGS " " /* To be used for string format validity checking with gcc */ -static inline void __printf(1, 2) ___mark_check_format(const char *fmt, ...) +static inline +void __attribute__((format(printf, 1, 2))) + ___ust_marker_check_format(const char *fmt, ...) { } -#define __mark_check_format(format, args...) \ +#define __ust_marker_check_format(format, args...) \ do { \ if (0) \ - ___mark_check_format(format, ## args); \ + ___ust_marker_check_format(format, ## args); \ } while (0) -extern marker_probe_func __mark_empty_function; - -extern void marker_probe_cb(const struct marker *mdata, - void *call_private, struct registers *regs, ...); - -/* - * Connect a probe to a marker. - * private data pointer must be a valid allocated memory address, or NULL. - */ -extern int marker_probe_register(const char *channel, const char *name, - const char *format, marker_probe_func *probe, void *probe_private); - -/* - * Returns the private data given to marker_probe_register. - */ -extern int marker_probe_unregister(const char *channel, const char *name, - marker_probe_func *probe, void *probe_private); -/* - * Unregister a marker by providing the registered private data. - */ -extern int marker_probe_unregister_private_data(marker_probe_func *probe, - void *probe_private); - -extern void *marker_get_private_data(const char *channel, const char *name, - marker_probe_func *probe, int num); - -/* - * marker_synchronize_unregister must be called between the last marker probe - * unregistration and the first one of - * - the end of module exit function - * - the free of any resource used by the probes - * to ensure the code and data are valid for any possibly running probes. - */ -#define marker_synchronize_unregister() synchronize_sched() - -struct marker_iter { -//ust// struct module *module; - struct lib *lib; - struct marker * const *marker; -}; - -extern void marker_iter_start(struct marker_iter *iter); -extern void marker_iter_next(struct marker_iter *iter); -extern void marker_iter_stop(struct marker_iter *iter); -extern void marker_iter_reset(struct marker_iter *iter); -extern int marker_get_iter_range(struct marker * const **marker, struct marker * const *begin, - struct marker * const *end); - -extern void marker_update_process(void); -extern int is_marker_enabled(const char *channel, const char *name); +extern ust_marker_probe_func __ust_marker_empty_function; -//ust// #ifdef CONFIG_MARKERS_USERSPACE -//ust// extern void exit_user_markers(struct task_struct *p); -//ust// #else -//ust// static inline void exit_user_markers(struct task_struct *p) -//ust// { -//ust// } -//ust// #endif +extern void ust_marker_probe_cb(const struct ust_marker *mdata, + void *call_private, ...); -struct marker_addr { - struct marker *marker; - void *addr; -}; - -struct lib { - struct marker * const *markers_start; -#ifdef CONFIG_UST_GDB_INTEGRATION - struct marker_addr *markers_addr_start; -#endif - int markers_count; +struct ust_marker_lib { + struct ust_marker * const *ust_marker_start; + int ust_marker_count; struct cds_list_head list; }; -extern int marker_register_lib(struct marker * const *markers_start, int markers_count); -extern int marker_unregister_lib(struct marker * const *markers_start); - -#define MARKER_LIB \ - extern struct marker * const __start___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \ - extern struct marker * const __stop___markers_ptrs[] __attribute__((weak, visibility("hidden"))); \ - static struct marker * const __mark_ptr_dummy \ - __attribute__((used, section("__markers_ptrs"))) = NULL;\ +#define UST_MARKER_LIB \ + extern struct ust_marker * const __start___ust_marker_ptrs[] __attribute__((weak, visibility("hidden"))); \ + extern struct ust_marker * const __stop___ust_marker_ptrs[] __attribute__((weak, visibility("hidden"))); \ + static struct ust_marker * __ust_marker_ptr_dummy \ + __attribute__((used, section("__ust_marker_ptrs"))); \ \ - static void __attribute__((constructor)) __markers__init(void) \ + static void __attribute__((constructor)) __ust_marker__init(void) \ { \ - marker_register_lib(__start___markers_ptrs, \ - __stop___markers_ptrs \ - - __start___markers_ptrs); \ + ust_marker_register_lib(__start___ust_marker_ptrs, \ + __stop___ust_marker_ptrs \ + - __start___ust_marker_ptrs); \ } \ \ - static void __attribute__((destructor)) __markers__destroy(void)\ + static void __attribute__((destructor)) __ust_marker__destroy(void) \ { \ - marker_unregister_lib(__start___markers_ptrs); \ + ust_marker_unregister_lib(__start___ust_marker_ptrs); \ } -extern void marker_set_new_marker_cb(void (*cb)(struct marker *)); -extern void init_markers(void); +extern +int ust_marker_register_lib(struct ust_marker * const *ust_marker_start, + int ust_marker_count); +extern +int ust_marker_unregister_lib(struct ust_marker * const *ust_marker_start); + +/* + * trace_mark() -- DEPRECATED + * @channel: name prefix, not quoted. Ignored. + * @name: marker name, not quoted. + * @format: format string + * @args...: variable argument list + * + * Kept as a compatibility API and is *DEPRECATED* in favor of + * ust_marker(). + */ +#define trace_mark(channel, name, format, args...) \ + ust_marker(name, format, ## args) + +static inline __attribute__((deprecated)) +void __MARKER_LIB_IS_DEPRECATED() +{ +} + +/* + * MARKER_LIB is kept for backward compatibility and is *DEPRECATED*. + * Use UST_MARKER_LIB instead. + */ +#define MARKER_LIB \ + __MARKER_LIB_IS_DEPRECATED(); \ + UST_MARKER_LIB + +/** + * MARKER_NOARGS - Compatibility API. *DEPRECATED*. Use + * UST_MARKER_NOARGS instead. + */ +#define MARK_NOARGS UST_MARKER_NOARGS #endif /* _UST_MARKER_H */