Actual source code: petscerror.h
1: /*
2: Contains all error handling interfaces for PETSc.
3: */
6: #include petsc.h
9: /*
10: Defines the directory where the compiled source is located; used
11: in printing error messages. Each makefile has an entry
12: LOCDIR = thedirectory
13: and bmake/common_variables includes in CCPPFLAGS -D__SDIR__='"${LOCDIR}"'
14: which is a flag passed to the C/C++ compilers. This declaration below
15: is only needed if some code is compiled without the -D__SDIR__
16: */
19: #endif
21: /*
22: Defines the function where the compiled source is located; used
23: in printing error messages. This is defined here in case the user
24: does not declare it.
25: */
28: #endif
30: /*
31: These are the generic error codes. These error codes are used
32: many different places in the PETSc source code. The string versions are
33: at src/sys/error/err.c any changes here must also be made there
34: These are also define in include/finclude/petscerror.h any CHANGES here
35: must be also made there.
37: */
38: #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */
40: #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */
41: #define PETSC_ERR_SUP 56 /* no support for requested operation */
42: #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */
43: #define PETSC_ERR_ORDER 58 /* operation done in wrong order */
44: #define PETSC_ERR_SIG 59 /* signal received */
45: #define PETSC_ERR_FP 72 /* floating point exception */
46: #define PETSC_ERR_COR 74 /* corrupted PETSc object */
47: #define PETSC_ERR_LIB 76 /* error in library called by PETSc */
48: #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */
49: #define PETSC_ERR_MEMC 78 /* memory corruption */
50: #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */
51: #define PETSC_ERR_USER 83 /* user has not provided needed function */
53: #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */
54: #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */
55: #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */
56: #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */
57: #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */
58: #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */
59: #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */
60: #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */
61: #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */
62: #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */
63: #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */
64: #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */
65: #define PETSC_ERR_ARG_DOMAIN 87 /* argument is not in domain of function */
67: #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */
68: #define PETSC_ERR_FILE_READ 66 /* unable to read from file */
69: #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */
70: #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */
72: #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */
73: #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */
75: #define PETSC_ERR_MAX_VALUE 88 /* this is always the one more than the largest error code */
77: #if defined(PETSC_USE_ERRORCHECKING)
79: /*MC
80: SETERRQ - Macro that is called when an error has been detected,
82: Not Collective
84: Synopsis:
85: void SETERRQ(PetscErrorCode errorcode,char *message)
88: Input Parameters:
89: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
90: - message - error message
92: Level: beginner
94: Notes:
95: Once the error handler is called the calling function is then returned from with the given error code.
97: See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments
100: Experienced users can set the error handler with PetscPushErrorHandler().
102: Concepts: error^setting condition
104: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
105: M*/
106: #define SETERRQ(n,s) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);}
108: /*MC
109: SETERRQ1 - Macro that is called when an error has been detected,
111: Not Collective
113: Synopsis:
114: void SETERRQ1(PetscErrorCode errorcode,char *formatmessage,arg)
117: Input Parameters:
118: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
119: . message - error message in the printf format
120: - arg - argument (for example an integer, string or double)
122: Level: beginner
124: Notes:
125: Once the error handler is called the calling function is then returned from with the given error code.
127: Experienced users can set the error handler with PetscPushErrorHandler().
129: Concepts: error^setting condition
131: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
132: M*/
133: #define SETERRQ1(n,s,a1) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1);}
135: /*MC
136: SETERRQ2 - Macro that is called when an error has been detected,
138: Not Collective
140: Synopsis:
141: void SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2)
144: Input Parameters:
145: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
146: . message - error message in the printf format
147: . arg1 - argument (for example an integer, string or double)
148: - arg2 - argument (for example an integer, string or double)
150: Level: beginner
152: Notes:
153: Once the error handler is called the calling function is then returned from with the given error code.
155: Experienced users can set the error handler with PetscPushErrorHandler().
157: Concepts: error^setting condition
159: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
160: M*/
161: #define SETERRQ2(n,s,a1,a2) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2);}
163: /*MC
164: SETERRQ3 - Macro that is called when an error has been detected,
166: Not Collective
168: Synopsis:
169: void SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3)
172: Input Parameters:
173: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
174: . message - error message in the printf format
175: . arg1 - argument (for example an integer, string or double)
176: . arg2 - argument (for example an integer, string or double)
177: - arg3 - argument (for example an integer, string or double)
179: Level: beginner
181: Notes:
182: Once the error handler is called the calling function is then returned from with the given error code.
184: There are also versions for 4, 5, 6 and 7 arguments.
186: Experienced users can set the error handler with PetscPushErrorHandler().
188: Concepts: error^setting condition
190: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
191: M*/
192: #define SETERRQ3(n,s,a1,a2,a3) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3);}
194: #define SETERRQ4(n,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4);}
195: #define SETERRQ5(n,s,a1,a2,a3,a4,a5) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5);}
196: #define SETERRQ6(n,s,a1,a2,a3,a4,a5,a6) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5,a6);}
197: #define SETERRQ7(n,s,a1,a2,a3,a4,a5,a6,a7) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5,a6,a7);}
198: #define SETERRABORT(comm,n,s) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);MPI_Abort(comm,n);}
200: /*MC
201: CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns
203: Not Collective
205: Synopsis:
206: void CHKERRQ(PetscErrorCode errorcode)
209: Input Parameters:
210: . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h
212: Level: beginner
214: Notes:
215: Once the error handler is called the calling function is then returned from with the given error code.
217: Experienced users can set the error handler with PetscPushErrorHandler().
219: CHKERRQ(n) is fundamentally a macro replacement for
220: if (n) return(PetscError(...,n,...));
222: Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is
223: highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular,
224: it cannot be used in functions which return(void) or any other datatype. In these types of functions,
225: a more appropriate construct for using PETSc Error Handling would be
226: if (n) {PetscError(....); return(YourReturnType);}
228: Concepts: error^setting condition
230: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
231: M*/
232: #define CHKERRQ(n) if (n) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");}
234: #define CHKERRABORT(comm,n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");MPI_Abort(comm,n);}
235: #define CHKERRCONTINUE(n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");}
237: #define CHKFPQ(f) if (f != f) {SETERRQ(PETSC_ERR_FP, "Invalid value: NaN");}
239: /*MC
240: CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected
242: Not Collective
244: Synopsis:
245: CHKMEMQ;
247: Level: beginner
249: Notes:
250: Must run with the option -malloc_debug to enable this option
252: Once the error handler is called the calling function is then returned from with the given error code.
254: By defaults prints location where memory that is corrupted was allocated.
256: Use CHKMEMA for functions that return void
258: Concepts: memory corruption
260: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
261: PetscMallocValidate()
262: M*/
263: #define CHKMEMQ {PetscErrorCode _7_PetscMallocValidate(__LINE__,__FUNCT__,__FILE__,__SDIR__);CHKERRQ(_7_ierr);}
265: #define CHKMEMA {PetscMallocValidate(__LINE__,__FUNCT__,__FILE__,__SDIR__);}
267: #if defined(PETSC_UNDERSCORE_CHKERR)
269: #define _ __g
271: #endif
273: #define PETSC_EXCEPTIONS_MAX 256
279: EXTERN PetscErrorCode PetscExceptionPush(PetscErrorCode);
280: EXTERN void PetscExceptionPop(PetscErrorCode);
282: EXTERN PetscErrorCode PetscErrorSetCatchable(PetscErrorCode,PetscTruth);
283: EXTERN PetscTruth PetscErrorIsCatchable(PetscErrorCode);
284: /*MC
285: PetscExceptionCaught - Indicates if a specific exception zierr was caught.
287: Not Collective
289: Synopsis:
290: PetscTruth PetscExceptionCaught(PetscErrorCode xierr,PetscErrorCode zierr);
292: Input Parameters:
293: + xierr - error code returned from PetscExceptionTry1()
294: - zierr - error code you want it to be
296: Level: advanced
298: Notes:
299: PETSc must not be configured using the option --with-errorchecking=0 for this to work
301: Use PetscExceptionValue() to see if the current error code is one that has been "tried"
303: Concepts: exceptions, exception hanlding
305: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
306: CHKERRQ(), PetscExceptionTry1(), PetscExceptionValue()
307: M*/
308: PETSC_STATIC_INLINE PetscTruth PetscExceptionCaught(PetscErrorCode xierr,PetscErrorCode zierr) {
309: PetscInt i;
310: if (xierr != zierr) return PETSC_FALSE;
311: for (i=0; i<PetscErrorUncatchableCount; i++) {
312: if (PetscErrorUncatchable[i] == zierr) {
313: return PETSC_FALSE;
314: }
315: }
316: return PETSC_TRUE;
317: }
319: /*MC
320: PetscExceptionValue - Indicates if the error code is one that is currently being tried
322: Not Collective
324: Synopsis:
325: PetscTruth PetscExceptionValue(PetscErrorCode xierr);
327: Input Parameters:
328: . xierr - error code
330: Level: developer
332: Notes:
333: PETSc must not be configured using the option --with-errorchecking=0 for this to work
335: Use PetscExceptionCaught() to see if the current error code is EXACTLY the one you want
337: Concepts: exceptions, exception hanlding
339: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
340: CHKERRQ(), PetscExceptionTry1(), PetscExceptionCaught()
341: M*/
342: PETSC_STATIC_INLINE PetscTruth PetscExceptionValue(PetscErrorCode zierr) {
343: PetscInt i;
344: for (i=0; i<PetscExceptionsCount; i++) {
345: if (PetscExceptions[i] == zierr) {
346: return PETSC_TRUE;
347: }
348: }
349: return PETSC_FALSE;
350: }
352: /*MC
353: PetscExceptionTry1 - Runs the routine, causing a particular error code to be treated as an exception,
354: rather than an error. That is if that error code is treated the program returns to this level,
355: but does not call the error handlers
357: Not Collective
359: Synopsis:
360: PetscExceptionTry1(PetscErrorCode routine(....),PetscErrorCode);
362: Level: advanced
364: Notes:
365: PETSc must not be configured using the option --with-errorchecking=0 for this to work
367: Note: In general, the outer most try on an exception is the one that will be caught (that is trys down in
368: PETSc code will not usually handle an exception that was issued above). See SNESSolve() for an example
369: of how the local try is ignored if a higher (in the stack) one is also in effect.
371: Concepts: exceptions, exception hanlding
373: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
374: CHKERRQ(), PetscExceptionCaught(), PetscExceptionPush(), PetscExceptionPop()
375: M*/
377: #define PetscExceptionTry1(a,b) (PetscExceptionTmp = PetscExceptionPush(b)) ? PetscExceptionTmp : (PetscExceptionTmp = a , PetscExceptionPop(b),PetscExceptionTmp)
379: #else
381: /*
382: These are defined to be empty for when error checking is turned off, with config/configure.py --with-errorchecking=0
383: */
385: #define SETERRQ(n,s) ;
386: #define SETERRQ1(n,s,a1) ;
387: #define SETERRQ2(n,s,a1,a2) ;
388: #define SETERRQ3(n,s,a1,a2,a3) ;
389: #define SETERRQ4(n,s,a1,a2,a3,a4) ;
390: #define SETERRQ5(n,s,a1,a2,a3,a4,a5) ;
391: #define SETERRQ6(n,s,a1,a2,a3,a4,a5,a6) ;
392: #define SETERRABORT(comm,n,s) ;
394: #define CHKERRQ(n) ;
395: #define CHKERRABORT(comm,n) ;
396: #define CHKERRCONTINUE(n) ;
398: #define CHKMEMQ ;
400: #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR)
401: #define _
403: #endif
405: #define PetscErrorSetCatchable(a,b) 0
406: #define PetscExceptionCaught(a,b) PETSC_FALSE
407: #define PetscExceptionValue(a) PETSC_FALSE
408: #define PetscExceptionTry1(a,b) a
409: #endif
411: EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
412: EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **);
413: EXTERN PetscErrorCode PetscTraceBackErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
414: EXTERN PetscErrorCode PetscIgnoreErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
415: EXTERN PetscErrorCode PetscEmacsClientErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
416: EXTERN PetscErrorCode PetscStopErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
417: EXTERN PetscErrorCode PetscAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
418: EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
419: EXTERN PetscErrorCode PetscReturnErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*);
420: EXTERN PetscErrorCode PetscError(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,...) PETSC_PRINTF_FORMAT_CHECK(7,8);
421: EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*),void*);
422: EXTERN PetscErrorCode PetscPopErrorHandler(void);
423: EXTERN PetscErrorCode PetscDefaultSignalHandler(int,void*);
424: EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
425: EXTERN PetscErrorCode PetscPopSignalHandler(void);
427: typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
428: EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
430: /*
431: Allows the code to build a stack frame as it runs
432: */
433: #if defined(PETSC_USE_DEBUG)
435: #define PETSCSTACKSIZE 15
437: typedef struct {
438: const char *function[PETSCSTACKSIZE];
439: const char *file[PETSCSTACKSIZE];
440: const char *directory[PETSCSTACKSIZE];
441: int line[PETSCSTACKSIZE];
442: int currentsize;
443: } PetscStack;
446: EXTERN PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*);
447: EXTERN PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp);
449: #define PetscStackActive (petscstack != 0)
452: /*MC
454: used for error handling.
456: Synopsis:
459: Usage:
460: .vb
461: int something;
464: .ve
466: Notes:
467: Not available in Fortran
469: Level: developer
471: .seealso: PetscFunctionReturn()
473: .keywords: traceback, error handling
474: M*/
476: {\
477: if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \
478: petscstack->function[petscstack->currentsize] = __FUNCT__; \
479: petscstack->file[petscstack->currentsize] = __FILE__; \
480: petscstack->directory[petscstack->currentsize] = __SDIR__; \
481: petscstack->line[petscstack->currentsize] = __LINE__; \
482: petscstack->currentsize++; \
483: }}
485: #define PetscStackPush(n) \
486: {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \
487: petscstack->function[petscstack->currentsize] = n; \
488: petscstack->file[petscstack->currentsize] = "unknown"; \
489: petscstack->directory[petscstack->currentsize] = "unknown"; \
490: petscstack->line[petscstack->currentsize] = 0; \
491: petscstack->currentsize++; \
492: }}
494: #define PetscStackPop \
495: {if (petscstack && petscstack->currentsize > 0) { \
496: petscstack->currentsize--; \
497: petscstack->function[petscstack->currentsize] = 0; \
498: petscstack->file[petscstack->currentsize] = 0; \
499: petscstack->directory[petscstack->currentsize] = 0; \
500: petscstack->line[petscstack->currentsize] = 0; \
501: }};
503: /*MC
504: PetscFunctionReturn - Last executable line of each PETSc function
505: used for error handling. Replaces return()
507: Synopsis:
508: void return(0);
510: Usage:
511: .vb
512: ....
513: return(0);
514: }
515: .ve
517: Notes:
518: Not available in Fortran
520: Level: developer
524: .keywords: traceback, error handling
525: M*/
526: #define PetscFunctionReturn(a) \
527: {\
528: PetscStackPop; \
529: return(a);}
531: #define PetscFunctionReturnVoid() \
532: {\
533: PetscStackPop; \
534: return;}
537: #else
540: #define PetscFunctionReturn(a) return(a)
541: #define PetscFunctionReturnVoid() return
542: #define PetscStackPop
543: #define PetscStackPush(f)
544: #define PetscStackActive 0
546: #endif
548: EXTERN PetscErrorCode PetscStackCreate(void);
549: EXTERN PetscErrorCode PetscStackView(PetscViewer);
550: EXTERN PetscErrorCode PetscStackDestroy(void);
551: EXTERN PetscErrorCode PetscStackPublish(void);
552: EXTERN PetscErrorCode PetscStackDepublish(void);
556: #endif