Clean-up: modernize pretty_xml.cpp
[lttng-tools.git] / src / common / macros.hpp
index 42f7a94d14648a35c6f84a1843fcb1db2de624c0..f1d039a1f4643fa3f3fb30771d5b375e934212a1 100644 (file)
 
 #include <common/compat/string.hpp>
 
+#include <memory>
+#include <pthread.h>
 #include <stddef.h>
 #include <stdlib.h>
 #include <string.h>
-
 #include <type_traits>
 
 /*
  * 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 <assert.h>
-# define LTTNG_ASSERT(_cond) assert(_cond)
+#include <assert.h>
+#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 <typename T>
-struct can_malloc
-{
+template <typename MallocableType>
+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
@@ -74,64 +73,69 @@ struct can_malloc
 #if __GNUG__ && __GNUC__ < 5
        static constexpr bool value = true;
 #else
-       static constexpr bool value = std::is_trivially_constructible<T>::value;
+       static constexpr bool value = std::is_trivially_constructible<MallocableType>::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<typename T>
-T *zmalloc()
+template <typename MallocableType>
+MallocableType *zmalloc()
 {
-       static_assert (can_malloc<T>::value, "type can be malloc'ed");
-       return (T *) zmalloc_internal(sizeof(T));
+       static_assert(can_malloc<MallocableType>::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<typename T>
-T *zmalloc(size_t size)
+template <typename AllocatedType>
+AllocatedType *zmalloc(size_t size)
 {
-       static_assert (can_malloc<T>::value, "type can be malloc'ed");
-       LTTNG_ASSERT(size >= sizeof(T));
-       return (T *) zmalloc_internal(size);
+       static_assert(can_malloc<AllocatedType>::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<typename T>
-T *calloc(size_t nmemb)
+template <typename AllocatedType>
+AllocatedType *calloc(size_t nmemb)
 {
-       static_assert (can_malloc<T>::value, "type can be malloc'ed");
-       return (T *) zmalloc_internal(nmemb * sizeof(T));
+       static_assert(can_malloc<AllocatedType>::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<typename T>
-T *malloc()
+template <typename AllocatedType>
+AllocatedType *malloc()
 {
-       static_assert (can_malloc<T>::value, "type can be malloc'ed");
-       return (T *) malloc(sizeof(T));
+       static_assert(can_malloc<AllocatedType>::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<typename T>
-T *malloc(size_t size)
+template <typename AllocatedType>
+AllocatedType *malloc(size_t size)
 {
-       static_assert (can_malloc<T>::value, "type can be malloc'ed");
-       return (T *) malloc(size);
+       static_assert(can_malloc<AllocatedType>::value, "type can be malloc'ed");
+       return (AllocatedType *) malloc(size);
 }
 
 /*
@@ -147,9 +151,8 @@ T *malloc(size_t size)
  * pointers to void, these will not be checked.
  */
 
-template<typename T>
-struct can_free
-{
+template <typename FreedType>
+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
@@ -161,25 +164,26 @@ struct can_free
 #if __GNUG__ && __GNUC__ < 5
        static constexpr bool value = true;
 #else
-       static constexpr bool value = std::is_trivially_destructible<T>::value || std::is_void<T>::value;
+       static constexpr bool value = std::is_trivially_destructible<FreedType>::value ||
+               std::is_void<FreedType>::value;
 #endif
 };
 
-template<typename T, typename = typename std::enable_if<!can_free<T>::value>::type>
-void free(T *p) = delete;
+template <typename FreedType, typename = typename std::enable_if<!can_free<FreedType>::value>::type>
+void free(FreedType *p) = delete;
 
-template<typename T>
-struct can_memset
-{
-       static constexpr bool value = std::is_pod<T>::value || std::is_void<T>::value;
+template <typename InitializedType>
+struct can_memset {
+       static constexpr bool value = std::is_pod<InitializedType>::value ||
+               std::is_void<InitializedType>::value;
 };
 
-template <typename T, typename = typename std::enable_if<!can_memset<T>::value>::type>
-void *memset(T *s, int c, size_t n) = delete;
+template <typename InitializedType,
+         typename = typename std::enable_if<!can_memset<InitializedType>::value>::type>
+void *memset(InitializedType *s, int c, size_t n) = delete;
 
-template<typename T>
-struct can_memcpy
-{
+template <typename T>
+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
@@ -195,14 +199,14 @@ struct can_memcpy
 #endif
 };
 
-template <typename T, typename U,
-               typename = typename std::enable_if<!can_memcpy<T>::value>::type,
-               typename = typename std::enable_if<!can_memcpy<U>::value>::type>
-void *memcpy(T *d, const U *s, size_t n) = delete;
+template <typename DestinationType,
+         typename SourceType,
+         typename = typename std::enable_if<!can_memcpy<DestinationType>::value>::type,
+         typename = typename std::enable_if<!can_memcpy<SourceType>::value>::type>
+void *memcpy(DestinationType *d, const SourceType *s, size_t n) = delete;
 
-template<typename T>
-struct can_memmove
-{
+template <typename MovedType>
+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
@@ -214,25 +218,18 @@ struct can_memmove
 #if __GNUG__ && __GNUC__ < 5
        static constexpr bool value = true;
 #else
-       static constexpr bool value = std::is_trivially_copyable<T>::value;
+       static constexpr bool value = std::is_trivially_copyable<MovedType>::value;
 #endif
 };
 
-template <typename T, typename U,
-               typename = typename std::enable_if<!can_memmove<T>::value>::type,
-               typename = typename std::enable_if<!can_memmove<U>::value>::type>
-void *memmove(T *d, const U *s, size_t n) = delete;
+template <typename DestinationType,
+         typename SourceType,
+         typename = typename std::enable_if<!can_memmove<DestinationType>::value>::type,
+         typename = typename std::enable_if<!can_memmove<SourceType>::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])))
-#endif
-
-#ifndef container_of
-#define container_of(ptr, type, member)                                        \
-       ({                                                              \
-               const typeof(((type *)NULL)->member) * __ptr = (ptr);   \
-               (type *)((char *)__ptr - offsetof(type, member));       \
-       })
+#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0])))
 #endif
 
 #ifndef LTTNG_PACKED
@@ -240,48 +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_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_DUPLICATED_BRANCHES \
+#define DIAGNOSTIC_IGNORE_LOGICAL_OP _Pragma("GCC diagnostic ignored \"-Wlogical-op\"")
+#if __GNUG__ && __GNUC__ >= 7
+#define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES \
        _Pragma("GCC diagnostic ignored \"-Wduplicated-branches\"")
+#else
+#define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES
+#endif /* __GNUG__ && __GNUC__ >= 7 */
+#define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF _Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"")
 #endif
 
 /* Used to make specific C++ functions to C code. */
@@ -291,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. */
@@ -311,4 +313,18 @@ int lttng_strncpy(char *dst, const char *src, size_t dst_len)
        return 0;
 }
 
+namespace lttng {
+namespace utils {
+template <class ParentType, class MemberType>
+ParentType *container_of(const MemberType *member, const MemberType ParentType::*ptr_to_member)
+{
+       const ParentType *dummy_parent = nullptr;
+       auto *offset_of_member = reinterpret_cast<const char *>(&(dummy_parent->*ptr_to_member));
+       auto address_of_parent = reinterpret_cast<const char *>(member) - offset_of_member;
+
+       return reinterpret_cast<ParentType *>(address_of_parent);
+}
+} /* namespace utils */
+} /* namespace lttng */
+
 #endif /* _MACROS_H */
This page took 0.029486 seconds and 4 git commands to generate.