X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fmacros.h;h=874501ef1749325b38ba6d4214990da1396cd74a;hp=1771d236c2daa3eeea5a807bef5ddc83cbb6d677;hb=1cbd136b2479ef142bfb339b13d3d25aa772dda5;hpb=54c90d10655e559818665234f29d5d01c8640ee7 diff --git a/src/common/macros.h b/src/common/macros.h index 1771d236c..874501ef1 100644 --- a/src/common/macros.h +++ b/src/common/macros.h @@ -1,25 +1,18 @@ /* - * Copyright (C) 2011 - David Goulet - * Mathieu Desnoyers + * Copyright (C) 2011 David Goulet + * Copyright (C) 2011 Mathieu Desnoyers * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License, version 2 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: GPL-2.0-only * - * This program 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 General Public License for - * more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef _MACROS_H #define _MACROS_H #include +#include +#include +#include /* * Takes a pointer x and transform it so we can use it to access members @@ -46,22 +39,102 @@ /* * Memory allocation zeroed */ -#define zmalloc(x) calloc(1, x) +static inline +void *zmalloc(size_t len) +{ + return calloc(1, len); +} #ifndef ARRAY_SIZE #define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0]))) #endif -#ifndef max -#define max(a, b) ((a) > (b) ? (a) : (b)) +#ifndef container_of +#define container_of(ptr, type, member) \ + ({ \ + const typeof(((type *)NULL)->member) * __ptr = (ptr); \ + (type *)((char *)__ptr - offsetof(type, member)); \ + }) #endif -#ifndef min -#define min(a, b) ((a) < (b) ? (a) : (b)) + +/* + * The min and max macros are not needed in C++ (std::min and std::max are + * preferred) and they conflict with some C++ header file. Don't define them + * when compiling C++ source. + */ +#ifndef __cplusplus + +# ifndef max +# define max(a, b) ((a) > (b) ? (a) : (b)) +# endif + +# ifndef min +# define min(a, b) ((a) < (b) ? (a) : (b)) +# endif + +# ifndef max_t +# define max_t(type, a, b) max((type) a, (type) b) +# endif + +# ifndef min_t +# define min_t(type, a, b) min((type) a, (type) b) +# endif + #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 is_signed(type) (((type) -1) < (type) 1) + +#define member_sizeof(type, field) sizeof(((type *) 0)->field) + +#define ASSERT_LOCKED(lock) LTTNG_ASSERT(pthread_mutex_trylock(&lock)) + +/* + * Get an aligned pointer to a value. This is meant + * as a helper to pass an aligned pointer to a member in a packed structure + * to a function. + */ +#define ALIGNED_CONST_PTR(value) (((const typeof(value) []) { value })) + +/* + * 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. + * + * dst_len includes the string's trailing NULL. + */ +static inline +int lttng_strncpy(char *dst, const char *src, size_t dst_len) +{ + if (lttng_strnlen(src, dst_len) >= dst_len) { + /* Fail since copying would result in truncation. */ + return -1; + } + strcpy(dst, src); + return 0; +} + +#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 +# define LTTNG_ASSERT(_cond) assert(_cond) +#endif + #endif /* _MACROS_H */