Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Oups, commited a stupid check which will help me one day for the portability to AIX...
[simgrid.git] / include / xbt / sysdep.h
index b94cfb9..2a0c78b 100644 (file)
@@ -1,5 +1,4 @@
 /* $Id$ */
-
 /*  xbt/sysdep.h -- all system dependency                                   */
 /*  no system header should be loaded out of this file so that we have only */
 /*  one file to check when porting to another OS                            */
 #ifndef _XBT_SYSDEP_H
 #define _XBT_SYSDEP_H
 
-#include <string.h> /* Included directly for speed */
-
-#include <time.h> /* FIXME: remove */
-#include <unistd.h> /* FIXME: remove */
+#include <string.h>
 #include <stdlib.h> 
-
+#include <stdarg.h> /* va_list */
+   
 #include "xbt/misc.h"
-BEGIN_DECL
-#if 0
-#define __CALLOC_OP(n, s)  calloc((n), (s))
-  #define __REALLOC_OP(n, s)  realloc((n), (s))
-#define CALLOC(n, s)  ((__CALLOC_OP  ((n)?:(FAILURE("attempt to alloc 0 bytes"), 0), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory allocation error"), NULL))
-  /* #define REALLOC(p, s) ((__REALLOC_OP ((p), (s)?:(FAILURE("attempt to alloc 0 bytes"), 0)))?:(FAILURE("memory reallocation error"), NULL)) */
-  #define REALLOC(p, s) (__REALLOC_OP ((p), (s)))
+#include "xbt/asserts.h"
+
+SG_BEGIN_DECL()
+
+/* They live in asserts.h, but need to be declared before this module.
+   double declaration to cut dependency cycle */
+/**
+ * @addtogroup XBT_error
+ * 
+ * @{
+ */
+XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
+XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+/** @} */
+
+/* these ones live in str.h, but redeclare them here so that we do 
+   not need to load the whole str.h and its heavy dependencies */
+#ifndef __USE_GNU /* do not redeclare existing headers */
+  XBT_PUBLIC(int) asprintf  (char **ptr, const char *fmt, /*args*/ ...) _XBT_GNUC_PRINTF(2,3);
+  XBT_PUBLIC(int) vasprintf (char **ptr, const char *fmt, va_list ap);
 #endif
+XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
+
+/** @addtogroup XBT_syscall
+ *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
+ *
+ *  @{
+ */
+
+#if defined(__GNUC__) || defined(DOXYGEN)
+/** @brief Like strdup, but xbt_die() on error */
+static XBT_INLINE char *xbt_strdup(const char *s) {
+  char *res = NULL;
+  if (s) {
+    res=strdup(s);
+    if (!res) 
+      xbt_die("memory allocation error (strdup returned NULL)");
+  } 
+  return res;
+}
+/** @brief Like malloc, but xbt_die() on error 
+    @hideinitializer */
+static XBT_INLINE void *xbt_malloc(unsigned int n){
+  void *res;
+//  if (n==0) xbt_die("malloc(0) is not portable");
+  res=malloc(n);
+  if (!res)
+     xbt_die(bprintf("Memory allocation of %d bytes failed",n));
+  return res;
+}
+
+/** @brief like malloc, but xbt_die() on error and memset data to 0
+    @hideinitializer */
+static XBT_INLINE void *xbt_malloc0(unsigned int n) {
+  void *res;
+//  if (n==0) xbt_die("calloc(0) is not portable");
+  res=calloc(n,1);
+  if (!res)
+     xbt_die(bprintf("Memory callocation of %d bytes failed",n));
+  return res;
+}
   
-#define xbt_strdup(s)  ((s)?(strdup(s)?:(xbt_die("memory allocation error"),NULL))\
-                           :(NULL))
-#define xbt_malloc(n)   (malloc(n) ?: (xbt_die("memory allocation error"),NULL))
-#define xbt_malloc0(n)  (calloc( (n),1 ) ?: (xbt_die("memory allocation error"),NULL))
-#define xbt_realloc(p,s) (s? (p? (realloc(p,s)?:xbt_die("memory allocation error"),NULL) \
-                               : xbt_malloc(s)) \
-                           : (p? (free(p),NULL) \
-                               : NULL))
+/** @brief like realloc, but xbt_die() on error 
+    @hideinitializer */
+static XBT_INLINE void *xbt_realloc(void*p,unsigned int s){
+  void *res=res;
+//  if (s==0) xbt_die("realloc(0) is not portable");
+  if (s) {
+    if (p) {
+      res=realloc(p,s);
+      if (!res) 
+       xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
+    } else {
+      res=xbt_malloc(s);
+    }
+  } else {
+    if (p) {
+      free(p);
+    }
+  }
+  return res;
+}
+#else /* non __GNUC__  */
+#  define xbt_strdup(s)    strdup(s)
+#  define xbt_malloc(n)    malloc(n)
+#  define xbt_malloc0(n)   calloc(n,1)
+#  define xbt_realloc(p,s) realloc(p,s)
+#endif /* __GNUC__ ? */
+
+/** @brief like free
+    @hideinitializer */
 #define xbt_free free /*nothing specific to do here. A poor valgrind replacement?*/
-#define xbt_free_fct free /* replacement with the guareenty of being a function */
-   
-#define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
-#define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
-
-/* Attributes are only in recent versions of GCC */
+/*#define xbt_free_fct free * replacement with the guareenty of being a function  FIXME:KILLME*/
 
-#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
-# define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
-          __attribute__((__format__ (__printf__, format_idx, arg_idx)))
-# define _XBT_GNUC_SCANF( format_idx, arg_idx )     \
-              __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
-# define _XBT_GNUC_FORMAT( arg_idx )                \
-                  __attribute__((__format_arg__ (arg_idx)))
-# define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
+/** @brief like free, but you can be sure that it is a function  */
+XBT_PUBLIC(void) xbt_free_f(void* p);
+/** @brief should be given a pointer to pointer, and frees the second one */
+XBT_PUBLIC(void) xbt_free_ref(void *d);
 
-#else   /* !__GNUC__ */
-# define _XBT_GNUC_PRINTF( format_idx, arg_idx )
-# define _XBT_GNUC_SCANF( format_idx, arg_idx )
-# define _XBT_GNUC_FORMAT( arg_idx )
-# define _XBT_GNUC_NORETURN
-
-#endif  /* !__GNUC__ */
-
-/* inline and __FUNCTION__ are only in GCC when -ansi is of */
-
-#if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
+/** @brief like calloc, but xbt_die() on error and don't memset to 0
+    @hideinitializer */
+#define xbt_new(type, count)  ((type*)xbt_malloc (sizeof (type) * (count)))
+/** @brief like calloc, but xbt_die() on error
+    @hideinitializer */
+#define xbt_new0(type, count) ((type*)xbt_malloc0 (sizeof (type) * (count)))
 
-# define _XBT_GNUC_FUNCTION __FUNCTION__
-# define _XBT_INLINE inline
-#else
-# define _XBT_GNUC_FUNCTION "function"
-# define _XBT_INLINE 
-#endif
+/** @} */  
 
-END_DECL
-   
-#include "xbt/error.h" /* needed for xbt_die */
+  
+SG_END_DECL()
 
 #endif /* _XBT_SYSDEP_H */