Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
XBT_RUNNING_CTX_INITIALIZER: don't list all element of bt[] in initializer.
[simgrid.git] / include / xbt / ex.h
index 1f7e538..77b1967 100644 (file)
@@ -55,16 +55,16 @@ SG_BEGIN_DECL()
 # include <stdio.h>
 #include <errno.h>
 #  define MAYDAY_SAVE(m)    printf("%d %s:%d save %p\n",                \
-                                   (*xbt_getpid)(),__FILE__,__LINE__,  \
+                                   xbt_getpid(), __FILE__, __LINE__,    \
                                    (m)->jb                              \
                                   ),
 #  define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n",             \
-                                   (*xbt_getpid)(),__FILE__,__LINE__,  \
+                                   xbt_getpid(), __FILE__, __LINE__,    \
                                    (m)->jb                              \
                                   ),
 #  define MAYDAY_CATCH(e)   printf("%d %s:%d Catched '%s'\n",           \
-                                   (*xbt_getpid)(),__FILE__,__LINE__,  \
-                                   e.msg                                \
+                                   xbt_getpid(), __FILE__, __LINE__,    \
+                                   (e).msg                              \
                                  ),
 #else
 #  define MAYDAY_SAVE(m)
@@ -259,9 +259,11 @@ typedef enum {
   system_error,   /**< a syscall did fail */
   network_error,  /**< error while sending/receiving data */
   timeout_error,  /**< not quick enough, dude */
+  cancel_error,   /**< an action was canceled */
   thread_error,    /**< error while [un]locking */
   host_error,                            /**< host failed */
-  tracing_error   /**< error during the simulation tracing */
+  tracing_error,   /**< error during the simulation tracing */
+  io_error          /**< disk or file error */
 } xbt_errcat_t;
 
 XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
@@ -289,50 +291,53 @@ typedef struct {
   void *bt[XBT_BACKTRACE_SIZE];
 } xbt_ex_t;
 
-/* declare the context type (private) */
+/* declare the running context type
+ * (that's where we get the process name for the logs and the exception storage)
+ *  -- do not mess with it --
+ */
 typedef struct {
   __ex_mctx_t *ctx_mctx;        /* permanent machine context of enclosing try/catch */
   volatile int ctx_caught;      /* temporary flag whether exception was caught */
-  volatile xbt_ex_t ctx_ex;     /* temporary exception storage */
-} ex_ctx_t;
+  volatile xbt_ex_t exception;  /* temporary exception storage */
+} xbt_running_ctx_t;
 
 /* the static and dynamic initializers for a context structure */
-#define XBT_CTX_INITIALIZER \
+#define XBT_RUNNING_CTX_INITIALIZER \
     { NULL, 0, { /* content */ NULL, unknown_error, 0, \
                  /* throw point*/ 0,NULL, NULL,0, NULL, 0, NULL,\
-                 /* backtrace */ 0,NULL,{NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL} } }
-#define XBT_CTX_INITIALIZE(ctx) \
+                 /* backtrace */ 0, NULL, /* bt[] */ } }
+#define XBT_RUNNING_CTX_INITIALIZE(ctx) \
     do { \
         (ctx)->ctx_mctx          = NULL; \
         (ctx)->ctx_caught        = 0;    \
-        (ctx)->ctx_ex.msg        = NULL; \
-        (ctx)->ctx_ex.category   = 0;    \
-        (ctx)->ctx_ex.value      = 0;    \
-        (ctx)->ctx_ex.remote     = 0;    \
-        (ctx)->ctx_ex.host       = NULL; \
-        (ctx)->ctx_ex.procname   = NULL; \
-        (ctx)->ctx_ex.pid        = 0;    \
-        (ctx)->ctx_ex.file       = NULL; \
-        (ctx)->ctx_ex.line       = 0;    \
-        (ctx)->ctx_ex.func       = NULL; \
-        (ctx)->ctx_ex.bt[0]      = NULL; \
-        (ctx)->ctx_ex.bt[1]      = NULL; \
-        (ctx)->ctx_ex.bt[2]      = NULL; \
-        (ctx)->ctx_ex.bt[3]      = NULL; \
-        (ctx)->ctx_ex.bt[4]      = NULL; \
-        (ctx)->ctx_ex.bt[5]      = NULL; \
-        (ctx)->ctx_ex.bt[6]      = NULL; \
-        (ctx)->ctx_ex.bt[7]      = NULL; \
-        (ctx)->ctx_ex.bt[8]      = NULL; \
-        (ctx)->ctx_ex.bt[9]      = NULL; \
-        (ctx)->ctx_ex.used       = 0; \
-        (ctx)->ctx_ex.bt_strings = NULL; \
+        (ctx)->exception.msg        = NULL; \
+        (ctx)->exception.category   = 0;    \
+        (ctx)->exception.value      = 0;    \
+        (ctx)->exception.remote     = 0;    \
+        (ctx)->exception.host       = NULL; \
+        (ctx)->exception.procname   = NULL; \
+        (ctx)->exception.pid        = 0;    \
+        (ctx)->exception.file       = NULL; \
+        (ctx)->exception.line       = 0;    \
+        (ctx)->exception.func       = NULL; \
+        (ctx)->exception.bt[0]      = NULL; \
+        (ctx)->exception.bt[1]      = NULL; \
+        (ctx)->exception.bt[2]      = NULL; \
+        (ctx)->exception.bt[3]      = NULL; \
+        (ctx)->exception.bt[4]      = NULL; \
+        (ctx)->exception.bt[5]      = NULL; \
+        (ctx)->exception.bt[6]      = NULL; \
+        (ctx)->exception.bt[7]      = NULL; \
+        (ctx)->exception.bt[8]      = NULL; \
+        (ctx)->exception.bt[9]      = NULL; \
+        (ctx)->exception.used       = 0; \
+        (ctx)->exception.bt_strings = NULL; \
     } while (0)
 
 /* the exception context */
