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 <string.h>
  15 #include <stdlib.h>
  16 #include <stdarg.h>             /* va_list */
  17
  18 #include "xbt/misc.h"
  19 #include "xbt/asserts.h"
  20
  21 #include "simgrid_config.h"
  22
  23 SG_BEGIN_DECL()
  24
  25 /* They live in asserts.h, but need to be declared before this module.
  26    double declaration to cut dependency cycle */
  27 /**
  28  * @addtogroup XBT_error
  29  *
  30  * @{
  31  */
  32 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  33 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
  34 /** @} */
  35
  36 /* these ones live in str.h, but redeclare them here so that we do
  37    not need to load the whole str.h and its heavy dependencies */
  38 #ifndef __USE_GNU               /* do not redeclare existing headers */
  39 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  40                          ...) _XBT_GNUC_PRINTF(2, 3);
  41 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  42 #endif
  43 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  44
  45 /** @addtogroup XBT_syscall
  46  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  47  *
  48  *  @{
  49  */
  50
  51 #if defined(__GNUC__) || defined(DOXYGEN)
  52 /** @brief Like strdup, but xbt_die() on error */
  53 static inline __attribute__ ((always_inline))
  54 char *xbt_strdup(const char *s)
  55 {
  56   char *res = NULL;
  57   if (s) {
  58     res = strdup(s);
  59     if (!res)
  60       xbt_die("memory allocation error (strdup returned NULL)");
  61   }
  62   return res;
  63 }
  64
  65 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  66
  67 /** @brief Like malloc, but xbt_die() on error
  68     @hideinitializer */
  69 static inline __attribute__ ((always_inline))
  70 void *xbt_malloc(size_t n)
  71 {
  72   void *res;
  73 /*  if (n==0) {
  74      xbt_backtrace_display_current();
  75      xbt_die("malloc(0) is not portable");
  76   }*/
  77
  78   res = malloc(n);
  79   if (!res)
  80     xbt_die(bprintf("Memory allocation of %lu bytes failed",
  81                     (unsigned long)n));
  82   return res;
  83 }
  84
  85 /** @brief like malloc, but xbt_die() on error and memset data to 0
  86     @hideinitializer */
  87 static inline __attribute__ ((always_inline))
  88 void *xbt_malloc0(size_t n)
  89 {
  90   void *res;
  91   //if (n==0) xbt_die("calloc(0) is not portable");
  92   res = calloc(n, 1);
  93   if (!res)
  94     xbt_die(bprintf("Memory callocation of %lu bytes failed",
  95                     (unsigned long)n));
  96   return res;
  97 }
  98
  99 /** @brief like realloc, but xbt_die() on error
 100     @hideinitializer */
 101 static inline __attribute__ ((always_inline))
 102 void *xbt_realloc(void *p, size_t s)
 103 {
 104   void *res = res;
 105   //if (s==0) xbt_die("realloc(0) is not portable");
 106   if (s) {
 107     if (p) {
 108       res = realloc(p, s);
 109       if (!res)
 110         xbt_die(bprintf("memory (re)allocation of %lu bytes failed",
 111                         (unsigned long)s));
 112     } else {
 113       res = xbt_malloc(s);
 114     }
 115   } else {
 116     if (p) {
 117       free(p);
 118     }
 119   }
 120   return res;
 121 }
 122 #else                           /* non __GNUC__  */
 123 #  define xbt_strdup(s)    strdup(s)
 124 #  define xbt_malloc(n)    malloc(n)
 125 #  define xbt_malloc0(n)   calloc(n,1)
 126 #  define xbt_realloc(p,s) realloc(p,s)
 127 #endif                          /* __GNUC__ ? */
 128
 129 /** @brief like free
 130     @hideinitializer */
 131 #define xbt_free free           /*nothing specific to do here. A poor valgrind replacement? */
 132 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 133
 134 /** @brief like free, but you can be sure that it is a function  */
 135 XBT_PUBLIC(void) xbt_free_f(void *p);
 136 /** @brief should be given a pointer to pointer, and frees the second one */
 137 XBT_PUBLIC(void) xbt_free_ref(void *d);
 138
 139 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 140     @hideinitializer */
 141 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 142 /** @brief like calloc, but xbt_die() on error
 143     @hideinitializer */
 144 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 145
 146 /** @} */
 147
 148
 149 SG_END_DECL()
 150 #endif                          /* _XBT_SYSDEP_H */