Cleanup malek's add

[simgrid.git] / include / xbt / ex.h

diff --git a/include/xbt/ex.h b/include/xbt/ex.h
index dfa3bad..269556b 100644 (file)
--- a/include/xbt/ex.h
+++ b/include/xbt/ex.h
@@ -53,7 +53,10 @@ int gras_os_getpid(void);
 
 
 /* the machine context */
-#if defined(__EX_MCTX_MCSC__)
+#if defined(_WIN32) || defined(__WIN32__) || defined(WIN32) | defined(__TOS_WIN__)
+#include "xbt/win32_context.h"
+
+#elif defined(__EX_MCTX_MCSC__)
 #include <ucontext.h>            /* POSIX.1 ucontext(3) */
 #define __ex_mctx_struct         ucontext_t uc;
 #define __ex_mctx_save(mctx)     (getcontext(&(mctx)->uc) == 0)
@@ -157,7 +160,14 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t;
  * This is because there is some hidden setup and
  * cleanup that needs to be done regardless of whether an exception is
  * caught. Bypassing these steps will break the exception handling facility.
- *     
+ * The symptom are likely to be a segfault at the next exception raising point,  
+ * ie far away from the point where you did the mistake. If you suspect
+ * that kind of error in your code, have a look at the little script
+ * <tt>tools/xbt_exception_checker</tt> in the CVS. It extracts all the TRY
+ * blocks from a set of C files you give it and display them (and only
+ * them) on the standard output. You can then grep for the forbidden 
+ * keywords on that output.
+ *   
  * The CLEANUP and CATCH blocks are regular ISO-C language statement
  * blocks without any restrictions. You are even allowed to throw (and, in the
  * CATCH block, to re-throw) exceptions.
@@ -165,7 +175,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t;
  * There is one subtle detail you should remember about TRY blocks:
  * Variables used in the CLEANUP or CATCH clauses must be declared with
  * the storage class "volatile", otherwise they might contain outdated
- * information if an exception it thrown.
+ * information if an exception is thrown.
  *
  *
  * This is because you usually do not know which commands in the TRY
@@ -244,18 +254,18 @@ const char * xbt_ex_catname(xbt_errcat_t cat);
 
 /** @brief Structure describing an exception */
 typedef struct {
-  char        *msg;      /**< human readable message; to be freed */
+  char        *msg;      /**< human readable message */
   xbt_errcat_t category; /**< category like HTTP (what went wrong) */
   int          value;    /**< like errno (why did it went wrong) */
   /* throw point */
-  short int remote; /* whether it was raised remotely */
-  char *host;     /* NULL for localhost; hostname if remote */
+  short int remote; /**< whether it was raised remotely */
+  char *host;     /**< NULL locally thrown exceptions; full hostname if remote ones */
   /* FIXME: host should be hostname:port[#thread] */
-  char *procname; 
-  long int pid;
-  char *file;     /**< to be freed only for remote exceptions */
-  int   line;     
-  char *func;     /**< to be freed only for remote exceptions */
+  char *procname; /**< Name of the process who thrown this */
+  long int pid;   /**< PID of the process who thrown this */
+  char *file;     /**< Thrown point */
+  int   line;     /**< Thrown point */
+  char *func;     /**< Thrown point */
   /* Backtrace */
   int   used;
   char **bt_strings; /* only filed on display (or before the network propagation) */
@@ -441,7 +451,7 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e);
 #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 THROW_IMPOSSIBLE     THROW0(unknown_error,0,"The Impossible Did Happen (yet again)")
-#define THROW_UNIMPLEMENTED  THROW1(unknown_error,0,"Function %s unimplemented",__FUNCTION__)
+#define THROW_UNIMPLEMENTED  THROW1(unknown_error,0,"Function %s unimplemented",_XBT_FUNCTION)
 
 #ifndef NDEBUG
 #  define DIE_IMPOSSIBLE       xbt_assert0(0,"The Impossible Did Happen (yet again)")