Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
typo in windows DLL cruft
[simgrid.git] / include / xbt / sysdep.h
index 2d7c63c..f8b282d 100644 (file)
 /* $Id$ */
-
-/* gras/sysdep.h -- all system dependency                                   */
+/*  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                            */
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2004 the OURAGAN project.                                  */
+/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
 
 /* This program is free software; you can redistribute it and/or modify it
-   under the terms of the license (GNU LGPL) which comes with this package. */
-
-
-#ifndef _GRAS_SYSDEP_H
-#define _GRAS_SYSDEP_H
-
-#include <string.h> /* Included directly for speed */
-
-#include <time.h> /* FIXME: remove */
-#include <unistd.h> /* FIXME: remove */
-
-#ifdef  __cplusplus
-extern "C" 
-#endif
-
-void* gras_malloc  (long int bytes);
-void* gras_malloc0 (long int bytes);
-void* gras_realloc (void  *memory, long int bytes);
-void  gras_free    (void  *memory);
-
-#define gras_new(type, count)  ((type*)gras_malloc (sizeof (type) * (count)))
-#define gras_new0(type, count) ((type*)gras_malloc0 (sizeof (type) * (count)))
-
-#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
-#define _GRAS_GNUC_PRINTF( format_idx, arg_idx )    \
-          __attribute__((__format__ (__printf__, format_idx, arg_idx)))
-#define _GRAS_GNUC_SCANF( format_idx, arg_idx )     \
-              __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
-#define _GRAS_GNUC_FORMAT( arg_idx )                \
-                  __attribute__((__format_arg__ (arg_idx)))
-#define _GRAS_GNUC_NORETURN                         \
-     __attribute__((__noreturn__))
-#else   /* !__GNUC__ */
-#define _GRAS_GNUC_PRINTF( format_idx, arg_idx )
-#define _GRAS_GNUC_SCANF( format_idx, arg_idx )
-#define _GRAS_GNUC_FORMAT( arg_idx )
-#define _GRAS_GNUC_NORETURN
-#endif  /* !__GNUC__ */
-
-void gras_abort(void) _GRAS_GNUC_NORETURN;
-
-/* FIXME: This is a very good candidate to rewrite (along with a proper string stuff) 
-   but I'm too lazy right now, so copy the definition */
-long int strtol(const char *nptr, char **endptr, int base);
-double strtod(const char *nptr, char **endptr);
-int atoi(const char *nptr);
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
+#ifndef _XBT_SYSDEP_H
+#define _XBT_SYSDEP_H
 
+#include <string.h>
+#include <stdlib.h> 
+#include <stdio.h>
+#include <stdarg.h> /* va_list */
    
-#ifdef  __cplusplus
+#include "xbt/misc.h"
+#include "xbt/asserts.h"
+  
+SG_BEGIN_DECL()
+
+/* FIXME: better place? */
+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);
+XBT_PUBLIC(char*) bprintf   (const char*fmt, ...) _XBT_GNUC_PRINTF(1,2);
+  
+/* They live in asserts.h, but need to be declared before this module.
+   double declaration to cut dependency cycle */
+
+XBT_PUBLIC(void) xbt_abort(void) _XBT_GNUC_NORETURN;
+XBT_PUBLIC(void) xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+
+
+/** @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(int n){
+  void *res=malloc(n);
+  if (!res)
+     xbt_die(bprintf("Memory allocation of %d bytes failed",n));
+  return res;
 }
-#endif
 
-#endif /* _GRAS_SYSDEP_H */
+/** @brief like malloc, but xbt_die() on error and memset data to 0
+    @hideinitializer */
+static XBT_INLINE void *xbt_malloc0(int n) {
+  void *res=calloc(n,1);
+  if (!res)
+     xbt_die(bprintf("Memory callocation of %d bytes failed",n));
+  return res;
+}
+  
+/** @brief like realloc, but xbt_die() on error 
+    @hideinitializer */
+static XBT_INLINE void *xbt_realloc(void*p,int s){
+  void *res=res;
+  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  FIXME:KILLME*/
+
+/** @brief like free 
+    @hideinitializer */
+XBT_PUBLIC(void) xbt_free_f(void* p);
+
+/** @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)))
+
+/** @} */  
+
+  
+SG_END_DECL()
+
+#endif /* _XBT_SYSDEP_H */