Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
effect of redefinition of the macro XBT_PUBLIC_DATA
[simgrid.git] / include / xbt / ex.h
index 843cf6d..0eda539 100644 (file)
@@ -19,7 +19,7 @@
 
 /* do not include execinfo.h directly since it's not always available. 
    Instead, copy the parts we need (and fake when it's not there) */
-extern int backtrace (void **__array, int __size);
+XBT_PUBLIC(int) backtrace (void **__array, int __size);
 
 /* required ISO-C standard facilities */
 #include <errno.h>
@@ -30,7 +30,7 @@ extern int backtrace (void **__array, int __size);
 #undef __EX_MAYDAY
 
 #ifdef __EX_MAYDAY
-int gras_os_getpid(void);
+XBT_PUBLIC(int) gras_os_getpid(void);
 #  define MAYDAY_SAVE(m)    printf("%d %s:%d save %p\n",                \
                                    gras_os_getpid(),__FILE__,__LINE__,  \
                                    (m)->jb                              \
@@ -51,8 +51,6 @@ int gras_os_getpid(void);
 
 /*-*-* end of debugging stuff *-*-*/
 
-
-/* the machine context */
 #if defined(__EX_MCTX_MCSC__)
 #include <ucontext.h>            /* POSIX.1 ucontext(3) */
 #define __ex_mctx_struct         ucontext_t uc;
@@ -157,7 +155,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 +170,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
@@ -225,7 +230,7 @@ typedef struct { __ex_mctx_struct } __ex_mctx_t;
  */
 
 /* we need this symbol here, even if it breaks a bit the module separation */
-long int gras_os_getpid(void);
+XBT_PUBLIC(long) int gras_os_getpid(void);
 
 /** @brief different kind of errors */
 typedef enum {
@@ -240,7 +245,7 @@ typedef enum {
   thread_error    /**< error while [un]locking */
 } xbt_errcat_t;
 
-const char * xbt_ex_catname(xbt_errcat_t cat);
+XBT_PUBLIC(const char *) xbt_ex_catname(xbt_errcat_t cat);
 
 /** @brief Structure describing an exception */
 typedef struct {
@@ -304,12 +309,12 @@ typedef struct {
 
 /* the exception context */
 typedef ex_ctx_t *(*ex_ctx_cb_t)(void);
-extern ex_ctx_cb_t __xbt_ex_ctx;
+extern ex_ctx_cb_t XBT_PUBLIC_DATA __xbt_ex_ctx;
 extern ex_ctx_t *__xbt_ex_ctx_default(void);
 
 /* the termination handler */
 typedef void (*ex_term_cb_t)(xbt_ex_t *);
-extern ex_term_cb_t __xbt_ex_terminate;
+extern ex_term_cb_t XBT_PUBLIC_DATA __xbt_ex_terminate;
 extern void __xbt_ex_terminate_default(xbt_ex_t *e);
 
 /** @brief Introduce a block where exception may be dealed with 
@@ -441,7 +446,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)")
@@ -500,10 +505,10 @@ extern void __xbt_ex_terminate_default(xbt_ex_t *e);
 #define RETHROW5(msg,a,b,c,d,e) _XBT_PRE_RETHROW msg,a,b,c,d,e, _XBT_POST_RETHROW
 
 /** @brief Exception destructor */
-void xbt_ex_free(xbt_ex_t e);
+XBT_PUBLIC(void) xbt_ex_free(xbt_ex_t e);
 
-void xbt_ex_display(xbt_ex_t *e);
-void xbt_backtrace_display(void);
+XBT_PUBLIC(void) xbt_ex_display(xbt_ex_t *e);
+XBT_PUBLIC(void) xbt_backtrace_display(void);
 
 /** @} */
 #endif /* __XBT_EX_H__ */