1: /*
2: Contains all error handling interfaces for PETSc.
3: */
7: /*
8: These are the generic error codes. These error codes are used
9: many different places in the PETSc source code. The string versions are
10: at src/sys/error/err.c any changes here must also be made there
11: These are also define in include/petsc/finclude/petscerror.h any CHANGES here
12: must be also made there.
14: */
15: #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 17: #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 18: #define PETSC_ERR_SUP 56 /* no support for requested operation */ 19: #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 20: #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 21: #define PETSC_ERR_SIG 59 /* signal received */ 22: #define PETSC_ERR_FP 72 /* floating point exception */ 23: #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 24: #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 25: #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 26: #define PETSC_ERR_MEMC 78 /* memory corruption */ 27: #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 28: #define PETSC_ERR_USER 83 /* user has not provided needed function */ 29: #define PETSC_ERR_SYS 88 /* error in system call */ 30: #define PETSC_ERR_POINTER 70 /* pointer does not point to valid address */ 31: #define PETSC_ERR_MPI_LIB_INCOMP 87 /* MPI library at runtime is not compatible with MPI user compiled with */ 33: #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 34: #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 35: #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 36: #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 37: #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 38: #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 39: #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 40: #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 41: #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 42: #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 43: #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 44: #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 45: #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 47: #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 48: #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 49: #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 50: #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 52: #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 53: #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 55: #define PETSC_ERR_INT_OVERFLOW 84 57: #define PETSC_ERR_FLOP_COUNT 90 58: #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 59: #define PETSC_ERR_MISSING_FACTOR 92 /* MatGetFactor() failed */ 60: #define PETSC_ERR_OPT_OVERWRITE 93 /* attempted to over wrote options which should not be changed */ 62: #define PETSC_ERR_MAX_VALUE 94 /* this is always the one more than the largest error code */ 64: #define PetscStringizeArg(a) #a 65: #define PetscStringize(a) PetscStringizeArg(a) 68: /*MC
69: SETERRQ - Macro to be called when an error has been detected,
71: Synopsis:
72: #include <petscsys.h>
73: PetscErrorCodeSETERRQ(MPI_Comm comm,PetscErrorCode ierr,char *message)
75: Collective on MPI_Comm 77: Input Parameters:
78: + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
79: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
80: - message - error message
82: Level: beginner
84: Notes:
85: Once the error handler is called the calling function is then returned from with the given error code.
87: See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments
89: Experienced users can set the error handler with PetscPushErrorHandler().
91: Concepts: error^setting condition
93: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
94: M*/
95: #define SETERRQ(comm,ierr,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s) 97: /*MC
98: SETERRMPI - Macro to be called when an error has been detected within an MPI callback function
100: Synopsis:
101: #include <petscsys.h>
102: PetscErrorCodeSETERRMPI(MPI_Comm comm,PetscErrorCode ierr,char *message)
104: Collective on MPI_Comm106: Input Parameters:
107: + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
108: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
109: - message - error message
111: Level: developer
113: Notes:
114: This macro is FOR USE IN MPI CALLBACK FUNCTIONS ONLY, such as those passed to MPI_Comm_create_keyval(). It always returns the error code PETSC_MPI_ERROR_CODE
115: which is registered with MPI_Add_error_code() when PETSc is initialized.
117: Concepts: error^setting condition
119: .seealso: SETERRQ(), CHKERRQ(), CHKERRMPI(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
120: M*/
121: #define SETERRMPI(comm,ierr,s) return (PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s),PETSC_MPI_ERROR_CODE)123: /*MC
124: SETERRQ1 - Macro that is called when an error has been detected,
126: Synopsis:
127: #include <petscsys.h>
128: PetscErrorCodeSETERRQ1(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg)
130: Collective on MPI_Comm132: Input Parameters:
133: + comm - A communicator, so that the error can be collective
134: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
135: . message - error message in the printf format
136: - arg - argument (for example an integer, string or double)
138: Level: beginner
140: Notes:
141: Once the error handler is called the calling function is then returned from with the given error code.
143: Experienced users can set the error handler with PetscPushErrorHandler().
145: Concepts: error^setting condition
147: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
148: M*/
149: #define SETERRQ1(comm,ierr,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1)151: /*MC
152: SETERRQ2 - Macro that is called when an error has been detected,
154: Synopsis:
155: #include <petscsys.h>
156: PetscErrorCodeSETERRQ2(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2)
158: Collective on MPI_Comm160: Input Parameters:
161: + comm - A communicator, so that the error can be collective
162: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
163: . message - error message in the printf format
164: . arg1 - argument (for example an integer, string or double)
165: - arg2 - argument (for example an integer, string or double)
167: Level: beginner
169: Notes:
170: Once the error handler is called the calling function is then returned from with the given error code.
172: Experienced users can set the error handler with PetscPushErrorHandler().
174: Concepts: error^setting condition
176: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
177: M*/
178: #define SETERRQ2(comm,ierr,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2)180: /*MC
181: SETERRQ3 - Macro that is called when an error has been detected,
183: Synopsis:
184: #include <petscsys.h>
185: PetscErrorCodeSETERRQ3(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
187: Collective on MPI_Comm189: Input Parameters:
190: + comm - A communicator, so that the error can be collective
191: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
192: . message - error message in the printf format
193: . arg1 - argument (for example an integer, string or double)
194: . arg2 - argument (for example an integer, string or double)
195: - arg3 - argument (for example an integer, string or double)
197: Level: beginner
199: Notes:
200: Once the error handler is called the calling function is then returned from with the given error code.
202: There are also versions for 4, 5, 6 and 7 arguments.
204: Experienced users can set the error handler with PetscPushErrorHandler().
206: Concepts: error^setting condition
208: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
209: M*/
210: #define SETERRQ3(comm,ierr,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3)212: /*MC
213: SETERRQ4 - Macro that is called when an error has been detected,
215: Synopsis:
216: #include <petscsys.h>
217: PetscErrorCodeSETERRQ4(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
219: Collective on MPI_Comm221: Input Parameters:
222: + comm - A communicator, so that the error can be collective
223: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
224: . message - error message in the printf format
225: . arg1 - argument (for example an integer, string or double)
226: . arg2 - argument (for example an integer, string or double)
227: . arg3 - argument (for example an integer, string or double)
228: - arg4 - argument (for example an integer, string or double)
230: Level: beginner
232: Notes:
233: Once the error handler is called the calling function is then returned from with the given error code.
235: There are also versions for 4, 5, 6 and 7 arguments.
237: Experienced users can set the error handler with PetscPushErrorHandler().
239: Concepts: error^setting condition
241: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
242: M*/
243: #define SETERRQ4(comm,ierr,s,a1,a2,a3,a4) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4)245: /*MC
246: SETERRQ5 - Macro that is called when an error has been detected,
248: Synopsis:
249: #include <petscsys.h>
250: PetscErrorCodeSETERRQ5(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
252: Collective on MPI_COmm
254: Input Parameters:
255: + comm - A communicator, so that the error can be collective
256: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
257: . message - error message in the printf format
258: . arg1 - argument (for example an integer, string or double)
259: . arg2 - argument (for example an integer, string or double)
260: . arg3 - argument (for example an integer, string or double)
261: . arg4 - argument (for example an integer, string or double)
262: - arg5 - argument (for example an integer, string or double)
264: Level: beginner
266: Notes:
267: Once the error handler is called the calling function is then returned from with the given error code.
269: There are also versions for 4, 5, 6 and 7 arguments.
271: Experienced users can set the error handler with PetscPushErrorHandler().
273: Concepts: error^setting condition
275: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
276: M*/
277: #define SETERRQ5(comm,ierr,s,a1,a2,a3,a4,a5) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5)279: /*MC
280: SETERRQ6 - Macro that is called when an error has been detected,
282: Synopsis:
283: #include <petscsys.h>
284: PetscErrorCodeSETERRQ6(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
286: Collective on MPI_Comm288: Input Parameters:
289: + comm - A communicator, so that the error can be collective
290: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
291: . message - error message in the printf format
292: . arg1 - argument (for example an integer, string or double)
293: . arg2 - argument (for example an integer, string or double)
294: . arg3 - argument (for example an integer, string or double)
295: . arg4 - argument (for example an integer, string or double)
296: . arg5 - argument (for example an integer, string or double)
297: - arg6 - argument (for example an integer, string or double)
299: Level: beginner
301: Notes:
302: Once the error handler is called the calling function is then returned from with the given error code.
304: There are also versions for 4, 5, 6 and 7 arguments.
306: Experienced users can set the error handler with PetscPushErrorHandler().
308: Concepts: error^setting condition
310: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
311: M*/
312: #define SETERRQ6(comm,ierr,s,a1,a2,a3,a4,a5,a6) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6)314: /*MC
315: SETERRQ7 - Macro that is called when an error has been detected,
317: Synopsis:
318: #include <petscsys.h>
319: PetscErrorCodeSETERRQ7(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
321: Collective on MPI_Comm323: Input Parameters:
324: + comm - A communicator, so that the error can be collective
325: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
326: . message - error message in the printf format
327: . arg1 - argument (for example an integer, string or double)
328: . arg2 - argument (for example an integer, string or double)
329: . arg3 - argument (for example an integer, string or double)
330: . arg4 - argument (for example an integer, string or double)
331: . arg5 - argument (for example an integer, string or double)
332: . arg6 - argument (for example an integer, string or double)
333: - arg7 - argument (for example an integer, string or double)
335: Level: beginner
337: Notes:
338: Once the error handler is called the calling function is then returned from with the given error code.
340: There are also versions for 4, 5, 6 and 7 arguments.
342: Experienced users can set the error handler with PetscPushErrorHandler().
344: Concepts: error^setting condition
346: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
347: M*/
348: #define SETERRQ7(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7)350: /*MC
351: SETERRQ8 - Macro that is called when an error has been detected,
353: Synopsis:
354: #include <petscsys.h>
355: PetscErrorCodeSETERRQ8(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
357: Collective on MPI_Comm359: Input Parameters:
360: + comm - A communicator, so that the error can be collective
361: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
362: . message - error message in the printf format
363: . arg1 - argument (for example an integer, string or double)
364: . arg2 - argument (for example an integer, string or double)
365: . arg3 - argument (for example an integer, string or double)
366: . arg4 - argument (for example an integer, string or double)
367: . arg5 - argument (for example an integer, string or double)
368: . arg6 - argument (for example an integer, string or double)
369: . arg7 - argument (for example an integer, string or double)
370: - arg8 - argument (for example an integer, string or double)
372: Level: beginner
374: Notes:
375: Once the error handler is called the calling function is then returned from with the given error code.
377: There are also versions for 4, 5, 6 and 7 arguments.
379: Experienced users can set the error handler with PetscPushErrorHandler().
381: Concepts: error^setting condition
383: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
384: M*/
385: #define SETERRQ8(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8)387: /*MC
388: SETERRABORT - Macro that can be called when an error has been detected,
390: Synopsis:
391: #include <petscsys.h>
392: PetscErrorCodeSETERRABORT(MPI_Comm comm,PetscErrorCode ierr,char *message)
394: Collective on MPI_Comm396: Input Parameters:
397: + comm - A communicator, so that the error can be collective
398: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
399: - message - error message in the printf format
401: Level: beginner
403: Notes:
404: This function just calls MPI_Abort().
406: Concepts: error^setting condition
408: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
409: M*/
410: #define SETERRABORT(comm,ierr,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,ierr);} while (0)412: /*MC
413: CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns
415: Synopsis:
416: #include <petscsys.h>
417: PetscErrorCodeCHKERRQ(PetscErrorCode ierr)
419: Not Collective
421: Input Parameters:
422: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
424: Level: beginner
426: Notes:
427: Once the error handler is called the calling function is then returned from with the given error code.
429: Experienced users can set the error handler with PetscPushErrorHandler().
431: CHKERRQ(ierr) is fundamentally a macro replacement for
432: if (ierr) return(PetscError(...,ierr,...));
434: Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is
435: highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular,
436: it cannot be used in functions which return(void) or any other datatype. In these types of functions,
437: you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or
438: if (ierr) {PetscError(....); return(YourReturnType);}
439: where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have
440: MPI_Abort() returned immediately.
442: Concepts: error^setting condition
444: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
445: M*/
446: #define CHKERRQ(ierr) do {if (PetscUnlikely(ierr)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");} while (0)447: #define CHKERRV(ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");return;}} while(0)448: #define CHKERRABORT(comm,ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,ierr);}} while (0)449: #define CHKERRCONTINUE(ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," ");}} while (0)452: /*MC
453: CHKERRMPI - Checks error code, if non-zero it calls the error handler and then returns
455: Synopsis:
456: #include <petscsys.h>
457: PetscErrorCodeCHKERRMPI(PetscErrorCode ierr)
459: Not Collective
461: Input Parameters:
462: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
464: Level: developer
466: Notes:
467: This macro is FOR USE IN MPI CALLBACK FUNCTIONS ONLY, such as those passed to MPI_Comm_create_keyval(). It always returns the error code PETSC_MPI_ERROR_CODE
468: which is registered with MPI_Add_error_code() when PETSc is initialized.
470: Concepts: error^setting condition
472: .seealso: CHKERRQ(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
473: M*/
474: #define CHKERRMPI(ierr) do {if (PetscUnlikely(ierr)) return (PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_REPEAT," "),PETSC_MPI_ERROR_CODE);} while (0)476: #ifdef PETSC_CLANGUAGE_CXX
478: /*MC
479: CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception
481: Synopsis:
482: #include <petscsys.h>
483: void CHKERRXX(PetscErrorCode ierr)
485: Not Collective
487: Input Parameters:
488: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
490: Level: beginner
492: Notes:
493: Once the error handler throws a ??? exception.
495: You can use CHKERRV() which returns without an error code (bad idea since the error is ignored)
496: or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately.
498: Concepts: error^setting condition
500: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ501: M*/
502: #define CHKERRXX(ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_IN_CXX,0);}} while(0)504: #endif
506: #define CHKERRCUDA(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUDA error %d",err);} while(0)507: #define CHKERRCUBLAS(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUBLAS error %d",err);} while(0)509: /*MC
510: CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected
512: Synopsis:
513: #include <petscsys.h>
514: CHKMEMQ;
516: Not Collective
518: Level: beginner
520: Notes:
521: We highly recommend using valgrind http://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind for finding memory problems. This is useful
522: on systems that do not have valgrind, but much much less useful.
524: Must run with the option -malloc_debug to enable this option
526: Once the error handler is called the calling function is then returned from with the given error code.
528: By defaults prints location where memory that is corrupted was allocated.
530: Use CHKMEMA for functions that return void
532: Concepts: memory corruption
534: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
535: PetscMallocValidate()
536: M*/
537: #define CHKMEMQ do {PetscErrorCode _7_PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);CHKERRQ(_7_ierr);} while(0)539: #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__)541: /*E
542: PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers
544: Level: advanced
546: PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated
548: Developer Notes:
549: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler()
551: .seealso: PetscError(), SETERRXX()
552: E*/
553: typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType;
555: #if defined(__clang_analyzer__)
556: __attribute__((analyzer_noreturn))557: #endif
558: PETSC_EXTERN PetscErrorCodePetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...);
560: PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
561: PETSC_EXTERN PetscErrorCodePetscErrorMessage(int,const char*[],char **);
562: PETSC_EXTERN PetscErrorCodePetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
563: PETSC_EXTERN PetscErrorCodePetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
564: PETSC_EXTERN PetscErrorCodePetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
565: PETSC_EXTERN PetscErrorCodePetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
566: PETSC_EXTERN PetscErrorCodePetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
567: PETSC_EXTERN PetscErrorCodePetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
568: PETSC_EXTERN PetscErrorCodePetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
569: PETSC_EXTERN PetscErrorCodePetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*);
570: PETSC_EXTERN PetscErrorCodePetscPopErrorHandler(void);
571: PETSC_EXTERN PetscErrorCodePetscSignalHandlerDefault(int,void*);
572: PETSC_EXTERN PetscErrorCodePetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
573: PETSC_EXTERN PetscErrorCodePetscPopSignalHandler(void);
575: PETSC_EXTERN void PetscSignalSegvCheckPointer(void);
577: /*MC
578: PetscErrorPrintf - Prints error messages.
580: Synopsis:
581: #include <petscsys.h>
582: PetscErrorCode (*PetscErrorPrintf)(const char format[],...);
584: Not Collective
586: Input Parameters:
587: . format - the usual printf() format string
589: Options Database Keys:
590: + -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr
591: - -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.)
593: Notes:
594: Use
595: $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the
596: $ error is handled.) and
597: $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function
599: Use
600: PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
601: PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.
603: Use
604: PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print
606: Level: developer
608: Fortran Note:
609: This routine is not supported in Fortran.
611: Concepts: error messages^printing
612: Concepts: printing^error messages
614: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscPushErrorHandler(), PetscVFPrintf(), PetscHelpPrintf()
615: M*/
616: PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...);
618: typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
619: PETSC_EXTERN PetscErrorCodePetscSetFPTrap(PetscFPTrap);
620: PETSC_EXTERN PetscErrorCodePetscFPTrapPush(PetscFPTrap);
621: PETSC_EXTERN PetscErrorCodePetscFPTrapPop(void);
623: /*
624: Allows the code to build a stack frame as it runs
625: */
627: #define PETSCSTACKSIZE 64629: typedef struct {
630: const char *function[PETSCSTACKSIZE];
631: const char *file[PETSCSTACKSIZE];
632: int line[PETSCSTACKSIZE];
633: PetscBool petscroutine[PETSCSTACKSIZE];
634: int currentsize;
635: int hotdepth;
636: } PetscStack;
638: PETSC_EXTERN PetscStack *petscstack;
640: PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*);
641: PetscErrorCode PetscStackPrint(PetscStack *,FILE*);
642: #if defined(PETSC_SERIALIZE_FUNCTIONS)
643: #include <petsc/private/petscfptimpl.h>644: /*
645: Registers the current function into the global function pointer to function name table
647: Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
648: */
649: #define PetscRegister__FUNCT__() do { \650: static PetscBool __chked = PETSC_FALSE; \651: if (!__chked) {\652: void *ptr; PetscDLSym(NULL,PETSC_FUNCTION_NAME,&ptr);\653: __chked = PETSC_TRUE;\654: }} while (0)655: #else
656: #define PetscRegister__FUNCT__()657: #endif
659: #if defined(PETSC_USE_DEBUG)
660: PETSC_STATIC_INLINE PetscBool PetscStackActive(void)661: {
662: return(petscstack ? PETSC_TRUE : PETSC_FALSE);
663: }
665: /* Stack handling is based on the following two "NoCheck" macros. These should only be called directly by other error
666: * handling macros. We record the line of the call, which may or may not be the location of the definition. But is at
667: * least more useful than "unknown" because it can distinguish multiple calls from the same function.
668: */
670: #define PetscStackPushNoCheck(funct,petsc_routine,hot) \671: do { \672: PetscStackSAWsTakeAccess(); \673: if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \674: petscstack->function[petscstack->currentsize] = funct; \675: petscstack->file[petscstack->currentsize] = __FILE__; \676: petscstack->line[petscstack->currentsize] = __LINE__; \677: petscstack->petscroutine[petscstack->currentsize] = petsc_routine; \678: petscstack->currentsize++; \679: } \680: if (petscstack) { \681: petscstack->hotdepth += (hot || petscstack->hotdepth); \682: } \683: PetscStackSAWsGrantAccess(); \684: } while (0)686: #define PetscStackPopNoCheck \687: do { \688: PetscStackSAWsTakeAccess(); \689: if (petscstack && petscstack->currentsize > 0) { \690: petscstack->currentsize--; \691: petscstack->function[petscstack->currentsize] = 0; \692: petscstack->file[petscstack->currentsize] = 0; \693: petscstack->line[petscstack->currentsize] = 0; \694: petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\695: } \696: if (petscstack) { \697: petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0); \698: } \699: PetscStackSAWsGrantAccess(); \700: } while (0)702: /*MC
704: line of PETSc functions should be return(0);
706: Synopsis:
707: #include <petscsys.h>
710: Not Collective
712: Usage:
713: .vb
714: int something;
717: .ve
719: Notes:
722: Not available in Fortran
724: Level: developer
728: .keywords: traceback, error handling
729: M*/
731: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \732: PetscRegister__FUNCT__(); \733: } while (0)735: /*MC
737: performance-critical circumstances. Use of this function allows for lighter profiling by default.
739: Synopsis:
740: #include <petscsys.h>
743: Not Collective
745: Usage:
746: .vb
747: int something;
750: .ve
752: Notes:
753: Not available in Fortran
755: Level: developer
759: .keywords: traceback, error handling
760: M*/
762: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE); \763: PetscRegister__FUNCT__(); \764: } while (0)766: /*MC
769: Synopsis:
770: #include <petscsys.h>
773: Not Collective
775: Usage:
776: .vb
777: int something;
780: .ve
782: Notes:
783: Final line of PETSc functions should be return(0) except for main().
785: Not available in Fortran
788: routine instead of as a PETSc library routine.
790: Level: intermediate
794: .keywords: traceback, error handling
795: M*/
797: do { \798: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \799: PetscRegister__FUNCT__(); \800: } while (0)803: #define PetscStackPush(n) \804: do { \805: PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE); \806: CHKMEMQ; \807: } while (0)809: #define PetscStackPop \810: do { \811: CHKMEMQ; \812: PetscStackPopNoCheck; \813: } while (0)815: /*MC
816: PetscFunctionReturn - Last executable line of each PETSc function
817: used for error handling. Replaces return()
819: Synopsis:
820: #include <petscsys.h>
821: void return(0);
823: Not Collective
825: Usage:
826: .vb
827: ....
828: return(0);
829: }
830: .ve
832: Notes:
833: Not available in Fortran
835: Level: developer
839: .keywords: traceback, error handling
840: M*/
841: #define PetscFunctionReturn(a) \842: do { \843: PetscStackPopNoCheck; \844: return(a);} while (0)846: #define PetscFunctionReturnVoid() \847: do { \848: PetscStackPopNoCheck; \849: return;} while (0)851: #else
853: PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;}
854: #define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0)855: #define PetscStackPopNoCheck do {} while (0)859: #define PetscFunctionReturn(a) return(a)860: #define PetscFunctionReturnVoid() return861: #define PetscStackPop CHKMEMQ862: #define PetscStackPush(f) CHKMEMQ864: #endif
866: /*
867: PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack.
869: Input Parameters:
870: + name - string that gives the name of the function being called
871: - routine - actual call to the routine, including and
873: Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes
875: Developer Note: this is so that when a user or external library routine results in a crash or corrupts memory, they get blamed instead of PETSc.
879: */
880: #define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while(0)882: /*
883: PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack.
885: Input Parameters:
886: + func- name of the routine
887: - args - arguments to the routine surrounded by ()
889: Notes:
890: This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not.
892: Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc.
894: */
895: #define PetscStackCallStandard(func,args) do { \896: PetscStackPush(#func);func args;PetscStackPop; if (ierr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s(): error code %d",#func,(int)ierr); \897: } while (0)899: PETSC_EXTERN PetscErrorCode PetscStackCreate(void);
900: PETSC_EXTERN PetscErrorCode PetscStackView(FILE*);
901: PETSC_EXTERN PetscErrorCode PetscStackDestroy(void);
903: #endif