X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Fmacros.hpp;h=f1d039a1f4643fa3f3fb30771d5b375e934212a1;hb=HEAD;hp=cfe6eb5289d637ef1f1d1ddafe1b2f808a78535a;hpb=efc2642c22639e9af4bd01953bfd4453f6218f61;p=lttng-tools.git diff --git a/src/common/macros.hpp b/src/common/macros.hpp index cfe6eb528..f1d039a1f 100644 --- a/src/common/macros.hpp +++ b/src/common/macros.hpp @@ -11,12 +11,11 @@ #include +#include +#include #include #include #include - -#include -#include #include /* @@ -39,32 +38,30 @@ * memory using malloc(), we must use generic accessors for compat in order to * *not* use a function to access members and not the variable name. */ -#define LTTNG_REF(x) ((typeof(*x) *)(x)) +#define LTTNG_REF(x) ((typeof(*(x)) *) (x)) #ifdef NDEBUG /* -* Force usage of the assertion condition to prevent unused variable warnings -* when `assert()` are disabled by the `NDEBUG` definition. -*/ -# define LTTNG_ASSERT(_cond) ((void) sizeof((void) (_cond), 0)) + * Force usage of the assertion condition to prevent unused variable warnings + * when `assert()` are disabled by the `NDEBUG` definition. + */ +#define LTTNG_ASSERT(_cond) ((void) sizeof((void) (_cond), 0)) #else -# include -# define LTTNG_ASSERT(_cond) assert(_cond) +#include +#define LTTNG_ASSERT(_cond) assert(_cond) #endif /* * Memory allocation zeroed */ -static inline -void *zmalloc_internal(size_t size) +static inline void *zmalloc_internal(size_t size) { return calloc(1, size); } -template -struct can_malloc -{ +template +struct can_malloc { /* * gcc versions before 5.0 lack some type traits defined in C++11. * Since in this instance we use the trait to prevent misuses @@ -76,64 +73,69 @@ struct can_malloc #if __GNUG__ && __GNUC__ < 5 static constexpr bool value = true; #else - static constexpr bool value = std::is_trivially_constructible::value; + static constexpr bool value = std::is_trivially_constructible::value; #endif }; /* - * Malloc and zero-initialize an object of type T, asserting that T can be + * Malloc and zero-initialize an object of type T, asserting that MallocableType can be * safely malloc-ed (is trivially constructible). */ -template -T *zmalloc() +template +MallocableType *zmalloc() { - static_assert (can_malloc::value, "type can be malloc'ed"); - return (T *) zmalloc_internal(sizeof(T)); + static_assert(can_malloc::value, "type can be malloc'ed"); + return (MallocableType *) zmalloc_internal(sizeof(MallocableType)); /* NOLINT sizeof + potentially used on a + pointer. */ } /* - * Malloc and zero-initialize a buffer of size `size`, asserting that type T + * Malloc and zero-initialize a buffer of size `size`, asserting that type AllocatedType * can be safely malloc-ed (is trivially constructible). */ -template -T *zmalloc(size_t size) +template +AllocatedType *zmalloc(size_t size) { - static_assert (can_malloc::value, "type can be malloc'ed"); - LTTNG_ASSERT(size >= sizeof(T)); - return (T *) zmalloc_internal(size); + static_assert(can_malloc::value, "type can be malloc'ed"); + LTTNG_ASSERT(size >= sizeof(AllocatedType)); + return (AllocatedType *) zmalloc_internal(size); } /* - * Malloc and zero-initialize an array of `nmemb` elements of type T, - * asserting that T can be safely malloc-ed (is trivially constructible). + * Malloc and zero-initialize an array of `nmemb` elements of type AllocatedType, + * asserting that AllocatedType can be safely malloc-ed (is trivially constructible). */ -template -T *calloc(size_t nmemb) +template +AllocatedType *calloc(size_t nmemb) { - static_assert (can_malloc::value, "type can be malloc'ed"); - return (T *) zmalloc_internal(nmemb * sizeof(T)); + static_assert(can_malloc::value, "type can be malloc'ed"); + return (AllocatedType *) zmalloc_internal(nmemb * sizeof(AllocatedType)); /* NOLINT sizeof + potentially + used on a + pointer. */ } /* - * Malloc an object of type T, asserting that T can be safely malloc-ed (is + * Malloc an object of type AllocatedType, asserting that AllocatedType can be safely malloc-ed (is * trivially constructible). */ -template -T *malloc() +template +AllocatedType *malloc() { - static_assert (can_malloc::value, "type can be malloc'ed"); - return (T *) malloc(sizeof(T)); + static_assert(can_malloc::value, "type can be malloc'ed"); + return (AllocatedType *) malloc(sizeof(AllocatedType)); } /* - * Malloc a buffer of size `size`, asserting that type T can be safely + * Malloc a buffer of size `size`, asserting that AllocatedType can be safely * malloc-ed (is trivially constructible). */ -template -T *malloc(size_t size) +template +AllocatedType *malloc(size_t size) { - static_assert (can_malloc::value, "type can be malloc'ed"); - return (T *) malloc(size); + static_assert(can_malloc::value, "type can be malloc'ed"); + return (AllocatedType *) malloc(size); } /* @@ -149,9 +151,8 @@ T *malloc(size_t size) * pointers to void, these will not be checked. */ -template -struct can_free -{ +template +struct can_free { /* * gcc versions before 5.0 lack some type traits defined in C++11. * Since in this instance we use the trait to prevent misuses @@ -163,25 +164,26 @@ struct can_free #if __GNUG__ && __GNUC__ < 5 static constexpr bool value = true; #else - static constexpr bool value = std::is_trivially_destructible::value || std::is_void::value; + static constexpr bool value = std::is_trivially_destructible::value || + std::is_void::value; #endif }; -template::value>::type> -void free(T *p) = delete; +template ::value>::type> +void free(FreedType *p) = delete; -template -struct can_memset -{ - static constexpr bool value = std::is_pod::value || std::is_void::value; +template +struct can_memset { + static constexpr bool value = std::is_pod::value || + std::is_void::value; }; -template ::value>::type> -void *memset(T *s, int c, size_t n) = delete; +template ::value>::type> +void *memset(InitializedType *s, int c, size_t n) = delete; -template -struct can_memcpy -{ +template +struct can_memcpy { /* * gcc versions before 5.0 lack some type traits defined in C++11. * Since in this instance we use the trait to prevent misuses @@ -197,14 +199,14 @@ struct can_memcpy #endif }; -template ::value>::type, - typename = typename std::enable_if::value>::type> -void *memcpy(T *d, const U *s, size_t n) = delete; +template ::value>::type, + typename = typename std::enable_if::value>::type> +void *memcpy(DestinationType *d, const SourceType *s, size_t n) = delete; -template -struct can_memmove -{ +template +struct can_memmove { /* * gcc versions before 5.0 lack some type traits defined in C++11. * Since in this instance we use the trait to prevent misuses @@ -216,17 +218,18 @@ struct can_memmove #if __GNUG__ && __GNUC__ < 5 static constexpr bool value = true; #else - static constexpr bool value = std::is_trivially_copyable::value; + static constexpr bool value = std::is_trivially_copyable::value; #endif }; -template ::value>::type, - typename = typename std::enable_if::value>::type> -void *memmove(T *d, const U *s, size_t n) = delete; +template ::value>::type, + typename = typename std::enable_if::value>::type> +void *memmove(DestinationType *d, const SourceType *s, size_t n) = delete; #ifndef ARRAY_SIZE -#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0]))) +#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0]))) #endif #ifndef LTTNG_PACKED @@ -234,56 +237,54 @@ void *memmove(T *d, const U *s, size_t n) = delete; #endif #ifndef LTTNG_NO_SANITIZE_ADDRESS -#if defined(__clang__) || defined (__GNUC__) +#if defined(__clang__) || defined(__GNUC__) #define LTTNG_NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address)) #else #define LTTNG_NO_SANITIZE_ADDRESS #endif #endif -#define member_sizeof(type, field) sizeof(((type *) 0)->field) +#define member_sizeof(type, field) sizeof(((type *) 0)->field) -#define ASSERT_LOCKED(lock) LTTNG_ASSERT(pthread_mutex_trylock(&lock)) -#define ASSERT_RCU_READ_LOCKED(lock) LTTNG_ASSERT(rcu_read_ongoing()) +#define ASSERT_LOCKED(lock) LTTNG_ASSERT(pthread_mutex_trylock(&(lock))) +#define ASSERT_RCU_READ_LOCKED() LTTNG_ASSERT(rcu_read_ongoing()) +#define ASSERT_RCU_READ_UNLOCKED() LTTNG_ASSERT(!rcu_read_ongoing()) /* Attribute suitable to tag functions as having printf()-like arguments. */ #define ATTR_FORMAT_PRINTF(_string_index, _first_to_check) \ __attribute__((format(printf, _string_index, _first_to_check))) /* Attribute suitable to tag functions as having strftime()-like arguments. */ -#define ATTR_FORMAT_STRFTIME(_string_index) \ - __attribute__((format(strftime, _string_index, 0))) +#define ATTR_FORMAT_STRFTIME(_string_index) __attribute__((format(strftime, _string_index, 0))) /* Macros used to ignore specific compiler diagnostics. */ #define DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push") -#define DIAGNOSTIC_POP _Pragma("GCC diagnostic pop") +#define DIAGNOSTIC_POP _Pragma("GCC diagnostic pop") #if defined(__clang__) - /* Clang */ -# define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT -# define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \ +/* Clang */ +#define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT +#define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \ _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"") -# define DIAGNOSTIC_IGNORE_LOGICAL_OP -# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES -# define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF - _Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"") +#define DIAGNOSTIC_IGNORE_LOGICAL_OP +#define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES +#define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF +_Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"") #else - /* GCC */ -# define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT \ +/* GCC */ +#define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT \ _Pragma("GCC diagnostic ignored \"-Wsuggest-attribute=format\"") -# define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \ +#define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \ _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"") -# define DIAGNOSTIC_IGNORE_LOGICAL_OP \ - _Pragma("GCC diagnostic ignored \"-Wlogical-op\"") +#define DIAGNOSTIC_IGNORE_LOGICAL_OP _Pragma("GCC diagnostic ignored \"-Wlogical-op\"") #if __GNUG__ && __GNUC__ >= 7 -# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES \ +#define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES \ _Pragma("GCC diagnostic ignored \"-Wduplicated-branches\"") #else -# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES +#define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES #endif /* __GNUG__ && __GNUC__ >= 7 */ -# define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF \ - _Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"") +#define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF _Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"") #endif /* Used to make specific C++ functions to C code. */ @@ -293,17 +294,16 @@ void *memmove(T *d, const U *s, size_t n) = delete; #define C_LINKAGE #endif -/* - * lttng_strncpy returns 0 on success, or nonzero on failure. - * It checks that the @src string fits into @dst_len before performing - * the copy. On failure, no copy has been performed. - * - * Assumes that 'src' is null-terminated. - * - * dst_len includes the string's trailing NULL. - */ -static inline -int lttng_strncpy(char *dst, const char *src, size_t dst_len) + /* + * lttng_strncpy returns 0 on success, or nonzero on failure. + * It checks that the @src string fits into @dst_len before performing + * the copy. On failure, no copy has been performed. + * + * Assumes that 'src' is null-terminated. + * + * dst_len includes the string's trailing NULL. + */ + static inline int lttng_strncpy(char *dst, const char *src, size_t dst_len) { if (strlen(src) >= dst_len) { /* Fail since copying would result in truncation. */ @@ -315,14 +315,14 @@ int lttng_strncpy(char *dst, const char *src, size_t dst_len) namespace lttng { namespace utils { -template -Parent *container_of(const Member *member, const Member Parent::*ptr_to_member) +template +ParentType *container_of(const MemberType *member, const MemberType ParentType::*ptr_to_member) { - const Parent *dummy_parent = nullptr; + const ParentType *dummy_parent = nullptr; auto *offset_of_member = reinterpret_cast(&(dummy_parent->*ptr_to_member)); auto address_of_parent = reinterpret_cast(member) - offset_of_member; - return reinterpret_cast(address_of_parent); + return reinterpret_cast(address_of_parent); } } /* namespace utils */ } /* namespace lttng */