X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-compiler.h;h=e610f98272ff91a366ce10cc15f99d827276a9a8;hb=1c1968450409b3c159a3000f9e1a968ff1e5f7e8;hp=c35a23e1dfc5aa8b0f1e0e07a931979739116e78;hpb=a8909ba54718ed54cefb1b839a5d41a065df09f9;p=lttng-ust.git diff --git a/include/lttng/ust-compiler.h b/include/lttng/ust-compiler.h index c35a23e1..e610f982 100644 --- a/include/lttng/ust-compiler.h +++ b/include/lttng/ust-compiler.h @@ -1,21 +1,162 @@ +// SPDX-FileCopyrightText: 2011-2012 Mathieu Desnoyers +// SPDX-FileCopyrightText: 2011-2012 Paul Woegerer +// +// SPDX-License-Identifier: MIT + #ifndef _LTTNG_UST_COMPILER_H #define _LTTNG_UST_COMPILER_H +#include + +/* + * By default, LTTng-UST uses the priority 150 for the tracepoint and probe + * provider constructors to trace tracepoints located within + * constructors/destructors with a higher priority value within the same + * module. This priority can be overridden by the application. + */ +#ifndef LTTNG_UST_CONSTRUCTOR_PRIO +#define LTTNG_UST_CONSTRUCTOR_PRIO 150 +#endif + +#define lttng_ust_notrace __attribute__((no_instrument_function)) + +/* + * Clang supports the no_sanitize variable attribute on global variables. + * GCC only supports the no_sanitize_address function attribute, which is + * not what we need. + */ +#if defined(__clang__) +# if __has_feature(address_sanitizer) +# define __lttng_ust_variable_attribute_no_sanitize_address \ + __attribute__((no_sanitize("address"))) +# else +# define __lttng_ust_variable_attribute_no_sanitize_address +# endif +#else +# define __lttng_ust_variable_attribute_no_sanitize_address +#endif + /* - * Copyright 2011-2012 - Mathieu Desnoyers - * Paul Woegerer + * g++ 4.8 and prior do not support C99 compound literals. Therefore, + * force allocating those on the heap with these C++ compilers. + */ +#if defined (__cplusplus) && !defined (__clang__) && defined (__GNUC__) && \ + ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ <= 8))) +# ifndef LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP +# define LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP +# endif +#endif + +/* + * Compound literals with static storage are needed by LTTng. + * Compound literals are part of the C99 and C11 standards, but not + * part of the C++ standards. However, those are supported by both g++ and + * clang. In order to be strictly C++11 compliant, defining + * LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP before including this header + * allocates those on the heap in C++. * - * 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: + * Example use: + * static struct mystruct *var = LTTNG_UST_COMPOUND_LITERAL(struct mystruct, { 1, 2, 3 }); + */ +#if defined (__cplusplus) && defined (LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP) +#define LTTNG_UST_COMPOUND_LITERAL(type, ...) new (type) __VA_ARGS__ +#else +#define LTTNG_UST_COMPOUND_LITERAL(type, ...) (type[]) { __VA_ARGS__ } +#endif + +/* + * Compile time assertion. + * - predicate: boolean expression to evaluate, + * - msg: string to print to the user on failure when `static_assert()` is + * supported, + * - c_identifier_msg: message to be included in the typedef to emulate a + * static assertion. This parameter must be a valid C identifier as it will + * be used as a typedef name. + */ +#ifdef __cplusplus +#define lttng_ust_static_assert(predicate, msg, c_identifier_msg) \ + static_assert(predicate, msg) +#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) +#define lttng_ust_static_assert(predicate, msg, c_identifier_msg) \ + _Static_assert(predicate, msg) +#else +/* + * Evaluates the predicate and emit a compilation error on failure. * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * If the predicate evaluates to true, this macro emits a function + * prototype with an argument type which is an array of size 0. + * + * If the predicate evaluates to false, this macro emits a function + * prototype with an argument type which is an array of negative size + * which is invalid in C and forces a compiler error. The + * c_identifier_msg parameter is used as the argument identifier so it + * is printed to the user when the error is reported. */ +#define lttng_ust_static_assert(predicate, msg, c_identifier_msg) \ + void lttng_ust_static_assert_proto(char c_identifier_msg[2*!!(predicate)-1]) +#endif -#define lttng_ust_notrace __attribute__((no_instrument_function)) +/* Combine two tokens. */ +#define LTTNG_UST_COMPILER__COMBINE_TOKENS(_tokena, _tokenb) \ + _tokena##_tokenb +#define LTTNG_UST_COMPILER_COMBINE_TOKENS(_tokena, _tokenb) \ + LTTNG_UST_COMPILER__COMBINE_TOKENS(_tokena, _tokenb) +/* + * Wrap constructor and destructor functions to invoke them as functions with + * the constructor/destructor GNU C attributes, which ensures that those + * constructors/destructors are ordered before/after C++ + * constructors/destructors. + * + * Wrap constructor and destructor functions as the constructor/destructor of a + * variable defined within an anonymous namespace when building as C++ with + * LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP defined. With this option, + * there are no guarantees that the events in C++ constructors/destructors will + * be traced. + */ +#if defined (__cplusplus) && defined (LTTNG_UST_ALLOCATE_COMPOUND_LITERAL_ON_HEAP) +#define LTTNG_UST_DECLARE_CONSTRUCTOR_DESTRUCTOR(name, constructor_func, \ + destructor_func, ...) \ +namespace lttng { \ +namespace ust { \ +namespace details { \ +class LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, \ + name) { \ +public: \ + LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)() __VA_ARGS__; \ + ~LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)() __VA_ARGS__; \ +}; \ +LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)::LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)() \ +{ \ + constructor_func(); \ +} \ +LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)::~LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_destructor_, name)() \ +{ \ + destructor_func(); \ +} \ +} \ +} \ +} \ + \ +namespace { \ +const lttng::ust::details::LTTNG_UST_COMPILER_COMBINE_TOKENS( \ + lttng_ust_constructor_destructor_, name) \ + LTTNG_UST_COMPILER_COMBINE_TOKENS(name, registration_instance); \ +} +#else +#define LTTNG_UST_DECLARE_CONSTRUCTOR_DESTRUCTOR(name, constructor_func, \ + destructor_func, ...) \ + static void LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_, name)(void) \ + __attribute__((constructor(LTTNG_UST_CONSTRUCTOR_PRIO))) __VA_ARGS__; \ + static void LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_constructor_, name)(void) \ + { \ + constructor_func(); \ + } \ + static void LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_destructor_, name)(void) \ + __attribute__((destructor(LTTNG_UST_CONSTRUCTOR_PRIO))) __VA_ARGS__; \ + static void LTTNG_UST_COMPILER_COMBINE_TOKENS(lttng_ust_destructor_, name)(void) \ + { \ + destructor_func(); \ + } +#endif #endif /* _LTTNG_UST_COMPILER_H */