Actual source code: petscerror.h
petsc-main 2021-04-20
1: /*
2: Contains all error handling interfaces for PETSc.
3: */
4: #if !defined(PETSCERROR_H)
5: #define PETSCERROR_H
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 src/sys/f90-mod/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 write options which should not be changed */
61: #define PETSC_ERR_WRONG_MPI_SIZE 94 /* example/application run with number of MPI ranks it does not support */
62: #define PETSC_ERR_USER_INPUT 95 /* missing or incorrect user input */
63: #define PETSC_ERR_GPU_RESOURCE 96 /* unable to load a GPU resource, for example cuBLAS */
64: #define PETSC_ERR_GPU 97 /* An error from a GPU call, this may be due to lack of resources on the GPU or a true error in the call */
65: #define PETSC_ERR_MPI 98 /* general MPI error */
66: #define PETSC_ERR_MAX_VALUE 99 /* this is always the one more than the largest error code */
68: #define PetscStringizeArg(a) #a
69: #define PetscStringize(a) PetscStringizeArg(a)
72: /*MC
73: SETERRQ - Macro to be called when an error has been detected,
75: Synopsis:
76: #include <petscsys.h>
77: PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode ierr,char *message)
79: Collective
81: Input Parameters:
82: + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
83: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
84: - message - error message
86: Level: beginner
88: Notes:
89: Once the error handler is called the calling function is then returned from with the given error code.
91: See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments
93: Experienced users can set the error handler with PetscPushErrorHandler().
95: Fortran Notes:
96: SETERRQ() may be called from Fortran subroutines but SETERRA() must be called from the
97: Fortran main program.
99: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), CHKERRMPI()
100: M*/
101: #define SETERRQ(comm,ierr,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s)
103: /*
104: Returned from PETSc functions that are called from MPI, such as related to attributes
105: Do not confuse PETSC_MPI_ERROR_CODE and PETSC_ERR_MPI, the first is registered with MPI and returned to MPI as
106: an error code, the latter is a regular PETSc error code passed within PETSc code indicating an error was detected in an MPI call.
107: */
108: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
109: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
112: /*MC
113: SETERRMPI - Macro to be called when an error has been detected within an MPI callback function
115: Synopsis:
116: #include <petscsys.h>
117: PetscErrorCode SETERRMPI(MPI_Comm comm,PetscErrorCode ierr,char *message)
119: Collective
121: Input Parameters:
122: + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error
123: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
124: - message - error message
126: Level: developer
128: Notes:
129: 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
130: which is registered with MPI_Add_error_code() when PETSc is initialized.
132: .seealso: SETERRQ(), CHKERRQ(), CHKERRMPI(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3()
133: M*/
134: #define SETERRMPI(comm,ierr,s) return (PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s),PETSC_MPI_ERROR_CODE)
136: /*MC
137: SETERRQ1 - Macro that is called when an error has been detected,
139: Synopsis:
140: #include <petscsys.h>
141: PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg)
143: Collective
145: Input Parameters:
146: + comm - A communicator, so that the error can be collective
147: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
148: . message - error message in the printf format
149: - arg - argument (for example an integer, string or double)
151: Level: beginner
153: Notes:
154: Once the error handler is called the calling function is then returned from with the given error code.
156: Experienced users can set the error handler with PetscPushErrorHandler().
158: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3()
159: M*/
160: #define SETERRQ1(comm,ierr,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1)
162: /*MC
163: SETERRQ2 - Macro that is called when an error has been detected,
165: Synopsis:
166: #include <petscsys.h>
167: PetscErrorCode SETERRQ2(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2)
169: Collective
171: Input Parameters:
172: + comm - A communicator, so that the error can be collective
173: . ierr - 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)
178: Level: beginner
180: Notes:
181: Once the error handler is called the calling function is then returned from with the given error code.
183: Experienced users can set the error handler with PetscPushErrorHandler().
185: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3()
186: M*/
187: #define SETERRQ2(comm,ierr,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2)
189: /*MC
190: SETERRQ3 - Macro that is called when an error has been detected,
192: Synopsis:
193: #include <petscsys.h>
194: PetscErrorCode SETERRQ3(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3)
196: Collective
198: Input Parameters:
199: + comm - A communicator, so that the error can be collective
200: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
201: . message - error message in the printf format
202: . arg1 - argument (for example an integer, string or double)
203: . arg2 - argument (for example an integer, string or double)
204: - arg3 - argument (for example an integer, string or double)
206: Level: beginner
208: Notes:
209: Once the error handler is called the calling function is then returned from with the given error code.
211: There are also versions for 4, 5, 6 and 7 arguments.
213: Experienced users can set the error handler with PetscPushErrorHandler().
215: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
216: M*/
217: #define SETERRQ3(comm,ierr,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3)
219: /*MC
220: SETERRQ4 - Macro that is called when an error has been detected,
222: Synopsis:
223: #include <petscsys.h>
224: PetscErrorCode SETERRQ4(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4)
226: Collective
228: Input Parameters:
229: + comm - A communicator, so that the error can be collective
230: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
231: . message - error message in the printf format
232: . arg1 - argument (for example an integer, string or double)
233: . arg2 - argument (for example an integer, string or double)
234: . arg3 - argument (for example an integer, string or double)
235: - arg4 - argument (for example an integer, string or double)
237: Level: beginner
239: Notes:
240: Once the error handler is called the calling function is then returned from with the given error code.
242: There are also versions for 4, 5, 6 and 7 arguments.
244: Experienced users can set the error handler with PetscPushErrorHandler().
246: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
247: M*/
248: #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)
250: /*MC
251: SETERRQ5 - Macro that is called when an error has been detected,
253: Synopsis:
254: #include <petscsys.h>
255: PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5)
257: Collective
259: Input Parameters:
260: + comm - A communicator, so that the error can be collective
261: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
262: . message - error message in the printf format
263: . arg1 - argument (for example an integer, string or double)
264: . arg2 - argument (for example an integer, string or double)
265: . arg3 - argument (for example an integer, string or double)
266: . arg4 - argument (for example an integer, string or double)
267: - arg5 - argument (for example an integer, string or double)
269: Level: beginner
271: Notes:
272: Once the error handler is called the calling function is then returned from with the given error code.
274: There are also versions for 4, 5, 6 and 7 arguments.
276: Experienced users can set the error handler with PetscPushErrorHandler().
278: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
279: M*/
280: #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)
282: /*MC
283: SETERRQ6 - Macro that is called when an error has been detected,
285: Synopsis:
286: #include <petscsys.h>
287: PetscErrorCode SETERRQ6(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6)
289: Collective
291: Input Parameters:
292: + comm - A communicator, so that the error can be collective
293: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
294: . message - error message in the printf format
295: . arg1 - argument (for example an integer, string or double)
296: . arg2 - argument (for example an integer, string or double)
297: . arg3 - argument (for example an integer, string or double)
298: . arg4 - argument (for example an integer, string or double)
299: . arg5 - argument (for example an integer, string or double)
300: - arg6 - argument (for example an integer, string or double)
302: Level: beginner
304: Notes:
305: Once the error handler is called the calling function is then returned from with the given error code.
307: There are also versions for 4, 5, 6 and 7 arguments.
309: Experienced users can set the error handler with PetscPushErrorHandler().
311: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
312: M*/
313: #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)
315: /*MC
316: SETERRQ7 - Macro that is called when an error has been detected,
318: Synopsis:
319: #include <petscsys.h>
320: PetscErrorCode SETERRQ7(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7)
322: Collective
324: Input Parameters:
325: + comm - A communicator, so that the error can be collective
326: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
327: . message - error message in the printf format
328: . arg1 - argument (for example an integer, string or double)
329: . arg2 - argument (for example an integer, string or double)
330: . arg3 - argument (for example an integer, string or double)
331: . arg4 - argument (for example an integer, string or double)
332: . arg5 - argument (for example an integer, string or double)
333: . arg6 - argument (for example an integer, string or double)
334: - arg7 - argument (for example an integer, string or double)
336: Level: beginner
338: Notes:
339: Once the error handler is called the calling function is then returned from with the given error code.
341: There are also versions for 4, 5, 6 and 7 arguments.
343: Experienced users can set the error handler with PetscPushErrorHandler().
345: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
346: M*/
347: #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)
349: /*MC
350: SETERRQ8 - Macro that is called when an error has been detected,
352: Synopsis:
353: #include <petscsys.h>
354: PetscErrorCode SETERRQ8(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8)
356: Collective
358: Input Parameters:
359: + comm - A communicator, so that the error can be collective
360: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
361: . message - error message in the printf format
362: . arg1 - argument (for example an integer, string or double)
363: . arg2 - argument (for example an integer, string or double)
364: . arg3 - argument (for example an integer, string or double)
365: . arg4 - argument (for example an integer, string or double)
366: . arg5 - argument (for example an integer, string or double)
367: . arg6 - argument (for example an integer, string or double)
368: . arg7 - argument (for example an integer, string or double)
369: - arg8 - argument (for example an integer, string or double)
371: Level: beginner
373: Notes:
374: Once the error handler is called the calling function is then returned from with the given error code.
376: There are also versions for 4, 5, 6 and 7 arguments.
378: Experienced users can set the error handler with PetscPushErrorHandler().
380: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
381: M*/
382: #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)
384: /*MC
385: SETERRQ9 - Macro that is called when an error has been detected,
387: Synopsis:
388: #include <petscsys.h>
389: PetscErrorCode SETERRQ9(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9)
391: Collective
393: Input Parameters:
394: + comm - A communicator, so that the error can be collective
395: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
396: . message - error message in the printf format
397: . arg1 - argument (for example an integer, string or double)
398: . arg2 - argument (for example an integer, string or double)
399: . arg3 - argument (for example an integer, string or double)
400: . arg4 - argument (for example an integer, string or double)
401: . arg5 - argument (for example an integer, string or double)
402: . arg6 - argument (for example an integer, string or double)
403: . arg7 - argument (for example an integer, string or double)
404: . arg8 - argument (for example an integer, string or double)
405: - arg9 - argument (for example an integer, string or double)
407: Level: beginner
409: Notes:
410: Once the error handler is called the calling function is then returned from with the given error code.
412: There are also versions for 0 to 9 arguments.
414: Experienced users can set the error handler with PetscPushErrorHandler().
416: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
417: M*/
418: #define SETERRQ9(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8,a9)
420: /*MC
421: SETERRABORT - Macro that can be called when an error has been detected,
423: Synopsis:
424: #include <petscsys.h>
425: PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode ierr,char *message)
427: Collective
429: Input Parameters:
430: + comm - A communicator, so that the error can be collective
431: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
432: - message - error message in the printf format
434: Level: beginner
436: Notes:
437: This function just calls MPI_Abort().
439: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2()
440: M*/
441: #define SETERRABORT(comm,ierr,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,ierr);} while (0)
443: /*MC
444: CHKERRQ - Checks error code returned from PETSc function, if non-zero it calls the error handler and then returns. Use CHKERRMPI() for checking errors from MPI calls
446: Synopsis:
447: #include <petscsys.h>
448: PetscErrorCode CHKERRQ(PetscErrorCode ierr)
450: Not Collective
452: Input Parameters:
453: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
455: Level: beginner
457: Notes:
458: Once the error handler is called the calling function is then returned from with the given error code.
460: Experienced users can set the error handler with PetscPushErrorHandler().
462: CHKERRQ(ierr) is fundamentally a macro replacement for
463: if (ierr) return(PetscError(...,ierr,...));
465: Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is
466: highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular,
467: it cannot be used in functions which return(void) or any other datatype. In these types of functions,
468: you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or
469: if (ierr) {PetscError(....); return(YourReturnType);}
470: where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have
471: MPI_Abort() returned immediately.
473: Fortran Notes:
474: CHKERRQ() may be called from Fortran subroutines but CHKERRA() must be called from the
475: Fortran main program.
477: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2()
478: M*/
479: #define CHKERRQ(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");} while (0)
480: #define CHKERRV(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");return;}} while (0)
482: /*MC
483: CHKERRABORT - Checks error code returned from PETSc function. If non-zero it aborts immediately.
485: Synopsis:
486: #include <petscsys.h>
487: PetscErrorCode CHKERRABORT(MPI_Comm comm,PetscErrorCode ierr)
489: Not Collective
491: Input Parameters:
492: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
494: Level: intermediate
496: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2(), SETERRABORT(), CHKERRMPI()
497: M*/
498: #define CHKERRABORT(comm,ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,ierr);}} while (0)
499: #define CHKERRCONTINUE(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");}} while (0)
501: PETSC_EXTERN PetscErrorCode PetscAbortFindSourceFile_Private(const char*,PetscInt*);
502: PETSC_EXTERN PetscBool petscwaitonerrorflg,petscindebugger;
504: /*MC
505: PETSCABORT - Call MPI_Abort with an informative error code
507: Synopsis:
508: #include <petscsys.h>
509: PETSCABORT(MPI_Comm comm, PetscErrorCode ierr)
511: Collective
513: Input Parameters:
514: + comm - A communicator, so that the error can be collective
515: - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
517: Level: advanced
519: Notes:
520: We pass MPI_Abort() an error code of format XX_YYYY_ZZZ, where XX, YYYY are an index and line number of the file
521: where PETSCABORT is called, respectively. ZZZ is the PETSc error code.
523: If XX is zero, this means that the call was made in the routine main().
524: If XX is one, that means 1) the file is not in PETSc (it may be in users code); OR 2) the file is in PETSc but PetscAbortSourceFiles[]
525: is out of date. PETSc developers have to update it.
526: Otherwise, look up the value of XX in the table PetscAbortSourceFiles[] in src/sys/error/err.c to map XX back to the source file where the PETSCABORT() was called.
528: If the option -start_in_debugger was used then this calls abort() to stop the program in the debugger.
530: M*/
531: #define PETSCABORT(comm,ierr) \
532: do { \
533: PetscInt idx = 0; \
534: PetscMPIInt errcode; \
535: PetscAbortFindSourceFile_Private(__FILE__,&idx); \
536: errcode = (PetscMPIInt)(0*idx*10000000 + 0*__LINE__*1000 + ierr); \
537: if (petscwaitonerrorflg) PetscSleep(1000); \
538: if (petscindebugger) abort(); \
539: else MPI_Abort(comm,errcode); \
540: } while (0)
542: /*MC
543: CHKERRMPI - Checks error code returned from MPI calls, if non-zero it calls the error handler and then returns
545: Synopsis:
546: #include <petscsys.h>
547: PetscErrorCode CHKERRMPI(PetscErrorCode ierr)
549: Not Collective
551: Input Parameters:
552: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
554: Level: intermediate
556: Notes:
557: Always returns the error code PETSC_ERR_MPI; the MPI error code and string are embedded in the string error message
559: .seealso: CHKERRQ(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2(), SETERRMPI(), SETERRABORT(), CHKERRABORT()
560: M*/
561: #define CHKERRMPI(ierr) \
562: do { \
563: PetscErrorCode _7_errorcode = (ierr); \
564: if (PetscUnlikely(_7_errorcode)) { \
565: char _7_errorstring[MPI_MAX_ERROR_STRING]; \
566: PetscMPIInt _7_resultlen; \
567: MPI_Error_string(_7_errorcode,(char*)_7_errorstring,&_7_resultlen); (void)_7_resultlen; \
568: SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_MPI,"MPI error %d %s",(int)_7_errorcode,_7_errorstring); \
569: } \
570: } while (0)
572: #ifdef PETSC_CLANGUAGE_CXX
574: /*MC
575: CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception
577: Synopsis:
578: #include <petscsys.h>
579: void CHKERRXX(PetscErrorCode ierr)
581: Not Collective
583: Input Parameters:
584: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
586: Level: beginner
588: Notes:
589: Once the error handler throws a ??? exception.
591: You can use CHKERRV() which returns without an error code (bad idea since the error is ignored)
592: or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately.
594: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ
595: M*/
596: #define CHKERRXX(ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_IN_CXX,0);}} while (0)
598: #endif
600: /* TODO: SEK: Need to figure out the hipsolver issues */
601: #if defined(PETSC_HAVE_HIP)
602: #define CHKERRHIPSOLVER(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"HIPSOLVER error %d",err);} while (0)
603: #endif
604: /*MC
605: CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected
607: Synopsis:
608: #include <petscsys.h>
609: CHKMEMQ;
611: Not Collective
613: Level: beginner
615: Notes:
616: We highly recommend using valgrind https://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind for finding memory problems. This is useful
617: on systems that do not have valgrind, but much much less useful.
619: Must run with the option -malloc_debug (-malloc_test in debug mode; or if PetscMallocSetDebug() called) to enable this option
621: Once the error handler is called the calling function is then returned from with the given error code.
623: By defaults prints location where memory that is corrupted was allocated.
625: Use CHKMEMA for functions that return void
627: .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(),
628: PetscMallocValidate()
629: M*/
630: #define CHKMEMQ do {PetscErrorCode _7_PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);CHKERRQ(_7_ierr);} while (0)
632: #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__)
634: /*E
635: PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers
637: Level: advanced
639: PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated
641: Developer Notes:
642: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler()
644: .seealso: PetscError(), SETERRXX()
645: E*/
646: typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType;
648: #if defined(__clang_analyzer__)
649: __attribute__((analyzer_noreturn))
650: #endif
651: PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...);
653: PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
654: PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **);
655: PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
656: PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
657: PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
658: PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
659: PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
660: PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
661: PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*);
662: PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*);
663: PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void);
664: PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*);
665: PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*);
666: PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void);
668: PETSC_EXTERN void PetscSignalSegvCheckPointerOrMpi(void);
669: PETSC_DEPRECATED_FUNCTION("Use PetscSignalSegvCheckPointerOrMpi() (since version 3.13)") PETSC_STATIC_INLINE void PetscSignalSegvCheckPointer(void) {PetscSignalSegvCheckPointerOrMpi();}
671: /*MC
672: PetscErrorPrintf - Prints error messages.
674: Synopsis:
675: #include <petscsys.h>
676: PetscErrorCode (*PetscErrorPrintf)(const char format[],...);
678: Not Collective
680: Input Parameters:
681: . format - the usual printf() format string
683: Options Database Keys:
684: + -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr
685: - -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.)
687: Notes:
688: Use
689: $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the
690: $ error is handled.) and
691: $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function
693: Use
694: PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
695: PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.
697: Use
698: PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print
700: Level: developer
702: Fortran Note:
703: This routine is not supported in Fortran.
706: .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscPushErrorHandler(), PetscVFPrintf(), PetscHelpPrintf()
707: M*/
708: PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...);
710: typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap;
711: PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
712: PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap);
713: PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void);
714: PETSC_EXTERN PetscErrorCode PetscDetermineInitialFPTrap(void);
716: /*
717: Allows the code to build a stack frame as it runs
718: */
720: #define PETSCSTACKSIZE 64
722: typedef struct {
723: const char *function[PETSCSTACKSIZE];
724: const char *file[PETSCSTACKSIZE];
725: int line[PETSCSTACKSIZE];
726: PetscBool petscroutine[PETSCSTACKSIZE];
727: int currentsize;
728: int hotdepth;
729: } PetscStack;
731: PETSC_EXTERN PetscStack *petscstack;
733: PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*);
734: PetscErrorCode PetscStackPrint(PetscStack *,FILE*);
735: #if defined(PETSC_SERIALIZE_FUNCTIONS)
736: #include <petsc/private/petscfptimpl.h>
737: /*
738: Registers the current function into the global function pointer to function name table
740: Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
741: */
742: #define PetscRegister__FUNCT__() do { \
743: static PetscBool __chked = PETSC_FALSE; \
744: if (!__chked) {\
745: void *ptr; PetscDLSym(NULL,PETSC_FUNCTION_NAME,&ptr);\
746: __chked = PETSC_TRUE;\
747: }} while (0)
748: #else
749: #define PetscRegister__FUNCT__()
750: #endif
752: #if defined(PETSC_USE_DEBUG)
753: PETSC_STATIC_INLINE PetscBool PetscStackActive(void)
754: {
755: return(petscstack ? PETSC_TRUE : PETSC_FALSE);
756: }
758: /* Stack handling is based on the following two "NoCheck" macros. These should only be called directly by other error
759: * handling macros. We record the line of the call, which may or may not be the location of the definition. But is at
760: * least more useful than "unknown" because it can distinguish multiple calls from the same function.
761: */
763: #define PetscStackPushNoCheck(funct,petsc_routine,hot) \
764: do { \
765: PetscStackSAWsTakeAccess(); \
766: if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \
767: petscstack->function[petscstack->currentsize] = funct; \
768: petscstack->file[petscstack->currentsize] = __FILE__; \
769: petscstack->line[petscstack->currentsize] = __LINE__; \
770: petscstack->petscroutine[petscstack->currentsize] = petsc_routine; \
771: petscstack->currentsize++; \
772: } \
773: if (petscstack) { \
774: petscstack->hotdepth += (hot || petscstack->hotdepth); \
775: } \
776: PetscStackSAWsGrantAccess(); \
777: } while (0)
779: #define PetscStackPopNoCheck \
780: do { \
781: PetscStackSAWsTakeAccess(); \
782: if (petscstack && petscstack->currentsize > 0) { \
783: petscstack->currentsize--; \
784: petscstack->function[petscstack->currentsize] = NULL; \
785: petscstack->file[petscstack->currentsize] = NULL; \
786: petscstack->line[petscstack->currentsize] = 0; \
787: petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\
788: } \
789: if (petscstack) { \
790: petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0); \
791: } \
792: PetscStackSAWsGrantAccess(); \
793: } while (0)
795: /*MC
797: line of PETSc functions should be return(0);
799: Synopsis:
800: #include <petscsys.h>
803: Not Collective
805: Usage:
806: .vb
807: int something;
810: .ve
812: Notes:
815: Not available in Fortran
817: Level: developer
821: M*/
823: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \
824: PetscRegister__FUNCT__(); \
825: } while (0)
827: /*MC
829: performance-critical circumstances. Use of this function allows for lighter profiling by default.
831: Synopsis:
832: #include <petscsys.h>
835: Not Collective
837: Usage:
838: .vb
839: int something;
842: .ve
844: Notes:
845: Not available in Fortran
847: Level: developer
851: M*/
853: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE); \
854: PetscRegister__FUNCT__(); \
855: } while (0)
857: /*MC
860: Synopsis:
861: #include <petscsys.h>
864: Not Collective
866: Usage:
867: .vb
868: int something;
871: .ve
873: Notes:
874: Final line of PETSc functions should be return(0) except for main().
876: Not available in Fortran
879: routine instead of as a PETSc library routine.
881: Level: intermediate
885: M*/
887: do { \
888: PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \
889: PetscRegister__FUNCT__(); \
890: } while (0)
893: #define PetscStackPush(n) \
894: do { \
895: PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE); \
896: CHKMEMQ; \
897: } while (0)
899: #define PetscStackPop \
900: do { \
901: CHKMEMQ; \
902: PetscStackPopNoCheck; \
903: } while (0)
905: /*MC
906: PetscFunctionReturn - Last executable line of each PETSc function
907: used for error handling. Replaces return()
909: Synopsis:
910: #include <petscsys.h>
911: void return(0);
913: Not Collective
915: Usage:
916: .vb
917: ....
918: return(0);
919: }
920: .ve
922: Notes:
923: Not available in Fortran
925: Level: developer
929: M*/
930: #define PetscFunctionReturn(a) \
931: do { \
932: PetscStackPopNoCheck; \
933: return(a);} while (0)
935: #define PetscFunctionReturnVoid() \
936: do { \
937: PetscStackPopNoCheck; \
938: return;} while (0)
940: #else
942: PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;}
943: #define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0)
944: #define PetscStackPopNoCheck do {} while (0)
948: #define PetscFunctionReturn(a) return(a)
949: #define PetscFunctionReturnVoid() return
950: #define PetscStackPop CHKMEMQ
951: #define PetscStackPush(f) CHKMEMQ
953: #endif
955: /*
956: PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack.
958: Input Parameters:
959: + name - string that gives the name of the function being called
960: - routine - actual call to the routine, including and
962: Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes
964: 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.
968: */
969: #define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while (0)
971: /*
972: PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack.
974: Input Parameters:
975: + func- name of the routine
976: - args - arguments to the routine surrounded by ()
978: Notes:
979: This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not.
981: Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc.
983: */
984: #define PetscStackCallStandard(func,args) do { \
985: PetscErrorCode __ierr; \
986: PetscStackPush(#func); \
987: __func args; \
988: PetscStackPop; \
989: if (__ierr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s(): error code %d",#func,(int)__ierr); \
990: } while (0)
992: PETSC_EXTERN PetscErrorCode PetscStackCreate(void);
993: PETSC_EXTERN PetscErrorCode PetscStackView(FILE*);
994: PETSC_EXTERN PetscErrorCode PetscStackDestroy(void);
996: #endif