Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Tweak things here and there so that we can propagate exceptions across the network...
[simgrid.git] / include / xbt / ex.h
1 /*
2 **  OSSP ex - Exception Handling (modified to fit into SimGrid)
3 **  Copyright (c) 2005 Martin Quinson.
4 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
5 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
6 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
7 **
8 **  This file is part of OSSP ex, an exception handling library
9 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
10 **
11 **  Permission to use, copy, modify, and distribute this software for
12 **  any purpose with or without fee is hereby granted, provided that
13 **  the above copyright notice and this permission notice appear in all
14 **  copies.
15 **
16 **  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
17 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
20 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 **  SUCH DAMAGE.
28 **
29 **  ex.h: exception handling (pre-processor part)
30 */
31
32 #ifndef __XBT_EX_H__
33 #define __XBT_EX_H__
34
35 #include <xbt/sysdep.h>
36 #include <xbt/misc.h>
37
38 /* do not include execinfo.h directly since it's not always available. 
39    Instead, copy the parts we need (and fake when it's not there) */
40 extern int backtrace (void **__array, int __size);
41
42 /* required ISO-C standard facilities */
43 #include <errno.h>
44 #include <stdio.h>
45
46 /* the machine context */
47 #if defined(__EX_MCTX_MCSC__)
48 #include <ucontext.h>            /* POSIX.1 ucontext(3) */
49 #define __ex_mctx_struct         ucontext_t uc;
50 #define __ex_mctx_save(mctx)     (getcontext(&(mctx)->uc) == 0)
51 #define __ex_mctx_restored(mctx) /* noop */
52 #define __ex_mctx_restore(mctx)  (void)setcontext(&(mctx)->uc)
53
54 #elif defined(__EX_MCTX_SSJLJ__)
55 #include <setjmp.h>              /* POSIX.1 sigjmp_buf(3) */
56 #define __ex_mctx_struct         sigjmp_buf jb;
57 #define __ex_mctx_save(mctx)     (sigsetjmp((mctx)->jb, 1) == 0)
58 #define __ex_mctx_restored(mctx) /* noop */
59 #define __ex_mctx_restore(mctx)  (void)siglongjmp((mctx)->jb, 1)
60
61 #elif defined(__EX_MCTX_SJLJ__) || !defined(__EX_MCTX_CUSTOM__)
62 #include <setjmp.h>              /* ISO-C jmp_buf(3) */
63 #define __ex_mctx_struct         jmp_buf jb;
64 #define __ex_mctx_save(mctx)     (setjmp((mctx)->jb) == 0)
65 #define __ex_mctx_restored(mctx) /* noop */
66 #define __ex_mctx_restore(mctx)  (void)longjmp((mctx)->jb, 1)
67 #endif
68
69 /* declare the machine context type */
70 typedef struct { __ex_mctx_struct } __ex_mctx_t;
71  
72 /** @addtogroup XBT_ex
73  *  @brief A set of macros providing exception a la C++ in ANSI C (grounding feature)
74  *
75  * This module is a small ISO-C++ style exception handling library
76  * for use in the ISO-C language. It allows you to use the paradigm 
77  * of throwing and catching exceptions in order to reduce the amount
78  * of error handling code without hindering program robustness.
79  *               
80  * This is achieved by directly transferring exceptional return codes
81  * (and the program control flow) from the location where the exception
82  * is raised (throw point) to the location where it is handled (catch
83  * point) -- usually from a deeply nested sub-routine to a parent 
84  * routine. All intermediate routines no longer have to make sure that 
85  * the exceptional return codes from sub-routines are correctly passed 
86  * back to the parent.
87  *
88  * These features are brought to you by a modified version of the libex 
89  * library, one of the numerous masterpiece of Ralf S. Engelschall.
90  *
91  * \htmlonly <div class="toc">\endhtmlonly
92  *
93  * @section XBT_ex_toc TABLE OF CONTENTS
94  *
95  *  - \ref XBT_ex_intro
96  *  - \ref XBT_ex_base
97  *  - \ref XBT_ex_pitfalls
98  *
99  * \htmlonly </div> \endhtmlonly
100  *
101  * @section XBT_ex_intro DESCRIPTION
102  * 
103  * In SimGrid, an exception is a triple <\a msg , \a category , \a value> 
104  * where \a msg is a human-readable text describing the exceptional 
105  * condition, \a code an integer describing what went wrong and \a value
106  * providing a sort of sub-category. (this is different in the original libex).
107  *
108  * @section XBT_ex_base BASIC USAGE
109  *
110  * \em TRY \b TRIED_BLOCK [\em CLEANUP \b CLEANUP_BLOCK] \em CATCH (variable) \b CATCH_BLOCK
111  *
112  * This is the primary syntactical construct provided. It is modeled after the
113  * ISO-C++ try-catch clause and should sound familiar to most of you.
114  *
115  * Any exception thrown directly from the TRIED_BLOCK block or from called
116  * subroutines is caught. Cleanups which must be done after this block
117  * (whenever an exception arised or not) should be placed into the optionnal
118  * CLEANUP_BLOCK. The code dealing with the exceptions when they arise should
119  * be placed into the (mandatory) CATCH_BLOCK.
120  *
121  * 
122  * In absence of exception, the control flow goes into the blocks TRIED_BLOCK
123  * and CLEANUP_BLOCK (if present); The CATCH_BLOCK block is then ignored. 
124  *
125  * When an exception is thrown, the control flow goes through the following
126  * blocks: TRIED_BLOCK (up to the statement throwing the exception),
127  * CLEANUP_BLOCK (if any) and CATCH_BLOCK. The exception is stored in a
128  * variable for inspection inside the CATCH_BLOCK. This variable must be
129  * declared in the outter scope, but its value is only valid within the
130  * CATCH_BLOCK block. 
131  *
132  * Some notes:
133  *  - TRY, CLEANUP and CATCH cannot be used separately, they work
134  *    only in combination and form a language clause as a whole.
135  *  - In contrast to the syntax of other languages (such as C++ or Jave) there
136  *    is only one CATCH block and not multiple ones (all exceptions are
137  *    of the same \em xbt_ex_t C type). 
138  *  - the variable of CATCH can naturally be reused in subsequent 
139  *    CATCH clauses.
140  *  - it is possible to nest TRY clauses.
141  *
142  * The TRY block is a regular ISO-C language statement block, but it is not
143  * allowed to jump into it via "goto" or longjmp(3) or out of it via "break",
144  * "return", "goto" or longjmp(3) because there is some hidden setup and
145  * cleanup that needs to be done regardless of whether an exception is
146  * caught. Bypassing these steps will break the exception handling facility.
147  *     
148  * The CLEANUP and CATCH blocks are regular ISO-C language statement
149  * blocks without any restrictions. You are even allowed to throw (and, in the
150  * CATCH block, to re-throw) exceptions.
151  *
152  * There is one subtle detail you should remember about TRY blocks:
153  * Variables used in the CLEANUP or CATCH clauses must be declared with
154  * the storage class "volatile", otherwise they might contain outdated
155  * information if an exception it thrown.
156  *
157  *
158  * This is because you usually do not know which commands in the TRY
159  * were already successful before the exception was thrown (logically speaking)
160  * and because the underlying ISO-C setjmp(3) facility applies those
161  * restrictions (technically speaking). As a matter of fact, value changes
162  * between the TRY and the THROW may be discarded if you forget the
163  * "volatile" keyword. 
164  * 
165  * \section XBT_ex_pitfalls PROGRAMMING PITFALLS 
166  *
167  * Exception handling is a very elegant and efficient way of dealing with
168  * exceptional situation. Nevertheless it requires additional discipline in
169  * programming and there are a few pitfalls one must be aware of. Look the
170  * following code which shows some pitfalls and contains many errors (assuming
171  * a mallocex() function which throws an exception if malloc(3) fails):
172  *
173  * \dontinclude ex.c
174  * \skip BAD_EXAMPLE
175  * \until end_of_bad_example
176  *
177  * This example raises a few issues:
178  *  -# \b variable \b scope \n
179  *     Variables which are used in the CLEANUP or CATCH clauses must be
180  *     declared before the TRY clause, otherwise they only exist inside the
181  *     TRY block. In the example above, cp1, cp2 and cp3 only exist in the
182  *     TRY block and are invisible from the CLEANUP and CATCH
183  *     blocks.
184  *  -# \b variable \b initialization \n
185  *     Variables which are used in the CLEANUP or CATCH clauses must
186  *     be initialized before the point of the first possible THROW is
187  *     reached. In the example above, CLEANUP would have trouble using cp3
188  *     if mallocex() throws a exception when allocating a TOOBIG buffer.
189  *  -# \b volatile \b variable \n
190  *     Variables which are used in the CLEANUP or CATCH clauses MUST BE
191  *     DECLARED AS "volatile", otherwise they might contain outdated
192  *     information when an exception is thrown. 
193  *  -# \b clean \b before \b catch \n
194  *     The CLEANUP clause is not only place before the CATCH clause in
195  *     the source code, it also occures before in the control flow. So,
196  *     resources being cleaned up cannot be used in the CATCH block. In the
197  *     example, c3 gets freed before the printf placed in CATCH.
198  *  -# \b variable \b uninitialization \n
199  *     If resources are passed out of the scope of the
200  *     TRY/CLEANUP/CATCH construct, they naturally shouldn't get
201  *     cleaned up. The example above does free(3) cp1 in CLEANUP although
202  *     its value was affected to globalcontext->first, invalidating this
203  *     pointer.
204
205  * The following is fixed version of the code (annotated with the pitfall items
206  * for reference): 
207  *
208  * \skip GOOD_EXAMPLE
209  * \until end_of_good_example
210  *
211  * @{
212  */
213
214 /** @brief different kind of errors */
215 typedef enum {
216   unknown_error=0,  /**< unknown error */
217   arg_error,        /**< Invalid argument */
218   mismatch_error,   /**< The provided ID does not match */
219   not_found_error,  /**< The searched element was not found */
220   
221   system_error,   /**< a syscall did fail */
222   network_error,  /**< error while sending/receiving data */
223   timeout_error,  /**< not quick enough, dude */
224   thread_error    /**< error while [un]locking */
225 } xbt_errcat_t;
226
227 const char * xbt_ex_catname(xbt_errcat_t cat);
228
229 /** @brief Structure describing an exception */
230 typedef struct {
231   char        *msg;      /**< human readable message; to be freed */
232   xbt_errcat_t category; /**< category like HTTP (what went wrong) */
233   int          value;    /**< like errno (why did it went wrong) */
234   /* throw point */
235   char *host;     /* NULL for localhost; hostname if remote */
236   /* FIXME: host should be hostname:port[#thread] */
237   char *procname; 
238   char *file;     /**< to be freed only for remote exceptions */
239   int   line;     
240   char *func;     /**< to be freed only for remote exceptions */
241   /* Backtrace */
242   int   used;
243   char **bt_strings; /* only filed on display (or before the network propagation) */
244   void *bt[XBT_BACKTRACE_SIZE];
245 } xbt_ex_t;
246
247 /* declare the context type (private) */
248 typedef struct {
249     __ex_mctx_t  *ctx_mctx;     /* permanent machine context of enclosing try/catch */
250     int           ctx_caught;   /* temporary flag whether exception was caught */
251     volatile xbt_ex_t ctx_ex;       /* temporary exception storage */
252 } ex_ctx_t;
253
254 /* the static and dynamic initializers for a context structure */
255 #define XBT_CTX_INITIALIZER \
256     { NULL, 0, { /* content */ NULL, unknown_error, 0, \
257                  /* throw point*/ NULL, NULL, NULL, 0, NULL,\
258                  /* backtrace */ 0,NULL,{NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL,NULL} } }
259 #define XBT_CTX_INITIALIZE(ctx) \
260     do { \
261         (ctx)->ctx_mctx          = NULL; \
262         (ctx)->ctx_caught        = 0;    \
263         (ctx)->ctx_ex.msg        = NULL; \
264         (ctx)->ctx_ex.category   = 0;    \
265         (ctx)->ctx_ex.value      = 0;    \
266         (ctx)->ctx_ex.host       = NULL; \
267         (ctx)->ctx_ex.procname   = NULL; \
268         (ctx)->ctx_ex.file       = NULL; \
269         (ctx)->ctx_ex.line       = 0;    \
270         (ctx)->ctx_ex.func       = NULL; \
271         (ctx)->ctx_ex.bt[0]      = NULL; \
272         (ctx)->ctx_ex.bt[1]      = NULL; \
273         (ctx)->ctx_ex.bt[2]      = NULL; \
274         (ctx)->ctx_ex.bt[3]      = NULL; \
275         (ctx)->ctx_ex.bt[4]      = NULL; \
276         (ctx)->ctx_ex.bt[5]      = NULL; \
277         (ctx)->ctx_ex.bt[6]      = NULL; \
278         (ctx)->ctx_ex.bt[7]      = NULL; \
279         (ctx)->ctx_ex.bt[8]      = NULL; \
280         (ctx)->ctx_ex.bt[9]      = NULL; \
281         (ctx)->ctx_ex.used       = 0; \
282         (ctx)->ctx_ex.bt_strings = NULL; \
283     } while (0)
284
285 /* the exception context */
286 typedef ex_ctx_t *(*ex_ctx_cb_t)(void);
287 extern ex_ctx_cb_t __xbt_ex_ctx;
288 extern ex_ctx_t *__xbt_ex_ctx_default(void);
289
290 /* the termination handler */
291 typedef void (*ex_term_cb_t)(xbt_ex_t *);
292 extern ex_term_cb_t __xbt_ex_terminate;
293 extern void __xbt_ex_terminate_default(xbt_ex_t *e);
294
295 /** @brief Introduce a block where exception may be dealed with 
296  *  @hideinitializer
297  */
298 #define TRY \
299     { \
300         ex_ctx_t *__xbt_ex_ctx_ptr = __xbt_ex_ctx(); \
301         int __ex_cleanup = 0; \
302         __ex_mctx_t *__ex_mctx_en; \
303         __ex_mctx_t __ex_mctx_me; \
304         __ex_mctx_en = __xbt_ex_ctx_ptr->ctx_mctx; \
305         __xbt_ex_ctx_ptr->ctx_mctx = &__ex_mctx_me; \
306         if (__ex_mctx_save(&__ex_mctx_me)) { \
307             if (1)
308
309 /** @brief optional(!) block for cleanup 
310  *  @hideinitializer
311  */
312 #define CLEANUP \
313             else { \
314             } \
315             __xbt_ex_ctx_ptr->ctx_caught = 0; \
316         } else { \
317             __ex_mctx_restored(&__ex_mctx_me); \
318             __xbt_ex_ctx_ptr->ctx_caught = 1; \
319         } \
320         __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
321         __ex_cleanup = 1; \
322         if (1) { \
323             if (1)
324
325 #ifndef DOXYGEN_SKIP
326 #  ifdef __cplusplus
327 #    define XBT_EX_T_CPLUSPLUSCAST (xbt_ex_t&)
328 #  else
329 #    define XBT_EX_T_CPLUSPLUSCAST 
330 #  endif
331 #endif
332
333 /** @brief the block for catching (ie, deal with) an exception 
334  *  @hideinitializer
335  */
336 #define CATCH(e) \
337             else { \
338             } \
339             if (!(__ex_cleanup)) \
340                 __xbt_ex_ctx_ptr->ctx_caught = 0; \
341         } else { \
342             if (!(__ex_cleanup)) { \
343                 __ex_mctx_restored(&__ex_mctx_me); \
344                 __xbt_ex_ctx_ptr->ctx_caught = 1; \
345             } \
346         } \
347         __xbt_ex_ctx_ptr->ctx_mctx = __ex_mctx_en; \
348     } \
349     if (   !(__xbt_ex_ctx()->ctx_caught) \
350         || ((e) = XBT_EX_T_CPLUSPLUSCAST __xbt_ex_ctx()->ctx_ex, 0)) { \
351     } \
352     else
353
354 #define DO_THROW(e) \
355      /* deal with the exception */                                             \
356      if (__xbt_ex_ctx()->ctx_mctx == NULL)                                     \
357        __xbt_ex_terminate((xbt_ex_t *)&(e)); /* not catched */\
358      else                                                                      \
359        __ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx); /* catched somewhere */    \
360      abort()/* nope, stupid GCC, we won't survive a THROW (this won't be reached) */
361
362 /** @brief Helper macro for THROWS0-6
363  *  @hideinitializer
364  *
365  *  @param c: category code (integer)
366  *  @param v: value (integer)
367  *  @param m: message text
368  *
369  * If called from within a TRY/CATCH construct, this exception 
370  * is copied into the CATCH relevant variable program control flow 
371  * is derouted to the CATCH (after the optional sg_cleanup). 
372  *
373  * If no TRY/CATCH construct embeeds this call, the program calls
374  * abort(3). 
375  *
376  * The THROW can be performed everywhere, including inside TRY, 
377  * CLEANUP and CATCH blocks.
378  */
379
380 #define _THROW(c,v,m) \
381   do { /* change this sequence into one block */                               \
382      /* build the exception */ \
383      __xbt_ex_ctx()->ctx_ex.msg      = (m); \
384      __xbt_ex_ctx()->ctx_ex.category = (xbt_errcat_t)(c); \
385      __xbt_ex_ctx()->ctx_ex.value    = (v);  \
386      __xbt_ex_ctx()->ctx_ex.host     = (char*)NULL;                            \
387      __xbt_ex_ctx()->ctx_ex.procname = strdup(xbt_procname());                 \
388      __xbt_ex_ctx()->ctx_ex.file     = (char*)__FILE__;                        \
389      __xbt_ex_ctx()->ctx_ex.line     = __LINE__;                               \
390      __xbt_ex_ctx()->ctx_ex.func     = (char*)_XBT_FUNCTION;                   \
391      __xbt_ex_ctx()->ctx_ex.used     = backtrace((void**)__xbt_ex_ctx()->ctx_ex.bt,XBT_BACKTRACE_SIZE);\
392      DO_THROW(__xbt_ex_ctx()->ctx_ex);\
393   } while (0)
394
395 /** @brief Builds and throws an exception with a string taking no arguments
396     @hideinitializer */
397 #define THROW0(c,v,m)                   _THROW(c,v,(m?bprintf(m):NULL))
398 /** @brief Builds and throws an exception with a string taking one argument
399     @hideinitializer */
400 #define THROW1(c,v,m,a1)                _THROW(c,v,bprintf(m,a1))
401 /** @brief Builds and throws an exception with a string taking two arguments
402     @hideinitializer */
403 #define THROW2(c,v,m,a1,a2)             _THROW(c,v,bprintf(m,a1,a2))
404 /** @brief Builds and throws an exception with a string taking three arguments
405     @hideinitializer */
406 #define THROW3(c,v,m,a1,a2,a3)          _THROW(c,v,bprintf(m,a1,a2,a3))
407 /** @brief Builds and throws an exception with a string taking four arguments
408     @hideinitializer */
409 #define THROW4(c,v,m,a1,a2,a3,a4)       _THROW(c,v,bprintf(m,a1,a2,a3,a4))
410 /** @brief Builds and throws an exception with a string taking five arguments
411     @hideinitializer */
412 #define THROW5(c,v,m,a1,a2,a3,a4,a5)    _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5))
413 /** @brief Builds and throws an exception with a string taking six arguments
414     @hideinitializer */
415 #define THROW6(c,v,m,a1,a2,a3,a4,a5,a6) _THROW(c,v,bprintf(m,a1,a2,a3,a4,a5,a6))
416
417 #define THROW_IMPOSSIBLE     THROW0(unknown_error,0,"The Impossible Did Happen (yet again)")
418 #define THROW_UNIMPLEMENTED  THROW1(unknown_error,0,"Function %s unimplemented",__FUNCTION__)
419
420 #ifndef NDEBUG
421 #  define DIE_IMPOSSIBLE       xbt_assert0(0,"The Impossible Did Happen (yet again)")
422 #else
423 #  define DIE_IMPOSSIBLE       exit(1);
424 #endif
425
426 /** @brief re-throwing of an already caught exception (ie, pass it to the upper catch block) 
427  *  @hideinitializer
428  */
429 #define RETHROW \
430   do { \
431    if (__xbt_ex_ctx()->ctx_mctx == NULL) \
432      __xbt_ex_terminate((xbt_ex_t *)&(__xbt_ex_ctx()->ctx_ex)); \
433    else \
434      __ex_mctx_restore(__xbt_ex_ctx()->ctx_mctx); \
435    abort();\
436   } while(0)
437
438
439 #ifndef DOXYGEN_SKIP
440 #define _XBT_PRE_RETHROW \
441   do {                                                               \
442     char *_xbt_ex_internal_msg = __xbt_ex_ctx()->ctx_ex.msg;         \
443     __xbt_ex_ctx()->ctx_ex.msg = bprintf(
444 #define _XBT_POST_RETHROW \
445  _xbt_ex_internal_msg); \
446     free(_xbt_ex_internal_msg);                                      \
447     RETHROW;                                                         \
448   } while (0)
449 #endif
450
451 /** @brief like THROW0, but adding some details to the message of an existing exception
452  *  @hideinitializer
453  */
454 #define RETHROW0(msg)           _XBT_PRE_RETHROW msg,          _XBT_POST_RETHROW
455 /** @brief like THROW1, but adding some details to the message of an existing exception
456  *  @hideinitializer
457  */
458 #define RETHROW1(msg,a)         _XBT_PRE_RETHROW msg,a,        _XBT_POST_RETHROW
459 /** @brief like THROW2, but adding some details to the message of an existing exception
460  *  @hideinitializer
461  */
462 #define RETHROW2(msg,a,b)       _XBT_PRE_RETHROW msg,a,b,      _XBT_POST_RETHROW
463 /** @brief like THROW3, but adding some details to the message of an existing exception
464  *  @hideinitializer
465  */
466 #define RETHROW3(msg,a,b,c)     _XBT_PRE_RETHROW msg,a,b,c,    _XBT_POST_RETHROW
467 /** @brief like THROW4, but adding some details to the message of an existing exception
468  *  @hideinitializer
469  */
470 #define RETHROW4(msg,a,b,c,d)   _XBT_PRE_RETHROW msg,a,b,c,    _XBT_POST_RETHROW
471 /** @brief like THROW5, but adding some details to the message of an existing exception
472  *  @hideinitializer
473  */
474 #define RETHROW5(msg,a,b,c,d,e) _XBT_PRE_RETHROW msg,a,b,c,d,e _XBT_POST_RETHROW
475
476 /** @brief Exception destructor */
477 void xbt_ex_free(xbt_ex_t e);
478
479 void xbt_ex_display(xbt_ex_t *e);
480
481 /** @} */
482 #endif /* __XBT_EX_H__ */
483