X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Ftracepoint.h;h=1cf02188f37f78eafb1f61a32b56e99f748b697e;hb=HEAD;hp=e44c0331212158fd255c61056ac2c240c607669d;hpb=39f98c62fa2eb208bc24230dc2d669132e08a1fa;p=lttng-ust.git diff --git a/include/lttng/tracepoint.h b/include/lttng/tracepoint.h index e44c0331..9342c5c1 100644 --- a/include/lttng/tracepoint.h +++ b/include/lttng/tracepoint.h @@ -1,229 +1,816 @@ -#ifndef _LTTNG_TRACEPOINT_H -#define _LTTNG_TRACEPOINT_H +// SPDX-FileCopyrightText: 2011-2012 Mathieu Desnoyers +// +// SPDX-License-Identifier: MIT +#ifndef _LTTNG_UST_TRACEPOINT_H +#define _LTTNG_UST_TRACEPOINT_H + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include /* for dlopen */ +#include /* for memset */ +#include + +#include /* for sdt */ +#include +#include +#include + +#if (defined(__cplusplus) && (__cplusplus <= 199711L)) +#error "C++11 support is required to build tracepoints and providers as C++" +#endif + +#define LTTNG_UST_TRACEPOINT_NAME_LEN_MAX 256 + +#ifdef LTTNG_UST_HAVE_SDT_INTEGRATION /* - * Copyright (C) 2008-2011 Mathieu Desnoyers - * Copyright (C) 2009 Pierre-Marc Fournier - * Copyright (C) 2009 Steven Rostedt - * - * 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; - * 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 - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - * - * Heavily inspired from the Linux Kernel Markers. + * Instead of using SDT_USE_VARIADIC from 'sys/sdt.h', use our own namespaced + * macros since the instrumented application might already have included + * 'sys/sdt.h' without variadic support. */ +#include -#include -#include -#include +#define LTTNG_UST__SDT_NARG(...) \ + LTTNG_UST___SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0) + +#define LTTNG_UST___SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N + +#define LTTNG_UST__SDT_PROBE_N(provider, name, N, ...) \ + _SDT_PROBE(provider, name, N, (__VA_ARGS__)) + +#define LTTNG_UST_STAP_PROBEV(provider, name, ...) \ + LTTNG_UST__SDT_PROBE_N(provider, name, LTTNG_UST__SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__) + +#else +#define LTTNG_UST_STAP_PROBEV(...) +#endif #ifdef __cplusplus extern "C" { #endif +#define lttng_ust_tracepoint_enabled(provider, name) \ + caa_unlikely(CMM_LOAD_SHARED(lttng_ust_tracepoint_##provider##___##name.state)) + +#define lttng_ust_do_tracepoint(provider, name, ...) \ + lttng_ust_tracepoint_cb_##provider##___##name(__VA_ARGS__) + +#define lttng_ust_tracepoint(provider, name, ...) \ + do { \ + LTTNG_UST_STAP_PROBEV(provider, name, ## __VA_ARGS__); \ + if (lttng_ust_tracepoint_enabled(provider, name)) \ + lttng_ust_do_tracepoint(provider, name, __VA_ARGS__); \ + } while (0) + +#define LTTNG_UST_TP_ARGS(...) __VA_ARGS__ + /* - * Tracepoints should be added to the instrumented code using the - * "tracepoint()" macro. + * LTTNG_UST_TP_ARGS takes tuples of type, argument separated by a comma. + * It can take up to 10 tuples (which means that less than 10 tuples is + * fine too). + * Each tuple is also separated by a comma. */ -#define tracepoint(provider, name, args...) \ - __trace_##provider##___##name(args) +#define LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb) \ + _tokena##_tokenb +#define LTTNG_UST__TP_COMBINE_TOKENS(_tokena, _tokenb) \ + LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb) +#define LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ + _tokena##_tokenb##_tokenc +#define LTTNG_UST__TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) \ + LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc) +#define LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ + _tokena##_tokenb##_tokenc##_tokend +#define LTTNG_UST__TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) \ + LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend) /* - * it_func[0] is never NULL because there is at least one element in the array - * when the array itself is non NULL. + * LTTNG_UST__TP_EXVAR* extract the var names. + * LTTNG_UST__TP_EXVAR1 and LTTNG_UST__TP_EXDATA_VAR1 are needed for -std=c99. */ -#define __DO_TRACE(tp, proto, args) \ - do { \ - struct tracepoint_probe *__tp_it_probe_ptr; \ - void *__tp_it_func; \ - void *__tp_cb_data; \ - \ - rcu_read_lock(); \ - __tp_it_probe_ptr = rcu_dereference((tp)->probes); \ - if (__tp_it_probe_ptr) { \ - do { \ - __tp_it_func = __tp_it_probe_ptr->func; \ - __tp_cb_data = __tp_it_probe_ptr->data; \ - URCU_FORCE_CAST(void(*)(proto), __tp_it_func)(args); \ - } while ((++__tp_it_probe_ptr)->func); \ - } \ - rcu_read_unlock(); \ - } while (0) - -#define TP_PARAMS(args...) args -#define TP_PROTO(args...) args -#define TP_VARS(args...) args +#define LTTNG_UST__TP_EXVAR0() +#define LTTNG_UST__TP_EXVAR1(a) +#define LTTNG_UST__TP_EXVAR2(a,b) b +#define LTTNG_UST__TP_EXVAR4(a,b,c,d) b,d +#define LTTNG_UST__TP_EXVAR6(a,b,c,d,e,f) b,d,f +#define LTTNG_UST__TP_EXVAR8(a,b,c,d,e,f,g,h) b,d,f,h +#define LTTNG_UST__TP_EXVAR10(a,b,c,d,e,f,g,h,i,j) b,d,f,h,j +#define LTTNG_UST__TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l) b,d,f,h,j,l +#define LTTNG_UST__TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) b,d,f,h,j,l,n +#define LTTNG_UST__TP_EXVAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) b,d,f,h,j,l,n,p +#define LTTNG_UST__TP_EXVAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) b,d,f,h,j,l,n,p,r +#define LTTNG_UST__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 __CHECK_TRACE(provider, name, proto, args) \ - do { \ - if (caa_unlikely(__tracepoint_##provider##___##name.state)) \ - __DO_TRACE(&__tracepoint_##provider##___##name, \ - TP_PROTO(proto), TP_VARS(args)); \ - } while (0) +#define LTTNG_UST__TP_EXDATA_VAR0() __tp_data +#define LTTNG_UST__TP_EXDATA_VAR1(a) __tp_data +#define LTTNG_UST__TP_EXDATA_VAR2(a,b) __tp_data,b +#define LTTNG_UST__TP_EXDATA_VAR4(a,b,c,d) __tp_data,b,d +#define LTTNG_UST__TP_EXDATA_VAR6(a,b,c,d,e,f) __tp_data,b,d,f +#define LTTNG_UST__TP_EXDATA_VAR8(a,b,c,d,e,f,g,h) __tp_data,b,d,f,h +#define LTTNG_UST__TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j) __tp_data,b,d,f,h,j +#define LTTNG_UST__TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l) __tp_data,b,d,f,h,j,l +#define LTTNG_UST__TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) __tp_data,b,d,f,h,j,l,n +#define LTTNG_UST__TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) __tp_data,b,d,f,h,j,l,n,p +#define LTTNG_UST__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 LTTNG_UST__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 /* - * Make sure the alignment of the structure in the __tracepoints 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. + * LTTNG_UST__TP_EXPROTO* extract tuples of type, var. + * LTTNG_UST__TP_EXPROTO1 and LTTNG_UST__TP_EXDATA_PROTO1 are needed for -std=c99. */ -#define __DECLARE_TRACEPOINT(provider, name, proto, args, data_proto, data_args) \ - extern struct tracepoint __tracepoint_##provider##___##name; \ - static inline void __trace_##provider##___##name(proto) \ - { \ - __CHECK_TRACE(provider, name, TP_PROTO(data_proto), \ - TP_VARS(data_args)); \ - } \ - static inline int \ - __register_trace_##provider##___##name(void (*probe)(data_proto), void *data) \ - { \ - return __tracepoint_probe_register(#provider ":" #name, (void *) probe, \ - data); \ - } \ - static inline int \ - __unregister_trace_##provider##___##name(void (*probe)(data_proto), void *data) \ - { \ - return __tracepoint_probe_unregister(#provider ":" #name, (void *) probe, \ - data); \ - } +#define LTTNG_UST__TP_EXPROTO0() void +#define LTTNG_UST__TP_EXPROTO1(a) void +#define LTTNG_UST__TP_EXPROTO2(a,b) a b +#define LTTNG_UST__TP_EXPROTO4(a,b,c,d) a b,c d +#define LTTNG_UST__TP_EXPROTO6(a,b,c,d,e,f) a b,c d,e f +#define LTTNG_UST__TP_EXPROTO8(a,b,c,d,e,f,g,h) a b,c d,e f,g h +#define LTTNG_UST__TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j) a b,c d,e f,g h,i j +#define LTTNG_UST__TP_EXPROTO12(a,b,c,d,e,f,g,h,i,j,k,l) a b,c d,e f,g h,i j,k l +#define LTTNG_UST__TP_EXPROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) a b,c d,e f,g h,i j,k l,m n +#define LTTNG_UST__TP_EXPROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) a b,c d,e f,g h,i j,k l,m n,o p +#define LTTNG_UST__TP_EXPROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) a b,c d,e f,g h,i j,k l,m n,o p,q r +#define LTTNG_UST__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 LTTNG_UST__TP_EXDATA_PROTO0() void *__tp_data +#define LTTNG_UST__TP_EXDATA_PROTO1(a) void *__tp_data +#define LTTNG_UST__TP_EXDATA_PROTO2(a,b) void *__tp_data,a b +#define LTTNG_UST__TP_EXDATA_PROTO4(a,b,c,d) void *__tp_data,a b,c d +#define LTTNG_UST__TP_EXDATA_PROTO6(a,b,c,d,e,f) void *__tp_data,a b,c d,e f +#define LTTNG_UST__TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h) void *__tp_data,a b,c d,e f,g h +#define LTTNG_UST__TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j) void *__tp_data,a b,c d,e f,g h,i j +#define LTTNG_UST__TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l) void *__tp_data,a b,c d,e f,g h,i j,k l +#define LTTNG_UST__TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n) void *__tp_data,a b,c d,e f,g h,i j,k l,m n +#define LTTNG_UST__TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p +#define LTTNG_UST__TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r +#define LTTNG_UST__TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t + +/* Preprocessor trick to count arguments. Inspired from sdt.h. */ +#define LTTNG_UST__TP_NARGS(...) LTTNG_UST___TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0) +#define LTTNG_UST___TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...) N +#define LTTNG_UST__TP_PROTO_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXPROTO, N)(__VA_ARGS__)) +#define LTTNG_UST__TP_VAR_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXVAR, N)(__VA_ARGS__)) +#define LTTNG_UST__TP_DATA_PROTO_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_PROTO, N)(__VA_ARGS__)) +#define LTTNG_UST__TP_DATA_VAR_N(N, ...) LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_VAR, N)(__VA_ARGS__)) +#define LTTNG_UST__TP_ARGS_PROTO(...) LTTNG_UST__TP_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) +#define LTTNG_UST__TP_ARGS_VAR(...) LTTNG_UST__TP_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) +#define LTTNG_UST__TP_ARGS_DATA_PROTO(...) LTTNG_UST__TP_DATA_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) +#define LTTNG_UST__TP_ARGS_DATA_VAR(...) LTTNG_UST__TP_DATA_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__) +#define LTTNG_UST__TP_PARAMS(...) __VA_ARGS__ /* - * The need for the _DECLARE_TRACEPOINT_NOARGS() is to handle the prototype - * (void). "void" is a special value in a function prototype and can - * not be combined with other arguments. Since the DECLARE_TRACEPOINT() - * macro adds a data element at the beginning of the prototype, - * we need a way to differentiate "(void *data, proto)" from - * "(void *data, void)". The second prototype is invalid. - * - * DECLARE_TRACEPOINT_NOARGS() passes "void" as the tracepoint prototype - * and "void *__tp_cb_data" as the callback prototype. - * - * DECLARE_TRACEPOINT() passes "proto" as the tracepoint protoype and - * "void *__tp_cb_data, proto" as the callback prototype. + * sizeof(#_provider) - 1 : length of the provider string (excluding \0). + * sizeof(#_name) - 1 : length of the name string (excluding \0). + * + 1 : separator between provider and event name. + * + * Upper bound (inclusive) is LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1 to + * account for \0. + * + * The comparison is: + * left hand side: sizeof(#_provider) - 1 + sizeof(#_name) - 1 + 1 + * right hand side: LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1 + * operator: <= (inclusive) + * Simplified in the code below. */ -#define _DECLARE_TRACEPOINT_NOARGS(provider, name) \ - __DECLARE_TRACEPOINT(provider, name, void, , void *__tp_cb_data, __tp_cb_data) +#define lttng_ust_tracepoint_validate_name_len(_provider, _name) \ + lttng_ust_static_assert(sizeof(#_provider) + sizeof(#_name) <= LTTNG_UST_TRACEPOINT_NAME_LEN_MAX, \ + "Tracepoint name length is too long", \ + Tracepoint_name_length_is_too_long) -#define _DECLARE_TRACEPOINT(provider, name, proto, args) \ - __DECLARE_TRACEPOINT(provider, name, TP_PARAMS(proto), TP_PARAMS(args), \ - TP_PARAMS(void *__tp_cb_data, proto), \ - TP_PARAMS(__tp_cb_data, args)) +/* + * The tracepoint cb is marked always inline so we can distinguish + * between caller's ip addresses within the probe using the return + * address. + */ +#define LTTNG_UST__DECLARE_TRACEPOINT(_provider, _name, ...) \ +extern struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name \ + LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY; \ +static inline \ +void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \ + __attribute__((always_inline, unused)) lttng_ust_notrace; \ +static \ +void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__)) \ +{ \ + struct lttng_ust_tracepoint_probe *__tp_probe; \ + \ + if (caa_unlikely(!LTTNG_UST_TP_RCU_LINK_TEST())) \ + return; \ + lttng_ust_tp_rcu_read_lock(); \ + __tp_probe = lttng_ust_tp_rcu_dereference(lttng_ust_tracepoint_##_provider##___##_name.probes); \ + if (caa_unlikely(!__tp_probe)) \ + goto end; \ + do { \ + void (*__tp_cb)(void) = __tp_probe->func; \ + void *__tp_data = __tp_probe->data; \ + \ + URCU_FORCE_CAST(void (*)(LTTNG_UST__TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb) \ + (LTTNG_UST__TP_ARGS_DATA_VAR(__VA_ARGS__)); \ + } while ((++__tp_probe)->func); \ +end: \ + lttng_ust_tp_rcu_read_unlock(); \ +} \ +static inline \ +void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \ + void (*func)(void), void *data) \ + lttng_ust_notrace; \ +static inline \ +void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \ + void (*func)(void), void *data) \ +{ \ + lttng_ust_tracepoint_provider_register(provider_name, event_name, func, data, \ + lttng_ust_tracepoint_##_provider##___##_name.signature); \ +} \ +static inline \ +void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \ + void (*func)(void), void *data) \ + lttng_ust_notrace; \ +static inline \ +void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \ + void (*func)(void), void *data) \ +{ \ + lttng_ust_tracepoint_provider_unregister(provider_name, event_name, func, data); \ +} /* - * __tracepoints_ptrs section is not const (read-only) to let the linker update - * the pointer, allowing PIC code. + * Registration of tracepoint provider probe functions with + * lttng_ust_tracepoint_provider_register, unregistration with + * lttng_ust_tracepoint_provider_unregister. */ -#define _DEFINE_TRACEPOINT(provider, name) \ - static const char __tpstrtab_##provider##___##name[] \ - __attribute__((section("__tracepoints_strings"))) = \ - #provider ":" #name; \ - struct tracepoint __tracepoint_##provider##___##name \ - __attribute__((section("__tracepoints"))) = \ - { __tpstrtab_##provider##___##name, 0, NULL }; \ - static struct tracepoint * __tracepoint_ptr_##provider##___##name \ - __attribute__((used, section("__tracepoints_ptrs"))) = \ - &__tracepoint_##provider##___##name; - - -#define __register_tracepoint(provider, name, probe, data) \ - __register_trace_##provider##___##name(probe, data) -#define __unregister_tracepoint(provider, name, probe, data) \ - __unregister_trace_##provider##___##name(probe, data) +int lttng_ust_tracepoint_provider_register(const char *provider_name, const char *event_name, + void (*func)(void), void *data, const char *signature); +int lttng_ust_tracepoint_provider_unregister(const char *provider_name, const char *event_name, + void (*func)(void), void *data); /* - * Connect a probe to a tracepoint. - * Internal API. + * Registration of tracepoint instrumentation modules with lttng_ust_tracepoint_module_register, + * unregistration with lttng_ust_tracepoint_module_unregister. */ -extern -int __tracepoint_probe_register(const char *name, void *probe, void *data); +int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start, + int tracepoints_count); +int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start); /* - * Disconnect a probe from a tracepoint. - * Internal API. + * tracepoint dynamic linkage handling (callbacks). Hidden visibility: + * shared across objects in a module/main executable. + * + * IMPORTANT: this structure is part of the ABI between instrumented + * applications and UST. Fields need to be only added at the end, never + * reordered, never removed. + * + * The field @struct_size should be used to determine the size of the + * structure. It should be queried before using additional fields added + * at the end of the structure. */ -extern -int __tracepoint_probe_unregister(const char *name, void *probe, void *data); +struct lttng_ust_tracepoint_dlopen { + uint32_t struct_size; + + void *liblttngust_handle; + + int (*lttng_ust_tracepoint_module_register)(struct lttng_ust_tracepoint * const *tracepoints_start, + int tracepoints_count); + int (*lttng_ust_tracepoint_module_unregister)(struct lttng_ust_tracepoint * const *tracepoints_start); + void (*rcu_read_lock_sym)(void); + void (*rcu_read_unlock_sym)(void); + void *(*rcu_dereference_sym)(void *p); -extern -int tracepoint_register_lib(struct tracepoint * const *tracepoints_start, - int tracepoints_count); -extern -int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start); + /* End of base ABI. Fields below should be used after checking struct_size. */ +}; + +extern struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen; +extern struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr; /* * 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[] +int lttng_ust_tracepoint_registered __attribute__((weak, visibility("hidden"))); -extern struct tracepoint * const __stop___tracepoints_ptrs[] +int lttng_ust_tracepoint_ptrs_registered __attribute__((weak, visibility("hidden"))); -int __tracepoint_registered +struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen + __attribute__((weak, visibility("hidden"))) = { + .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen), +}; +/* + * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc + * 4.8 and prior does not have the same behavior for symbol scoping on + * 32-bit powerpc depending on the object size: symbols for objects of 8 + * bytes or less have the same address throughout a module, whereas they + * have different addresses between compile units for objects larger + * than 8 bytes. Add this pointer indirection to ensure that the symbol + * scoping match that of the other weak hidden symbols found in this + * header. + */ +struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr __attribute__((weak, visibility("hidden"))); -static void __attribute__((constructor)) __tracepoints__init(void) +/* + * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared + * across objects in a module/main executable. The callbacks are used to + * control and check if the destructors should be executed. + * + * IMPORTANT: this structure is part of the ABI between instrumented + * applications and UST. Fields need to be only added at the end, never + * reordered, never removed. + * + * The field @struct_size should be used to determine the size of the + * structure. It should be queried before using additional fields added + * at the end of the structure. + */ +struct lttng_ust_tracepoint_destructors_syms { + uint32_t struct_size; + + void (*tracepoint_disable_destructors)(void); + int (*tracepoint_get_destructors_state)(void); + + /* End of base ABI. Fields below should be used after checking struct_size. */ +}; + +extern struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms; +extern struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr; + +struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms + __attribute__((weak, visibility("hidden"))) = { + .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms), +}; +struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr + __attribute__((weak, visibility("hidden"))); + +static inline void tracepoint_disable_destructors(void) +{ + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + if (!lttng_ust_tracepoint_destructors_syms_ptr) + lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; + if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle + && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors) + lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors(); +} + +#ifndef _LGPL_SOURCE +static inline void +lttng_ust_tracepoint__init_urcu_sym(void) + lttng_ust_notrace; +static inline void +lttng_ust_tracepoint__init_urcu_sym(void) +{ + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + /* + * Symbols below are needed by tracepoint call sites and probe + * providers. + */ + if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym) + lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym = + URCU_FORCE_CAST(void (*)(void), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tp_rcu_read_lock")); + if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym) + lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym = + URCU_FORCE_CAST(void (*)(void), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tp_rcu_read_unlock")); + if (!lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym) + lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym = + URCU_FORCE_CAST(void *(*)(void *p), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tp_rcu_dereference_sym")); +} +#else +static inline void +lttng_ust_tracepoint__init_urcu_sym(void) + lttng_ust_notrace; +static inline void +lttng_ust_tracepoint__init_urcu_sym(void) +{ +} +#endif + +/* + * Use getenv() directly and bypass lttng-ust helper functions + * because we may not have access to lttng-ust shared libraries. + */ +#ifdef LTTNG_UST_DEBUG +static inline +bool lttng_ust_tracepoint_logging_debug_enabled(void) +{ + return true; +} +#else /* #ifdef LTTNG_UST_DEBUG */ +static inline +bool lttng_ust_tracepoint_logging_debug_enabled(void) +{ + return getenv("LTTNG_UST_DEBUG"); +} +#endif /* #ifdef LTTNG_UST_DEBUG */ + +#ifdef LTTNG_UST_ABORT_ON_CRITICAL +static inline +bool lttng_ust_tracepoint_logging_abort_on_critical_enabled(void) +{ + return true; +} +#else /* #ifdef LTTNG_UST_ABORT_ON_CRITICAL */ +static inline +bool lttng_ust_tracepoint_logging_abort_on_critical_enabled(void) { - if (__tracepoint_registered++) + return getenv("LTTNG_UST_ABORT_ON_CRITICAL"); +} +#endif + +#define LTTNG_UST_TRACEPOINT_THIS_IP \ + ({ __label__ here; here: &&here; }) + +static void +lttng_ust_tracepoints_print_disabled_message(void) +{ + if (lttng_ust_tracepoint_logging_debug_enabled()) + fprintf(stderr, "lttng-ust-tracepoint [%ld]: Critical: dlopen() failed to find '%s', tracepoints in this binary won't be registered. " + "(at addr=%p in %s() at " __FILE__ ":" lttng_ust_stringify(__LINE__) ")\n", + (long) getpid(), + LTTNG_UST_TRACEPOINT_LIB_SONAME, + LTTNG_UST_TRACEPOINT_THIS_IP, + __func__); + if (lttng_ust_tracepoint_logging_abort_on_critical_enabled()) + abort(); +} + +static void +lttng_ust__tracepoints__init(void) + lttng_ust_notrace __attribute__((constructor(LTTNG_UST_CONSTRUCTOR_PRIO))); +static void +lttng_ust__tracepoints__init(void) +{ + if (lttng_ust_tracepoint_registered++) { + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) + return; + lttng_ust_tracepoint__init_urcu_sym(); return; - tracepoint_register_lib(__start___tracepoints_ptrs, - __stop___tracepoints_ptrs - - __start___tracepoints_ptrs); + } + + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) + lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle = + dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL); + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) { + lttng_ust_tracepoints_print_disabled_message(); + return; + } + lttng_ust_tracepoint__init_urcu_sym(); } -static void __attribute__((destructor)) __tracepoints__destroy(void) +static void +lttng_ust__tracepoints__destroy(void) + lttng_ust_notrace __attribute__((destructor(LTTNG_UST_CONSTRUCTOR_PRIO))); +static void +lttng_ust__tracepoints__destroy(void) { - if (--__tracepoint_registered) + int ret; + + if (--lttng_ust_tracepoint_registered) + return; + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + if (!lttng_ust_tracepoint_destructors_syms_ptr) + lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) return; - tracepoint_unregister_lib(__start___tracepoints_ptrs); + if (lttng_ust_tracepoint_ptrs_registered) + return; + /* + * Lookup if destructors must be executed using the new method. + */ + if (lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state + && !lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) { + /* + * The tracepoint_get_destructors_state symbol was found with + * dlsym but its returned value is 0 meaning that destructors + * must not be executed. + */ + return; + } + ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle); + if (ret) { + fprintf(stderr, "Error (%d) in dlclose\n", ret); + abort(); + } + memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr)); } -#ifndef TRACEPOINT_EVENT +#if LTTNG_UST_COMPAT_API(0) +# if defined(TRACEPOINT_DEFINE) && !defined(LTTNG_UST_TRACEPOINT_DEFINE) +# define LTTNG_UST_TRACEPOINT_DEFINE +# endif +#endif /* #if LTTNG_UST_COMPAT_API(0) */ + +#if LTTNG_UST_COMPAT_API(0) +#define tracepoint lttng_ust_tracepoint +#define do_tracepoint lttng_ust_do_tracepoint +#define tracepoint_enabled lttng_ust_tracepoint_enabled +#define TP_ARGS LTTNG_UST_TP_ARGS +#endif /* #if LTTNG_UST_COMPAT_API(0) */ + +#ifdef __cplusplus +} +#endif + +#endif /* _LTTNG_UST_TRACEPOINT_H */ + +/* The following declarations must be outside re-inclusion protection. */ + +#ifdef LTTNG_UST_TRACEPOINT_DEFINE + +#ifndef _LTTNG_UST_TRACEPOINT_DEFINE_ONCE +#define _LTTNG_UST_TRACEPOINT_DEFINE_ONCE + +#ifdef __cplusplus +extern "C" { +#endif + /* - * Usage of the TRACEPOINT_EVENT macro: + * 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 lttng_ust_tracepoint * const __start_lttng_ust_tracepoints_ptrs[] + __attribute__((weak, visibility("hidden"))); +extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[] + __attribute__((weak, visibility("hidden"))); + +/* + * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a + * unresolved symbol that requires the provider to be linked in. When + * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an + * unresolved symbol that depends on having the provider linked in, + * otherwise the linker complains. This deals with use of static + * libraries, ensuring that the linker does not remove the provider + * object from the executable. + */ + +#if LTTNG_UST_COMPAT_API(0) +# if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE) +# define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE +# endif +#endif /* #if LTTNG_UST_COMPAT_API(0) */ + +#ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE +#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) NULL +#else /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ +#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider) <tng_ust_tracepoint_provider_##provider +#endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */ + +/* + * Note: to allow PIC code, we need to allow the linker to update the pointers + * in the lttng_ust_tracepoints_ptrs section. + * Therefore, this section is _not_ const (read-only). + */ +#define LTTNG_UST__TP_EXTRACT_STRING(...) #__VA_ARGS__ + +#undef LTTNG_UST__DEFINE_TRACEPOINT +#define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args) \ + lttng_ust_tracepoint_validate_name_len(_provider, _name); \ + extern int lttng_ust_tracepoint_provider_##_provider \ + LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY; \ + static const char lttng_ust_tp_provider_strtab_##_provider##___##_name[] \ + __attribute__((section("lttng_ust_tracepoints_strings"))) = \ + #_provider; \ + static const char lttng_ust_tp_name_strtab_##_provider##___##_name[] \ + __attribute__((section("lttng_ust_tracepoints_strings"))) = \ + #_name; \ + struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name \ + __attribute__((section("lttng_ust_tracepoints"))) \ + LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY = { \ + sizeof(struct lttng_ust_tracepoint), \ + lttng_ust_tp_provider_strtab_##_provider##___##_name, \ + lttng_ust_tp_name_strtab_##_provider##___##_name, \ + 0, \ + NULL, \ + LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider), \ + LTTNG_UST__TP_EXTRACT_STRING(_args), \ + }; \ + static struct lttng_ust_tracepoint * \ + lttng_ust_tracepoint_ptr_##_provider##___##_name \ + __attribute__((section("lttng_ust_tracepoints_ptrs"), used)) \ + __lttng_ust_variable_attribute_no_sanitize_address = \ + <tng_ust_tracepoint_##_provider##___##_name; + +static void +lttng_ust__tracepoints__ptrs_init(void) + lttng_ust_notrace __attribute__((constructor(LTTNG_UST_CONSTRUCTOR_PRIO))); +static void +lttng_ust__tracepoints__ptrs_init(void) +{ + if (lttng_ust_tracepoint_ptrs_registered++) + return; + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) + lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle = + dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL); + if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle) { + lttng_ust_tracepoints_print_disabled_message(); + return; + } + if (!lttng_ust_tracepoint_destructors_syms_ptr) + lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; + lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register = + URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tracepoint_module_register")); + lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister = + URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tracepoint_module_unregister")); + lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors = + URCU_FORCE_CAST(void (*)(void), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tp_disable_destructors")); + lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state = + URCU_FORCE_CAST(int (*)(void), + dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle, + "lttng_ust_tp_get_destructors_state")); + lttng_ust_tracepoint__init_urcu_sym(); + if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register) { + lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_register(__start_lttng_ust_tracepoints_ptrs, + __stop_lttng_ust_tracepoints_ptrs - + __start_lttng_ust_tracepoints_ptrs); + } +} + +static void +lttng_ust__tracepoints__ptrs_destroy(void) + lttng_ust_notrace __attribute__((destructor(LTTNG_UST_CONSTRUCTOR_PRIO))); +static void +lttng_ust__tracepoints__ptrs_destroy(void) +{ + int ret; + + if (--lttng_ust_tracepoint_ptrs_registered) + return; + if (!lttng_ust_tracepoint_dlopen_ptr) + lttng_ust_tracepoint_dlopen_ptr = <tng_ust_tracepoint_dlopen; + if (!lttng_ust_tracepoint_destructors_syms_ptr) + lttng_ust_tracepoint_destructors_syms_ptr = <tng_ust_tracepoint_destructors_syms; + if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister) + lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_module_unregister(__start_lttng_ust_tracepoints_ptrs); + if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle + && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state + && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state() + && !lttng_ust_tracepoint_ptrs_registered) { + ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle); + if (ret) { + fprintf(stderr, "Error (%d) in dlclose\n", ret); + abort(); + } + memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr)); + } +} + +#ifdef __cplusplus +} +#endif + +#endif /* _LTTNG_UST_TRACEPOINT_DEFINE_ONCE */ + +#else /* LTTNG_UST_TRACEPOINT_DEFINE */ + +#undef LTTNG_UST__DEFINE_TRACEPOINT +#define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args) + +#endif /* #else LTTNG_UST_TRACEPOINT_DEFINE */ + +/* + * LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION: Define this before including + * a tracepoint instrumentation header to hide symbols associated with + * tracepoint module instrumentation. This is useful if all compile + * units using the lttng_ust_tracepoint(), + * lttng_ust_tracepoint_enabled() and lttng_ust_do_tracepoint() macros + * is within the same module as the compile unit including the + * tracepoint header after defining LTTNG_UST_TRACEPOINT_DEFINE. + */ + +#undef LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY +#ifdef LTTNG_UST_TRACEPOINT_HIDDEN_DEFINITION +#define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY __attribute__((visibility("hidden"))) +#else +#define LTTNG_UST__TRACEPOINT_DEFINITION_VISIBILITY __attribute__((visibility("default"))) +#endif + +/* + * LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION: Define this before + * including a tracepoint instrumentation header to hide symbols + * associated with the tracepoint provider. This is useful if the + * tracepoint definition (including the header after defining + * LTTNG_UST_TRACEPOINT_DEFINE) is in the same module as the provider + * (including the header after defining + * LTTNG_UST_TRACEPOINT_CREATE_PROBES). + */ +#undef LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY +#ifdef LTTNG_UST_TRACEPOINT_PROVIDER_HIDDEN_DEFINITION +#define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("hidden"))) +#else +#define LTTNG_UST__TRACEPOINT_PROVIDER_DEFINITION_VISIBILITY __attribute__((visibility("default"))) +#endif + +#ifndef LTTNG_UST_TRACEPOINT_ENUM + +/* + * Tracepoint Enumerations * - * In short, an example: + * The enumeration is a mapping between an integer, or range of integers, and + * a string. It can be used to have a more compact trace in cases where the + * possible values for a field are limited: * - * TRACEPOINT_EVENT(< [com_company_]project[_component] >, < event >, - * TP_PROTO(int arg0, void *arg1, char *string, size_t strlen, - * long *arg4, size_t arg4_len), - * TP_VARS(arg0, arg1, string, strlen, arg4, arg4_len), - * TP_FIELDS( + * An example: * - * * Integer, printed in base 10 * - * ctf_integer(int, field_a, arg0) + * LTTNG_UST_TRACEPOINT_ENUM(someproject_component, enumname, + * LTTNG_UST_TP_ENUM_VALUES( + * lttng_ust_field_enum_value("even", 0) + * lttng_ust_field_enum_value("uneven", 1) + * lttng_ust_field_enum_range("twoto4", 2, 4) + * lttng_ust_field_enum_value("five", 5) + * ) + * ) + * + * Where "someproject_component" is the name of the component this enumeration + * belongs to and "enumname" identifies this enumeration. Inside the + * LTTNG_UST_TP_ENUM_VALUES macro is the actual mapping. Each string value can map + * to either a single value with lttng_ust_field_enum_value or a range of values + * with lttng_ust_field_enum_range. * - * * Integer, printed with 0x base 16 * - * ctf_integer_hex(unsigned long, field_d, arg1) + * Enumeration ranges may overlap, but the behavior is implementation-defined, + * each trace reader will handle overlapping as it wishes. * - * * Array Sequence, printed as UTF8-encoded array of bytes * - * ctf_array_text(char, field_b, string, FIXED_LEN) - * ctf_sequence_text(char, field_c, string, size_t, strlen) + * That enumeration can then be used in a field inside the TP_FIELD macro using + * the following line: * - * * String, printed as UTF8-encoded string * - * ctf_string(field_e, string) + * lttng_ust_field_enum(someproject_component, enumname, enumtype, enumfield, enumval) * - * * Array sequence of signed integer values * - * ctf_array(long, field_f, arg4, FIXED_LEN4) - * ctf_sequence(long, field_g, arg4, size_t, arg4_len) + * Where "someproject_component" and "enumname" match those in the + * LTTNG_UST_TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type + * backing the enumeration, "enumfield" is the name of the field and + * "enumval" is the value. + */ + +#define LTTNG_UST_TRACEPOINT_ENUM(provider, name, values) + +#if LTTNG_UST_COMPAT_API(0) +#define TRACEPOINT_ENUM LTTNG_UST_TRACEPOINT_ENUM +#endif /* #if LTTNG_UST_COMPAT_API(0) */ + +#endif /* #ifndef LTTNG_UST_TRACEPOINT_ENUM */ + +#ifndef LTTNG_UST_TRACEPOINT_EVENT + +/* + * How to use the LTTNG_UST_TRACEPOINT_EVENT macro: + * + * An example: + * + * LTTNG_UST_TRACEPOINT_EVENT(someproject_component, event_name, + * + * * LTTNG_UST_TP_ARGS takes from 0 to 10 "type, field_name" pairs * + * + * LTTNG_UST_TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen, + * long *, arg4, size_t, arg4_len), + * + * * LTTNG_UST_TP_FIELDS describes the event payload layout in the trace * + * + * LTTNG_UST_TP_FIELDS( + * * Integer, printed in base 10 * + * lttng_ust_field_integer(int, field_a, arg0) + * + * * Integer, printed with 0x base 16 * + * lttng_ust_field_integer_hex(unsigned long, field_d, arg1) + * + * * Enumeration * + * lttng_ust_field_enum(someproject_component, enum_name, int, field_e, arg0) + * + * * Array Sequence, printed as UTF8-encoded array of bytes * + * lttng_ust_field_array_text(char, field_b, string, FIXED_LEN) + * lttng_ust_field_sequence_text(char, field_c, string, size_t, strlen) + * + * * String, printed as UTF8-encoded string * + * lttng_ust_field_string(field_e, string) + * + * * Array sequence of signed integer values * + * lttng_ust_field_array(long, field_f, arg4, FIXED_LEN4) + * lttng_ust_field_sequence(long, field_g, arg4, size_t, arg4_len) * ) * ) * - * In more detail: - * - * We define a tracepoint, its arguments, and its 'fast binary record' - * layout. + * More detailed explanation: * - * Firstly, name your tracepoint via TRACEPOINT_EVENT(provider, name, + * The name of the tracepoint is expressed as a tuple with the provider + * and name arguments. * * The provider and name should be a proper C99 identifier. * The "provider" and "name" MUST follow these rules to ensure no @@ -263,152 +850,149 @@ static void __attribute__((destructor)) __tracepoints__destroy(void) * "event" is the name of the tracepoint event. * * the provider:event identifier is limited to 127 characters. - * - * As an example, let's consider a user-space application "someproject" - * that would have an internal thread scheduler: - * - * TRACEPOINT_EVENT(someproject_sched, switch, - * - * * - * * A function has a regular function arguments - * * prototype, declare it via TP_PROTO(): - * * - * - * TP_PROTO(struct rq *rq, struct task_struct *prev, - * struct task_struct *next), - * - * * - * * Define the call signature of the 'function'. - * * (Design sidenote: we use this instead of a - * * TP_PROTO1/TP_PROTO2/TP_PROTO3 ugliness.) - * * - * - * TP_VARS(rq, prev, next), - * - * * - * * Fast binary tracing: define the trace record via - * * TP_FIELDS(). You can think about it like a - * * regular C structure local variable definition. - * * - * * This is how the trace record is structured and will - * * be saved into the ring buffer. These are the fields - * * that will be exposed to readers. - * * - * * ctf_integer(pid_t, prev_pid, prev->pid) is equivalent - * * to a standard declaraton: - * * - * * pid_t prev_pid; - * * - * * followed by an assignment: - * * - * * prev_pid = prev->pid; - * * - * * ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN) is - * * equivalent to: - * * - * * char prev_comm[TASK_COMM_LEN]; - * * - * * followed by an assignment: - * * - * * memcpy(prev_comm, prev->comm, TASK_COMM_LEN); - * * - * - * TP_FIELDS( - * ctf_array(char, prev_comm, prev->comm, TASK_COMM_LEN) - * ctf_integer(pid_t, prev_pid, prev->pid) - * ctf_integer(int, prev_prio, prev->prio) - * ctf_array(char, next_comm, next->comm, TASK_COMM_LEN) - * ctf_integer(pid_t, next_pid, next->pid) - * ctf_integer(int, next_prio, next->prio) - * ) - * ) - * - * Do _NOT_ add comma (,) nor semicolon (;) after the TRACEPOINT_EVENT - * declaration. - * - * The TRACEPOINT_SYSTEM must be defined when declaring a - * TRACEPOINT_EVENT. See ust/tracepoint-event.h for information about - * usage of other macros controlling TRACEPOINT_EVENT. */ -#define TRACEPOINT_EVENT(provider, name, proto, args, fields) \ - _DECLARE_TRACEPOINT(provider, name, TP_PARAMS(proto), TP_PARAMS(args)) +#define LTTNG_UST_TRACEPOINT_EVENT(provider, name, args, fields) \ + LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \ + LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) -#define TRACEPOINT_EVENT_CLASS(provider, name, proto, args, fields) -#define TRACEPOINT_EVENT_INSTANCE(provider, template, name, proto, args)\ - _DECLARE_TRACEPOINT(provider, name, TP_PARAMS(proto), TP_PARAMS(args)) +#define LTTNG_UST_TRACEPOINT_EVENT_CLASS(provider, name, args, fields) -/* - * Declaration of tracepoints that take 0 argument. - */ -#define TRACEPOINT_EVENT_NOARGS(provider, name, fields) \ - _DECLARE_TRACEPOINT_NOARGS(provider, name) +#define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(template_provider, template_name, provider, name, args) \ + LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) \ + LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args)) + +#if LTTNG_UST_COMPAT_API(0) +#define TRACEPOINT_EVENT LTTNG_UST_TRACEPOINT_EVENT +#define TRACEPOINT_EVENT_CLASS LTTNG_UST_TRACEPOINT_EVENT_CLASS +#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, args) \ + LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(_provider, _template, \ + _provider, _name, LTTNG_UST__TP_PARAMS(args)) -#define TRACEPOINT_EVENT_CLASS_NOARGS(provider, name, fields) -#define TRACEPOINT_EVENT_INSTANCE_NOARGS(provider, template, name) \ - _DECLARE_TRACEPOINT_NOARGS(provider, name) +#endif /* #if LTTNG_UST_COMPAT_API(0) */ -#endif /* #ifndef TRACEPOINT_EVENT */ +#endif /* #ifndef LTTNG_UST_TRACEPOINT_EVENT */ -#ifndef TRACEPOINT_LOGLEVEL +#ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL /* - * Tracepoint Loglevel Declaration Facility - * - * This is a place-holder the tracepoint loglevel declaration, - * overridden by the tracer implementation. + * Tracepoint Loglevels * * Typical use of these loglevels: * - * 1) Declare the mapping between loglevel names and an integer values - * within TRACEPOINT_LOGLEVEL_ENUM, using TP_LOGLEVEL for each tuple. - * Do _NOT_ add comma (,) nor semicolon (;) between the - * TRACEPOINT_LOGLEVEL_ENUM entries. Do _NOT_ add comma (,) nor - * semicolon (;) after the TRACEPOINT_LOGLEVEL_ENUM declaration. The - * name should be a proper C99 identifier. - * - * TRACEPOINT_LOGLEVEL_ENUM( - * TP_LOGLEVEL( < loglevel_name >, < value > ) - * TP_LOGLEVEL( < loglevel_name >, < value > ) - * ... - * ) - * - * e.g.: - * - * TRACEPOINT_LOGLEVEL_ENUM( - * TP_LOGLEVEL(LOG_EMERG, 0) - * TP_LOGLEVEL(LOG_ALERT, 1) - * TP_LOGLEVEL(LOG_CRIT, 2) - * TP_LOGLEVEL(LOG_ERR, 3) - * TP_LOGLEVEL(LOG_WARNING, 4) - * TP_LOGLEVEL(LOG_NOTICE, 5) - * TP_LOGLEVEL(LOG_INFO, 6) - * TP_LOGLEVEL(LOG_DEBUG, 7) - * ) - * - * 2) Then, 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_LOGLEVEL(< [com_company_]project[_component] >, < event >, + * The loglevels go from 0 to 14. Higher numbers imply the most + * verbosity (higher event throughput expected. + * + * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels + * semantic. Loglevels 7 through 13 offer more fine-grained selection of + * debug information. + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG 0 + * system is unusable + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT 1 + * action must be taken immediately + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT 2 + * critical conditions + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR 3 + * error conditions + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING 4 + * warning conditions + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE 5 + * normal, but significant, condition + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO 6 + * informational message + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM 7 + * debug information with system-level scope (set of programs) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM 8 + * debug information with program-level scope (set of processes) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS 9 + * debug information with process-level scope (set of modules) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE 10 + * debug information with module (executable/library) scope (set of units) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT 11 + * debug information with compilation unit scope (set of functions) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION 12 + * debug information with function-level scope + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE 13 + * debug information with line-level scope (LTTNG_UST_TRACEPOINT_EVENT default) + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG 14 + * debug-level message + * + * Declare tracepoint loglevels for tracepoints. A LTTNG_UST_TRACEPOINT_EVENT + * should be declared prior to the the LTTNG_UST_TRACEPOINT_LOGLEVEL for a given + * 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. + * + * LTTNG_UST_TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, * < loglevel_name >) * - * The TRACEPOINT_SYSTEM must be defined when declaring a - * TRACEPOINT_LOGLEVEL_ENUM and TRACEPOINT_LOGLEVEL. The tracepoint - * loglevel enumeration apply to the entire TRACEPOINT_SYSTEM. Only one - * tracepoint loglevel enumeration should be declared per tracepoint - * system. + * The LTTNG_UST_TRACEPOINT_PROVIDER must be already declared before declaring a + * LTTNG_UST_TRACEPOINT_LOGLEVEL. */ -#define TRACEPOINT_LOGLEVEL_ENUM() -#define TRACEPOINT_LOGLEVEL(name, loglevel) +enum { + LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG = 0, + LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT = 1, + LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT = 2, + LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR = 3, + LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING = 4, + LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE = 5, + LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO = 6, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM = 7, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM = 8, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS = 9, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE = 10, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT = 11, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION = 12, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE = 13, + LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG = 14, +}; -#endif /* #ifndef TRACEPOINT_LOGLEVEL */ +#define LTTNG_UST_TRACEPOINT_LOGLEVEL(provider, name, loglevel) -#ifdef __cplusplus -} +#if LTTNG_UST_COMPAT_API(0) +#define TRACEPOINT_LOGLEVEL LTTNG_UST_TRACEPOINT_LOGLEVEL + +#define TRACE_EMERG LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG +#define TRACE_ALERT LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT +#define TRACE_CRIT LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT +#define TRACE_ERR LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR +#define TRACE_WARNING LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING +#define TRACE_NOTICE LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE +#define TRACE_INFO LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO +#define TRACE_DEBUG_SYSTEM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM +#define TRACE_DEBUG_PROGRAM LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM +#define TRACE_DEBUG_PROCESS LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS +#define TRACE_DEBUG_MODULE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE +#define TRACE_DEBUG_UNIT LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT +#define TRACE_DEBUG_FUNCTION LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION +#define TRACE_DEBUG_LINE LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE +#define TRACE_DEBUG LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG +#endif + +#endif /* #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL */ + +#ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI + +#define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(provider, name, uri) + +#if LTTNG_UST_COMPAT_API(0) +#define TRACEPOINT_MODEL_EMF_URI LTTNG_UST_TRACEPOINT_MODEL_EMF_URI #endif -#endif /* _LTTNG_TRACEPOINT_H */ +#endif /* #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI */