include/xbt/sysdep.h

   1 /* $Id$ */
   2 /*  xbt/sysdep.h -- all system dependency                                   */
   3 /*  no system header should be loaded out of this file so that we have only */
   4 /*  one file to check when porting to another OS                            */
   5
   6 /* Copyright (c) 2004 Martin Quinson. 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 #include "xbt/str.h"
  21
  22 SG_BEGIN_DECL()
  23
  24 /* They live in asserts.h, but need to be declared before this module.
  25    double declaration to cut dependency cycle */
  26 /**
  27  * @addtogroup XBT_error
  28  *
  29  * @{
  30  */
  31 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  32 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
  33 /** @} */
  34
  35 /** @addtogroup XBT_syscall
  36  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  37  *
  38  *  @{
  39  */
  40
  41 #if defined(__GNUC__) || defined(DOXYGEN)
  42 /** @brief Like strdup, but xbt_die() on error */
  43 static XBT_INLINE char *xbt_strdup(const char *s) {
  44   char *res = NULL;
  45   if (s) {
  46     res=strdup(s);
  47     if (!res)
  48       xbt_die("memory allocation error (strdup returned NULL)");
  49   }
  50   return res;
  51 }
  52 /** @brief Like malloc, but xbt_die() on error
  53     @hideinitializer */
  54 static XBT_INLINE void *xbt_malloc(int n){
  55   void *res=malloc(n);
  56   if (!res)
  57      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
  58   return res;
  59 }
  60
  61 /** @brief like malloc, but xbt_die() on error and memset data to 0
  62     @hideinitializer */
  63 static XBT_INLINE void *xbt_malloc0(int n) {
  64   void *res=calloc(n,1);
  65   if (!res)
  66      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
  67   return res;
  68 }
  69
  70 /** @brief like realloc, but xbt_die() on error
  71     @hideinitializer */
  72 static XBT_INLINE void *xbt_realloc(void*p,int s){
  73   void *res=res;
  74   if (s) {
  75     if (p) {
  76       res=realloc(p,s);
  77       if (!res)
  78         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
  79     } else {
  80       res=xbt_malloc(s);
  81     }
  82   } else {
  83     if (p) {
  84       free(p);
  85     }
  86   }
  87   return res;
  88 }
  89 #else /* non __GNUC__  */
  90 #  define xbt_strdup(s)    strdup(s)
  91 #  define xbt_malloc(n)    malloc(n)
  92 #  define xbt_malloc0(n)   calloc(n,1)
  93 #  define xbt_realloc(p,s) realloc(p,s)
  94 #endif /* __GNUC__ ? */
  95
  96 /** @brief like free
  97     @hideinitializer */
  98 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
  99 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 100
 101 /** @brief like free
 102     @hideinitializer */
 103 XBT_PUBLIC(void) xbt_free_f(void* p);
 104
 105 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 106     @hideinitializer */
 107 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 108 /** @brief like calloc, but xbt_die() on error
 109     @hideinitializer */
 110 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 111
 112 /** @} */
 113
 114
 115 SG_END_DECL()
 116
 117 #endif /* _XBT_SYSDEP_H */