X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Ftracepoint.h;h=a3b5d3f0c7741c4d92f86bff0e8a2bde0f18a1b6;hb=04f5c9407a2bbf9fd9a160db9ffec18c0dc99189;hp=fe18c5b7e4a60a78d9fd721bdcfb5276912696fe;hpb=0f2f7e21ff998452eea75a7130016471b4653935;p=lttng-ust.git diff --git a/include/lttng/tracepoint.h b/include/lttng/tracepoint.h index fe18c5b7..a3b5d3f0 100644 --- a/include/lttng/tracepoint.h +++ b/include/lttng/tracepoint.h @@ -2,23 +2,43 @@ #define _LTTNG_TRACEPOINT_H /* - * Copyright (c) 2011 - Mathieu Desnoyers - * - * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED - * OR IMPLIED. ANY USE IS AT YOUR OWN RISK. - * - * Permission is hereby granted to use or copy this program - * for any purpose, provided the above notices are retained on all copies. - * Permission to modify the code and to distribute modified code is granted, - * provided the above notices are retained, and a notice that the code was - * modified is included with the above copyright notice. + * Copyright 2011-2012 - Mathieu Desnoyers + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ +#include +#include #include #include #include #include /* for dlopen */ -#include +#include /* for memset */ +#include /* for sdt */ +#include + +#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION +#define SDT_USE_VARIADIC +#include +#else +#define STAP_PROBEV(...) +#endif #ifdef __cplusplus extern "C" { @@ -26,6 +46,7 @@ extern "C" { #define tracepoint(provider, name, ...) \ do { \ + STAP_PROBEV(provider, name, ## __VA_ARGS__); \ if (caa_unlikely(__tracepoint_##provider##___##name.state)) \ __tracepoint_cb_##provider##___##name(__VA_ARGS__); \ } while (0) @@ -51,8 +72,12 @@ extern "C" { #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) -/* _TP_EXVAR* extract the var names. */ +/* + * _TP_EXVAR* extract the var names. + * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99. + */ #define _TP_EXVAR0() +#define _TP_EXVAR1(a) #define _TP_EXVAR2(a,b) b #define _TP_EXVAR4(a,b,c,d) b,d #define _TP_EXVAR6(a,b,c,d,e,f) b,d,f @@ -65,6 +90,7 @@ extern "C" { #define _TP_EXVAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) b,d,f,h,j,l,n,p,r,t #define _TP_EXDATA_VAR0() __tp_data +#define _TP_EXDATA_VAR1(a) __tp_data #define _TP_EXDATA_VAR2(a,b) __tp_data,b #define _TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d #define _TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f @@ -76,8 +102,12 @@ extern "C" { #define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) __tp_data,b,d,f,h,j,l,n,p,r #define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) __tp_data,b,d,f,h,j,l,n,p,r,t -/* _TP_EXPROTO* extract tuples of type, var */ -#define _TP_EXPROTO0() +/* + * _TP_EXPROTO* extract tuples of type, var. + * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99. + */ +#define _TP_EXPROTO0() void +#define _TP_EXPROTO1(a) void #define _TP_EXPROTO2(a,b) a b #define _TP_EXPROTO4(a,b,c,d) a b,c d #define _TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f @@ -90,6 +120,7 @@ extern "C" { #define _TP_EXPROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) a b,c d,e f,g h,i j,k l,m n,o p,q r,s t #define _TP_EXDATA_PROTO0() void *__tp_data +#define _TP_EXDATA_PROTO1(a) void *__tp_data #define _TP_EXDATA_PROTO2(a,b) void *__tp_data,a b #define _TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d #define _TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f @@ -116,18 +147,21 @@ extern "C" { #define _DECLARE_TRACEPOINT(_provider, _name, ...) \ extern struct tracepoint __tracepoint_##_provider##___##_name; \ -static inline void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \ +static inline lttng_ust_notrace \ +void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)); \ +static inline \ +void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__)) \ { \ struct tracepoint_probe *__tp_probe; \ \ - if (!TP_RCU_LINK_TEST()) \ + if (caa_unlikely(!TP_RCU_LINK_TEST())) \ return; \ tp_rcu_read_lock_bp(); \ __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \ if (caa_unlikely(!__tp_probe)) \ goto end; \ do { \ - void *__tp_cb = __tp_probe->func; \ + void (*__tp_cb)(void) = __tp_probe->func; \ void *__tp_data = __tp_probe->data; \ \ URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \ @@ -136,22 +170,148 @@ static inline void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_A end: \ tp_rcu_read_unlock_bp(); \ } \ -static inline void __tracepoint_register_##_provider##___##_name(char *name, \ - void *func, void *data) \ +static inline lttng_ust_notrace \ +void __tracepoint_register_##_provider##___##_name(char *name, \ + void (*func)(void), void *data); \ +static inline \ +void __tracepoint_register_##_provider##___##_name(char *name, \ + void (*func)(void), void *data) \ { \ - __tracepoint_probe_register(name, func, data); \ + __tracepoint_probe_register(name, func, data, \ + __tracepoint_##_provider##___##_name.signature); \ } \ -static inline void __tracepoint_unregister_##_provider##___##_name(char *name, \ - void *func, void *data) \ +static inline lttng_ust_notrace \ +void __tracepoint_unregister_##_provider##___##_name(char *name, \ + void (*func)(void), void *data); \ +static inline \ +void __tracepoint_unregister_##_provider##___##_name(char *name, \ + void (*func)(void), void *data) \ { \ __tracepoint_probe_unregister(name, func, data); \ } -extern int __tracepoint_probe_register(const char *name, void *func, void *data); -extern int __tracepoint_probe_unregister(const char *name, void *func, void *data); +extern int __tracepoint_probe_register(const char *name, void (*func)(void), + void *data, const char *signature); +extern int __tracepoint_probe_unregister(const char *name, void (*func)(void), + void *data); + +/* + * tracepoint dynamic linkage handling (callbacks). Hidden visibility: + * shared across objects in a module/main executable. + */ +struct tracepoint_dlopen { + void *liblttngust_handle; + + int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start, + int tracepoints_count); + int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start); +#ifndef _LGPL_SOURCE + void (*rcu_read_lock_sym_bp)(void); + void (*rcu_read_unlock_sym_bp)(void); + void *(*rcu_dereference_sym_bp)(void *p); +#endif +}; + +extern struct tracepoint_dlopen tracepoint_dlopen; + +#if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES) + +/* + * These weak symbols, the constructor, and destructor take care of + * registering only _one_ instance of the tracepoints per shared-ojbect + * (or for the whole main program). + */ +int __tracepoint_registered + __attribute__((weak, visibility("hidden"))); +int __tracepoint_ptrs_registered + __attribute__((weak, visibility("hidden"))); +struct tracepoint_dlopen tracepoint_dlopen + __attribute__((weak, visibility("hidden"))); + +#ifndef _LGPL_SOURCE +static inline void lttng_ust_notrace +__tracepoint__init_urcu_sym(void); +static inline void +__tracepoint__init_urcu_sym(void) +{ + /* + * Symbols below are needed by tracepoint call sites and probe + * providers. + */ + if (!tracepoint_dlopen.rcu_read_lock_sym_bp) + tracepoint_dlopen.rcu_read_lock_sym_bp = + URCU_FORCE_CAST(void (*)(void), + dlsym(tracepoint_dlopen.liblttngust_handle, + "tp_rcu_read_lock_bp")); + if (!tracepoint_dlopen.rcu_read_unlock_sym_bp) + tracepoint_dlopen.rcu_read_unlock_sym_bp = + URCU_FORCE_CAST(void (*)(void), + dlsym(tracepoint_dlopen.liblttngust_handle, + "tp_rcu_read_unlock_bp")); + if (!tracepoint_dlopen.rcu_dereference_sym_bp) + tracepoint_dlopen.rcu_dereference_sym_bp = + URCU_FORCE_CAST(void *(*)(void *p), + dlsym(tracepoint_dlopen.liblttngust_handle, + "tp_rcu_dereference_sym_bp")); +} +#else +static inline void lttng_ust_notrace +__tracepoint__init_urcu_sym(void); +static inline void +__tracepoint__init_urcu_sym(void) +{ +} +#endif + +static void lttng_ust_notrace __attribute__((constructor)) +__tracepoints__init(void); +static void +__tracepoints__init(void) +{ + if (__tracepoint_registered++) + return; + + if (!tracepoint_dlopen.liblttngust_handle) + tracepoint_dlopen.liblttngust_handle = + dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); + if (!tracepoint_dlopen.liblttngust_handle) + return; + __tracepoint__init_urcu_sym(); +} + +static void lttng_ust_notrace __attribute__((destructor)) +__tracepoints__destroy(void); +static void +__tracepoints__destroy(void) +{ + int ret; + + if (--__tracepoint_registered) + return; + if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_ptrs_registered) { + ret = dlclose(tracepoint_dlopen.liblttngust_handle); + if (ret) { + fprintf(stderr, "Error (%d) in dlclose\n", ret); + abort(); + } + memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen)); + } +} + +#endif #ifdef TRACEPOINT_DEFINE +/* + * These weak symbols, the constructor, and destructor take care of + * registering only _one_ instance of the tracepoints per shared-ojbect + * (or for the whole main program). + */ +extern struct tracepoint * const __start___tracepoints_ptrs[] + __attribute__((weak, visibility("hidden"))); +extern struct tracepoint * const __stop___tracepoints_ptrs[] + __attribute__((weak, visibility("hidden"))); + /* * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a * unresolved symbol that requires the provider to be linked in. When @@ -162,10 +322,9 @@ extern int __tracepoint_probe_unregister(const char *name, void *func, void *dat * object from the executable. */ #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE -#define _TRACEPOINT_UNDEFINED_REF(provider) +#define _TRACEPOINT_UNDEFINED_REF(provider) NULL #else /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ -#define _TRACEPOINT_UNDEFINED_REF(provider) \ - &__tracepoint_provider_##provider, +#define _TRACEPOINT_UNDEFINED_REF(provider) &__tracepoint_provider_##provider #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ /* @@ -173,88 +332,79 @@ extern int __tracepoint_probe_unregister(const char *name, void *func, void *dat * in the __tracepoints_ptrs section. * Therefore, this section is _not_ const (read-only). */ -#define _DEFINE_TRACEPOINT(provider, name) \ - extern int __tracepoint_provider_##provider; \ - static const char __tp_strtab_##provider##___##name[] \ +#define _TP_EXTRACT_STRING(...) #__VA_ARGS__ + +#define _DEFINE_TRACEPOINT(_provider, _name, _args) \ + extern int __tracepoint_provider_##_provider; \ + static const char __tp_strtab_##_provider##___##_name[] \ __attribute__((section("__tracepoints_strings"))) = \ - #provider ":" #name; \ - struct tracepoint __tracepoint_##provider##___##name \ + #_provider ":" #_name; \ + struct tracepoint __tracepoint_##_provider##___##_name \ __attribute__((section("__tracepoints"))) = \ - { __tp_strtab_##provider##___##name, 0, NULL, _TRACEPOINT_UNDEFINED_REF(provider) }; \ - static struct tracepoint * __tracepoint_ptr_##provider##___##name \ + { \ + __tp_strtab_##_provider##___##_name, \ + 0, \ + NULL, \ + _TRACEPOINT_UNDEFINED_REF(_provider), \ + _TP_EXTRACT_STRING(_args), \ + { }, \ + }; \ + static struct tracepoint * __tracepoint_ptr_##_provider##___##_name \ __attribute__((used, section("__tracepoints_ptrs"))) = \ - &__tracepoint_##provider##___##name; - -static int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start, - int tracepoints_count); -static int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start); -static void *liblttngust_handle; - -/* - * These weak symbols, the constructor, and destructor take care of - * registering only _one_ instance of the tracepoints per shared-ojbect - * (or for the whole main program). - */ -extern struct tracepoint * const __start___tracepoints_ptrs[] - __attribute__((weak, visibility("hidden"))); -extern struct tracepoint * const __stop___tracepoints_ptrs[] - __attribute__((weak, visibility("hidden"))); -int __tracepoint_registered - __attribute__((weak, visibility("hidden"))); + &__tracepoint_##_provider##___##_name; -static void __attribute__((constructor)) __tracepoints__init(void) +static void lttng_ust_notrace __attribute__((constructor)) +__tracepoints__ptrs_init(void); +static void +__tracepoints__ptrs_init(void) { - if (__tracepoint_registered++) + if (__tracepoint_ptrs_registered++) return; - - liblttngust_handle = dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); - if (!liblttngust_handle) + if (!tracepoint_dlopen.liblttngust_handle) + tracepoint_dlopen.liblttngust_handle = + dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL); + if (!tracepoint_dlopen.liblttngust_handle) return; - tracepoint_register_lib = + tracepoint_dlopen.tracepoint_register_lib = URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int), - dlsym(liblttngust_handle, + dlsym(tracepoint_dlopen.liblttngust_handle, "tracepoint_register_lib")); - tracepoint_unregister_lib = + tracepoint_dlopen.tracepoint_unregister_lib = URCU_FORCE_CAST(int (*)(struct tracepoint * const *), - dlsym(liblttngust_handle, + dlsym(tracepoint_dlopen.liblttngust_handle, "tracepoint_unregister_lib")); -#ifndef _LGPL_SOURCE - tp_rcu_read_lock_bp = - URCU_FORCE_CAST(void (*)(void), - dlsym(liblttngust_handle, - "tp_rcu_read_lock_bp")); - tp_rcu_read_unlock_bp = - URCU_FORCE_CAST(void (*)(void), - dlsym(liblttngust_handle, - "tp_rcu_read_unlock_bp")); - tp_rcu_dereference_sym_bp = - URCU_FORCE_CAST(void *(*)(void *p), - dlsym(liblttngust_handle, - "tp_rcu_dereference_sym_bp")); -#endif - tracepoint_register_lib(__start___tracepoints_ptrs, + __tracepoint__init_urcu_sym(); + if (tracepoint_dlopen.tracepoint_register_lib) { + tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs, __stop___tracepoints_ptrs - __start___tracepoints_ptrs); + } } -static void __attribute__((destructor)) __tracepoints__destroy(void) +static void lttng_ust_notrace __attribute__((destructor)) +__tracepoints__ptrs_destroy(void); +static void +__tracepoints__ptrs_destroy(void) { int ret; - if (--__tracepoint_registered) + + if (--__tracepoint_ptrs_registered) return; - if (tracepoint_unregister_lib) - tracepoint_unregister_lib(__start___tracepoints_ptrs); - if (liblttngust_handle) { - tracepoint_unregister_lib = NULL; - tracepoint_register_lib = NULL; - ret = dlclose(liblttngust_handle); - assert(!ret); + if (tracepoint_dlopen.tracepoint_unregister_lib) + tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs); + if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_registered) { + ret = dlclose(tracepoint_dlopen.liblttngust_handle); + if (ret) { + fprintf(stderr, "Error (%d) in dlclose\n", ret); + abort(); + } + memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen)); } } #else /* TRACEPOINT_DEFINE */ -#define _DEFINE_TRACEPOINT(provider, name) +#define _DEFINE_TRACEPOINT(_provider, _name, _args) #endif /* #else TRACEPOINT_DEFINE */ @@ -349,13 +499,13 @@ static void __attribute__((destructor)) __tracepoints__destroy(void) #define TRACEPOINT_EVENT(provider, name, args, fields) \ _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ - _DEFINE_TRACEPOINT(provider, name) + _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args)) #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields) #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args) \ _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args)) \ - _DEFINE_TRACEPOINT(provider, name) + _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args)) #endif /* #ifndef TRACEPOINT_EVENT */ @@ -420,8 +570,9 @@ static void __attribute__((destructor)) __tracepoints__destroy(void) * * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given - * tracepoint name. The first field is the name of the tracepoint, the - * second field is the loglevel name. + * tracepoint name. The first field is the provider name, the second + * field is the name of the tracepoint, the third field is the loglevel + * name. * * TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, * < loglevel_name >) @@ -451,3 +602,9 @@ enum { #define TRACEPOINT_LOGLEVEL(provider, name, loglevel) #endif /* #ifndef TRACEPOINT_LOGLEVEL */ + +#ifndef TRACEPOINT_MODEL_EMF_URI + +#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri) + +#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */