[lttng-tools.git] / src / common / macros.hpp

/*
 * Copyright (C) 2011 EfficiOS Inc.
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _MACROS_H
#define _MACROS_H

#include <common/compat/string.hpp>

#include <stddef.h>
#include <stdlib.h>
#include <string.h>

#include <memory>
#include <pthread.h>
#include <type_traits>

/*
 * Takes a pointer x and transform it so we can use it to access members
 * without a function call. Here an example:
 *
 *    #define GET_SIZE(x) LTTNG_REF(x)->size
 *
 *    struct { int size; } s;
 *
 *    printf("size : %d\n", GET_SIZE(&s));
 *
 * For this example we can't use something like this for compatibility purpose
 * since this will fail:
 *
 *    #define GET_SIZE(x) x->size;
 *
 * This is mostly use for the compatibility layer of lttng-tools. See
 * poll/epoll for a good example. Since x can be on the stack or allocated
 * 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))

#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))
#else
# include <assert.h>
# define LTTNG_ASSERT(_cond) assert(_cond)
#endif

/*
 * Memory allocation zeroed
 */

static inline
void *zmalloc_internal(size_t size)
{
	return calloc(1, size);
}

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
	 * of malloc (and statically assert) and not to generate different
	 * code based on this property, simply set value to true and allow
	 * the code to compile. Anyone using a contemporary compiler will
	 * catch the error.
	 */
#if __GNUG__ && __GNUC__ < 5
	static constexpr bool value = true;
#else
	static constexpr bool value = std::is_trivially_constructible<MallocableType>::value;
#endif
};

/*
 * Malloc and zero-initialize an object of type T, asserting that MallocableType can be
 * safely malloc-ed (is trivially constructible).
 */
template <typename MallocableType>
MallocableType *zmalloc()
{
	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 AllocatedType
 * can be safely malloc-ed (is trivially constructible).
 */
template <typename AllocatedType>
AllocatedType *zmalloc(size_t 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 AllocatedType,
 * asserting that AllocatedType can be safely malloc-ed (is trivially constructible).
 */
template <typename AllocatedType>
AllocatedType *calloc(size_t nmemb)
{
	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 AllocatedType, asserting that AllocatedType can be safely malloc-ed (is
 * trivially constructible).
 */
template <typename AllocatedType>
AllocatedType *malloc()
{
	static_assert(can_malloc<AllocatedType>::value, "type can be malloc'ed");
	return (AllocatedType *) malloc(sizeof(AllocatedType));
}

/*
 * Malloc a buffer of size `size`, asserting that AllocatedType can be safely
 * malloc-ed (is trivially constructible).
 */
template<typename AllocatedType>
AllocatedType *malloc(size_t size)
{
	static_assert (can_malloc<AllocatedType>::value, "type can be malloc'ed");
	return (AllocatedType *) malloc(size);
}

/*
 * Prevent using `free` on types that are non-POD.
 *
 * Declare a delete prototype of free if the parameter type is not safe to free
 * (non-POD).
 *
 * If the parameter is a pointer to void, we can't check if what is pointed
 * to is safe to free or not, as we don't know what is pointed to.  Ideally,
 * all calls to free would be with a typed pointer, but there are too many
 * instances of passing a pointer to void to enforce that right now.  So allow
 * pointers to void, these will not be checked.
 */

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
	 * of free (and statically assert) and not to generate different
	 * code based on this property, simply set value to true and allow
	 * the code to compile. Anyone using a contemporary compiler will
	 * catch the error.
	 */
#if __GNUG__ && __GNUC__ < 5
	static constexpr bool value = true;
#else
	static constexpr bool value = std::is_trivially_destructible<FreedType>::value ||
		std::is_void<FreedType>::value;
#endif
};

template <typename FreedType, typename = typename std::enable_if<!can_free<FreedType>::value>::type>
void free(FreedType *p) = delete;

template <typename InitializedType>
struct can_memset {
	static constexpr bool value = std::is_pod<InitializedType>::value ||
		std::is_void<InitializedType>::value;
};

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
{
	/*
	 * gcc versions before 5.0 lack some type traits defined in C++11.
	 * Since in this instance we use the trait to prevent misuses
	 * of memcpy (and statically assert) and not to generate different
	 * code based on this property, simply set value to true and allow
	 * the code to compile. Anyone using a contemporary compiler will
	 * catch the error.
	 */
#if __GNUG__ && __GNUC__ < 5
	static constexpr bool value = true;
#else
	static constexpr bool value = std::is_trivially_copyable<T>::value;
#endif
};

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 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
	 * of memmove (and statically assert) and not to generate different
	 * code based on this property, simply set value to true and allow
	 * the code to compile. Anyone using a contemporary compiler will
	 * catch the error.
	 */
#if __GNUG__ && __GNUC__ < 5
	static constexpr bool value = true;
#else
	static constexpr bool value = std::is_trivially_copyable<MovedType>::value;
#endif
};

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 LTTNG_PACKED
#define LTTNG_PACKED __attribute__((__packed__))
#endif

#ifndef LTTNG_NO_SANITIZE_ADDRESS
#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 ASSERT_LOCKED(lock)	     LTTNG_ASSERT(pthread_mutex_trylock(&(lock)))
#define ASSERT_RCU_READ_LOCKED(lock) 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)))

/* Macros used to ignore specific compiler diagnostics. */

#define DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push")
#define DIAGNOSTIC_POP _Pragma("GCC diagnostic pop")

#if defined(__clang__)
  /* 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\"")
#else
  /* GCC */
# define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT \
	_Pragma("GCC diagnostic ignored \"-Wsuggest-attribute=format\"")
# define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \
	_Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
# 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. */
#ifdef __cplusplus
#define C_LINKAGE extern "C"
#else
#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)
{
	if (strlen(src) >= dst_len) {
		/* Fail since copying would result in truncation. */
		return -1;
	}
	strcpy(dst, src);
	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 */
Commit	Line	Data
990570ed	1	/*
21cf9b6b	2	* Copyright (C) 2011 EfficiOS Inc.
ab5be9fa	3	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
990570ed	4	*
ab5be9fa	5	* SPDX-License-Identifier: GPL-2.0-only
990570ed	6	*
990570ed DG	7	*/
	8
	9	#ifndef _MACROS_H
	10	#define _MACROS_H
	11
64803277 SM	12	#include <common/compat/string.hpp>
64803277 SM	13
93375aa6	14	#include <stddef.h>
64803277	15	#include <stdlib.h>
f6835b82	16	#include <string.h>
64803277	17
f1ca0880 JG	18	#include <memory>
f1ca0880 JG	19	#include <pthread.h>
64803277	20	#include <type_traits>
990570ed DG	21
	22	/*
	23	* Takes a pointer x and transform it so we can use it to access members
	24	* without a function call. Here an example:
	25	*
	26	* #define GET_SIZE(x) LTTNG_REF(x)->size
	27	*
	28	* struct { int size; } s;
	29	*
	30	* printf("size : %d\n", GET_SIZE(&s));
	31	*
	32	* For this example we can't use something like this for compatibility purpose
	33	* since this will fail:
	34	*
	35	* #define GET_SIZE(x) x->size;
	36	*
	37	* This is mostly use for the compatibility layer of lttng-tools. See
	38	* poll/epoll for a good example. Since x can be on the stack or allocated
	39	* memory using malloc(), we must use generic accessors for compat in order to
	40	* not use a function to access members and not the variable name.
	41	*/
5c7248cd	42	#define LTTNG_REF(x) ((typeof((x)) ) (x))
990570ed	43
64803277 SM	44	#ifdef NDEBUG
	45	/*
	46	* Force usage of the assertion condition to prevent unused variable warnings
	47	* when `assert()` are disabled by the `NDEBUG` definition.
	48	*/
	49	# define LTTNG_ASSERT(_cond) ((void) sizeof((void) (_cond), 0))
	50	#else
	51	# include <assert.h>
	52	# define LTTNG_ASSERT(_cond) assert(_cond)
	53	#endif
	54
990570ed DG	55	/*
	56	* Memory allocation zeroed
	57	*/
64803277	58
4616a46c	59	static inline
64803277 SM	60	void *zmalloc_internal(size_t size)
	61	{
	62	return calloc(1, size);
	63	}
	64
31375c42 JG	65	template <typename MallocableType>
31375c42 JG	66	struct can_malloc {
f12e33ba JG	67	/*
	68	* gcc versions before 5.0 lack some type traits defined in C++11.
	69	* Since in this instance we use the trait to prevent misuses
	70	* of malloc (and statically assert) and not to generate different
	71	* code based on this property, simply set value to true and allow
	72	* the code to compile. Anyone using a contemporary compiler will
	73	* catch the error.
	74	*/
	75	#if __GNUG__ && __GNUC__ < 5
	76	static constexpr bool value = true;
	77	#else
31375c42	78	static constexpr bool value = std::is_trivially_constructible<MallocableType>::value;
f12e33ba	79	#endif
64803277 SM	80	};
	81
	82	/*
31375c42	83	* Malloc and zero-initialize an object of type T, asserting that MallocableType can be
64803277 SM	84	* safely malloc-ed (is trivially constructible).
64803277 SM	85	*/
31375c42 JG	86	template <typename MallocableType>
31375c42 JG	87	MallocableType *zmalloc()
64803277	88	{
31375c42 JG	89	static_assert(can_malloc<MallocableType>::value, "type can be malloc'ed");
	90	return (MallocableType ) zmalloc_internal(sizeof(MallocableType)); / NOLINT sizeof
	91	potentially used on a
	92	pointer. */
64803277 SM	93	}
	94
	95	/*
31375c42	96	* Malloc and zero-initialize a buffer of size `size`, asserting that type AllocatedType
64803277 SM	97	* can be safely malloc-ed (is trivially constructible).
64803277 SM	98	*/
31375c42 JG	99	template <typename AllocatedType>
31375c42 JG	100	AllocatedType *zmalloc(size_t size)
64803277	101	{
31375c42 JG	102	static_assert(can_malloc<AllocatedType>::value, "type can be malloc'ed");
	103	LTTNG_ASSERT(size >= sizeof(AllocatedType));
	104	return (AllocatedType *) zmalloc_internal(size);
64803277 SM	105	}
	106
	107	/*
31375c42 JG	108	* Malloc and zero-initialize an array of `nmemb` elements of type AllocatedType,
31375c42 JG	109	* asserting that AllocatedType can be safely malloc-ed (is trivially constructible).
64803277	110	*/
31375c42 JG	111	template <typename AllocatedType>
31375c42 JG	112	AllocatedType *calloc(size_t nmemb)
64803277	113	{
31375c42 JG	114	static_assert(can_malloc<AllocatedType>::value, "type can be malloc'ed");
	115	return (AllocatedType ) zmalloc_internal(nmemb sizeof(AllocatedType)); /* NOLINT sizeof
	116	potentially
	117	used on a
	118	pointer. */
64803277 SM	119	}
	120
	121	/*
31375c42	122	* Malloc an object of type AllocatedType, asserting that AllocatedType can be safely malloc-ed (is
64803277 SM	123	* trivially constructible).
64803277 SM	124	*/
31375c42 JG	125	template <typename AllocatedType>
31375c42 JG	126	AllocatedType *malloc()
4616a46c	127	{
31375c42 JG	128	static_assert(can_malloc<AllocatedType>::value, "type can be malloc'ed");
31375c42 JG	129	return (AllocatedType *) malloc(sizeof(AllocatedType));
4616a46c	130	}
990570ed	131
64803277	132	/*
31375c42	133	* Malloc a buffer of size `size`, asserting that AllocatedType can be safely
64803277 SM	134	* malloc-ed (is trivially constructible).
64803277 SM	135	*/
31375c42 JG	136	template<typename AllocatedType>
31375c42 JG	137	AllocatedType *malloc(size_t size)
64803277	138	{
31375c42 JG	139	static_assert (can_malloc<AllocatedType>::value, "type can be malloc'ed");
31375c42 JG	140	return (AllocatedType *) malloc(size);
64803277 SM	141	}
	142
	143	/*
	144	* Prevent using `free` on types that are non-POD.
	145	*
	146	* Declare a delete prototype of free if the parameter type is not safe to free
	147	* (non-POD).
	148	*
	149	* If the parameter is a pointer to void, we can't check if what is pointed
	150	* to is safe to free or not, as we don't know what is pointed to. Ideally,
	151	* all calls to free would be with a typed pointer, but there are too many
	152	* instances of passing a pointer to void to enforce that right now. So allow
	153	* pointers to void, these will not be checked.
	154	*/
	155
31375c42	156	template<typename FreedType>
a8e336c2	157	struct can_free
64803277	158	{
f12e33ba JG	159	/*
	160	* gcc versions before 5.0 lack some type traits defined in C++11.
	161	* Since in this instance we use the trait to prevent misuses
	162	* of free (and statically assert) and not to generate different
	163	* code based on this property, simply set value to true and allow
	164	* the code to compile. Anyone using a contemporary compiler will
	165	* catch the error.
	166	*/
	167	#if __GNUG__ && __GNUC__ < 5
	168	static constexpr bool value = true;
	169	#else
31375c42 JG	170	static constexpr bool value = std::is_trivially_destructible<FreedType>::value \|\|
31375c42 JG	171	std::is_void<FreedType>::value;
f12e33ba	172	#endif
64803277 SM	173	};
64803277 SM	174
31375c42 JG	175	template <typename FreedType, typename = typename std::enable_if<!can_free<FreedType>::value>::type>
31375c42 JG	176	void free(FreedType *p) = delete;
64803277	177
31375c42 JG	178	template <typename InitializedType>
	179	struct can_memset {
	180	static constexpr bool value = std::is_pod<InitializedType>::value \|\|
	181	std::is_void<InitializedType>::value;
a8e336c2 SM	182	};
a8e336c2 SM	183
31375c42 JG	184	template <typename InitializedType,
	185	typename = typename std::enable_if<!can_memset<InitializedType>::value>::type>
	186	void memset(InitializedType s, int c, size_t n) = delete;
a8e336c2 SM	187
	188	template<typename T>
	189	struct can_memcpy
	190	{
f12e33ba JG	191	/*
	192	* gcc versions before 5.0 lack some type traits defined in C++11.
	193	* Since in this instance we use the trait to prevent misuses
	194	* of memcpy (and statically assert) and not to generate different
	195	* code based on this property, simply set value to true and allow
	196	* the code to compile. Anyone using a contemporary compiler will
	197	* catch the error.
	198	*/
	199	#if __GNUG__ && __GNUC__ < 5
	200	static constexpr bool value = true;
	201	#else
a8e336c2	202	static constexpr bool value = std::is_trivially_copyable<T>::value;
f12e33ba	203	#endif
a8e336c2 SM	204	};
a8e336c2 SM	205
31375c42 JG	206	template <typename DestinationType,
	207	typename SourceType,
	208	typename = typename std::enable_if<!can_memcpy<DestinationType>::value>::type,
	209	typename = typename std::enable_if<!can_memcpy<SourceType>::value>::type>
	210	void memcpy(DestinationType d, const SourceType *s, size_t n) = delete;
a8e336c2	211
31375c42 JG	212	template <typename MovedType>
31375c42 JG	213	struct can_memmove {
f12e33ba JG	214	/*
	215	* gcc versions before 5.0 lack some type traits defined in C++11.
	216	* Since in this instance we use the trait to prevent misuses
	217	* of memmove (and statically assert) and not to generate different
	218	* code based on this property, simply set value to true and allow
	219	* the code to compile. Anyone using a contemporary compiler will
	220	* catch the error.
	221	*/
	222	#if __GNUG__ && __GNUC__ < 5
	223	static constexpr bool value = true;
	224	#else
31375c42	225	static constexpr bool value = std::is_trivially_copyable<MovedType>::value;
f12e33ba	226	#endif
a8e336c2 SM	227	};
a8e336c2 SM	228
31375c42 JG	229	template <typename DestinationType,
	230	typename SourceType,
	231	typename = typename std::enable_if<!can_memmove<DestinationType>::value>::type,
	232	typename = typename std::enable_if<!can_memmove<SourceType>::value>::type>
	233	void memmove(DestinationType d, const SourceType *s, size_t n) = delete;
a8e336c2	234
990570ed DG	235	#ifndef ARRAY_SIZE
	236	#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0])))
	237	#endif
	238
54c90d10 DG	239	#ifndef LTTNG_PACKED
	240	#define LTTNG_PACKED __attribute__((__packed__))
	241	#endif
	242
1405051a FD	243	#ifndef LTTNG_NO_SANITIZE_ADDRESS
	244	#if defined(__clang__) \|\| defined (__GNUC__)
	245	#define LTTNG_NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
	246	#else
	247	#define LTTNG_NO_SANITIZE_ADDRESS
	248	#endif
	249	#endif
	250
f8f3885c MD	251	#define member_sizeof(type, field) sizeof(((type *) 0)->field)
f8f3885c MD	252
5c7248cd	253	#define ASSERT_LOCKED(lock) LTTNG_ASSERT(pthread_mutex_trylock(&(lock)))
48b7cdc2	254	#define ASSERT_RCU_READ_LOCKED(lock) LTTNG_ASSERT(rcu_read_ongoing())
5e5c14ce	255
d22ad5f8 SM	256	/* Attribute suitable to tag functions as having printf()-like arguments. */
	257	#define ATTR_FORMAT_PRINTF(_string_index, _first_to_check) \
	258	__attribute__((format(printf, _string_index, _first_to_check)))
	259
411b3154 SM	260	/* Attribute suitable to tag functions as having strftime()-like arguments. */
	261	#define ATTR_FORMAT_STRFTIME(_string_index) \
	262	__attribute__((format(strftime, _string_index, 0)))
	263
d22ad5f8 SM	264	/* Macros used to ignore specific compiler diagnostics. */
	265
	266	#define DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push")
	267	#define DIAGNOSTIC_POP _Pragma("GCC diagnostic pop")
	268
	269	#if defined(__clang__)
	270	/* Clang */
	271	# define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT
411b3154 SM	272	# define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \
411b3154 SM	273	_Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
942003e5	274	# define DIAGNOSTIC_IGNORE_LOGICAL_OP
05aa7e19	275	# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES
bd2c951e JG	276	# define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF
bd2c951e JG	277	_Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"")
d22ad5f8 SM	278	#else
	279	/* GCC */
	280	# define DIAGNOSTIC_IGNORE_SUGGEST_ATTRIBUTE_FORMAT \
	281	_Pragma("GCC diagnostic ignored \"-Wsuggest-attribute=format\"")
411b3154 SM	282	# define DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL \
411b3154 SM	283	_Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
942003e5 MJ	284	# define DIAGNOSTIC_IGNORE_LOGICAL_OP \
942003e5 MJ	285	_Pragma("GCC diagnostic ignored \"-Wlogical-op\"")
efc2642c JG	286	#if __GNUG__ && __GNUC__ >= 7
efc2642c JG	287	# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES \
05aa7e19	288	_Pragma("GCC diagnostic ignored \"-Wduplicated-branches\"")
efc2642c JG	289	#else
	290	# define DIAGNOSTIC_IGNORE_DUPLICATED_BRANCHES
	291	#endif /* __GNUG__ && __GNUC__ >= 7 */
	292	# define DIAGNOSTIC_IGNORE_INVALID_OFFSETOF \
bd2c951e	293	_Pragma("GCC diagnostic ignored \"-Winvalid-offsetof\"")
d22ad5f8 SM	294	#endif
d22ad5f8 SM	295
d50d200a SM	296	/* Used to make specific C++ functions to C code. */
	297	#ifdef __cplusplus
	298	#define C_LINKAGE extern "C"
	299	#else
	300	#define C_LINKAGE
	301	#endif
	302
f6835b82 MD	303	/*
	304	* lttng_strncpy returns 0 on success, or nonzero on failure.
	305	* It checks that the @src string fits into @dst_len before performing
	306	* the copy. On failure, no copy has been performed.
	307	*
b25a5991 JG	308	* Assumes that 'src' is null-terminated.
b25a5991 JG	309	*
f6835b82 MD	310	* dst_len includes the string's trailing NULL.
	311	*/
	312	static inline
	313	int lttng_strncpy(char dst, const char src, size_t dst_len)
	314	{
b25a5991	315	if (strlen(src) >= dst_len) {
f6835b82 MD	316	/* Fail since copying would result in truncation. */
	317	return -1;
	318	}
c3ef76cd	319	strcpy(dst, src);
f6835b82 MD	320	return 0;
	321	}
	322
0114db0e JG	323	namespace lttng {
0114db0e JG	324	namespace utils {
31375c42 JG	325	template <class ParentType, class MemberType>
31375c42 JG	326	ParentType container_of(const MemberType member, const MemberType ParentType::*ptr_to_member)
0114db0e	327	{
31375c42	328	const ParentType *dummy_parent = nullptr;
0114db0e JG	329	auto offset_of_member = reinterpret_cast<const char >(&(dummy_parent->*ptr_to_member));
	330	auto address_of_parent = reinterpret_cast<const char *>(member) - offset_of_member;
	331
31375c42	332	return reinterpret_cast<ParentType *>(address_of_parent);
0114db0e JG	333	}
	334	} /* namespace utils */
	335	} /* namespace lttng */
	336
990570ed	337	#endif /* _MACROS_H */