-typedef ex_ctx_t *(*ex_ctx_cb_t) (void);
-XBT_PUBLIC_DATA(ex_ctx_cb_t) __xbt_ex_ctx;
-extern ex_ctx_t *__xbt_ex_ctx_default(void);
+typedef xbt_running_ctx_t *(*xbt_running_ctx_fetcher_t) (void);
+XBT_PUBLIC_DATA(xbt_running_ctx_fetcher_t) __xbt_running_ctx_fetch;
+extern xbt_running_ctx_t *__xbt_ex_ctx_default(void);
 
 /* the termination handler */
 typedef void (*ex_term_cb_t) (xbt_ex_t *);
@@ -344,7 +349,7 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e);
  */
 #define TRY \
     { \
-        ex_ctx_t *__xbt_ex_ctx_ptr = __xbt_ex_ctx(); \
+        xbt_running_ctx_t *__xbt_ex_ctx_ptr = __xbt_running_ctx_fetch(); \
         int __ex_cleanup = 0; \
         __ex_mctx_t *__ex_mctx_en; \
         __ex_mctx_t __ex_mctx_me; \
@@ -381,6 +386,17 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e);
  *  @hideinitializer
  */
 #define CATCH(e) \
+  DO_CATCH((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_running_ctx_fetch()->exception)
+
+/** @brief like CATCH(e) but without argument
+ *  @hideinitializer
+ *
+ *  Useful if you only want to rethrow the exception caught, and do not want to
+ *  bother with an unused variable.
+ */
+#define CATCH_ANONYMOUS DO_CATCH(0)
+
+#define DO_CATCH(_xbt_do_catch_set_e) \
             else { \
             } \
             if (!(__ex_cleanup)) \
@@ -393,20 +409,21 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e);
         } \
         __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
     } \
-    if (   !(__xbt_ex_ctx()->ctx_caught) \
-        || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, MAYDAY_CATCH(e) 0)) { \
+    if (   !(__xbt_running_ctx_fetch()->ctx_caught) \
+        || ((void)(_xbt_do_catch_set_e),                             \
+            MAYDAY_CATCH(__xbt_running_ctx_fetch()->exception) 0)) {    \
     } \
     else
 
-#define DO_THROW(e) \
-     /* deal with the exception */                                             \
-     if (__xbt_ex_ctx()->ctx_mctx == NULL)                                     \
-       __xbt_ex_terminate((xbt_ex_t *)&(e)); /* not catched */\
-     else                                                                      \
-       __ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx); /* catched somewhere */    \
-     abort()                    /* nope, stupid GCC, we won't survive a THROW (this won't be reached) */
+#define DO_THROW(running_ctx) \
+     /* deal with the exception */                                                     \
+     if (running_ctx->ctx_mctx == NULL)                                                \
+       __xbt_ex_terminate((xbt_ex_t*)&(running_ctx->exception)); /* not catched */     \
+     else                                                                              \
+       __ex_mctx_restore(running_ctx->ctx_mctx); /* catched somewhere */               \
+     abort()  /* nope, stupid GCC, we won't survive a THROW (this won't be reached) */
 
-/** @brief Helper macro for THROWS0-6
+/** @brief Helper macro for THROW and THROWF
  *  @hideinitializer
  *
  *  @param c: category code (integer)
@@ -425,55 +442,39 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e);
  */
 
 #define _THROW(c,v,m) \
