Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make dist now works
[simgrid.git] / include / error.h
1 /* $Id$ */
2
3 /* gras/error.h - Error tracking support                                    */
4
5 /* Authors: Martin Quinson                                                  */
6 /* Copyright (C) 2003 the OURAGAN project.                                  */
7
8 /* This program is free software; you can redistribute it and/or modify it
9    under the terms of the license (GNU LGPL) which comes with this package. */
10
11
12 #ifndef GRAS_ERROR_H
13 #define GRAS_ERROR_H
14
15 #include <stddef.h>    /* offsetof() */
16 #include <sys/types.h>  /* size_t */
17 #include <stdarg.h>
18 #include <execinfo.h>  /* to print the backtrace */
19
20
21 /* C++ users need love */
22 #ifndef BEGIN_DECL
23 # ifdef __cplusplus
24 #  define BEGIN_DECL extern "C" {
25 # else
26 #  define BEGIN_DECL 
27 # endif
28 #endif
29
30 /*! C++ users need love */
31 #ifndef END_DECL
32 # ifdef __cplusplus
33 #  define END_DECL }
34 # else
35 #  define END_DECL 
36 # endif
37 #endif
38 /* End of cruft for C++ */
39
40 BEGIN_DECL
41
42 typedef enum {
43   no_error=0,     /* succes */
44   malloc_error,   /* Well known error */
45   mismatch_error, /* The provided ID does not match */
46   system_error,   /* a syscall did fail */
47   network_error,  /* error while sending/receiving data */
48   timeout_error,  /* not quick enough, dude */
49   thread_error,   /* error while [un]locking */
50   unknown_error 
51 } gras_error_t;
52
53 /*@observer@*/ const char *gras_error_name(gras_error_t errcode);
54
55 #define TRY(a) if ((errcode=a) != no_error) return errcode
56 #define TRYCATCH(a,b) if ((errcode=a) != no_error && errcode !=b) return errcode
57 #define TRYFAIL(a) do {                                        \
58   if ((errcode=a) != no_error) {                               \
59      fprintf(stderr,"Got '%s' error !\n",                      \
60              gras_error_name(errcode));                        \
61      fflush(stdout);                                           \
62      abort();                                                  \
63   } } while(0)
64
65 #define TRYEXPECT(action,expected_error)  do {                 \
66   errcode=action;                                              \
67   if (errcode != expected_error) {                             \
68     fprintf(stderr,"Got error %s (instead of %s expected)\n",  \
69             gras_error_name(errcode),                          \
70             gras_error_name(expected_error));                  \
71     abort();                                                   \
72   }                                                            \
73 } while(0)
74
75 /* FIXME TRYCLEAN should be avoided for readability */
76 #define TRYCLEAN(action,cleanup) do {                          \
77   if ((errcode=action) != no_error) {                          \
78     cleanup;                                                   \
79     return errcode;                                            \
80   }                                                            \
81 } while(0)
82
83 #define _GRAS_ERR_PRE do {                                     \
84  void *_gs_array[30];                                          \
85   size_t _gs_size= backtrace (_gs_array, 30);                  \
86   char **_gs_strings= backtrace_symbols (_gs_array, _gs_size); \
87   size_t _gs_i;
88
89 #define _GRAS_ERR_POST(code)                                   \
90   fprintf(stderr,"Backtrace follows\n");                       \
91   for (_gs_i = 0; _gs_i < _gs_size; _gs_i++)                   \
92      fprintf (stderr,"   %s\n", _gs_strings[_gs_i]);           \
93   return code;                                                 \
94 } while (0)
95
96
97 #define RAISE0(code,fmt) _GRAS_ERR_PRE     \
98   fprintf(stderr,"%s:%d:%s: " fmt "\n",    \
99           __FILE__,__LINE__,__FUNCTION__); \
100   _GRAS_ERR_POST(code)
101 #define RAISE1(code,fmt,a1) _GRAS_ERR_PRE     \
102   fprintf(stderr,"%s:%d:%s: " fmt "\n",       \
103           __FILE__,__LINE__,__FUNCTION__,a1); \
104   _GRAS_ERR_POST(code)
105 #define RAISE2(code,fmt,a1,a2) _GRAS_ERR_PRE     \
106   fprintf(stderr,"%s:%d:%s: " fmt "\n",          \
107           __FILE__,__LINE__,__FUNCTION__,a1,a2); \
108   _GRAS_ERR_POST(code)
109 #define RAISE3(code,fmt,a1,a2,a3) _GRAS_ERR_PRE     \
110   fprintf(stderr,"%s:%d:%s: " fmt "\n",             \
111           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3); \
112   _GRAS_ERR_POST(code)
113 #define RAISE4(code,fmt,a1,a2,a3,a4) _GRAS_ERR_PRE     \
114   fprintf(stderr,"%s:%d:%s: " fmt "\n",                \
115           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4); \
116   _GRAS_ERR_POST(code)
117 #define RAISE5(code,fmt,a1,a2,a3,a4,a5) _GRAS_ERR_PRE     \
118   fprintf(stderr,"%s:%d:%s: " fmt "\n",                   \
119           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5); \
120   _GRAS_ERR_POST(code)
121 #define RAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _GRAS_ERR_PRE     \
122   fprintf(stderr,"%s:%d:%s: " fmt "\n",                      \
123           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5,a6); \
124   _GRAS_ERR_POST(code)
125
126 #define RAISE_MALLOC     RAISE0(malloc_error,"Malloc error")
127 #define RAISE_IMPOSSIBLE RAISE0(unknown_error,"The Impossible did happen")
128
129 #define gras_abort abort
130
131 #define gras_assert(cond)                  if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); gras_abort(); }
132 #define gras_assert0(cond,msg)             if (!(cond)) { CRITICAL0(msg); gras_abort(); }
133 #define gras_assert1(cond,msg,a)           if (!(cond)) { CRITICAL1(msg,a); gras_abort(); }
134 #define gras_assert2(cond,msg,a,b)         if (!(cond)) { CRITICAL2(msg,a,b); gras_abort(); }
135 #define gras_assert3(cond,msg,a,b,c)       if (!(cond)) { CRITICAL3(msg,a,b,c); gras_abort(); }
136 #define gras_assert4(cond,msg,a,b,c,d)     if (!(cond)) { CRITICAL4(msg,a,b,c,d); gras_abort(); }
137 #define gras_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); gras_abort(); }
138 #define gras_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); gras_abort(); }
139
140 END_DECL
141
142 #endif /* GRAS_ERROR_H */
143