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  *  @{
  34  */
  35
  36 #if defined(__GNUC__) || defined(DOXYGEN)
  37 /** @brief Like strdup, but xbt_die() on error */
  38 static XBT_INLINE char *xbt_strdup(const char *s) {
  39   char *res = NULL;
  40   if (s) {
  41     res=strdup(s);
  42     if (!res)
  43       xbt_die("memory allocation error");
  44   }
  45   return res;
  46 }
  47 /** @brief Like malloc, but xbt_die() on error
  48     @hideinitializer */
  49 static XBT_INLINE void *xbt_malloc(int n){
  50   void *res=malloc(n);
  51   if (!res)
  52      xbt_die("Memory allocation failed");
  53   return res;
  54 }
  55
  56 /** @brief like malloc, but xbt_die() on error and memset data to 0
  57     @hideinitializer */
  58 static XBT_INLINE void *xbt_malloc0(int n) {
  59   void *res=calloc(n,1);
  60   if (!res)
  61      xbt_die("Memory callocation failed");
  62   return res;
  63 }
  64
  65 /** @brief like realloc, but xbt_die() on error
  66     @hideinitializer */
  67 static XBT_INLINE void *xbt_realloc(void*p,int s){
  68   void *res=res;
  69   if (s) {
  70     if (p) {
  71       res=realloc(p,s);
  72       if (!res)
  73         xbt_die("memory allocation error");
  74     } else {
  75       res=xbt_malloc(s);
  76     }
  77   } else {
  78     if (p) {
  79       free(p);
  80     }
  81   }
  82   return res;
  83 }
  84 #else /* non __GNUC__  */
  85 #  define xbt_strdup(s)    strdup(s)
  86 #  define xbt_malloc(n)    malloc(n)
  87 #  define xbt_malloc0(n)   calloc(n,1)
  88 #  define xbt_realloc(p,s) realloc(p,s)
  89 #endif /* __GNUC__ ? */
  90
  91 /** @brief like free
  92     @hideinitializer */
  93 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
  94 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
  95
  96 /** @brief like calloc, but xbt_die() on error and don't memset to 0
  97     @hideinitializer */
  98 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
  99 /** @brief like calloc, but xbt_die() on error
 100     @hideinitializer */
 101 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 102
 103 /** @} */
 104
 105 /* FIXME: better place? */
 106 int   asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
 107 int   vasprintf (char **ptr, const char *fmt, va_list ap);
 108 char *bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
 109
 110 SG_END_DECL()
 111
 112 #endif /* _XBT_SYSDEP_H */