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
  21 SG_BEGIN_DECL()
  22
  23 /* They live in asserts.h, but need to be declared before this module.
  24    double declaration to cut dependency cycle */
  25 /**
  26  * @addtogroup XBT_error
  27  *
  28  * @{
  29  */
  30 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  31 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
  32 /** @} */
  33
  34 /* these ones live in str.h, but redeclare them here so that we do
  35    not need to load the whole str.h and its heavy dependencies */
  36 #ifndef __USE_GNU /* do not redeclare existing headers */
  37   XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _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 XBT_INLINE char *xbt_strdup(const char *s) {
  51   char *res = NULL;
  52   if (s) {
  53     res=strdup(s);
  54     if (!res)
  55       xbt_die("memory allocation error (strdup returned NULL)");
  56   }
  57   return res;
  58 }
  59 /** @brief Like malloc, but xbt_die() on error
  60     @hideinitializer */
  61 static XBT_INLINE void *xbt_malloc(unsigned int n){
  62   void *res;
  63 //  if (n==0) xbt_die("malloc(0) is not portable");
  64   res=malloc(n);
  65   if (!res)
  66      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
  67   return res;
  68 }
  69
  70 /** @brief like malloc, but xbt_die() on error and memset data to 0
  71     @hideinitializer */
  72 static XBT_INLINE void *xbt_malloc0(unsigned int n) {
  73   void *res;
  74 //  if (n==0) xbt_die("calloc(0) is not portable");
  75   res=calloc(n,1);
  76   if (!res)
  77      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
  78   return res;
  79 }
  80
  81 /** @brief like realloc, but xbt_die() on error
  82     @hideinitializer */
  83 static XBT_INLINE void *xbt_realloc(void*p,unsigned int s){
  84   void *res=res;
  85 //  if (s==0) xbt_die("realloc(0) is not portable");
  86   if (s) {
  87     if (p) {
  88       res=realloc(p,s);
  89       if (!res)
  90         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
  91     } else {
  92       res=xbt_malloc(s);
  93     }
  94   } else {
  95     if (p) {
  96       free(p);
  97     }
  98   }
  99   return res;
 100 }
 101 #else /* non __GNUC__  */
 102 #  define xbt_strdup(s)    strdup(s)
 103 #  define xbt_malloc(n)    malloc(n)
 104 #  define xbt_malloc0(n)   calloc(n,1)
 105 #  define xbt_realloc(p,s) realloc(p,s)
 106 #endif /* __GNUC__ ? */
 107
 108 /** @brief like free
 109     @hideinitializer */
 110 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
 111 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 112
 113 /** @brief like free, but you can be sure that it is a function  */
 114 XBT_PUBLIC(void) xbt_free_f(void* p);
 115 /** @brief should be given a pointer to pointer, and frees the second one */
 116 XBT_PUBLIC(void) xbt_free_ref(void *d);
 117
 118 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 119     @hideinitializer */
 120 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 121 /** @brief like calloc, but xbt_die() on error
 122     @hideinitializer */
 123 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 124
 125 /** @} */
 126
 127
 128 SG_END_DECL()
 129
 130 #endif /* _XBT_SYSDEP_H */