X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3d0d626e19a7b79320e7d922c9c1dcf122076cea..43cfff77113704360f4d55b40e890c65a09d8059:/include/xbt/sysdep.h diff --git a/include/xbt/sysdep.h b/include/xbt/sysdep.h index 852c4665f7..9ed7c53e13 100644 --- a/include/xbt/sysdep.h +++ b/include/xbt/sysdep.h @@ -1,80 +1,196 @@ -/* $Id$ */ - -/* gras/sysdep.h -- all system dependency */ +/* 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-2015. 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. */ - + * under the terms of the license (GNU LGPL) which comes with this package. */ -#ifndef _GRAS_SYSDEP_H -#define _GRAS_SYSDEP_H +#ifndef _XBT_SYSDEP_H +#define _XBT_SYSDEP_H -#include /* Included directly for speed */ - -#include /* FIXME: remove */ -#include /* FIXME: remove */ +#ifdef __cplusplus +#include +#endif -#ifdef __cplusplus -extern "C" +#include "xbt/log.h" +#include "xbt/misc.h" +#include "xbt/asserts.h" + +#include "simgrid_config.h" + +SG_BEGIN_DECL() + +#include +#include +#include /* va_list */ + +/* 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_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN; + +/** + * @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(xbt, __VA_ARGS__); \ + xbt_abort(); \ + } while (0) +/** @} */ + +XBT_LOG_EXTERNAL_CATEGORY(xbt); + +/* these ones live in str.h, but redeclare them here so that we do + not need to load the whole str.h and its heavy dependencies */ +#ifndef __USE_GNU /* do not redeclare existing headers */ +XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt, /*args */ + ...) _XBT_GNUC_PRINTF(2, 3); +XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap); #endif +XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2); + +/** @addtogroup XBT_syscall + * @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex) + * + * @{ + */ + +#if defined(__GNUC__) || defined(DOXYGEN) +/** @brief Like strdup, but xbt_die() on error */ +static inline __attribute__ ((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; +} -char* gras_strdup (const char *str); -void* gras_malloc (long int bytes); -void* gras_malloc0 (long int bytes); -void* gras_realloc (void *memory, long int bytes); -void gras_free (void *memory); +XBT_PUBLIC(void) xbt_backtrace_display_current(void); + +/** @brief Like malloc, but xbt_die() on error + @hideinitializer */ +static inline __attribute__ ((always_inline)) +void *xbt_malloc(size_t n) +{ + void *res; +/* if (n==0) { + xbt_backtrace_display_current(); + xbt_die("malloc(0) is not portable"); + }*/ + + res = malloc(n); + if (!res) + xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n); + return res; +} -#define gras_new(type, count) ((type*)gras_malloc (sizeof (type) * (count))) -#define gras_new0(type, count) ((type*)gras_malloc0 (sizeof (type) * (count))) +/** @brief like malloc, but xbt_die() on error and memset data to 0 + @hideinitializer */ +static inline __attribute__ ((always_inline)) +void *xbt_malloc0(size_t n) +{ + void *res; + //if (n==0) xbt_die("calloc(0) is not portable"); + res = calloc(n, 1); + if (!res) + xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n); + return res; +} -/* Attributes are only in recent versions of GCC */ +/** @brief like realloc, but xbt_die() on error + @hideinitializer */ +static inline __attribute__ ((always_inline)) +void *xbt_realloc(void *p, size_t s) +{ + void *res = NULL; + //if (s==0) xbt_die("realloc(0) is not portable"); + 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; +} +#else /* non __GNUC__ */ +# define xbt_strdup(s) strdup(s) +# define xbt_malloc(n) malloc(n) +# define xbt_malloc0(n) calloc(n,1) +# define xbt_realloc(p,s) realloc(p,s) +#endif /* __GNUC__ ? */ -#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4) -# define _GRAS_GNUC_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__printf__, format_idx, arg_idx))) -# define _GRAS_GNUC_SCANF( format_idx, arg_idx ) \ - __attribute__((__format__ (__scanf__, format_idx, arg_idx))) -# define _GRAS_GNUC_FORMAT( arg_idx ) \ - __attribute__((__format_arg__ (arg_idx))) -# define _GRAS_GNUC_NORETURN __attribute__((__noreturn__)) +/** @brief like free + @hideinitializer */ +#define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */ -#else /* !__GNUC__ */ -# define _GRAS_GNUC_PRINTF( format_idx, arg_idx ) -# define _GRAS_GNUC_SCANF( format_idx, arg_idx ) -# define _GRAS_GNUC_FORMAT( arg_idx ) -# define _GRAS_GNUC_NORETURN +/** @brief like free, but you can be sure that it is a function */ +XBT_PUBLIC(void) xbt_free_f(void *p); +/** @brief should be given a pointer to pointer, and frees the second one */ +XBT_PUBLIC(void) xbt_free_ref(void *d); -#endif /* !__GNUC__ */ +SG_END_DECL() -/* inline and __FUNCTION__ are only in GCC when -ansi is of */ +/** @brief like calloc, but xbt_die() on error and don't memset to 0 + @hideinitializer */ +#ifndef __cplusplus -#if defined(__GNUC__) && ! defined(__STRICT_ANSI__) +#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))) -# define _GRAS_GNUC_FUNCTION __FUNCTION__ -# define _GRAS_INLINE inline #else -# define _GRAS_GNUC_FUNCTION "function" -# define _GRAS_INLINE -#endif +/** C++ wrapper for xtb_new + * + * This ensures that we do not xbt_new things that need a constructor. + */ +template inline +T* xbt_new_(size_t count) +{ + static_assert(std::is_trivial(), + "Cannot xbt_new this type"); + return (T*) xbt_malloc(sizeof(T) * count); +} -void gras_abort(void) _GRAS_GNUC_NORETURN; - -/* FIXME: This is a very good candidate to rewrite (along with a proper string stuff) - but I'm too lazy right now, so copy the definition */ -long int strtol(const char *nptr, char **endptr, int base); -double strtod(const char *nptr, char **endptr); -int atoi(const char *nptr); +template inline +T* xbt_new0_(size_t count) +{ + static_assert(std::is_trivial(), + "Cannot xbt_new0 this type"); + return (T*) xbt_malloc0(sizeof(T) * count); +} +#define xbt_new(type, count) ::xbt_new_(count) +#define xbt_new0(type, count) ::xbt_new0_(count) - -#ifdef __cplusplus -} #endif -#endif /* _GRAS_SYSDEP_H */ +/** @} */ + +#endif /* _XBT_SYSDEP_H */