-  do { /* change this sequence into one block */                          \
-     ex_ctx_t *_throw_ctx = __xbt_ex_ctx();                               \
-     /* build the exception */                                            \
-     _throw_ctx->ctx_ex.msg      = (m);                                   \
-     _throw_ctx->ctx_ex.category = (xbt_errcat_t)(c);                     \
-     _throw_ctx->ctx_ex.value    = (v);                                   \
-     _throw_ctx->ctx_ex.remote   = 0;                                     \
-     _throw_ctx->ctx_ex.host     = (char*)NULL;                           \
-     _throw_ctx->ctx_ex.procname = (char*)xbt_procname();                 \
-     _throw_ctx->ctx_ex.pid      = (*xbt_getpid)();                       \
-     _throw_ctx->ctx_ex.file     = (char*)__FILE__;                       \
-     _throw_ctx->ctx_ex.line     = __LINE__;                              \
-     _throw_ctx->ctx_ex.func     = (char*)_XBT_FUNCTION;                  \
-     _throw_ctx->ctx_ex.bt_strings = NULL;                                \
-     xbt_backtrace_current( (xbt_ex_t *) &(_throw_ctx->ctx_ex) );         \
-     DO_THROW(_throw_ctx->ctx_ex);                                        \
+  do { /* change this sequence into one block */                             \
+     xbt_running_ctx_t *_throw_ctx = __xbt_running_ctx_fetch();              \
+     /* build the exception */                                               \
+     _throw_ctx->exception.msg      = (m);                                   \
+     _throw_ctx->exception.category = (xbt_errcat_t)(c);                     \
+     _throw_ctx->exception.value    = (v);                                   \
+     _throw_ctx->exception.remote   = 0;                                     \
+     _throw_ctx->exception.host     = (char*)NULL;                           \
+     _throw_ctx->exception.procname = (char*)xbt_procname();                 \
+     _throw_ctx->exception.pid      = xbt_getpid();                          \
+     _throw_ctx->exception.file     = (char*)__FILE__;                       \
+     _throw_ctx->exception.line     = __LINE__;                              \
+     _throw_ctx->exception.func     = (char*)_XBT_FUNCTION;                  \
+     _throw_ctx->exception.bt_strings = NULL;                                \
+     xbt_backtrace_current( (xbt_ex_t *) &(_throw_ctx->exception) );         \
+     DO_THROW(_throw_ctx);                                                   \
   } while (0)
-/*     __xbt_ex_ctx()->ctx_ex.used     = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE); */
 
-/** @brief Builds and throws an exception with a string taking no arguments
-    @hideinitializer */
-#define THROW0(c,v,m)                   _THROW(c,v,(m?bprintf(m):NULL))
-/** @brief Builds and throws an exception with a string taking one argument
-    @hideinitializer */
-#define THROW1(c,v,m,a1)                _THROW(c,v,bprintf(m,a1))
-/** @brief Builds and throws an exception with a string taking two arguments
-    @hideinitializer */
-#define THROW2(c,v,m,a1,a2)             _THROW(c,v,bprintf(m,a1,a2))
-/** @brief Builds and throws an exception with a string taking three arguments
+/** @brief Builds and throws an exception
     @hideinitializer */
-#define THROW3(c,v,m,a1,a2,a3)          _THROW(c,v,bprintf(m,a1,a2,a3))
-/** @brief Builds and throws an exception with a string taking four arguments
-    @hideinitializer */
-#define THROW4(c,v,m,a1,a2,a3,a4)       _THROW(c,v,bprintf(m,a1,a2,a3,a4))
-/** @brief Builds and throws an exception with a string taking five arguments
-    @hideinitializer */
-#define THROW5(c,v,m,a1,a2,a3,a4,a5)    _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5))
-/** @brief Builds and throws an exception with a string taking six arguments
-    @hideinitializer */
-#define THROW6(c,v,m,a1,a2,a3,a4,a5,a6) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6))
-/** @brief Builds and throws an exception with a string taking seven arguments
+#define THROW(c, v)             _THROW(c, v, NULL)
+
+/** @brief Builds and throws an exception with a printf-like formatted message
     @hideinitializer */
-#define THROW7(c,v,m,a1,a2,a3,a4,a5,a6,a7) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6,a7))
+#define THROWF(c, v, ...)       _THROW(c, v, bprintf(__VA_ARGS__))
 
-#define THROW_IMPOSSIBLE     THROW0(unknown_error,0,"The Impossible Did Happen (yet again)")
-#define THROW_UNIMPLEMENTED  THROW1(unknown_error,0,"Function %s unimplemented",_XBT_FUNCTION)
+#define THROW_IMPOSSIBLE \
+  THROWF(unknown_error, 0, "The Impossible Did Happen (yet again)")
+#define THROW_UNIMPLEMENTED \
+  THROWF(unknown_error, 0, "Function %s unimplemented",_XBT_FUNCTION)
 
 #ifndef NDEBUG
-#  define DIE_IMPOSSIBLE       xbt_assert0(0,"The Impossible Did Happen (yet again)")
+#  define DIE_IMPOSSIBLE       xbt_assert(0,"The Impossible Did Happen (yet again)")
 #else
 #  define DIE_IMPOSSIBLE       exit(1);
 #endif
@@ -483,61 +484,61 @@ extern void __xbt_ex_terminate_default(xbt_ex_t * e);
  */
 #define RETHROW \
   do { \
-   if (__xbt_ex_ctx()->ctx_mctx == NULL) \
-     __xbt_ex_terminate((xbt_ex_t *)&(__xbt_ex_ctx()->ctx_ex)); \
+   xbt_running_ctx_t *ctx = __xbt_running_ctx_fetch(); \
+   if (ctx->ctx_mctx == NULL) \
+     __xbt_ex_terminate((xbt_ex_t*)&(ctx->exception)); \
    else \
-     __ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx); \
+     __ex_mctx_restore(ctx->ctx_mctx); \
    abort();\
   } while(0)
 
