include/xbt/sysdep.h

   1 /*  xbt/sysdep.h -- all system dependency                                   */
   2 /*  no system header should be loaded out of this file so that we have only */
   3 /*  one file to check when porting to another OS                            */
   4
   5 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   6  * All rights reserved.                                                     */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef _XBT_SYSDEP_H
  12 #define _XBT_SYSDEP_H
  13
  14 #include "xbt/log.h"
  15 #include "xbt/misc.h"
  16 #include "xbt/asserts.h"
  17
  18 #include "simgrid_config.h"
  19
  20 #include <string.h>
  21 #include <stdlib.h>
  22 #include <stdarg.h>             /* va_list */
  23
  24 SG_BEGIN_DECL()
  25
  26 /* They live in asserts.h, but need to be declared before this module.
  27    double declaration to cut dependency cycle */
  28 /**
  29  * @addtogroup XBT_error
  30  *
  31  * @{
  32  */
  33 /** @brief Kill the program in silence */
  34 #ifdef COVERAGE
  35 /* Call __gcov_flush on abort when compiling with coverage options. */
  36 #define xbt_abort()                             \
  37   do {                                          \
  38     extern void __gcov_flush(void);             \
  39     __gcov_flush();                             \
  40     abort();                                    \
  41   } while (0)
  42 #else
  43 #define xbt_abort() abort()
  44 #endif
  45
  46 /**
  47  * @brief Kill the program with an error message
  48  * \param ... a format string and its arguments
  49  *
  50  * Things are so messed up that the only thing to do now, is to stop the
  51  * program.
  52  *
  53  * The message is handled by a CRITICAL logging request, and may consist of a
  54  * format string with arguments.
  55  */
  56 #define xbt_die(...)                            \
  57   do {                                          \
  58     XBT_LOG_EXTERNAL_CATEGORY(xbt);             \
  59     XBT_CCRITICAL(xbt, __VA_ARGS__);            \
  60     xbt_abort();                                \
  61   } while (0)
  62 /** @} */
  63
  64 /* these ones live in str.h, but redeclare them here so that we do
  65    not need to load the whole str.h and its heavy dependencies */
  66 #ifndef __USE_GNU               /* do not redeclare existing headers */
  67 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  68                          ...) _XBT_GNUC_PRINTF(2, 3);
  69 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  70 #endif
  71 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  72
  73 /** @addtogroup XBT_syscall
  74  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  75  *
  76  *  @{
  77  */
  78
  79 #if defined(__GNUC__) || defined(DOXYGEN)
  80 /** @brief Like strdup, but xbt_die() on error */
  81 static inline __attribute__ ((always_inline))
  82 char *xbt_strdup(const char *s)
  83 {
  84   char *res = NULL;
  85   if (s) {
  86     res = strdup(s);
  87     if (!res)
  88       xbt_die("memory allocation error (strdup returned NULL)");
  89   }
  90   return res;
  91 }
  92
  93 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  94
  95 /** @brief Like malloc, but xbt_die() on error
  96     @hideinitializer */
  97 static inline __attribute__ ((always_inline))
  98 void *xbt_malloc(size_t n)
  99 {
 100   void *res;
 101 /*  if (n==0) {
 102      xbt_backtrace_display_current();
 103      xbt_die("malloc(0) is not portable");
 104   }*/
 105
 106   res = malloc(n);
 107   if (!res)
 108     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
 109   return res;
 110 }
 111
 112 /** @brief like malloc, but xbt_die() on error and memset data to 0
 113     @hideinitializer */
 114 static inline __attribute__ ((always_inline))
 115 void *xbt_malloc0(size_t n)
 116 {
 117   void *res;
 118   //if (n==0) xbt_die("calloc(0) is not portable");
 119   res = calloc(n, 1);
 120   if (!res)
 121     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
 122   return res;
 123 }
 124
 125 /** @brief like realloc, but xbt_die() on error
 126     @hideinitializer */
 127 static inline __attribute__ ((always_inline))
 128 void *xbt_realloc(void *p, size_t s)
 129 {
 130   void *res = NULL;
 131   //if (s==0) xbt_die("realloc(0) is not portable");
 132   if (s) {
 133     if (p) {
 134       res = realloc(p, s);
 135       if (!res)
 136         xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
 137     } else {
 138       res = xbt_malloc(s);
 139     }
 140   } else {
 141     free(p);
 142   }
 143   return res;
 144 }
 145 #else                           /* non __GNUC__  */
 146 #  define xbt_strdup(s)    strdup(s)
 147 #  define xbt_malloc(n)    malloc(n)
 148 #  define xbt_malloc0(n)   calloc(n,1)
 149 #  define xbt_realloc(p,s) realloc(p,s)
 150 #endif                          /* __GNUC__ ? */
 151
 152 /** @brief like free
 153     @hideinitializer */
 154 #define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
 155
 156 /** @brief like free, but you can be sure that it is a function  */
 157 XBT_PUBLIC(void) xbt_free_f(void *p);
 158 /** @brief should be given a pointer to pointer, and frees the second one */
 159 XBT_PUBLIC(void) xbt_free_ref(void *d);
 160
 161 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 162     @hideinitializer */
 163 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 164 /** @brief like calloc, but xbt_die() on error
 165     @hideinitializer */
 166 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 167
 168 /** @} */
 169
 170
 171 SG_END_DECL()
 172 #endif                          /* _XBT_SYSDEP_H */