#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 */
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:
} 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 RAISE0(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 RAISE1(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 RAISE2(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 RAISE3(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 RAISE4(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)
+#define RAISE5(code,fmt,a1,a2,a3,a4,a5) _XBT_ERR_PRE ERROR5(fmt,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)
+#define RAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _XBT_ERR_PRE ERROR6(fmt,a1,a2,a3,a4,a5,a6); _XBT_ERR_POST(code)
-/**@}*/
+/** @} */
/**
- * \name assert macro familly
+ * \name 4. 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.
+ * arguments, just as if it where a printf. It is converted to a CRITICALn logging request.
*
* @{
*/
#define xbt_assert5(cond,msg,a,b,c,d,e)
#define xbt_assert6(cond,msg,a,b,c,d,e,f)
#else
-/** @hideinitializer */
+/** @brief The condition which failed will be displayed.
+ @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(); }
#define xbt_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); xbt_abort(); }
#endif
-/** @}*/
+/** @} */
-/** @name Useful predefined errors
+/** @name 5. Useful predefined errors
*
* @{
*/
#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))
-/** @}*/
-/**@}*/
+/** @} */
+/** @} */
END_DECL()
