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