Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
of course, xlC does not like gcc attributes. And since this is a leftover, don't...
[simgrid.git] / include / xbt / error.h
index 0864739..a715a80 100644 (file)
 #ifndef XBT_ERROR_H
 #define XBT_ERROR_H
 
-#include <stdio.h> /* FIXME: Get rid of it */
+#error do not use this crap anymore
 
 #include "xbt/misc.h" /* BEGIN_DECL */
 #include "xbt/log.h"
 
-#ifdef HAVE_EXECINFO_H
-#include <execinfo.h>  /* to print the backtrace */
-#endif
-
 BEGIN_DECL()
 
-#define _XBT_ERR_PRE do {
-#define _XBT_ERR_POST(code)                                    \
-  return code;                                                 \
-} while (0)
-  
 /** @addtogroup XBT_error 
+ *
+ *  This is how the errors get reported in the SimGrid toolkit. This mechanism is not 
+ *  as powerful as exceptions, but since we're using C, there is not much we can do.
+ *
  *  @{*/
 
-/** \brief Kill the programm in silence */
-void xbt_abort(void) _XBT_GNUC_NORETURN;
-
-/** \brief Kill the programm with an error message */
-void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
-
-
+/** @name 1. Type definition and basic operations
+ *
+ *  @{
+ */
 /** \brief Error types */
 typedef enum {
   no_error=0,       /**< succes */
-  mismatch_error=1, /**< The provided ID does not match */
-  system_error=2,   /**< a syscall did fail */
-  network_error=3,  /**< error while sending/receiving data */
-  timeout_error=4,  /**< not quick enough, dude */
-  thread_error=5,   /**< error while [un]locking */
-  unknown_error=6,  /**< unknown error */
+  old_mismatch_error=1, /**< The provided ID does not match */
+  old_system_error=2,   /**< a syscall did fail */
+  old_network_error=3,  /**< error while sending/receiving data */
+  old_timeout_error=4,  /**< not quick enough, dude */
+  old_thread_error=5,   /**< error while [un]locking */
+  old_unknown_error=6   /**< unknown error */
      
-  /* remote errors: result of a RMI/RPC.
-     no_error(=0) is the same for both */   
-  remote_mismatch_error=129,
-  remote_system_error,
-  remote_network_error,
-  remote_timeout_error,
-  remote_thread_error,
-  remote_unknown_error
 } xbt_error_t;
 
-const char *xbt_error_name(xbt_error_t errcode);
+ const char *xbt_error_name(xbt_error_t errcode);
+ void xbt_abort(void) _XBT_GNUC_NORETURN;
+ void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+
+/** @} */
 
-/** @name TRY macro family
+/** @name 2. TRY macro family
  * 
  * Those functions are used to launch a function call and react automatically 
  * to its return value. They expect such a variable to be declared in the scope:
@@ -69,12 +57,10 @@ const char *xbt_error_name(xbt_error_t errcode);
 /** @brief return the error code if != no_error
  *  @hideinitializer
  */
-#define TRY(action) do {                                \
-  if ((errcode=action) != no_error) {                   \
-     fprintf (stderr, "%s:%d: '%s' error raising...\n", \
-            __FILE__,__LINE__,                         \
-             xbt_error_name(errcode));                  \
-     return errcode;                                    \
+#define TRYOLD(action) do {                                       \
+  if ((errcode=action) != no_error) {                          \
+     ERROR1("'%s' error raising...", xbt_error_name(errcode)); \
+     return errcode;                                           \
   } } while (0)
    
 /** @brief return the error code if != no_error and != \a catched
@@ -87,9 +73,7 @@ const char *xbt_error_name(xbt_error_t errcode);
  */
 #define TRYFAIL(action) do {                                   \
   if ((errcode=action) != no_error) {                          \
-     fprintf(stderr,"%s:%d: Got '%s' error !\n",               \
-            __FILE__,__LINE__,                                \
-             xbt_error_name(errcode));                         \
+     ERROR1("Got '%s' error !", xbt_error_name(errcode));      \
      fflush(stdout);                                           \
      xbt_abort();                                              \
   } } while(0)
