-/* ex - Exception Handling */
-
-/* Copyright (c) 2005-2015. The SimGrid Team.
+/* Copyright (c) 2005-2017. The SimGrid Team.
* All rights reserved. */
/* Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com> */
/* The extensions made for the SimGrid project can either be distributed */
/* under the same license, or under the LGPL v2.1 */
-#ifndef __XBT_EX_H__
-#define __XBT_EX_H__
+#ifndef XBT_EX_H
+#define XBT_EX_H
#include <stdlib.h>
-#ifdef __cplusplus
-#include <string>
-#include <vector>
-#include <stdexcept>
-#endif
-
#include "xbt/base.h"
#include "xbt/sysdep.h"
#include "xbt/misc.h"
#include "xbt/virtu.h"
-/*-*-* Emergency debuging: define this when the exceptions get crazy *-*-*/
-#undef __EX_MAYDAY
-#ifdef __EX_MAYDAY
-# include <stdio.h>
-#include <errno.h>
-# define MAYDAY_SAVE(m) printf("%d %s:%d save %p\n", \
- xbt_getpid(), __FILE__, __LINE__, \
- (m)->jb \
- ),
-# define MAYDAY_RESTORE(m) printf("%d %s:%d restore %p\n", \
- xbt_getpid(), __FILE__, __LINE__, \
- (m)->jb \
- ),
-# define MAYDAY_CATCH(e) printf("%d %s:%d Catched '%s'\n", \
- xbt_getpid(), __FILE__, __LINE__, \
- (e).msg \
- ),
-#else
-# define MAYDAY_SAVE(m)
-# define MAYDAY_RESTORE(m)
-# define MAYDAY_CATCH(e)
-#endif
-/*-*-* end of debugging stuff *-*-*/
-
-/** @brief different kind of errors */
+/** @addtogroup XBT_ex_c
+ * @brief Exceptions support (C)
+ *
+ * Those fonctions are used to throw C++ exceptions from C code. This feature
+ * should probably be removed in the future because C and exception do not
+ * exactly play nicely together.
+ */
+
+/** Categories of errors
+ *
+ * This very similar to std::error_catgory and should probably be replaced
+ * by this in the future.
+ *
+ * @ingroup XBT_ex_c
+ */
typedef enum {
unknown_error = 0, /**< unknown error */
arg_error, /**< Invalid argument */
vm_error /**< vm error */
} xbt_errcat_t;
-#ifdef __cplusplus
-XBT_PUBLIC_CLASS xbt_ex : public std::runtime_error {
-public:
- xbt_ex() : std::runtime_error("") {}
- xbt_ex(const char* message) : std::runtime_error(message) {}
- ~xbt_ex() override;
-
- xbt_errcat_t category; /**< category like HTTP (what went wrong) */
- int value; /**< like errno (why did it went wrong) */
- /* throw point */
- std::string procname; /**< Name of the process who thrown this */
- int pid; /**< PID of the process who thrown this */
- const char *file; /**< Thrown point */
- int line; /**< Thrown point */
- const char *func; /**< Thrown point */
- /* Backtrace */
- std::vector<std::string> bt_strings;
- std::vector<void*> bt;
-};
-#endif
-
SG_BEGIN_DECL()
+/** Get the name of a category
+ * @ingroup XBT_ex_c
+ */
XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
typedef struct xbt_ex xbt_ex_t;
-XBT_PUBLIC(void) xbt_throw(char* message, xbt_errcat_t errcat, int value, const char* file, int line, const char* func) XBT_ATTRIB_NORETURN;
+/** Helper function used to throw exceptions in C */
+XBT_ATTRIB_NORETURN XBT_PUBLIC(void)
+ _xbt_throw(char* message, xbt_errcat_t errcat, int value, const char* file, int line, const char* func);
-/** @brief Builds and throws an exception
- @hideinitializer */
-#define THROW(c, v) { xbt_throw(NULL, (xbt_errcat_t) c, v, __FILE__, __LINE__, __func__); }
+/** Builds and throws an exception
+ * @ingroup XBT_ex_c
+ * @hideinitializer
+ */
+#define THROW(c, v) { _xbt_throw(NULL, (xbt_errcat_t) c, v, __FILE__, __LINE__, __func__); }
-/** @brief Builds and throws an exception with a printf-like formatted message
- @hideinitializer */
-#define THROWF(c, v, ...) xbt_throw(bprintf(__VA_ARGS__), (xbt_errcat_t) c, v, __FILE__, __LINE__, __func__)
+/** Builds and throws an exception with a printf-like formatted message
+ * @ingroup XBT_ex_c
+ * @hideinitializer
+ */
+#define THROWF(c, v, ...) _xbt_throw(bprintf(__VA_ARGS__), (xbt_errcat_t) c, v, __FILE__, __LINE__, __func__)
+/** Throw an exception because someting impossible happened
+ * @ingroup XBT_ex_c
+ */
#define THROW_IMPOSSIBLE \
THROWF(unknown_error, 0, "The Impossible Did Happen (yet again)")
+
+/** Throw an exception because someting unimplemented stuff has been attempted
+ * @ingroup XBT_ex_c
+ */
#define THROW_UNIMPLEMENTED \
THROWF(unknown_error, 0, "Function %s unimplemented",__func__)
+
+/** Throw an exception because some dead code was reached
+ * @ingroup XBT_ex_c
+ */
#define THROW_DEADCODE \
THROWF(unknown_error, 0, "Function %s was supposed to be DEADCODE, but it's not",__func__)
+/** Die because something impossible happened
+ * @ingroup XBT_ex_c
+ */
#define DIE_IMPOSSIBLE xbt_die("The Impossible Did Happen (yet again)")
-/** @brief The display made by an exception that is not catched */
+/** Display an exception */
XBT_PUBLIC(void) xbt_ex_display(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);
-/** @brief Get current backtrace with libunwind */
-XBT_PUBLIC(int) xbt_libunwind_backtrace(void *bt[XBT_BACKTRACE_SIZE], int size);
-
SG_END_DECL()
/** @} */