-
-#ifndef DOXYGEN_SKIP
-#define _XBT_PRE_RETHROW \
-  do {                                                               \
-    char *_xbt_ex_internal_msg = __xbt_ex_ctx()->ctx_ex.msg;         \
-    __xbt_ex_ctx()->ctx_ex.msg = bprintf(
-#define _XBT_POST_RETHROW \
- _xbt_ex_internal_msg); \
-    free(_xbt_ex_internal_msg);                                      \
-    RETHROW;                                                         \
-  } while (0)
-#endif
-
-/** @brief like THROW0, but adding some details to the message of an existing exception
+/** @brief like THROWF, but adding some details to the message of an existing exception
  *  @hideinitializer
  */
-#define RETHROW0(msg)           _XBT_PRE_RETHROW msg,          _XBT_POST_RETHROW
-/** @brief like THROW1, but adding some details to the message of an existing exception
- *  @hideinitializer
- */
-#define RETHROW1(msg,a)         _XBT_PRE_RETHROW msg,a,        _XBT_POST_RETHROW
-/** @brief like THROW2, but adding some details to the message of an existing exception
- *  @hideinitializer
- */
-#define RETHROW2(msg,a,b)       _XBT_PRE_RETHROW msg,a,b,      _XBT_POST_RETHROW
-/** @brief like THROW3, but adding some details to the message of an existing exception
- *  @hideinitializer
- */
-#define RETHROW3(msg,a,b,c)     _XBT_PRE_RETHROW msg,a,b,c,    _XBT_POST_RETHROW
-/** @brief like THROW4, but adding some details to the message of an existing exception
- *  @hideinitializer
- */
-#define RETHROW4(msg,a,b,c,d)   _XBT_PRE_RETHROW msg,a,b,c,d,  _XBT_POST_RETHROW
-/** @brief like THROW5, but adding some details to the message of an existing exception
- *  @hideinitializer
- */
-#define RETHROW5(msg,a,b,c,d,e) _XBT_PRE_RETHROW msg,a,b,c,d,e, _XBT_POST_RETHROW
+#define RETHROWF(...)                                                   \
+  do {                                                                  \
+    char *_xbt_ex_internal_msg = __xbt_running_ctx_fetch()->exception.msg; \
+    __xbt_running_ctx_fetch()->exception.msg = bprintf(__VA_ARGS__,     \
+                                                       _xbt_ex_internal_msg); \
+    free(_xbt_ex_internal_msg);                                         \
+    RETHROW;                                                            \
+  } while (0)
 
 /** @brief Exception destructor */
 XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e);
 
 /** @brief Shows a backtrace of the current location */
 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
+/** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc  */
+XBT_PUBLIC(int)xbt_backtrace_no_malloc(void**bt, int size);
 /** @brief Captures a backtrace for further use */
 XBT_PUBLIC(void) xbt_backtrace_current(xbt_ex_t * e);
 /** @brief Display a previously captured backtrace */
 XBT_PUBLIC(void) xbt_backtrace_display(xbt_ex_t * e);
 
+#ifdef XBT_USE_DEPRECATED
+
+/* Kept for backward compatibility. */
+
+#define THROW0(c, v, m) \
+  do { if (m) THROWF(c, v, m); else THROW(c, v); } while (0)
+#define THROW1(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW2(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW3(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW4(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW5(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW6(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+#define THROW7(c, v, ...)       THROWF(c, v, __VA_ARGS__)
+
+#define RETHROW0(...)           RETHROWF(__VA_ARGS__)
+#define RETHROW1(...)           RETHROWF(__VA_ARGS__)
+#define RETHROW2(...)           RETHROWF(__VA_ARGS__)
+#define RETHROW3(...)           RETHROWF(__VA_ARGS__)
+#define RETHROW4(...)           RETHROWF(__VA_ARGS__)
+#define RETHROW5(...)           RETHROWF(__VA_ARGS__)
+
+#endif
+
 SG_END_DECL()
 
 /** @} */