Continue documenting my changes

[simgrid.git] / include / xbt / sysdep.h

diff --git a/include/xbt/sysdep.h b/include/xbt/sysdep.h
index 4bd3cea..a2271ab 100644 (file)
--- a/include/xbt/sysdep.h
+++ b/include/xbt/sysdep.h
@@ -13,53 +13,69 @@
 
 #include <string.h>
 #include <stdlib.h> 
+#include <stdarg.h> /* va_list */
    
 #include "xbt/misc.h"
-#include "xbt/error.h"
+#include "xbt/asserts.h"
+#include "xbt/str.h"
   
-BEGIN_DECL()
+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;
+/** @} */
+
 /** @addtogroup XBT_syscall
+ *  @brief Malloc and associated functions, killing the program on error (with \ref XBT_ex)
+ *
  *  @{
  */
 
-#ifdef __GNUC__
-/** @brief like strdup, but xbt_die() on error */
-static inline char *xbt_strdup(const char *s) {
+#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");
+      xbt_die("memory allocation error (strdup returned NULL)");
   } 
   return res;
 }
-/** @brief like malloc, but xbt_die() on error 
+/** @brief Like malloc, but xbt_die() on error 
     @hideinitializer */
-static inline void *xbt_malloc(int n){
+static XBT_INLINE void *xbt_malloc(int n){
   void *res=malloc(n);
   if (!res)
-     xbt_die("Memory allocation failed");
+     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 inline void *xbt_malloc0(int n) {
+static XBT_INLINE void *xbt_malloc0(int n) {
   void *res=calloc(n,1);
   if (!res)
-     xbt_die("Memory callocation failed");
+     xbt_die(bprintf("Memory callocation of %d bytes failed",n));
   return res;
 }
   
 /** @brief like realloc, but xbt_die() on error 
     @hideinitializer */
-static inline void *xbt_realloc(void*p,int s){
+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("memory allocation error");
+       xbt_die(bprintf("memory (re)allocation of %d bytes failed",s));
     } else {
       res=xbt_malloc(s);
     }
@@ -81,7 +97,11 @@ static inline void *xbt_realloc(void*p,int s){
     @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)))
@@ -91,13 +111,7 @@ static inline void *xbt_realloc(void*p,int s){
 
 /** @} */  
 
-/** @brief get time in seconds 
-
-  * gives  the  number  of  seconds since the Epoch (00:00:00 UTC, January 1, 1970).
-  * Most users should use gras_os_time and should not use this function unless 
-    they really know what they are doing. */
-double xbt_os_time(void);
-
-END_DECL()
+  
+SG_END_DECL()
 
 #endif /* _XBT_SYSDEP_H */