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