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-2014. 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 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  35
  36 /**
  37  * @brief Kill the program with an error message
  38  * \param ... a format string and its arguments
  39  *
  40  * Things are so messed up that the only thing to do now, is to stop the
  41  * program.
  42  *
  43  * The message is handled by a CRITICAL logging request, and may consist of a
  44  * format string with arguments.
  45  */
  46 #define xbt_die(...)                            \
  47   do {                                          \
  48     XBT_CCRITICAL(xbt, __VA_ARGS__);            \
  49     xbt_abort();                                \
  50   } while (0)
  51 /** @} */
  52
  53 XBT_LOG_EXTERNAL_CATEGORY(xbt);
  54
  55 /* these ones live in str.h, but redeclare them here so that we do
  56    not need to load the whole str.h and its heavy dependencies */
  57 #ifndef __USE_GNU               /* do not redeclare existing headers */
  58 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  59                          ...) _XBT_GNUC_PRINTF(2, 3);
  60 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  61 #endif
  62 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  63
  64 /** @addtogroup XBT_syscall
  65  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  66  *
  67  *  @{
  68  */
  69
  70 #if defined(__GNUC__) || defined(DOXYGEN)
  71 /** @brief Like strdup, but xbt_die() on error */
  72 static inline __attribute__ ((always_inline))
  73 char *xbt_strdup(const char *s)
  74 {
  75   char *res = NULL;
  76   if (s) {
  77     res = strdup(s);
  78     if (!res)
  79       xbt_die("memory allocation error (strdup returned NULL)");
  80   }
  81   return res;
  82 }
  83
  84 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  85
  86 /** @brief Like malloc, but xbt_die() on error
  87     @hideinitializer */
  88 static inline __attribute__ ((always_inline))
  89 void *xbt_malloc(size_t n)
  90 {
  91   void *res;
  92 /*  if (n==0) {
  93      xbt_backtrace_display_current();
  94      xbt_die("malloc(0) is not portable");
  95   }*/
  96
  97   res = malloc(n);
  98   if (!res)
  99     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
 100   return res;
 101 }
 102
 103 /** @brief like malloc, but xbt_die() on error and memset data to 0
 104     @hideinitializer */
 105 static inline __attribute__ ((always_inline))
 106 void *xbt_malloc0(size_t n)
 107 {
 108   void *res;
 109   //if (n==0) xbt_die("calloc(0) is not portable");
 110   res = calloc(n, 1);
 111   if (!res)
 112     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
 113   return res;
 114 }
 115
 116 /** @brief like realloc, but xbt_die() on error
 117     @hideinitializer */
 118 static inline __attribute__ ((always_inline))
 119 void *xbt_realloc(void *p, size_t s)
 120 {
 121   void *res = NULL;
 122   //if (s==0) xbt_die("realloc(0) is not portable");
 123   if (s) {
 124     if (p) {
 125       res = realloc(p, s);
 126       if (!res)
 127         xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
 128     } else {
 129       res = xbt_malloc(s);
 130     }
 131   } else {
 132     free(p);
 133   }
 134   return res;
 135 }
 136 #else                           /* non __GNUC__  */
 137 #  define xbt_strdup(s)    strdup(s)
 138 #  define xbt_malloc(n)    malloc(n)
 139 #  define xbt_malloc0(n)   calloc(n,1)
 140 #  define xbt_realloc(p,s) realloc(p,s)
 141 #endif                          /* __GNUC__ ? */
 142
 143 /** @brief like free
 144     @hideinitializer */
 145 #define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
 146
 147 /** @brief like free, but you can be sure that it is a function  */
 148 XBT_PUBLIC(void) xbt_free_f(void *p);
 149 /** @brief should be given a pointer to pointer, and frees the second one */
 150 XBT_PUBLIC(void) xbt_free_ref(void *d);
 151
 152 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 153     @hideinitializer */
 154 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 155 /** @brief like calloc, but xbt_die() on error
 156     @hideinitializer */
 157 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 158
 159 /** @} */
 160
 161
 162 SG_END_DECL()
 163 #endif                          /* _XBT_SYSDEP_H */