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 <stdio.h>
  17 #include <stdarg.h> /* va_list */
  18
  19 #include "xbt/misc.h"
  20 #include "xbt/asserts.h"
  21
  22 SG_BEGIN_DECL()
  23
  24 /* FIXME: better place? */
  25 int   asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
  26 int   vasprintf (char **ptr, const char *fmt, va_list ap);
  27 XBT_PUBLIC char *bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
  28
  29 /* They live in asserts.h, but need to be declared before this module.
  30    double declaration to cut dependency cycle */
  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 /** @addtogroup XBT_syscall
  37  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  38  *
  39  *  @{
  40  */
  41
  42 #if defined(__GNUC__) || defined(DOXYGEN)
  43 /** @brief Like strdup, but xbt_die() on error */
  44 static XBT_INLINE char *xbt_strdup(const char *s) {
  45   char *res = NULL;
  46   if (s) {
  47     res=strdup(s);
  48     if (!res)
  49       xbt_die("memory allocation error (strdup returned NULL)");
  50   }
  51   return res;
  52 }
  53 /** @brief Like malloc, but xbt_die() on error
  54     @hideinitializer */
  55 static XBT_INLINE void *xbt_malloc(int n){
  56   void *res=malloc(n);
  57   if (!res)
  58      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
  59   return res;
  60 }
  61
  62 /** @brief like malloc, but xbt_die() on error and memset data to 0
  63     @hideinitializer */
  64 static XBT_INLINE void *xbt_malloc0(int n) {
  65   void *res=calloc(n,1);
  66   if (!res)
  67      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
  68   return res;
  69 }
  70
  71 /** @brief like realloc, but xbt_die() on error
  72     @hideinitializer */
  73 static XBT_INLINE void *xbt_realloc(void*p,int s){
  74   void *res=res;
  75   if (s) {
  76     if (p) {
  77       res=realloc(p,s);
  78       if (!res)
  79         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
  80     } else {
  81       res=xbt_malloc(s);
  82     }
  83   } else {
  84     if (p) {
  85       free(p);
  86     }
  87   }
  88   return res;
  89 }
  90 #else /* non __GNUC__  */
  91 #  define xbt_strdup(s)    strdup(s)
  92 #  define xbt_malloc(n)    malloc(n)
  93 #  define xbt_malloc0(n)   calloc(n,1)
  94 #  define xbt_realloc(p,s) realloc(p,s)
  95 #endif /* __GNUC__ ? */
  96
  97 /** @brief like free
  98     @hideinitializer */
  99 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
 100 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 101
 102 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 103     @hideinitializer */
 104 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 105 /** @brief like calloc, but xbt_die() on error
 106     @hideinitializer */
 107 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 108
 109 /** @} */
 110
 111
 112 SG_END_DECL()
 113
 114 #endif /* _XBT_SYSDEP_H */