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-2015. 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 SG_BEGIN_DECL()
  21
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>             /* va_list */
  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_ATTRIB_NORETURN xbt_abort(void);
  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 #ifdef XBT_LOG_LOCALLY_DEFINE_XBT_CHANNEL
  54 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
  55 #else
  56 XBT_LOG_EXTERNAL_CATEGORY(xbt);
  57 #endif
  58
  59 /* these ones live in str.h, but redeclare them here so that we do
  60    not need to load the whole str.h and its heavy dependencies */
  61 #ifndef __USE_GNU               /* do not redeclare existing headers */
  62 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  63                          ...) XBT_ATTRIB_PRINTF(2, 3);
  64 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  65 #endif
  66 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) XBT_ATTRIB_PRINTF(1, 2);
  67
  68 /** @addtogroup XBT_syscall
  69  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  70  *
  71  *  @{
  72  */
  73
  74 #if defined(_MSC_VER) && !defined(strdup)
  75 #  define strdup _strdup /* POSIX name is not ANSI complient blabla */
  76 #endif
  77
  78 /** @brief Like strdup, but xbt_die() on error */
  79 static XBT_ALWAYS_INLINE char *xbt_strdup(const char *s) {
  80   char *res = NULL;
  81   if (s) {
  82     res = strdup(s);
  83     if (!res)
  84       xbt_die("memory allocation error (strdup returned NULL)");
  85   }
  86   return res;
  87 }
  88
  89 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  90
  91 /** @brief Like malloc, but xbt_die() on error
  92     @hideinitializer */
  93 static XBT_ALWAYS_INLINE void *xbt_malloc(size_t n) {
  94   void *res;
  95 /*  if (n==0) {
  96      xbt_backtrace_display_current();
  97      xbt_die("malloc(0) is not portable");
  98   }*/
  99
 100   res = malloc(n);
 101   if (!res)
 102     xbt_die("Memory allocation of %lu bytes failed", (unsigned long)n);
 103   return res;
 104 }
 105
 106 /** @brief like malloc, but xbt_die() on error and memset data to 0
 107     @hideinitializer */
 108 static XBT_ALWAYS_INLINE void *xbt_malloc0(size_t n) {
 109   void *res;
 110   //if (n==0) xbt_die("calloc(0) is not portable");
 111   res = calloc(n, 1);
 112   if (!res)
 113     xbt_die("Memory callocation of %lu bytes failed", (unsigned long)n);
 114   return res;
 115 }
 116
 117 /** @brief like realloc, but xbt_die() on error
 118     @hideinitializer */
 119 static XBT_ALWAYS_INLINE void *xbt_realloc(void *p, size_t s) {
 120   void *res = NULL;
 121   //if (s==0) xbt_die("realloc(0) is not portable");
 122   if (s) {
 123     if (p) {
 124       res = realloc(p, s);
 125       if (!res)
 126         xbt_die("memory (re)allocation of %lu bytes failed", (unsigned long)s);
 127     } else {
 128       res = xbt_malloc(s);
 129     }
 130   } else {
 131     free(p);
 132   }
 133   return res;
 134 }
 135
 136 /** @brief like free
 137     @hideinitializer */
 138 #define xbt_free(p) free(p) /*nothing specific to do here. A poor valgrind replacement? */
 139
 140 /** @brief like free, but you can be sure that it is a function  */
 141 XBT_PUBLIC(void) xbt_free_f(void *p);
 142 /** @brief should be given a pointer to pointer, and frees the second one */
 143 XBT_PUBLIC(void) xbt_free_ref(void *d);
 144
 145 SG_END_DECL()
 146
 147 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 148 /** @brief like calloc, but xbt_die() on error
 149     @hideinitializer */
 150 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 151
 152 /** @} */
 153
 154 #endif                          /* _XBT_SYSDEP_H */