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) do {                                     \
  56   if ((errcode=a) != no_error) {                        \
  57      fprintf (stderr, "%s:%d: '%s' error raising...\n", \
  58              __FILE__,__LINE__,                         \
  59              gras_error_name(errcode));                 \
  60      return errcode;                                    \
  61   } } while (0)
  62
  63 #define TRYCATCH(a,b) if ((errcode=a) != no_error && errcode !=b) return errcode
  64 #define TRYFAIL(a) do {                                        \
  65   if ((errcode=a) != no_error) {                               \
  66      fprintf(stderr,"%s:%d: Got '%s' error !\n",               \
  67              __FILE__,__LINE__,                                \
  68              gras_error_name(errcode));                        \
  69      fflush(stdout);                                           \
  70      abort();                                                  \
  71   } } while(0)
  72
  73 #define TRYEXPECT(action,expected_error)  do {                 \
  74   errcode=action;                                              \
  75   if (errcode != expected_error) {                             \
  76     fprintf(stderr,"Got error %s (instead of %s expected)\n",  \
  77             gras_error_name(errcode),                          \
  78             gras_error_name(expected_error));                  \
  79     abort();                                                   \
  80   }                                                            \
  81 } while(0)
  82
  83 /* FIXME TRYCLEAN should be avoided for readability */
  84 #define TRYCLEAN(action,cleanup) do {                          \
  85   if ((errcode=action) != no_error) {                          \
  86     cleanup;                                                   \
  87     return errcode;                                            \
  88   }                                                            \
  89 } while(0)
  90
  91 #define _GRAS_ERR_PRE do {                                     \
  92  void *_gs_array[30];                                          \
  93   size_t _gs_size= backtrace (_gs_array, 30);                  \
  94   char **_gs_strings= backtrace_symbols (_gs_array, _gs_size); \
  95   size_t _gs_i;
  96
  97 #define _GRAS_ERR_POST(code)                                   \
  98   fprintf(stderr,"Backtrace follows\n");                       \
  99   for (_gs_i = 0; _gs_i < _gs_size; _gs_i++)                   \
 100      fprintf (stderr,"   %s\n", _gs_strings[_gs_i]);           \
 101   return code;                                                 \
 102 } while (0)
 103
 104
 105 #define RAISE0(code,fmt) _GRAS_ERR_PRE     \
 106   fprintf(stderr,"%s:%d:%s: " fmt "\n",    \
 107           __FILE__,__LINE__,__FUNCTION__); \
 108   _GRAS_ERR_POST(code)
 109 #define RAISE1(code,fmt,a1) _GRAS_ERR_PRE     \
 110   fprintf(stderr,"%s:%d:%s: " fmt "\n",       \
 111           __FILE__,__LINE__,__FUNCTION__,a1); \
 112   _GRAS_ERR_POST(code)
 113 #define RAISE2(code,fmt,a1,a2) _GRAS_ERR_PRE     \
 114   fprintf(stderr,"%s:%d:%s: " fmt "\n",          \
 115           __FILE__,__LINE__,__FUNCTION__,a1,a2); \
 116   _GRAS_ERR_POST(code)
 117 #define RAISE3(code,fmt,a1,a2,a3) _GRAS_ERR_PRE     \
 118   fprintf(stderr,"%s:%d:%s: " fmt "\n",             \
 119           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3); \
 120   _GRAS_ERR_POST(code)
 121 #define RAISE4(code,fmt,a1,a2,a3,a4) _GRAS_ERR_PRE     \
 122   fprintf(stderr,"%s:%d:%s: " fmt "\n",                \
 123           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4); \
 124   _GRAS_ERR_POST(code)
 125 #define RAISE5(code,fmt,a1,a2,a3,a4,a5) _GRAS_ERR_PRE     \
 126   fprintf(stderr,"%s:%d:%s: " fmt "\n",                   \
 127           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5); \
 128   _GRAS_ERR_POST(code)
 129 #define RAISE6(code,fmt,a1,a2,a3,a4,a5,a6) _GRAS_ERR_PRE     \
 130   fprintf(stderr,"%s:%d:%s: " fmt "\n",                      \
 131           __FILE__,__LINE__,__FUNCTION__,a1,a2,a3,a4,a5,a6); \
 132   _GRAS_ERR_POST(code)
 133
 134 #define RAISE_MALLOC     RAISE0(malloc_error,"Malloc error")
 135 #define RAISE_IMPOSSIBLE RAISE0(unknown_error,"The Impossible did happen")
 136 #define RAISE_UNIMPLEMENTED RAISE1(unknown_error,"Function %s unimplemented",__FUNCTION__)
 137
 138 #define gras_abort abort
 139
 140 #define gras_assert(cond)                  if (!(cond)) { CRITICAL1("Assertion %s failed", #cond); gras_abort(); }
 141 #define gras_assert0(cond,msg)             if (!(cond)) { CRITICAL0(msg); gras_abort(); }
 142 #define gras_assert1(cond,msg,a)           if (!(cond)) { CRITICAL1(msg,a); gras_abort(); }
 143 #define gras_assert2(cond,msg,a,b)         if (!(cond)) { CRITICAL2(msg,a,b); gras_abort(); }
 144 #define gras_assert3(cond,msg,a,b,c)       if (!(cond)) { CRITICAL3(msg,a,b,c); gras_abort(); }
 145 #define gras_assert4(cond,msg,a,b,c,d)     if (!(cond)) { CRITICAL4(msg,a,b,c,d); gras_abort(); }
 146 #define gras_assert5(cond,msg,a,b,c,d,e)   if (!(cond)) { CRITICAL5(msg,a,b,c,d,e); gras_abort(); }
 147 #define gras_assert6(cond,msg,a,b,c,d,e,f) if (!(cond)) { CRITICAL6(msg,a,b,c,d,e,f); gras_abort(); }
 148
 149 END_DECL
 150
 151 #endif /* GRAS_ERROR_H */
 152