@@ -101,7 +85,7 @@ const char *xbt_error_name(xbt_error_t errcode);
 #define TRYEXPECT(action,expected_error)  do {                 \
   errcode=action;                                              \
   if (errcode != expected_error) {                             \
-    fprintf(stderr,"Got error %s (instead of %s expected)\n",  \
+    ERROR2("Got error %s (instead of %s expected)\n",          \
            xbt_error_name(errcode),                          \
            xbt_error_name(expected_error));                  \
     xbt_abort();                                              \
@@ -109,100 +93,51 @@ const char *xbt_error_name(xbt_error_t errcode);
 } while(0)
 
 /** @}*/
-/** @name RAISE macro family
+
+#define _XBT_ERR_PRE do {
+#define _XBT_ERR_POST(code)                                    \
+  return code;                                                 \
+} while (0)
+  
+
+/** @name 3. RAISE macro family
  *
  *  Return a error code, doing some logs on stderr.
+ *
+ *  @todo This should use the logging features, not stderr
  * 
  *  @{
  */
 
 /** @hideinitializer  */
-#define RAISE0(code,fmt) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",    \
-          __FILE__,__LINE__,__FUNCTION__); \
-  _XBT_ERR_POST(code)
+#define OLDRAISE0(code,fmt)                   _XBT_ERR_PRE   ERROR0(fmt);                   _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define RAISE1(code,fmt,a1) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",       \
-          __FILE__,__LINE__,__FUNCTION__,a1); \
-  _XBT_ERR_POST(code)
+#define OLDRAISE1(code,fmt,a1)                _XBT_ERR_PRE   ERROR1(fmt,a1);                _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define RAISE2(code,fmt,a1,a2) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",          \
-          __FILE__,__LINE__,__FUNCTION__,a1,a2); \
-  _XBT_ERR_POST(code)
+#define OLDRAISE2(code,fmt,a1,a2)             _XBT_ERR_PRE   ERROR2(fmt,a1,a2);             _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define RAISE3(code,fmt,a1,a2,a3) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",             \
-          __FILE__,__LINE__,__FUNCTION__,a1,a2,a3); \
-  _XBT_ERR_POST(code)
+#define OLDRAISE3(code,fmt,a1,a2,a3)          _XBT_ERR_PRE   ERROR3(fmt,a1,a2,a3);          _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define RAISE4(code,fmt,a1,a2,a3,a4) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",                \
-          __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4); \
-  _XBT_ERR_POST(code)
+#define OLDRAISE4(code,fmt,a1,a2,a3,a4)       _XBT_ERR_PRE   ERROR4(fmt,a1,a2,a3,a4);       _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define RAISE5(code,fmt,a1,a2,a3,a4,a5) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",                   \
-          __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5); \
-  _XBT_ERR_POST(code)
-/** @hideinitializer  */
-#define RAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _XBT_ERR_PRE     \
-  fprintf(stderr,"%s:%d:%s: " fmt "\n",                      \
-          __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5,a6); \
-  _XBT_ERR_POST(code)
-
-/**@}*/
-/** 
- * \name assert macro familly
- *
- * Those are the GRAS version of the good ol' assert macro. You can pass them a format message and 
- * arguments, just as if it where a printf.
- *
- * @{
- */
-#ifdef NDEBUG
-#define xbt_assert(cond)
-#define xbt_assert0(cond,msg)
-#define xbt_assert1(cond,msg,a)
-#define xbt_assert2(cond,msg,a,b)
-#define xbt_assert3(cond,msg,a,b,c)
-#define xbt_assert4(cond,msg,a,b,c,d)
-#define xbt_assert5(cond,msg,a,b,c,d,e)
-#define xbt_assert6(cond,msg,a,b,c,d,e,f)
-#else
+#define OLDRAISE5(code,fmt,a1,a2,a3,a4,a5)    _XBT_ERR_PRE   ERROR5(fmt,a1,a2,a3,a4,a5);    _XBT_ERR_POST(code)
 /** @hideinitializer  */
-#define xbt_assert(cond)                  if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert0(cond,msg)             if (!(cond)) { CRITICAL0(msg); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert1(cond,msg,a)           if (!(cond)) { CRITICAL1(msg,a); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert2(cond,msg,a,b)         if (!(cond)) { CRITICAL2(msg,a,b); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert3(cond,msg,a,b,c)       if (!(cond)) { CRITICAL3(msg,a,b,c); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert4(cond,msg,a,b,c,d)     if (!(cond)) { CRITICAL4(msg,a,b,c,d); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); xbt_abort(); }
-/** @hideinitializer  */
-#define xbt_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); xbt_abort(); }
-#endif
+#define OLDRAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _XBT_ERR_PRE   ERROR6(fmt,a1,a2,a3,a4,a5,a6); _XBT_ERR_POST(code)
 
-/** @}*/
+/** @} */
 
-/** @name Useful predefined errors 
+/** @name 5. Useful predefined errors 
  *
  *  @{ 
  */
-#define RAISE_IMPOSSIBLE RAISE0(unknown_error,"The Impossible did happen")
-#define RAISE_UNIMPLEMENTED RAISE1(unknown_error,"Function %s unimplemented",__FUNCTION__)
+#define RAISE_IMPOSSIBLE RAISE0(old_unknown_error,"The Impossible did happen (yet again)")
+#define RAISE_UNIMPLEMENTED RAISE1(old_unknown_error,"Function %s unimplemented",__FUNCTION__)
 
-#define DIE_IMPOSSIBLE xbt_assert0(0,"The Impossible did happen (yet again)")
-#define xbt_assert_error(a) xbt_assert1(errcode == (a), "Error %s unexpected",xbt_error_name(errcode))
+#define OLDDIE_IMPOSSIBLE xbt_assert0(0,"The Impossible did happen (yet again)")
+#define OLDxbt_assert_error(a) xbt_assert1(errcode == (a), "Error %s unexpected",xbt_error_name(errcode))
 
-/** @}*/
-/**@}*/
+/** @} */
+/** @} */
 
 END_DECL()