ScaMaC  0.8.2
A Scalable Matrix Collection
scamac_error.h
Go to the documentation of this file.
1 
8 #ifndef SCAMAC_ERROR_H
9 #define SCAMAC_ERROR_H
10 
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <stdbool.h>
14 
15 /* error codes */
16 /* we support up to 2^6 = 63 error codes + 1 "EOK"
17  * The error codes ENULL ... ECORRUPTED can be OR'ed with the position of the problematic input value,
18  * that is if the i-th parameter is problematic, with 1 <= i <= 31, functions return, e.g,
19  * SCAMAC_EINVALID | (i << SCAMAC_ESHIFT) or SCAMAC_EINVALID | (i << SCAMAC_ESHIFT) | SCAMAC_EINTERNAL
20  * The shift is given by SCAMAC_ESHIFT = 7
21  */
22 /* This definition must agree with the list of error names
23  in scamac_error_desc() in scamac_collection.c */
24 #define SCAMAC_ESHIFT 6
25 #define SCAMAC_EMASK ((1U << SCAMAC_ESHIFT) - 1)
26 typedef enum {
27 // +++ basic status
28 // routine completed successfully
29  SCAMAC_EOK=0,
30 // routine failed for an unspecified reason
31  SCAMAC_EFAIL,
32 // +++
33 // +++ problems with specific function parameters (on input)
34 // a null pointer was supplied in the wrong place
35  SCAMAC_ENULL,
36 // an input parameter, or the combination of all parameters, is invalid
37  SCAMAC_EINVALID,
38 // an (integer or double) input parameter is outside of the valid range (e.g, is negative when a positive value is expected)
39  SCAMAC_ERANGE,
40 // an object passed to a routine, probably constructed elsewhere, is corrupted. Can signal an internal error,
41 // or improper use of ScaMaC routines & algorithms.
42 // example: If a complex matrix is passed to a routine that expects a real matrix, EINVALID is returned.
43 // But if the valtype of the matrix is neither real nor complex, ECORRUPTED is returned, because that's not a valid matrix at all.
44  SCAMAC_ECORRUPTED,
45 // +++
46 // +++
47 // the requested computation is outside of the scope of the function (e.g., Lanczos for non-symmetric matrices)
48  SCAMAC_ESCOPE,
49 // the combination of all input parameters is invalid (but each individual parameter may be valid)
50  SCAMAC_EINPUT,
51 // +++
52 // +++ problems during execution or on return
53 // index/matrix dimension exceeds possible integer range (2^31 ~ 2E9 for int32, 2^63 ~ 9E18 for int64)
54  SCAMAC_EOVERFLOW,
55 // memory allocation failed
56  SCAMAC_EMALLOCFAIL,
57 // an integer parameter is too large, i.e., larger then SCAMACHUGE
58  SCAMAC_EHUGEINT,
59 // an integer value computed in the routine is too large, i.e., larger then SCAMACHUGE
60  SCAMAC_EHUGECOMP,
61 // a (parameter) warning. Not necessarily an error
62  SCAMAC_EWARNING,
63 // algorithm (e.g., Lanczos) not converged
64  SCAMAC_ENOTCONVERGED,
65 // row to short
66  SCAMAC_ESHORTROW,
67 // the error originates from an internal call to a ScaMaC routine. This is a flag that can be combined with the other error codes,
68 // as in SCAMAC_EFAIL | SCAMAC_EINTERNAL
69  SCAMAC_EINTERNAL = (1U << (2*SCAMAC_ESHIFT))
70 } ScamacErrorCode;
71 
72 
73 /* error handler */
74 /* Only global variable in scamac */
75 typedef void (*scamac_error_handler_ft)(void);
76 extern scamac_error_handler_ft scamac_error_handler;
77 
78 // macros for assertions.
79 // The macros call exit(EXIT_FAILURE) or scamac_error_handler
80 #ifdef NDEBUG
81 #define SCAMAC_ASSERT(err) \
82  do { \
83  } while (0)
84 
85 #define SCAMAC_APPROVE(exp) \
86  do { \
87  exp; \
88  } while (0)
89 
90 #else /* NO NDEBUG */
91 
92 #define SCAMAC_ASSERT(expr) \
93  do { \
94  if (!(expr)) { \
95  fprintf(stderr, "\n*************\n*** ABORT ***\n*************\n%s\n\nassertion in function >%s< at line %d failed.\n\n", \
96  __FILE__, __func__, __LINE__); \
97  fprintf(stderr,"%s\n",#expr); \
98  fprintf(stderr,"* * * * * * *\n\naborted\n"); \
99  if (scamac_error_handler) { \
100  scamac_error_handler(); \
101  } else { \
102  exit(EXIT_FAILURE); \
103  } \
104  } \
105  } while (0)
106 
107 #define SCAMAC_APPROVE(cmd) \
108  do { \
109  ScamacErrorCode unique_142b176e_err; \
110  unique_142b176e_err = cmd; \
111  if (err) { \
112  fprintf(stderr, "\n*************\n*** ABORT ***\n*************\n%s\n\nin function >%s< at line %d\n\n>%s< failed with\n\n", \
113  __FILE__, __func__, __LINE__, #cmd); \
114  fprintf(stderr,"%s%s\n",scamac_error_desc(unique_142b176e_err),scamac_error_dpar(unique_142b176e_err)); \
115  fprintf(stderr,"* * * * * * *\n\naborted\n"); \
116  if (scamac_error_handler) { \
117  scamac_error_handler(); \
118  } else { \
119  exit(EXIT_FAILURE); \
120  } \
121  } \
122  } while (0)
123 
124 #endif /* NDEBUG */
125 
126 // macros for error handling. Replace as you wish.
127 #define SCAMAC_CHKERR(err) \
128  do { \
129  if (err) { \
130  fprintf(stderr, "\n*************\n*** ABORT ***\n*************\n%s\n\nfunction >%s< at line %d failed with\n\n", \
131  __FILE__, __func__, __LINE__); \
132  fprintf(stderr,"%s%s\n",scamac_error_desc(err),scamac_error_dpar(err)); \
133  fprintf(stderr,"* * * * * * *\n\naborted\n"); \
134  if (scamac_error_handler) { \
135  scamac_error_handler(); \
136  } else { \
137  exit(EXIT_FAILURE); \
138  } \
139  } \
140  } while (0)
141 
142 #define SCAMAC_TRY(exp) \
143  do { \
144  ScamacErrorCode unique_142b176e_err; \
145  unique_142b176e_err = exp; \
146  if (unique_142b176e_err) { \
147  fprintf(stderr, "\n*************\n*** ABORT ***\n*************\n%s\n\nin function >%s< at line %d\n\n>%s< failed with\n\n", \
148  __FILE__, __func__, __LINE__, #exp); \
149  fprintf(stderr,"%s%s\n",scamac_error_desc(unique_142b176e_err),scamac_error_dpar(unique_142b176e_err)); \
150  fprintf(stderr,"* * * * * * *\n\naborted\n"); \
151  if (scamac_error_handler) { \
152  scamac_error_handler(); \
153  } else { \
154  exit(EXIT_FAILURE); \
155  } \
156  } \
157  } while (0)
158 
159 #ifdef NDEBUG
160 
161 #define SCAMAC_RETERR(err) \
162  do { \
163  if (err) { \
164  return scamac_error_set_internal(err); \
165  } \
166  } while (0)
167 
168 #define SCAMAC_GOTOERR(err, label) \
169  do { \
170  if (err) { \
171  err=scamac_error_set_internal(err); \
172  goto label; \
173  } \
174  } while (0)
175 
176 
177 #else /* NO NDEBUG */
178 
179 #define SCAMAC_RETERR(err) \
180  do { \
181  if (err) { \
182  fprintf(stderr, "\n*************\n*** ERROR ***\n*************\n%s\n\nfunction >%s< at line %d encountered an error\n\n", \
183  __FILE__, __func__, __LINE__); \
184  fprintf(stderr,"%s%s\n* * * * * * *\n\n",scamac_error_desc(err),scamac_error_dpar(err)); \
185  return scamac_error_set_internal(err); \
186  } \
187  } while (0)
188 
189 #define SCAMAC_GOTOERR(err, label) \
190  do { \
191  if (err) { \
192  fprintf(stderr, "\n*************\n*** ERROR ***\n*************\n%s\n\nfunction >%s< at line %d encountered an error\n\n", \
193  __FILE__, __func__, __LINE__); \
194  fprintf(stderr,"%s%s\n* * * * * * *\n\n",scamac_error_desc(err),scamac_error_dpar(err)); \
195  err=scamac_error_set_internal(err); \
196  goto label; \
197  } \
198  } while (0)
199 
200 
201 #endif
202 
203 #ifdef NDEBUG
204 #define SCAMAC_REPORT(str) \
205  do { \
206  } while (0)
207 
208 #else /* NO NDEBUG */
209 
210 #define SCAMAC_REPORT(str) \
211  do { \
212  fprintf(stderr, "-- report >%s< line %d: %s\n",__func__, __LINE__,str); \
213  } while (0)
214 
215 #endif
216 
217 #ifdef NDEBUG
218 #define SCAMAC_LOG(...) \
219  do { \
220  } while (0)
221 # else /* NO NDEBUG */
222 #define SCAMAC_LOG(...) \
223  do { \
224  fprintf(stderr, ">%s : %d<\n ", __func__, __LINE__); \
225  fprintf(stderr, __VA_ARGS__); \
226  fprintf(stderr, "\n"); \
227  } while (0)
228 #endif
229 
230 
233 const char * scamac_error_desc(ScamacErrorCode err);
234  int scamac_error_par (ScamacErrorCode err);
235 const char * scamac_error_dpar(ScamacErrorCode err);
236 /* discard warnings (SCAMAC_EWARNING) */
237 ScamacErrorCode scamac_error_discard_warning(ScamacErrorCode err);
238 /* set INTERNAL flag for errors caused by wrong function calls (but not for, e.g., EMALLOCFAIL) */
239 ScamacErrorCode scamac_error_set_internal(ScamacErrorCode err);
240 ScamacErrorCode scamac_error_set_par(ScamacErrorCode err, int par);
241 bool scamac_error_is(ScamacErrorCode err1, ScamacErrorCode err2);
242 
243 #endif /* SCAMAC_ERROR_H */
scamac_error_desc
const char * scamac_error_desc(ScamacErrorCode err)
Return error name.
Generated by   doxygen 1.8.13