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