X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c45203b2e06e1be40d5c1c614f928b9d31981c30..7a0c355466d01a81f953e8529a8d76751a2964ac:/include/xbt/sysdep.h diff --git a/include/xbt/sysdep.h b/include/xbt/sysdep.h index 31175d6160..63a4bbce11 100644 --- a/include/xbt/sysdep.h +++ b/include/xbt/sysdep.h @@ -1,84 +1,135 @@ -/* $Id$ */ - /* xbt/sysdep.h -- all system dependency */ /* no system header should be loaded out of this file so that we have only */ /* one file to check when porting to another OS */ -/* Authors: Martin Quinson */ -/* Copyright (C) 2004 the OURAGAN project. */ +/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it - under the terms of the license (GNU LGPL) which comes with this package. */ - - -#ifndef _XBT_SYSDEP_H -#define _XBT_SYSDEP_H - -#include /* Included directly for speed */ - -#include /* FIXME: remove */ -#include /* FIXME: remove */ -#include - -#include "xbt/misc.h" -BEGIN_DECL -#if 0 -#define __CALLOC_OP(n, s) calloc((n), (s)) - #define __REALLOC_OP(n, s) realloc((n), (s)) -#define CALLOC(n, s) ((__CALLOC_OP ((n)?:(FAILURE("attempt to alloc 0 bytes"), 0), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory allocation error"), NULL)) - /* #define REALLOC(p, s) ((__REALLOC_OP ((p), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory reallocation error"), NULL)) */ - #define REALLOC(p, s) (__REALLOC_OP ((p), (s))) + * under the terms of the license (GNU LGPL) which comes with this package. */ + +#ifndef XBT_SYSDEP_H +#define XBT_SYSDEP_H + +#include +#include +#include + +#include + +#include +#include +#include /* va_list */ + +SG_BEGIN_DECL + +/* They live in asserts.h, but need to be declared before this module. + double declaration to cut dependency cycle */ +/** + * @addtogroup XBT_error + * + * @{ + */ +/** @brief Kill the program in silence */ +XBT_ATTRIB_NORETURN XBT_PUBLIC void xbt_abort(void); + +/** + * @brief Kill the program with an error message + * @param ... a format string and its arguments + * + * Things are so messed up that the only thing to do now, is to stop the program. + * + * The message is handled by a CRITICAL logging request, and may consist of a format string with arguments. + */ +#define xbt_die(...) \ + do { \ + XBT_CCRITICAL(root, __VA_ARGS__); \ + xbt_abort(); \ + } while (0) +/** @} */ + +#ifdef XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL +XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)"); +XBT_LOG_NEW_SUBCATEGORY(xbt_help, xbt, "Help messages"); +#else +XBT_LOG_EXTERNAL_CATEGORY(xbt); +XBT_LOG_EXTERNAL_CATEGORY(xbt_help); #endif - -#define xbt_strdup(s) ((s)?(strdup(s)?:(xbt_die("memory allocation error"),NULL))\ - :(NULL)) -#define xbt_malloc(n) (malloc(n) ?: (xbt_die("memory allocation error"),NULL)) -#define xbt_malloc0(n) (calloc( (n),1 ) ?: (xbt_die("memory allocation error"),NULL)) -#define xbt_realloc(p,s) (s? (p? (realloc(p,s)?:xbt_die("memory allocation error"),NULL) \ - : xbt_malloc(s)) \ - : (p? (free(p),NULL) \ - : NULL)) -#define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/ -#define xbt_free_fct free /* replacement with the guareenty of being a function */ - -#define xbt_new(type, count) ((type*)xbt_malloc (sizeof (type) * (count))) -#define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count))) -/* Attributes are only in recent versions of GCC */ - -#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4) -# define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__printf__, format_idx, arg_idx))) -# define _XBT_GNUC_SCANF( format_idx, arg_idx ) \ - __attribute__((__format__ (__scanf__, format_idx, arg_idx))) -# define _XBT_GNUC_FORMAT( arg_idx ) \ - __attribute__((__format_arg__ (arg_idx))) -# define _XBT_GNUC_NORETURN __attribute__((__noreturn__)) - -#else /* !__GNUC__ */ -# define _XBT_GNUC_PRINTF( format_idx, arg_idx ) -# define _XBT_GNUC_SCANF( format_idx, arg_idx ) -# define _XBT_GNUC_FORMAT( arg_idx ) -# define _XBT_GNUC_NORETURN - -#endif /* !__GNUC__ */ - -/* inline and __FUNCTION__ are only in GCC when -ansi is of */ - -#if defined(__GNUC__) && ! defined(__STRICT_ANSI__) - -# define _XBT_GNUC_FUNCTION __FUNCTION__ -# define _XBT_INLINE inline +/** @addtogroup XBT_syscall + * @brief Malloc and associated functions, killing the program on error (with @ref XBT_ex) + * + * @{ + */ + +/** @brief Like strdup, but xbt_die() on error */ +static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) { + char *res = NULL; + if (s) { + res = strdup(s); + if (!res) + xbt_die("memory allocation error (strdup returned NULL)"); + } + return res; +} + +/** @brief Like malloc, but xbt_die() on error + @hideinitializer */ +static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) { + void* res = malloc(n); + if (!res) + xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n); + return res; +} + +/** @brief like malloc, but xbt_die() on error and memset data to 0 + @hideinitializer */ +static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) { + void* res = calloc(n, 1); + if (!res) + xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n); + return res; +} + +/** @brief like realloc, but xbt_die() on error + @hideinitializer */ +static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) { + void *res = NULL; + if (s) { + if (p) { + res = realloc(p, s); + if (!res) + xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s); + } else { + res = xbt_malloc(s); + } + } else { + free(p); + } + return res; +} + +/** @brief like free + @hideinitializer */ +#define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */ + +#ifdef __cplusplus +#define XBT_FREE_NOEXCEPT noexcept(noexcept(::free)) #else -# define _XBT_GNUC_FUNCTION "function" -# define _XBT_INLINE +#define XBT_FREE_NOEXCEPT #endif +/** @brief like free, but you can be sure that it is a function */ +XBT_PUBLIC void xbt_free_f(void* p) XBT_FREE_NOEXCEPT; +/** @brief should be given a pointer to pointer, and frees the second one */ +XBT_PUBLIC void xbt_free_ref(void* d) XBT_FREE_NOEXCEPT; + +SG_END_DECL -void xbt_abort(void) _XBT_GNUC_NORETURN; +#define xbt_new(type, count) ((type*)xbt_malloc (sizeof (type) * (count))) +/** @brief like calloc, but xbt_die() on error + @hideinitializer */ +#define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count))) -END_DECL - -#include "xbt/error.h" /* needed for xbt_die */ +/** @} */ -#endif /* _XBT_SYSDEP_H */ +#endif /* XBT_SYSDEP_H */