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 extern int   asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
  26 extern 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
  30 #if ((defined (_MSC_VER) || defined(__BORLANDC__)) && !defined(SSIZE_T_DEFINED))
  31 typedef int ssize_t;
  32 #define SSIZE_T_DEFINED
  33 #endif
  34
  35 /* FIXME: ssize_t must be 'long' on windows, no idea whether we should define this explicitly */
  36 XBT_PUBLIC(ssize_t) getline(char **lineptr, size_t *n, FILE *stream);
  37
  38
  39 /* They live in asserts.h, but need to be declared before this module.
  40    double declaration to cut dependency cycle */
  41 /**
  42  * @addtogroup XBT_error
  43  *
  44  * @{
  45  */
  46 XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
  47 XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
  48 /** @} */
  49
  50 /** @addtogroup XBT_syscall
  51  *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
  52  *
  53  *  @{
  54  */
  55
  56 #if defined(__GNUC__) || defined(DOXYGEN)
  57 /** @brief Like strdup, but xbt_die() on error */
  58 static XBT_INLINE char *xbt_strdup(const char *s) {
  59   char *res = NULL;
  60   if (s) {
  61     res=strdup(s);
  62     if (!res)
  63       xbt_die("memory allocation error (strdup returned NULL)");
  64   }
  65   return res;
  66 }
  67 /** @brief Like malloc, but xbt_die() on error
  68     @hideinitializer */
  69 static XBT_INLINE void *xbt_malloc(int n){
  70   void *res=malloc(n);
  71   if (!res)
  72      xbt_die(bprintf("Memory allocation of %d bytes failed",n));
  73   return res;
  74 }
  75
  76 /** @brief like malloc, but xbt_die() on error and memset data to 0
  77     @hideinitializer */
  78 static XBT_INLINE void *xbt_malloc0(int n) {
  79   void *res=calloc(n,1);
  80   if (!res)
  81      xbt_die(bprintf("Memory callocation of %d bytes failed",n));
  82   return res;
  83 }
  84
  85 /** @brief like realloc, but xbt_die() on error
  86     @hideinitializer */
  87 static XBT_INLINE void *xbt_realloc(void*p,int s){
  88   void *res=res;
  89   if (s) {
  90     if (p) {
  91       res=realloc(p,s);
  92       if (!res)
  93         xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
  94     } else {
  95       res=xbt_malloc(s);
  96     }
  97   } else {
  98     if (p) {
  99       free(p);
 100     }
 101   }
 102   return res;
 103 }
 104 #else /* non __GNUC__  */
 105 #  define xbt_strdup(s)    strdup(s)
 106 #  define xbt_malloc(n)    malloc(n)
 107 #  define xbt_malloc0(n)   calloc(n,1)
 108 #  define xbt_realloc(p,s) realloc(p,s)
 109 #endif /* __GNUC__ ? */
 110
 111 /** @brief like free
 112     @hideinitializer */
 113 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
 114 /*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 115
 116 /** @brief like free
 117     @hideinitializer */
 118 XBT_PUBLIC(void) xbt_free_f(void* p);
 119
 120 /** @brief like calloc, but xbt_die() on error and don't memset to 0
 121     @hideinitializer */
 122 #define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
 123 /** @brief like calloc, but xbt_die() on error
 124     @hideinitializer */
 125 #define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 126
 127 /** @} */
 128
 129
 130 SG_END_DECL()
 131
 132 #endif /* _XBT_SYSDEP_H */