/* $Id$ */
-/* gras/error.h - Error tracking support */
+/* xbt/error.h - Error tracking support */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2003 the OURAGAN project. */
+/* Copyright (c) 2003, 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
-
-#ifndef GRAS_ERROR_H
-#define GRAS_ERROR_H
-
-#include <stddef.h> /* offsetof() */
-#include <sys/types.h> /* size_t */
-#include <stdarg.h>
+#ifndef XBT_ERROR_H
+#define XBT_ERROR_H
#include <stdio.h> /* FIXME: Get rid of it */
+#include "xbt/misc.h" /* BEGIN_DECL */
#include "xbt/log.h"
-#ifdef HAVE_EXECINFO_H
-#include <execinfo.h> /* to print the backtrace */
-#endif
-
-/* C++ users need love */
-#ifndef BEGIN_DECL
-# ifdef __cplusplus
-# define BEGIN_DECL extern "C" {
-# else
-# define BEGIN_DECL
-# endif
-#endif
+BEGIN_DECL()
-/*! C++ users need love */
-#ifndef END_DECL
-# ifdef __cplusplus
-# define END_DECL }
-# else
-# define END_DECL
-# endif
-#endif
-/* End of cruft for C++ */
-
-BEGIN_DECL
+/** @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.
+ *
+ * @{*/
+/** @name 1. Type definition and basic operations
+ *
+ * @{
+ */
+/** \brief Error types */
typedef enum {
- no_error=0, /* succes */
-// malloc_error, /* Well known error */
- mismatch_error, /* The provided ID does not match */
- system_error, /* a syscall did fail */
- network_error, /* error while sending/receiving data */
- timeout_error, /* not quick enough, dude */
- thread_error, /* error while [un]locking */
- unknown_error
-} gras_error_t;
-
-/*@observer@*/ const char *gras_error_name(gras_error_t errcode);
-
-#define TRY(a) do { \
- if ((errcode=a) != no_error) { \
- fprintf (stderr, "%s:%d: '%s' error raising...\n", \
- __FILE__,__LINE__, \
- gras_error_name(errcode)); \
- return errcode; \
+ 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 */
+
+ /* 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);
+ void xbt_abort(void) _XBT_GNUC_NORETURN;
+ void xbt_die(const char *msg) _XBT_GNUC_NORETURN;
+
+/** @} */
+
+/** @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:
+ * \verbatim xbt_error_t errcode;\endverbatim
+ * @{
+ */
+
+/** @brief return the error code if != no_error
+ * @hideinitializer
+ */
+#define TRY(action) do { \
+ if ((errcode=action) != no_error) { \
+ ERROR1("'%s' error raising...", xbt_error_name(errcode)); \
+ return errcode; \
} } while (0)
-#define TRYCATCH(a,b) if ((errcode=a) != no_error && errcode !=b) return errcode
-#define TRYFAIL(a) do { \
- if ((errcode=a) != no_error) { \
- fprintf(stderr,"%s:%d: Got '%s' error !\n", \
- __FILE__,__LINE__, \
- gras_error_name(errcode)); \
+/** @brief return the error code if != no_error and != \a catched
+ * @hideinitializer
+ */
+#define TRYCATCH(action,catched) if ((errcode=action) != no_error && errcode !=catched) return errcode
+
+/** @brief xbt_abort if the error code != no_error
+ * @hideinitializer
+ */
+#define TRYFAIL(action) do { \
+ if ((errcode=action) != no_error) { \
+ ERROR1("Got '%s' error !", xbt_error_name(errcode)); \
fflush(stdout); \
- gras_abort(); \
+ xbt_abort(); \
} } while(0)
+
+/** @brief return the error code if != \a expected_error (no_error not ok)
+ * @hideinitializer
+ */
#define TRYEXPECT(action,expected_error) do { \
errcode=action; \
if (errcode != expected_error) { \
- fprintf(stderr,"Got error %s (instead of %s expected)\n", \
- gras_error_name(errcode), \
- gras_error_name(expected_error)); \
- gras_abort(); \
+ ERROR2("Got error %s (instead of %s expected)\n", \
+ xbt_error_name(errcode), \
+ xbt_error_name(expected_error)); \
+ xbt_abort(); \
} \
} while(0)
-/* FIXME TRYCLEAN should be avoided for readability */
-#define TRYCLEAN(action,cleanup) do { \
- if ((errcode=action) != no_error) { \
- cleanup; \
- return errcode; \
- } \
-} while(0)
+/** @}*/
-#if 0 /* FIXME: We don't use backtrace. Drop it? */
-#define _GRAS_ERR_PRE do { \
- void *_gs_array[30]; \
- size_t _gs_size= backtrace (_gs_array, 30); \
- char **_gs_strings= backtrace_symbols (_gs_array, _gs_size); \
- size_t _gs_i;
-
-#define _GRAS_ERR_POST(code) \
- fprintf(stderr,"Backtrace follows\n"); \
- for (_gs_i = 0; _gs_i < _gs_size; _gs_i++) \
- fprintf (stderr," %s\n", _gs_strings[_gs_i]); \
+#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 ERROR0(fmt); _XBT_ERR_POST(code)
+/** @hideinitializer */
+#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 ERROR2(fmt,a1,a2); _XBT_ERR_POST(code)
+/** @hideinitializer */
+#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 ERROR4(fmt,a1,a2,a3,a4); _XBT_ERR_POST(code)
+/** @hideinitializer */
+#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 ERROR6(fmt,a1,a2,a3,a4,a5,a6); _XBT_ERR_POST(code)
+
+/** @} */
+/**
+ * \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. It is converted to a CRITICALn logging request.
+ *
+ * @{
+ */
+#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 _GRAS_ERR_PRE do {
-#define _GRAS_ERR_POST(code) \
- return code; \
-} while (0)
+/** @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(); }
+/** @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 RAISE0(code,fmt) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__); \
- _GRAS_ERR_POST(code)
-#define RAISE1(code,fmt,a1) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1); \
- _GRAS_ERR_POST(code)
-#define RAISE2(code,fmt,a1,a2) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1,a2); \
- _GRAS_ERR_POST(code)
-#define RAISE3(code,fmt,a1,a2,a3) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1,a2,a3); \
- _GRAS_ERR_POST(code)
-#define RAISE4(code,fmt,a1,a2,a3,a4) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4); \
- _GRAS_ERR_POST(code)
-#define RAISE5(code,fmt,a1,a2,a3,a4,a5) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5); \
- _GRAS_ERR_POST(code)
-#define RAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _GRAS_ERR_PRE \
- fprintf(stderr,"%s:%d:%s: " fmt "\n", \
- __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5,a6); \
- _GRAS_ERR_POST(code)
-
-//#define RAISE_MALLOC RAISE0(malloc_error,"Malloc error")
+/** @} */
+
+/** @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__)
-#ifdef NDEBUG
-#define gras_assert(cond)
-#define gras_assert0(cond,msg)
-#define gras_assert1(cond,msg,a)
-#define gras_assert2(cond,msg,a,b)
-#define gras_assert3(cond,msg,a,b,c)
-#define gras_assert4(cond,msg,a,b,c,d)
-#define gras_assert5(cond,msg,a,b,c,d,e)
-#define gras_assert6(cond,msg,a,b,c,d,e,f)
-#else
-#define gras_assert(cond) if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); gras_abort(); }
-#define gras_assert0(cond,msg) if (!(cond)) { CRITICAL0(msg); gras_abort(); }
-#define gras_assert1(cond,msg,a) if (!(cond)) { CRITICAL1(msg,a); gras_abort(); }
-#define gras_assert2(cond,msg,a,b) if (!(cond)) { CRITICAL2(msg,a,b); gras_abort(); }
-#define gras_assert3(cond,msg,a,b,c) if (!(cond)) { CRITICAL3(msg,a,b,c); gras_abort(); }
-#define gras_assert4(cond,msg,a,b,c,d) if (!(cond)) { CRITICAL4(msg,a,b,c,d); gras_abort(); }
-#define gras_assert5(cond,msg,a,b,c,d,e) if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); gras_abort(); }
-#define gras_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); gras_abort(); }
-#endif
-
-#define DIE_IMPOSSIBLE gras_assert0(0,"The Impossible did happen (yet again)")
-#define gras_assert_error(a) gras_assert1(errcode == (a), "Error %s unexpected",gras_error_name(errcode))
+#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
+/** @} */
+/** @} */
-#endif /* GRAS_ERROR_H */
+END_DECL()
+#endif /* XBT_ERROR_H */
