Actual source code: petscerror.h
1: /*
2: Contains all error handling interfaces for PETSc.
3: */
4: #pragma once
5: // IWYU pragma: private, include "petscsys.h"
7: #include <petscmacros.h>
8: #include <petscsystypes.h>
10: #if defined(__cplusplus)
11: #include <exception> // std::exception
12: #endif
14: /* SUBMANSEC = Sys */
16: #define SETERRQ1(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
17: #define SETERRQ2(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
18: #define SETERRQ3(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
19: #define SETERRQ4(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
20: #define SETERRQ5(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
21: #define SETERRQ6(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
22: #define SETERRQ7(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
23: #define SETERRQ8(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
24: #define SETERRQ9(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "SETERRQ", ) SETERRQ(__VA_ARGS__)
26: /*MC
27: SETERRQ - Macro to be called when an error has been detected,
29: Synopsis:
30: #include <petscsys.h>
31: PetscErrorCode SETERRQ(MPI_Comm comm, PetscErrorCode ierr, char *message, ...)
33: Collective
35: Input Parameters:
36: + comm - An MPI communicator, use `PETSC_COMM_SELF` unless you know all ranks of another communicator will detect the error
37: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
38: - message - error message
40: Level: beginner
42: Notes:
43: This is rarely needed, one should use `PetscCheck()` and `PetscCall()` and friends to automatically handle error conditions.
44: Once the error handler is called the calling function is then returned from with the given error code.
46: Experienced users can set the error handler with `PetscPushErrorHandler()`.
48: Fortran Note:
49: `SETERRQ()` may be called from Fortran subroutines but `SETERRA()` must be called from the
50: Fortran main program.
52: .seealso: `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`,
53: `PetscError()`, `PetscCall()`, `CHKMEMQ`, `CHKERRA()`, `PetscCallMPI()`, `PetscErrorCode`
54: M*/
55: #define SETERRQ(comm, ierr, ...) \
56: do { \
57: PetscErrorCode ierr_seterrq_petsc_ = PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__); \
58: return ierr_seterrq_petsc_ ? ierr_seterrq_petsc_ : PETSC_ERR_RETURN; \
59: } while (0)
61: #define SETERRQNULL(comm, ierr, ...) \
62: do { \
63: (void)PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__); \
64: return NULL; \
65: } while (0)
67: /*
68: Returned from PETSc functions that are called from MPI, such as related to attributes
69: Do not confuse PETSC_MPI_ERROR_CODE and PETSC_ERR_MPI, the first is registered with MPI and returned to MPI as
70: an error code, the latter is a regular PETSc error code passed within PETSc code indicating an error was detected in an MPI call.
71: */
72: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS;
73: PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE;
75: /*MC
76: SETERRMPI - Macro to be called when an error has been detected within an MPI callback function
78: No Fortran Support
80: Synopsis:
81: #include <petscsys.h>
82: PetscErrorCode SETERRMPI(MPI_Comm comm, PetscErrorCode ierr, char *message, ...)
84: Collective
86: Input Parameters:
87: + comm - An MPI communicator, use `PETSC_COMM_SELF` unless you know all ranks of another communicator will detect the error
88: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
89: - message - error message
91: Level: developer
93: Note:
94: 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`
95: which is registered with `MPI_Add_error_code()` when PETSc is initialized.
97: .seealso: `SETERRQ()`, `PetscCall()`, `PetscCallMPI()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `PetscErrorCode`
98: M*/
99: #define SETERRMPI(comm, ierr, ...) return ((void)PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__), PETSC_MPI_ERROR_CODE)
101: /*MC
102: SETERRA - Fortran-only macro that can be called when an error has been detected from the main program
104: Synopsis:
105: #include <petscsys.h>
106: PetscErrorCode SETERRA(MPI_Comm comm, PetscErrorCode ierr, char *message)
108: Collective
110: Input Parameters:
111: + comm - An MPI communicator, so that the error can be collective
112: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
113: - message - error message in the `printf()` format
115: Level: beginner
117: Notes:
118: This should only be used with Fortran. With C/C++, use `SETERRQ()`.
120: `SETERRQ()` may be called from Fortran subroutines but `SETERRA()` must be called from the
121: Fortran main program.
123: .seealso: `SETERRQ()`, `SETERRABORT()`, `PetscCall()`, `CHKERRA()`, `PetscCallAbort()`, `PetscErrorCode`
124: M*/
126: /*MC
127: SETERRABORT - Macro that can be called when an error has been detected,
129: Synopsis:
130: #include <petscsys.h>
131: PetscErrorCode SETERRABORT(MPI_Comm comm, PetscErrorCode ierr, char *message, ...)
133: Collective
135: Input Parameters:
136: + comm - An MPI communicator, so that the error can be collective
137: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
138: - message - error message in the `printf()` format
140: Level: beginner
142: Notes:
143: This function just calls `MPI_Abort()`.
145: This should only be called in routines that cannot return an error code, such as in C++ constructors.
147: Fortran Note:
148: Use `SETERRA()` in Fortran main program and `SETERRQ()` in Fortran subroutines
150: Developer Note:
151: In Fortran `SETERRA()` could be called `SETERRABORT()` since they serve the same purpose
153: .seealso: `SETERRQ()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `PetscCall()`, `CHKMEMQ`, `PetscErrorCode`
154: M*/
155: #define SETERRABORT(comm, ierr, ...) \
156: do { \
157: (void)PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__); \
158: (void)MPI_Abort(comm, ierr); \
159: } while (0)
161: /*MC
162: PetscCheck - Checks that a particular condition is true; if not true, then returns the provided error code
164: Synopsis:
165: #include <petscsys.h>
166: void PetscCheck(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)
168: Collective; No Fortran Support
170: Input Parameters:
171: + cond - The boolean condition
172: . comm - The communicator on which the check can be collective on
173: . ierr - A nonzero error code, see include/petscerror.h for the complete list
174: - message - Error message in the `printf()` format
176: Level: beginner
178: Notes:
179: Enabled in both optimized and debug builds.
181: As a general rule, `PetscCheck()` is used to check "usage error" (for example, passing an incorrect value as a function argument),
182: `PetscAssert()` is used to "check for bugs in PETSc" (for example, is a value in a PETSc data structure nonsensical).
183: However, for functions that are called in a "hot spot", for example, thousands of times in a loop, `PetscAssert()` should be used instead
184: of `PetscCheck()` since the former is compiled out in PETSc's optimization code.
186: Calls `SETERRQ()` if the assertion fails, so can only be called from functions returning a
187: `PetscErrorCode` (or equivalent type after conversion).
189: .seealso: `PetscAssert()`, `PetscCheckReturnMPI()`, `SETERRQ()`, `PetscError()`, `PetscCall()`, `PetscCheckAbort()`, `PetscErrorCode`
190: M*/
191: #define PetscCheck(cond, comm, ierr, ...) \
192: do { \
193: if (PetscUnlikely(!(cond))) SETERRQ(comm, ierr, __VA_ARGS__); \
194: } while (0)
196: /*MC
197: PetscCheckReturnMPI - Checks that a particular condition is true; if not true, then returns an MPI error code.
198: To check for errors in PETSc-provided MPI callbacks.
200: Synopsis:
201: #include <petscsys.h>
202: void PetscCheckReturnMPI(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)
204: Collective; No Fortran Support
206: Input Parameters:
207: + cond - The boolean condition
208: . comm - The communicator on which the check can be collective on
209: . ierr - A nonzero error code, see include/petscerror.h for the complete list
210: - message - Error message in the `printf()` format
212: Level: beginner
214: Note:
215: Enabled in both optimized and debug builds.
217: .seealso: `PetscCheck()`, `PetscAssert()`, `SETERRQ()`, `PetscError()`, `PetscCall()`, `PetscCheckAbort()`, `PetscErrorCode`
218: M*/
219: #define PetscCheckReturnMPI(cond, comm, ierr, ...) \
220: do { \
221: if (PetscUnlikely(!(cond))) SETERRMPI(comm, ierr, __VA_ARGS__); \
222: } while (0)
224: /*MC
225: PetscCheckAbort - Check that a particular condition is true, otherwise prints error and aborts
227: Synopsis:
228: #include <petscsys.h>
229: void PetscCheckAbort(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)
231: Collective; No Fortran Support
233: Input Parameters:
234: + cond - The boolean condition
235: . comm - The communicator on which the check can be collective on
236: . ierr - A nonzero error code, see include/petscerror.h for the complete list
237: - message - Error message in the `printf()` format
239: Level: developer
241: Notes:
242: Enabled in both optimized and debug builds.
244: Calls `SETERRABORT()` if the assertion fails, can be called from a function that does not return an
245: error code, such as a C++ constructor. usually `PetscCheck()` should be used.
247: .seealso: `PetscAssertAbort()`, `PetscAssert()`, `SETERRQ()`, `PetscError()`, `PetscCall()`, `PetscCheck()`, `SETERRABORT()`, `PetscErrorCode`
248: M*/
249: #define PetscCheckAbort(cond, comm, ierr, ...) \
250: do { \
251: if (PetscUnlikely(!(cond))) SETERRABORT(comm, ierr, __VA_ARGS__); \
252: } while (0)
254: /*MC
255: PetscAssert - Assert that a particular condition is true
257: Synopsis:
258: #include <petscsys.h>
259: void PetscAssert(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)
261: Collective; No Fortran Support
263: Input Parameters:
264: + cond - The boolean condition
265: . comm - The communicator on which the check can be collective on
266: . ierr - A nonzero error code, see include/petscerror.h for the complete list
267: - message - Error message in `printf()` format
269: Level: beginner
271: Notes:
272: Equivalent to `PetscCheck()` if debugging is enabled, and `PetscAssume(cond)` otherwise.
274: See `PetscCheck()` for usage and behaviour.
276: This is needed instead of simply using `assert()` because this correctly handles the collective nature of errors under MPI
278: .seealso: `PetscCheck()`, `SETERRQ()`, `PetscError()`, `PetscAssertAbort()`, `PetscErrorCode`
279: M*/
280: #if PetscDefined(USE_DEBUG)
281: #define PetscAssert(cond, comm, ierr, ...) PetscCheck(cond, comm, ierr, __VA_ARGS__)
282: #else
283: #define PetscAssert(cond, ...) PetscAssume(cond)
284: #endif
286: /*MC
287: PetscAssertAbort - Assert that a particular condition is true, otherwise prints error and aborts
289: Synopsis:
290: #include <petscsys.h>
291: void PetscAssertAbort(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...)
293: Collective; No Fortran Support
295: Input Parameters:
296: + cond - The boolean condition
297: . comm - The communicator on which the check can be collective on
298: . ierr - A nonzero error code, see include/petscerror.h for the complete list
299: - message - Error message in the `printf()` format
301: Level: beginner
303: Note:
304: Enabled only in debug builds. See `PetscCheckAbort()` for usage.
306: .seealso: `PetscCheckAbort()`, `PetscAssert()`, `PetscCheck()`, `SETERRABORT()`, `PetscError()`
307: M*/
308: #if PetscDefined(USE_DEBUG)
309: #define PetscAssertAbort(cond, comm, ierr, ...) PetscCheckAbort(cond, comm, ierr, __VA_ARGS__)
310: #else
311: #define PetscAssertAbort(cond, comm, ierr, ...) PetscAssume(cond)
312: #endif
314: /*MC
315: PetscCall - Calls a PETSc function and then checks the resulting error code, if it is
316: non-zero it calls the error handler and returns from the current function with the error
317: code.
319: Synopsis:
320: #include <petscsys.h>
321: void PetscCall(PetscFunction(args))
323: Not Collective
325: Input Parameter:
326: . PetscFunction - any PETSc function that returns an error code
328: Level: beginner
330: Notes:
331: Once the error handler is called the calling function is then returned from with the given
332: error code. Experienced users can set the error handler with `PetscPushErrorHandler()`.
334: `PetscCall()` cannot be used in functions returning a datatype not convertible to
335: `PetscErrorCode`. For example, `PetscCall()` may not be used in functions returning `void`, use
336: `PetscCallAbort()` or `PetscCallVoid()` in this case.
338: Example Usage:
339: .vb
340: PetscCall(PetscInitiailize(...)); // OK to call even when PETSc is not yet initialized!
342: struct my_struct
343: {
344: void *data;
345: } my_complex_type;
347: struct my_struct bar(void)
348: {
349: PetscCall(foo(15)); // ERROR PetscErrorCode not convertible to struct my_struct!
350: }
352: PetscCall(bar()) // ERROR input not convertible to PetscErrorCode
353: .ve
355: It is also possible to call this directly on a `PetscErrorCode` variable
356: .vb
357: PetscCall(ierr); // check if ierr is nonzero
358: .ve
360: Should not be used to call callback functions provided by users, `PetscCallBack()` should be used in that situation.
362: `PetscUseTypeMethod()` or `PetscTryTypeMethod()` should be used when calling functions pointers contained in a PETSc object's `ops` array
364: Fortran Notes:
365: The Fortran function in which this is used must declare a `PetscErrorCode` variable necessarily named `ierr`, and `ierr` must be
366: the final argument to the PETSc function being called.
368: In the main program and in Fortran subroutines that do not have `ierr` as the final return parameter, one
369: should use `PetscCallA()`
371: Example Fortran Usage:
372: .vb
373: PetscErrorCode ierr
374: Vec v
376: ...
377: PetscCall(VecShift(v, 1.0, ierr))
378: PetscCallA(VecShift(v, 1.0, ierr))
379: .ve
381: .seealso: `SETERRQ()`, `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()`,
382: `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`,
383: `CHKERRMPI()`, `PetscCallBack()`, `PetscCallAbort()`, `PetscCallVoid()`, `PetscCallNull()`
384: M*/
386: /*MC
387: PetscCallNull - Calls a PETSc function and then checks the resulting error code, if it is
388: non-zero it calls the error handler and returns a `NULL`
390: Synopsis:
391: #include <petscsys.h>
392: void PetscCallNull(PetscFunction(args))
394: Not Collective; No Fortran Support
396: Input Parameter:
397: . PetscFunction - any PETSc function that returns something that can be returned as a `NULL`
399: Level: developer
401: .seealso: `PetscCall()`, `SETERRQ()`, `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()`,
402: `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`,
403: `CHKERRMPI()`, `PetscCallBack()`, `PetscCallAbort()`, `PetscCallVoid()`, `PetscCall()`
404: M*/
406: /*MC
407: PetscCallA - Fortran-only macro that should be used in the main program and subroutines that do not have `ierr` as the final return parameter, to call PETSc functions instead of using
408: `PetscCall()` which should be used in other Fortran subroutines
410: Synopsis:
411: #include <petscsys.h>
412: PetscErrorCode PetscCallA(PetscFunction(arguments, ierr))
414: Collective
416: Input Parameter:
417: . PetscFunction(arguments,ierr) - the call to the function
419: Level: beginner
421: Notes:
422: This should only be used with Fortran. With C/C++, use `PetscCall()` always.
424: The Fortran function in which this is used must declare a `PetscErrorCode` variable necessarily named `ierr`
425: Use `SETERRA()` to set an error in a Fortran main program and `SETERRQ()` in Fortran subroutines
427: .seealso: `SETERRQ()`, `SETERRA()`, `SETERRABORT()`, `PetscCall()`, `CHKERRA()`, `PetscCallAbort()`
428: M*/
430: /*MC
431: PetscCallBack - Calls a user provided PETSc callback function and then checks the resulting error code, if it is non-zero it calls the error
432: handler and returns from the current function with the error code.
434: Synopsis:
435: #include <petscsys.h>
436: void PetscCallBack(const char *functionname, PetscFunction(args))
438: Not Collective; No Fortran Support
440: Input Parameters:
441: + functionname - the name of the function being called, this can be a string with spaces that describes the meaning of the callback
442: - PetscFunction - user provided callback function that returns an error code
444: Example Usage:
445: .vb
446: PetscCallBack("XXX callback to do something", a->callback(...));
447: .ve
449: Level: developer
451: Notes:
452: `PetscUseTypeMethod()` and ` PetscTryTypeMethod()` are the preferred API for this functionality. But when the callback functions are associated with a
453: `DMSNES` or `DMTS` this API must be used.
455: Once the error handler is called the calling function is then returned from with the given
456: error code. Experienced users can set the error handler with `PetscPushErrorHandler()`.
458: `PetscCallBack()` should only be called in PETSc when a call is being made to a user provided call-back routine.
460: Developer Note:
461: It would be good to provide a new API for when the callbacks are associated with `DMSNES` or `DMTS` so this routine could be used less
463: .seealso: `SETERRQ()`, `PetscCheck()`, `PetscCall()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()`
464: `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`, `CHKERRMPI()`, `PetscCall()`, `PetscUseTypeMethod()`, `PetscTryTypeMethod()`
465: M*/
467: /*MC
468: PetscCallVoid - Like `PetscCall()` but for use in functions that return `void`
470: Synopsis:
471: #include <petscsys.h>
472: void PetscCallVoid(PetscFunction(args))
474: Not Collective; No Fortran Support
476: Input Parameter:
477: . PetscFunction - any PETSc function that returns an error code
479: Example Usage:
480: .vb
481: void foo()
482: {
483: KSP ksp;
485: PetscFunctionBeginUser;
486: // OK, properly handles PETSc error codes
487: PetscCallVoid(KSPCreate(PETSC_COMM_WORLD, &ksp));
488: PetscFunctionReturnVoid();
489: }
491: PetscErrorCode bar()
492: {
493: KSP ksp;
495: PetscFunctionBeginUser;
496: // ERROR, Non-void function 'bar' should return a value
497: PetscCallVoid(KSPCreate(PETSC_COMM_WORLD, &ksp));
498: // OK, returning PetscErrorCode
499: PetscCall(KSPCreate(PETSC_COMM_WORLD, &ksp));
500: PetscFunctionReturn(PETSC_SUCCESS);
501: }
502: .ve
504: Level: beginner
506: Notes:
507: Has identical usage to `PetscCall()`, except that it returns `void` on error instead of a
508: `PetscErrorCode`. See `PetscCall()` for more detailed discussion.
510: Note that users should prefer `PetscCallAbort()` to this routine. While this routine does
511: "handle" errors by returning from the enclosing function, it effectively gobbles the
512: error. Since the enclosing function itself returns `void`, its callers have no way of knowing
513: that the routine returned early due to an error. `PetscCallAbort()` at least ensures that the
514: program crashes gracefully.
516: .seealso: `PetscCall()`, `PetscErrorCode`, `PetscCallAbort()`, `PetscCallNull()`
517: M*/
519: /*MC
520: PetscCallReturnMPI - Calls a PETSc function and then checks the resulting error code, if it is
521: non-zero it calls the error handler and returns from the current function with an MPI error code.
522: To check for errors in PETSc provided MPI callbacks.
524: Synopsis:
525: #include <petscsys.h>
526: void PetscCallReturnMPI(PetscFunction(args))
528: Not Collective
530: Input Parameter:
531: . PetscFunction - any PETSc function that returns an error code
533: Level: advanced
535: Notes:
536: Note to be confused with `PetscCallMPI()`.
538: This is be used in a PETSc-provided MPI callback function, such as `MPI_Comm_delete_attr_function function()`.
540: Currently, it always returns `MPI_ERR_OTHER` on failure
542: .seealso: `PetscCall()`, `PetscCallMPI()`, `SETERRQ()`, `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()`,
543: `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`,
544: `CHKERRMPI()`, `PetscCallBack()`, `PetscCallAbort()`, `PetscCallVoid()`, `PetscCallNull()`
545: M*/
547: #if defined(PETSC_CLANG_STATIC_ANALYZER)
548: void PetscCall(PetscErrorCode);
549: void PetscCallBack(const char *, PetscErrorCode);
550: void PetscCallVoid(PetscErrorCode);
551: void PetscCallNull(PetscErrorCode);
552: void PetscCallReturnMPI(PetscErrorCode);
553: #else
554: #define PetscCall(...) \
555: do { \
556: PetscErrorCode ierr_petsc_call_q_; \
557: PetscStackUpdateLine; \
558: ierr_petsc_call_q_ = __VA_ARGS__; \
559: if (PetscUnlikely(ierr_petsc_call_q_ != PETSC_SUCCESS)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_q_, PETSC_ERROR_REPEAT, " "); \
560: } while (0)
561: #define PetscCallNull(...) \
562: do { \
563: PetscErrorCode ierr_petsc_call_q_; \
564: PetscStackUpdateLine; \
565: ierr_petsc_call_q_ = __VA_ARGS__; \
566: if (PetscUnlikely(ierr_petsc_call_q_ != PETSC_SUCCESS)) { \
567: (void)PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_PLIB, PETSC_ERROR_INITIAL, " "); \
568: PetscFunctionReturn(NULL); \
569: } \
570: } while (0)
571: #define PetscCallBack(function, ...) \
572: do { \
573: PetscErrorCode ierr_petsc_call_q_; \
574: PetscStackUpdateLine; \
575: PetscStackPushExternal(function); \
576: ierr_petsc_call_q_ = __VA_ARGS__; \
577: PetscStackPop; \
578: if (PetscUnlikely(ierr_petsc_call_q_ != PETSC_SUCCESS)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_q_, PETSC_ERROR_REPEAT, " "); \
579: } while (0)
580: #define PetscCallVoid(...) \
581: do { \
582: PetscErrorCode ierr_petsc_call_void_; \
583: PetscStackUpdateLine; \
584: ierr_petsc_call_void_ = __VA_ARGS__; \
585: if (PetscUnlikely(ierr_petsc_call_void_ != PETSC_SUCCESS)) { \
586: (void)PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_void_, PETSC_ERROR_REPEAT, " "); \
587: return; \
588: } \
589: } while (0)
590: #define PetscCallReturnMPI(...) \
591: do { \
592: PetscErrorCode ierr_petsc_call_q_; \
593: PetscStackUpdateLine; \
594: ierr_petsc_call_q_ = __VA_ARGS__; \
595: if (PetscUnlikely(ierr_petsc_call_q_ != PETSC_SUCCESS)) { \
596: (void)PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_q_, PETSC_ERROR_REPEAT, " "); \
597: return MPI_ERR_OTHER; \
598: } \
599: } while (0)
600: #endif
602: /*MC
603: CHKERRQ - Checks error code returned from PETSc function
605: Synopsis:
606: #include <petscsys.h>
607: void CHKERRQ(PetscErrorCode ierr)
609: Not Collective
611: Input Parameter:
612: . ierr - nonzero error code
614: Level: deprecated
616: Note:
617: Deprecated in favor of `PetscCall()`. This routine behaves identically to it.
619: .seealso: `PetscCall()`
620: M*/
621: #define CHKERRQ(...) PetscCall(__VA_ARGS__)
622: #define CHKERRV(...) PetscCallVoid(__VA_ARGS__)
624: PETSC_EXTERN void PetscMPIErrorString(PetscMPIInt, size_t, char *);
626: /*MC
627: PetscCallMPI - Checks error code returned from MPI calls, if non-zero it calls the error
628: handler and then returns a `PetscErrorCode`
630: Synopsis:
631: #include <petscsys.h>
632: void PetscCallMPI(MPI_Function(args))
634: Not Collective
636: Input Parameter:
637: . MPI_Function - an MPI function that returns an MPI error code
639: Level: beginner
641: Notes:
642: Always returns the error code `PETSC_ERR_MPI`; the MPI error code and string are embedded in
643: the string error message. Do not use this to call any other routines (for example PETSc
644: routines), it should only be used for direct MPI calls. The user may configure PETSc with the
645: `--with-strict-petscerrorcode` option to check this at compile-time, otherwise they must
646: check this themselves.
648: This routine can only be used in functions returning `PetscErrorCode` themselves. If the
649: calling function returns a different type, use `PetscCallMPIAbort()` instead.
651: Example Usage:
652: .vb
653: PetscCallMPI(MPI_Comm_size(...)); // OK, calling MPI function
655: PetscCallMPI(PetscFunction(...)); // ERROR, use PetscCall() instead!
656: .ve
658: Fortran Notes:
659: The Fortran function from which this is used must declare a variable `PetscErrorCode` ierr and ierr must be
660: the final argument to the MPI function being called.
662: In the main program and in Fortran subroutines that do not have ierr as the final return parameter one
663: should use `PetscCallMPIA()`
665: Fortran Usage:
666: .vb
667: PetscErrorCode ierr or integer ierr
668: ...
669: PetscCallMPI(MPI_Comm_size(...,ierr))
670: PetscCallMPIA(MPI_Comm_size(...,ierr)) ! Will abort after calling error handler
672: PetscCallMPI(MPI_Comm_size(...,eflag)) ! ERROR, final argument must be ierr
673: .ve
675: .seealso: `SETERRMPI()`, `PetscCall()`, `PetscCallReturnMPI()`, `SETERRQ()`, `SETERRABORT()`, `PetscCallAbort()`,
676: `PetscCallMPIAbort()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`,
677: `PetscError()`, `CHKMEMQ`, `PetscCallMPINull()`
678: M*/
680: /*MC
681: PetscCallMPIReturnMPI - Checks error code returned from MPI calls, if non-zero it calls the error
682: handler and then returns an MPI error code. To check for errors in PETSc-provided MPI callbacks.
684: Synopsis:
685: #include <petscsys.h>
686: void PetscCallMPIReturnMPI(MPI_Function(args))
688: Not Collective
690: Input Parameter:
691: . MPI_Function - an MPI function that returns an MPI error code
693: Level: advanced
695: .seealso: `SETERRMPI()`, `PetscCall()`, `PetscCallMPI()`, `PetscCallReturnMPI()`, `SETERRQ()`, `SETERRABORT()`, `PetscCallAbort()`,
696: `PetscCallMPIAbort()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`,
697: `PetscError()`, `CHKMEMQ`, `PetscCallMPINull()`
698: M*/
700: /*MC
701: PetscCallMPINull - Checks error code returned from MPI calls, if non-zero it calls the error
702: handler and then returns a `NULL`
704: Synopsis:
705: #include <petscsys.h>
706: void PetscCallMPINull(MPI_Function(args))
708: Not Collective; No Fortran Support
710: Input Parameter:
711: . MPI_Function - an MPI function that returns an MPI error code
713: Level: beginner
715: Notes:
716: Always passes the error code `PETSC_ERR_MPI` to the error handler `PetscError()`; the MPI error code and string are embedded in
717: the string error message. Do not use this to call any other routines (for example PETSc
718: routines), it should only be used for direct MPI calls.
720: This routine can only be used in functions returning anything that can be returned as a `NULL` themselves. If the
721: calling function returns a different type, use `PetscCallMPIAbort()` instead.
723: Example Usage:
724: .vb
725: PetscCallMPINull(MPI_Comm_size(...)); // OK, calling MPI function
727: PetscCallMPI(PetscFunction(...)); // ERROR, use PetscCall() instead!
728: .ve
730: .seealso: `SETERRMPI()`, `PetscCall()`, `SETERRQ()`, `SETERRABORT()`, `PetscCallAbort()`,
731: `PetscCallMPIAbort()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`,
732: `PetscError()`, `CHKMEMQ`, `PetscCallMPI()`
733: M*/
735: /*MC
736: PetscCallMPIAbort - Like `PetscCallMPI()` but calls `MPI_Abort()` on error
738: Synopsis:
739: #include <petscsys.h>
740: void PetscCallMPIAbort(MPI_Comm comm, MPI_Function(args))
742: Not Collective
744: Input Parameters:
745: + comm - the MPI communicator to abort on
746: - MPI_Function - an MPI function that returns an MPI error code
748: Level: beginner
750: Notes:
751: Usage is identical to `PetscCallMPI()`. See `PetscCallMPI()` for detailed discussion.
753: This routine may be used in functions returning `void` or other non-`PetscErrorCode` types.
755: Fortran Note:
756: In Fortran this is called `PetscCallMPIA()` and is intended to be used in the main program while `PetscCallMPI()` is
757: used in Fortran subroutines.
759: Developer Note:
760: This should have the same name in Fortran.
762: .seealso: `PetscCallMPI()`, `PetscCallAbort()`, `SETERRABORT()`
763: M*/
764: #if defined(PETSC_CLANG_STATIC_ANALYZER)
765: void PetscCallMPI(PetscMPIInt);
766: void PetscCallMPIAbort(MPI_Comm, PetscMPIInt);
767: void PetscCallMPINull(PetscMPIInt);
768: #else
769: #define PetscCallMPI_Private(__PETSC_STACK_POP_FUNC__, __SETERR_FUNC__, __COMM__, ...) \
770: do { \
771: PetscMPIInt ierr_petsc_call_mpi_; \
772: PetscStackUpdateLine; \
773: PetscStackPushExternal("MPI function"); \
774: { \
775: ierr_petsc_call_mpi_ = __VA_ARGS__; \
776: } \
777: __PETSC_STACK_POP_FUNC__; \
778: if (PetscUnlikely(ierr_petsc_call_mpi_ != MPI_SUCCESS)) { \
779: char petsc_mpi_7_errorstring[2 * MPI_MAX_ERROR_STRING]; \
780: PetscMPIErrorString(ierr_petsc_call_mpi_, 2 * MPI_MAX_ERROR_STRING, (char *)petsc_mpi_7_errorstring); \
781: __SETERR_FUNC__(__COMM__, PETSC_ERR_MPI, "MPI error %d %s", ierr_petsc_call_mpi_, petsc_mpi_7_errorstring); \
782: } \
783: } while (0)
785: #define PetscCallMPI(...) PetscCallMPI_Private(PetscStackPop, SETERRQ, PETSC_COMM_SELF, __VA_ARGS__)
786: #define PetscCallMPIReturnMPI(...) PetscCallMPI_Private(PetscStackPopNoCheck(PETSC_FUNCTION_NAME), SETERRMPI, PETSC_COMM_SELF, __VA_ARGS__)
787: #define PetscCallMPIAbort(comm, ...) PetscCallMPI_Private(PetscStackPopNoCheck(PETSC_FUNCTION_NAME), SETERRABORT, comm, __VA_ARGS__)
788: #define PetscCallMPINull(...) PetscCallMPI_Private(PetscStackPopNoCheck(PETSC_FUNCTION_NAME), SETERRQNULL, PETSC_COMM_SELF, __VA_ARGS__)
789: #endif
791: /*MC
792: CHKERRMPI - Checks error code returned from MPI calls, if non-zero it calls the error
793: handler and then returns
795: Synopsis:
796: #include <petscsys.h>
797: void CHKERRMPI(PetscErrorCode ierr)
799: Not Collective
801: Input Parameter:
802: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
804: Level: deprecated
806: Note:
807: Deprecated in favor of `PetscCallMPI()`. This routine behaves identically to it.
809: .seealso: `PetscCallMPI()`
810: M*/
811: #define CHKERRMPI(...) PetscCallMPI(__VA_ARGS__)
813: /*MC
814: PetscCallAbort - Checks error code returned from PETSc function, if non-zero it aborts immediately by calling `MPI_Abort()`
816: Synopsis:
817: #include <petscsys.h>
818: void PetscCallAbort(MPI_Comm comm, PetscErrorCode ierr)
820: Collective
822: Input Parameters:
823: + comm - the MPI communicator on which to abort
824: - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
826: Level: intermediate
828: Notes:
829: This macro has identical type and usage semantics to `PetscCall()` with the important caveat
830: that this macro does not return. Instead, if ierr is nonzero it calls the PETSc error handler
831: and then immediately calls `MPI_Abort()`. It can therefore be used anywhere.
833: As per `MPI_Abort()` semantics the communicator passed must be valid, although there is currently
834: no attempt made at handling any potential errors from `MPI_Abort()`. Note that while
835: `MPI_Abort()` is required to terminate only those processes which reside on comm, it is often
836: the case that `MPI_Abort()` terminates *all* processes.
838: Example Usage:
839: .vb
840: PetscErrorCode boom(void) { return PETSC_ERR_MEM; }
842: void foo(void)
843: {
844: PetscCallAbort(PETSC_COMM_WORLD,boom()); // OK, does not return a type
845: }
847: double bar(void)
848: {
849: PetscCallAbort(PETSC_COMM_WORLD,boom()); // OK, does not return a type
850: }
852: PetscCallAbort(MPI_COMM_NULL,boom()); // ERROR, communicator should be valid
854: struct baz
855: {
856: baz()
857: {
858: PetscCallAbort(PETSC_COMM_SELF,boom()); // OK
859: }
861: ~baz()
862: {
863: PetscCallAbort(PETSC_COMM_SELF,boom()); // OK (in fact the only way to handle PETSc errors)
864: }
865: };
866: .ve
868: Fortran Note:
869: Use `PetscCallA()`.
871: Developer Note:
872: This should have the same name in Fortran as in C.
874: .seealso: `SETERRABORT()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`,
875: `SETERRQ()`, `CHKMEMQ`, `PetscCallMPI()`, `PetscCallCXXAbort()`
876: M*/
877: #if defined(PETSC_CLANG_STATIC_ANALYZER)
878: void PetscCallAbort(MPI_Comm, PetscErrorCode);
879: void PetscCallContinue(PetscErrorCode);
880: #else
881: #define PetscCallAbort(comm, ...) \
882: do { \
883: PetscErrorCode ierr_petsc_call_abort_; \
884: PetscStackUpdateLine; \
885: ierr_petsc_call_abort_ = __VA_ARGS__; \
886: if (PetscUnlikely(ierr_petsc_call_abort_ != PETSC_SUCCESS)) { \
887: ierr_petsc_call_abort_ = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_abort_, PETSC_ERROR_REPEAT, " "); \
888: (void)MPI_Abort(comm, (PetscMPIInt)ierr_petsc_call_abort_); \
889: } \
890: } while (0)
891: #define PetscCallContinue(...) \
892: do { \
893: PetscErrorCode ierr_petsc_call_continue_; \
894: PetscStackUpdateLine; \
895: ierr_petsc_call_continue_ = __VA_ARGS__; \
896: if (PetscUnlikely(ierr_petsc_call_continue_ != PETSC_SUCCESS)) { \
897: ierr_petsc_call_continue_ = PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_continue_, PETSC_ERROR_REPEAT, " "); \
898: (void)ierr_petsc_call_continue_; \
899: } \
900: } while (0)
901: #endif
903: /*MC
904: CHKERRABORT - Checks error code returned from PETSc function. If non-zero it aborts immediately.
906: Synopsis:
907: #include <petscsys.h>
908: void CHKERRABORT(MPI_Comm comm, PetscErrorCode ierr)
910: Not Collective
912: Input Parameters:
913: + comm - the MPI communicator
914: - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
916: Level: deprecated
918: Note:
919: Deprecated in favor of `PetscCallAbort()`. This routine behaves identically to it.
921: .seealso: `PetscCallAbort()`, `PetscErrorCode`
922: M*/
923: #define CHKERRABORT(comm, ...) PetscCallAbort(comm, __VA_ARGS__)
924: #define CHKERRCONTINUE(...) PetscCallContinue(__VA_ARGS__)
926: /*MC
927: CHKERRA - Fortran-only replacement for use of `CHKERRQ()` in the main program, which aborts immediately
929: Synopsis:
930: #include <petscsys.h>
931: PetscErrorCode CHKERRA(PetscErrorCode ierr)
933: Not Collective
935: Input Parameter:
936: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
938: Level: deprecated
940: Note:
941: This macro is rarely needed, normal usage is `PetscCallA()` in the main Fortran program.
943: Developer Note:
944: Why isn't this named `CHKERRABORT()` in Fortran?
946: .seealso: `PetscCall()`, `PetscCallA()`, `PetscCallAbort()`, `CHKERRQ()`, `SETERRA()`, `SETERRQ()`, `SETERRABORT()`
947: M*/
949: PETSC_EXTERN PetscBool petscwaitonerrorflg;
950: PETSC_EXTERN PetscBool petscindebugger;
951: PETSC_EXTERN PetscBool petscabortmpifinalize;
953: #if defined(PETSC_CLANG_STATIC_ANALYZER)
954: void PETSCABORTWITHERR_Private(MPI_Comm, PetscErrorCode);
955: #else
956: #define PETSCABORTWITHIERR_Private(comm, ierr) \
957: do { \
958: PetscMPIInt size_; \
959: (void)MPI_Comm_size(comm, &size_); \
960: if (PetscCIEnabledPortableErrorOutput && (size_ == PetscGlobalSize || petscabortmpifinalize) && ierr != PETSC_ERR_SIG) { \
961: (void)MPI_Finalize(); \
962: exit(0); \
963: } else if (PetscCIEnabledPortableErrorOutput && PetscGlobalSize == 1) { \
964: exit(0); \
965: } else { \
966: (void)MPI_Abort(comm, (PetscMPIInt)ierr); \
967: } \
968: } while (0)
969: #endif
971: /*MC
972: PETSCABORT - Call `MPI_Abort()` with an informative error code
974: Synopsis:
975: #include <petscsys.h>
976: PETSCABORT(MPI_Comm comm, PetscErrorCode ierr)
978: Collective; No Fortran Support
980: Input Parameters:
981: + comm - An MPI communicator, so that the error can be collective
982: - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
984: Level: advanced
986: Notes:
987: If the option `-start_in_debugger` was used then this calls `abort()` to stop the program in the debugger.
989: if `PetscCIEnabledPortableErrorOutput` is set, which means the code is running in the PETSc test harness (make test),
990: and `comm` is `MPI_COMM_WORLD` it strives to exit cleanly without calling `MPI_Abort()` and instead calling `MPI_Finalize()`.
992: This is currently only used when an error propagates up to the C `main()` program and is detected by a `PetscCall()`, `PetscCallMPI()`,
993: or is set in `main()` with `SETERRQ()`. Abort calls such as `SETERRABORT()`,
994: `PetscCheckAbort()`, `PetscCallMPIAbort()`, and `PetscCallAbort()` always call `MPI_Abort()` and do not have any special
995: handling for the test harness.
997: Developer Note:
998: Should the other abort calls also pass through this call instead of calling `MPI_Abort()` directly?
1000: .seealso: `PetscError()`, `PetscCall()`, `SETERRABORT()`, `PetscCheckAbort()`, `PetscCallMPIAbort()`, `PetscCall()`, `PetscCallMPI()`,
1001: `PetscCallAbort()`, `MPI_Abort()`, `PetscErrorCode`
1002: M*/
1003: #if defined(PETSC_CLANG_STATIC_ANALYZER)
1004: void PETSCABORT(MPI_Comm, PetscErrorCode);
1005: #else
1006: #define PETSCABORT(comm, ...) \
1007: do { \
1008: PetscErrorCode ierr_petsc_abort_; \
1009: if (petscwaitonerrorflg) { ierr_petsc_abort_ = PetscSleep(1000); } \
1010: if (petscindebugger) { \
1011: abort(); \
1012: } else { \
1013: ierr_petsc_abort_ = __VA_ARGS__; \
1014: PETSCABORTWITHIERR_Private(comm, ierr_petsc_abort_); \
1015: } \
1016: } while (0)
1017: #endif
1019: #ifdef PETSC_CLANGUAGE_CXX
1020: /*MC
1021: PetscCallThrow - Checks error code, if non-zero it calls the C++ error handler which throws
1022: an exception
1024: Synopsis:
1025: #include <petscsys.h>
1026: void PetscCallThrow(PetscErrorCode ierr)
1028: Not Collective
1030: Input Parameter:
1031: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
1033: Level: beginner
1035: Notes:
1036: Requires PETSc to be configured with clanguage of c++. Throws a std::runtime_error() on error.
1038: Once the error handler throws the exception you can use `PetscCallVoid()` which returns without
1039: an error code (bad idea since the error is ignored) or `PetscCallAbort()` to have `MPI_Abort()`
1040: called immediately.
1042: .seealso: `SETERRQ()`, `PetscCall()`, `SETERRABORT()`, `PetscCallAbort()`, `PetscTraceBackErrorHandler()`,
1043: `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`
1044: M*/
1045: #define PetscCallThrow(...) \
1046: do { \
1047: PetscStackUpdateLine; \
1048: PetscErrorCode ierr_petsc_call_throw_ = __VA_ARGS__; \
1049: if (PetscUnlikely(ierr_petsc_call_throw_ != PETSC_SUCCESS)) PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_call_throw_, PETSC_ERROR_IN_CXX, PETSC_NULLPTR); \
1050: } while (0)
1052: /*MC
1053: CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception
1055: Synopsis:
1056: #include <petscsys.h>
1057: void CHKERRXX(PetscErrorCode ierr)
1059: Not Collective
1061: Input Parameter:
1062: . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h
1064: Level: deprecated
1066: Note:
1067: Deprecated in favor of `PetscCallThrow()`. This routine behaves identically to it.
1069: .seealso: `PetscCallThrow()`
1070: M*/
1071: #define CHKERRXX(...) PetscCallThrow(__VA_ARGS__)
1072: #endif
1074: #define PetscCallCXX_Private(__SETERR_FUNC__, __COMM__, ...) \
1075: do { \
1076: PetscStackUpdateLine; \
1077: try { \
1078: __VA_ARGS__; \
1079: } catch (const std::exception &e) { \
1080: __SETERR_FUNC__(__COMM__, PETSC_ERR_LIB, "%s", e.what()); \
1081: } \
1082: } while (0)
1084: /*MC
1085: PetscCallCXX - Checks C++ function calls and if they throw an exception, catch it and then
1086: return a PETSc error code
1088: Synopsis:
1089: #include <petscsys.h>
1090: void PetscCallCXX(...) noexcept;
1092: Not Collective
1094: Input Parameter:
1095: . __VA_ARGS__ - An arbitrary expression
1097: Level: beginner
1099: Notes:
1100: `PetscCallCXX(...)` is a macro replacement for
1101: .vb
1102: try {
1103: __VA_ARGS__;
1104: } catch (const std::exception& e) {
1105: return ConvertToPetscErrorCode(e);
1106: }
1107: .ve
1108: Due to the fact that it catches any (reasonable) exception, it is essentially noexcept.
1110: If you cannot return a `PetscErrorCode` use `PetscCallCXXAbort()` instead.
1112: Example Usage:
1113: .vb
1114: void foo(void) { throw std::runtime_error("error"); }
1116: void bar()
1117: {
1118: PetscCallCXX(foo()); // ERROR bar() does not return PetscErrorCode
1119: }
1121: PetscErrorCode baz()
1122: {
1123: PetscCallCXX(foo()); // OK
1125: PetscCallCXX(
1126: bar();
1127: foo(); // OK multiple statements allowed
1128: );
1129: }
1131: struct bop
1132: {
1133: bop()
1134: {
1135: PetscCallCXX(foo()); // ERROR returns PetscErrorCode, cannot be used in constructors
1136: }
1137: };
1139: // ERROR contains do-while, cannot be used as function-try block
1140: PetscErrorCode qux() PetscCallCXX(
1141: bar();
1142: baz();
1143: foo();
1144: return 0;
1145: )
1146: .ve
1148: .seealso: `PetscCallCXXAbort()`, `PetscCallThrow()`, `SETERRQ()`, `PetscCall()`,
1149: `SETERRABORT()`, `PetscCallAbort()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`,
1150: `PetscError()`, `CHKMEMQ`
1151: M*/
1152: #define PetscCallCXX(...) PetscCallCXX_Private(SETERRQ, PETSC_COMM_SELF, __VA_ARGS__)
1154: /*MC
1155: PetscCallCXXAbort - Like `PetscCallCXX()` but calls `MPI_Abort()` instead of returning an
1156: error-code
1158: Synopsis:
1159: #include <petscsys.h>
1160: void PetscCallCXXAbort(MPI_Comm comm, ...) noexcept;
1162: Collective; No Fortran Support
1164: Input Parameters:
1165: + comm - The MPI communicator to abort on
1166: - __VA_ARGS__ - An arbitrary expression
1168: Level: beginner
1170: Notes:
1171: This macro may be used to check C++ expressions for exceptions in cases where you cannot
1172: return an error code. This includes constructors, destructors, copy/move assignment functions
1173: or constructors among others.
1175: If an exception is caught, the macro calls `SETERRABORT()` on `comm`. The exception must
1176: derive from `std::exception` in order to be caught.
1178: If the routine _can_ return an error-code it is highly advised to use `PetscCallCXX()`
1179: instead.
1181: See `PetscCallCXX()` for additional discussion.
1183: Example Usage:
1184: .vb
1185: class Foo
1186: {
1187: std::vector<int> data_;
1189: public:
1190: // normally std::vector::reserve() may raise an exception, but since we handle it with
1191: // PetscCallCXXAbort() we may mark this routine as noexcept!
1192: Foo() noexcept
1193: {
1194: PetscCallCXXAbort(PETSC_COMM_SELF, data_.reserve(10));
1195: }
1196: };
1198: std::vector<int> bar()
1199: {
1200: std::vector<int> v;
1202: PetscFunctionBegin;
1203: // OK!
1204: PetscCallCXXAbort(PETSC_COMM_SELF, v.emplace_back(1));
1205: PetscFunctionReturn(v);
1206: }
1208: PetscErrorCode baz()
1209: {
1210: std::vector<int> v;
1212: PetscFunctionBegin;
1213: // WRONG! baz() returns a PetscErrorCode, prefer PetscCallCXX() instead
1214: PetscCallCXXAbort(PETSC_COMM_SELF, v.emplace_back(1));
1215: PetscFunctionReturn(PETSC_SUCCESS);
1216: }
1217: .ve
1219: .seealso: `PetscCallCXX()`, `SETERRABORT()`, `PetscCallAbort()`
1220: M*/
1221: #define PetscCallCXXAbort(comm, ...) PetscCallCXX_Private(SETERRABORT, comm, __VA_ARGS__)
1223: /*MC
1224: CHKERRCXX - Checks C++ function calls and if they throw an exception, catch it and then
1225: return a PETSc error code
1227: Synopsis:
1228: #include <petscsys.h>
1229: void CHKERRCXX(func) noexcept;
1231: Not Collective
1233: Input Parameter:
1234: . func - C++ function calls
1236: Level: deprecated
1238: Note:
1239: Deprecated in favor of `PetscCallCXX()`. This routine behaves identically to it.
1241: .seealso: `PetscCallCXX()`
1242: M*/
1243: #define CHKERRCXX(...) PetscCallCXX(__VA_ARGS__)
1245: /*MC
1246: CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected
1248: Synopsis:
1249: #include <petscsys.h>
1250: CHKMEMQ;
1252: Not Collective
1254: Level: beginner
1256: Notes:
1257: We recommend using Valgrind <https://petsc.org/release/faq/#valgrind> or for NVIDIA CUDA systems
1258: <https://docs.nvidia.com/cuda/cuda-memcheck/index.html> for finding memory problems. The ``CHKMEMQ`` macro is useful on systems that
1259: do not have valgrind, but is not as good as valgrind or cuda-memcheck.
1261: Must run with the option `-malloc_debug` (`-malloc_test` in debug mode; or if `PetscMallocSetDebug()` called) to enable this option
1263: Once the error handler is called the calling function is then returned from with the given error code.
1265: By defaults prints location where memory that is corrupted was allocated.
1267: Use `CHKMEMA` for functions that return `void`
1269: .seealso: `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `SETERRQ()`, `PetscMallocValidate()`
1270: M*/
1271: #if defined(PETSC_CLANG_STATIC_ANALYZER)
1272: #define CHKMEMQ
1273: #define CHKMEMA
1274: #else
1275: #define CHKMEMQ \
1276: do { \
1277: PetscErrorCode ierr_petsc_memq_ = PetscMallocValidate(__LINE__, PETSC_FUNCTION_NAME, __FILE__); \
1278: if (PetscUnlikely(ierr_petsc_memq_ != PETSC_SUCCESS)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_petsc_memq_, PETSC_ERROR_REPEAT, " "); \
1279: } while (0)
1280: #define CHKMEMA PetscMallocValidate(__LINE__, PETSC_FUNCTION_NAME, __FILE__)
1281: #endif
1283: /*E
1284: PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers
1286: Level: advanced
1288: Note:
1289: `PETSC_ERROR_IN_CXX` indicates the error was detected in C++ and an exception should be generated
1291: Developer Note:
1292: This is currently used to decide when to print the detailed information about the run in `PetscTraceBackErrorHandler()`
1294: .seealso: `PetscError()`, `SETERRQ()`
1295: E*/
1296: typedef enum {
1297: PETSC_ERROR_INITIAL = 0,
1298: PETSC_ERROR_REPEAT = 1,
1299: PETSC_ERROR_IN_CXX = 2
1300: } PetscErrorType;
1302: #if defined(__clang_analyzer__)
1303: __attribute__((analyzer_noreturn))
1304: #endif
1305: PETSC_EXTERN PetscErrorCode
1306: PetscError(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, ...) PETSC_ATTRIBUTE_COLD PETSC_ATTRIBUTE_FORMAT(7, 8);
1308: PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void);
1309: PETSC_EXTERN PetscErrorCode PetscErrorMessage(PetscErrorCode, const char *[], char **);
1310: PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1311: PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1312: PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1313: PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1314: PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1315: PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1316: PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD;
1317: PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *), void *);
1318: PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void);
1319: PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int, void *);
1320: PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int, void *), void *);
1321: PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void);
1322: PETSC_EXTERN PetscErrorCode PetscCheckPointerSetIntensity(PetscInt);
1323: PETSC_EXTERN void PetscSignalSegvCheckPointerOrMpi(void);
1324: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "PetscSignalSegvCheckPointerOrMpi()", ) static inline void PetscSignalSegvCheckPointer(void)
1325: {
1326: PetscSignalSegvCheckPointerOrMpi();
1327: }
1329: /*MC
1330: PetscErrorPrintf - Prints error messages.
1332: Synopsis:
1333: #include <petscsys.h>
1334: PetscErrorCode (*PetscErrorPrintf)(const char format[], ...);
1336: Not Collective; No Fortran Support
1338: Input Parameter:
1339: . format - the usual `printf()` format string
1341: Options Database Keys:
1342: + -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr
1343: - -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.)
1345: Level: developer
1347: Notes:
1348: Use
1349: .vb
1350: PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the error is handled) and
1351: PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function
1352: .ve
1353: Use
1354: .vb
1355: `PETSC_STDERR` = FILE* obtained from a file open etc. to have stderr printed to the file.
1356: `PETSC_STDOUT` = FILE* obtained from a file open etc. to have stdout printed to the file.
1357: .ve
1358: Use
1359: .vb
1360: `PetscPushErrorHandler()` to provide your own error handler that determines what kind of messages to print
1361: .ve
1363: .seealso: `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscHelpPrintf()`, `PetscPrintf()`, `PetscPushErrorHandler()`, `PetscVFPrintf()`, `PetscHelpPrintf()`
1364: M*/
1365: PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2);
1367: /*E
1368: PetscFPTrap - types of floating point exceptions that may be trapped
1370: Currently only `PETSC_FP_TRAP_OFF` and `PETSC_FP_TRAP_ON` are handled. All others are treated as `PETSC_FP_TRAP_ON`.
1372: Level: intermediate
1374: .seealso: `PetscSetFPTrap()`, `PetscFPTrapPush()`
1375: E*/
1376: typedef enum {
1377: PETSC_FP_TRAP_OFF = 0,
1378: PETSC_FP_TRAP_INDIV = 1,
1379: PETSC_FP_TRAP_FLTOPERR = 2,
1380: PETSC_FP_TRAP_FLTOVF = 4,
1381: PETSC_FP_TRAP_FLTUND = 8,
1382: PETSC_FP_TRAP_FLTDIV = 16,
1383: PETSC_FP_TRAP_FLTINEX = 32,
1384: PETSC_FP_TRAP_ON = 63
1385: } PetscFPTrap;
1387: PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap);
1388: PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap);
1389: PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void);
1390: PETSC_EXTERN PetscErrorCode PetscDetermineInitialFPTrap(void);
1392: /*
1393: Allows the code to build a stack frame as it runs
1394: */
1396: #define PETSCSTACKSIZE 64
1397: typedef struct {
1398: const char *function[PETSCSTACKSIZE];
1399: const char *file[PETSCSTACKSIZE];
1400: int line[PETSCSTACKSIZE];
1401: int petscroutine[PETSCSTACKSIZE]; /* 0 external called from PETSc, 1 PETSc functions, 2 PETSc user functions */
1402: int currentsize;
1403: int hotdepth;
1404: PetscBool check; /* option to check for correct Push/Pop semantics, true for default petscstack but not other stacks */
1405: } PetscStack;
1406: #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1407: PETSC_EXTERN PetscStack petscstack;
1408: #endif
1410: #if defined(PETSC_SERIALIZE_FUNCTIONS)
1411: #include <petsc/private/petscfptimpl.h>
1412: /*
1413: Registers the current function into the global function pointer to function name table
1415: Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc
1416: */
1417: #define PetscRegister__FUNCT__() \
1418: do { \
1419: static PetscBool __chked = PETSC_FALSE; \
1420: if (!__chked) { \
1421: void *ptr; \
1422: PetscCallAbort(PETSC_COMM_SELF, PetscDLSym(NULL, PETSC_FUNCTION_NAME, &ptr)); \
1423: __chked = PETSC_TRUE; \
1424: } \
1425: } while (0)
1426: #else
1427: #define PetscRegister__FUNCT__()
1428: #endif
1430: #if defined(PETSC_CLANG_STATIC_ANALYZER) || defined(__clang_analyzer__)
1431: #define PetscStackPushNoCheck(funct, petsc_routine, hot)
1432: #define PetscStackUpdateLine
1433: #define PetscStackPushExternal(funct)
1434: #define PetscStackPopNoCheck(funct)
1435: #define PetscStackClearTop
1436: #define PetscFunctionBegin
1437: #define PetscFunctionBeginUser
1438: #define PetscFunctionBeginHot
1439: #define PetscFunctionReturn(...) return __VA_ARGS__
1440: #define PetscFunctionReturnVoid() return
1441: #define PetscStackPop
1442: #define PetscStackPush(f)
1443: #define PetscStackPush_Private(stack__, file__, func__, line__, petsc_routine__, hot__) \
1444: (void)file__; \
1445: (void)func__; \
1446: (void)line__
1447: #define PetscStackPop_Private(stack__, func__) (void)func__
1448: #elif defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1450: #define PetscStackPush_Private(stack__, file__, func__, line__, petsc_routine__, hot__) \
1451: do { \
1452: if (stack__.currentsize < PETSCSTACKSIZE) { \
1453: stack__.function[stack__.currentsize] = func__; \
1454: if (petsc_routine__) { \
1455: stack__.file[stack__.currentsize] = file__; \
1456: stack__.line[stack__.currentsize] = line__; \
1457: } else { \
1458: stack__.file[stack__.currentsize] = PETSC_NULLPTR; \
1459: stack__.line[stack__.currentsize] = 0; \
1460: } \
1461: stack__.petscroutine[stack__.currentsize] = petsc_routine__; \
1462: } \
1463: ++stack__.currentsize; \
1464: stack__.hotdepth += (hot__ || stack__.hotdepth); \
1465: } while (0)
1467: /* uses PetscCheckAbort() because may be used in a function that does not return an error code */
1468: #define PetscStackPop_Private(stack__, func__) \
1469: do { \
1470: PetscCheckAbort(!stack__.check || stack__.currentsize > 0, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Invalid stack size %d, pop %s %s:%d.\n", stack__.currentsize, func__, __FILE__, __LINE__); \
1471: if (--stack__.currentsize < PETSCSTACKSIZE) { \
1472: PetscCheckAbort(!stack__.check || stack__.petscroutine[stack__.currentsize] != 1 || stack__.function[stack__.currentsize] == func__, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Invalid stack: push from %s %s:%d. Pop from %s %s:%d.\n", \
1473: stack__.function[stack__.currentsize], stack__.file[stack__.currentsize], stack__.line[stack__.currentsize], func__, __FILE__, __LINE__); \
1474: stack__.function[stack__.currentsize] = PETSC_NULLPTR; \
1475: stack__.file[stack__.currentsize] = PETSC_NULLPTR; \
1476: stack__.line[stack__.currentsize] = 0; \
1477: stack__.petscroutine[stack__.currentsize] = 0; \
1478: } \
1479: stack__.hotdepth = PetscMax(stack__.hotdepth - 1, 0); \
1480: } while (0)
1482: /*MC
1483: PetscStackPushNoCheck - Pushes a new function name and line number onto the PETSc default stack that tracks where the running program is
1484: currently in the source code.
1486: Synopsis:
1487: #include <petscsys.h>
1488: void PetscStackPushNoCheck(char *funct,int petsc_routine,PetscBool hot);
1490: Not Collective
1492: Input Parameters:
1493: + funct - the function name
1494: . petsc_routine - 2 user function, 1 PETSc function, 0 some other function
1495: - hot - indicates that the function may be called often so expensive error checking should be turned off inside the function
1497: Level: developer
1499: Notes:
1500: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1501: occurred, for example, when a signal is received without running in the debugger. It is recommended to use the debugger if extensive information is needed to
1502: help debug the problem.
1504: This version does not check the memory corruption (an expensive operation), use `PetscStackPush()` to check the memory.
1506: Use `PetscStackPushExternal()` for a function call that is about to be made to a non-PETSc or user function (such as BLAS etc).
1508: The default stack is a global variable called `petscstack`.
1510: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`,
1511: `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPush()`, `PetscStackPop`,
1512: `PetscStackPushExternal()`
1513: M*/
1514: #define PetscStackPushNoCheck(funct, petsc_routine, hot) \
1515: do { \
1516: PetscStackSAWsTakeAccess(); \
1517: PetscStackPush_Private(petscstack, __FILE__, funct, __LINE__, petsc_routine, hot); \
1518: PetscStackSAWsGrantAccess(); \
1519: } while (0)
1521: /*MC
1522: PetscStackUpdateLine - in a function that has a `PetscFunctionBegin` or `PetscFunctionBeginUser` updates the stack line number to the
1523: current line number.
1525: Synopsis:
1526: #include <petscsys.h>
1527: void PetscStackUpdateLine
1529: Not Collective
1531: Level: developer
1533: Notes:
1534: Using `PetscCall()` and friends automatically handles this process
1536: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1537: occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to
1538: help debug the problem.
1540: The default stack is a global variable called `petscstack`.
1542: This is used by `PetscCall()` and is otherwise not like to be needed
1544: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPop`, `PetscCall()`
1545: M*/
1546: #define PetscStackUpdateLine \
1547: do { \
1548: if (petscstack.currentsize > 0 && petscstack.currentsize < PETSCSTACKSIZE && petscstack.function[petscstack.currentsize - 1] == PETSC_FUNCTION_NAME) { petscstack.line[petscstack.currentsize - 1] = __LINE__; } \
1549: } while (0)
1551: /*MC
1552: PetscStackPushExternal - Pushes a new function name onto the PETSc default stack that tracks where the running program is
1553: currently in the source code. Does not include the filename or line number since this is called by the calling routine
1554: for non-PETSc or user functions.
1556: Synopsis:
1557: #include <petscsys.h>
1558: void PetscStackPushExternal(char *funct);
1560: Not Collective
1562: Input Parameter:
1563: . funct - the function name
1565: Level: developer
1567: Notes:
1568: Using `PetscCallExternal()` and friends automatically handles this process
1570: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1571: occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to
1572: help debug the problem.
1574: The default stack is a global variable called `petscstack`.
1576: This is to be used when calling an external package function such as a BLAS function.
1578: This also updates the stack line number for the current stack function.
1580: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`,
1581: `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()`, `PetscStackPop`
1582: M*/
1583: #define PetscStackPushExternal(funct) \
1584: do { \
1585: PetscStackUpdateLine; \
1586: PetscStackPushNoCheck(funct, 0, PETSC_TRUE); \
1587: } while (0)
1589: /*MC
1590: PetscStackPopNoCheck - Pops a function name from the PETSc default stack that tracks where the running program is
1591: currently in the source code.
1593: Synopsis:
1594: #include <petscsys.h>
1595: void PetscStackPopNoCheck(char *funct);
1597: Not Collective
1599: Input Parameter:
1600: . funct - the function name
1602: Level: developer
1604: Notes:
1605: Using `PetscCall()`, `PetscCallExternal()`, `PetscCallBack()` and friends negates the need to call this
1607: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1608: occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to
1609: help debug the problem.
1611: The default stack is a global variable called `petscstack`.
1613: Developer Note:
1614: `PetscStackPopNoCheck()` takes a function argument while `PetscStackPop` does not, this difference is likely just historical.
1616: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPop`
1617: M*/
1618: #define PetscStackPopNoCheck(funct) \
1619: do { \
1620: PetscStackSAWsTakeAccess(); \
1621: PetscStackPop_Private(petscstack, funct); \
1622: PetscStackSAWsGrantAccess(); \
1623: } while (0)
1625: #define PetscStackClearTop \
1626: do { \
1627: PetscStackSAWsTakeAccess(); \
1628: if (petscstack.currentsize > 0 && --petscstack.currentsize < PETSCSTACKSIZE) { \
1629: petscstack.function[petscstack.currentsize] = PETSC_NULLPTR; \
1630: petscstack.file[petscstack.currentsize] = PETSC_NULLPTR; \
1631: petscstack.line[petscstack.currentsize] = 0; \
1632: petscstack.petscroutine[petscstack.currentsize] = 0; \
1633: } \
1634: petscstack.hotdepth = PetscMax(petscstack.hotdepth - 1, 0); \
1635: PetscStackSAWsGrantAccess(); \
1636: } while (0)
1638: /*MC
1639: PetscFunctionBegin - First executable line of each PETSc function, used for error handling. Final
1640: line of PETSc functions should be `PetscFunctionReturn`(0);
1642: Synopsis:
1643: #include <petscsys.h>
1644: void PetscFunctionBegin;
1646: Not Collective; No Fortran Support
1648: Usage:
1649: .vb
1650: int something;
1652: PetscFunctionBegin;
1653: .ve
1655: Level: developer
1657: Note:
1658: Use `PetscFunctionBeginUser` for application codes.
1660: .seealso: `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()`
1662: M*/
1663: #define PetscFunctionBegin \
1664: do { \
1665: PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 1, PETSC_FALSE); \
1666: PetscRegister__FUNCT__(); \
1667: } while (0)
1669: /*MC
1670: PetscFunctionBeginHot - Substitute for `PetscFunctionBegin` to be used in functions that are called in
1671: performance-critical circumstances. Use of this function allows for lighter profiling by default.
1673: Synopsis:
1674: #include <petscsys.h>
1675: void PetscFunctionBeginHot;
1677: Not Collective; No Fortran Support
1679: Usage:
1680: .vb
1681: int something;
1683: PetscFunctionBeginHot;
1684: .ve
1686: Level: developer
1688: .seealso: `PetscFunctionBegin`, `PetscFunctionReturn()`, `PetscStackPushNoCheck()`
1690: M*/
1691: #define PetscFunctionBeginHot \
1692: do { \
1693: PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 1, PETSC_TRUE); \
1694: PetscRegister__FUNCT__(); \
1695: } while (0)
1697: /*MC
1698: PetscFunctionBeginUser - First executable line of user provided routines
1700: Synopsis:
1701: #include <petscsys.h>
1702: void PetscFunctionBeginUser;
1704: Not Collective; No Fortran Support
1706: Usage:
1707: .vb
1708: int something;
1710: PetscFunctionBeginUser;
1711: .ve
1713: Level: intermediate
1715: Notes:
1716: Functions that incorporate this must call `PetscFunctionReturn()` instead of return except for main().
1718: May be used before `PetscInitialize()`
1720: This is identical to `PetscFunctionBegin` except it labels the routine as a user
1721: routine instead of as a PETSc library routine.
1723: .seealso: `PetscFunctionReturn()`, `PetscFunctionBegin`, `PetscFunctionBeginHot`, `PetscStackPushNoCheck()`
1724: M*/
1725: #define PetscFunctionBeginUser \
1726: do { \
1727: PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 2, PETSC_FALSE); \
1728: PetscRegister__FUNCT__(); \
1729: } while (0)
1731: /*MC
1732: PetscStackPush - Pushes a new function name and line number onto the PETSc default stack that tracks where the running program is
1733: currently in the source code and verifies the memory is not corrupted.
1735: Synopsis:
1736: #include <petscsys.h>
1737: void PetscStackPush(char *funct)
1739: Not Collective
1741: Input Parameter:
1742: . funct - the function name
1744: Level: developer
1746: Notes:
1747: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1748: occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to
1749: help debug the problem.
1751: The default stack is a global variable called `petscstack`.
1753: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`,
1754: `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()`, `PetscStackPop`
1755: M*/
1756: #define PetscStackPush(n) \
1757: do { \
1758: PetscStackPushNoCheck(n, 0, PETSC_FALSE); \
1759: CHKMEMQ; \
1760: } while (0)
1762: /*MC
1763: PetscStackPop - Pops a function name from the PETSc default stack that tracks where the running program is
1764: currently in the source code and verifies the memory is not corrupted.
1766: Synopsis:
1767: #include <petscsys.h>
1768: void PetscStackPop
1770: Not Collective
1772: Level: developer
1774: Notes:
1775: In debug mode PETSc maintains a stack of the current function calls that can be used to help to quickly see where a problem has
1776: occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to
1777: help debug the problem.
1779: The default stack is a global variable called `petscstack`.
1781: .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPopNoCheck()`, `PetscStackPush()`
1782: M*/
1783: #define PetscStackPop \
1784: do { \
1785: CHKMEMQ; \
1786: PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \
1787: } while (0)
1789: /*MC
1790: PetscFunctionReturn - Last executable line of each PETSc function used for error
1791: handling. Replaces `return()`.
1793: Synopsis:
1794: #include <petscsys.h>
1795: void PetscFunctionReturn(...)
1797: Not Collective; No Fortran Support
1799: Level: beginner
1801: Notes:
1802: This routine is a macro, so while it does not "return" anything itself, it does return from
1803: the function in the literal sense.
1805: Usually the return value is the integer literal `0` (for example in any function returning
1806: `PetscErrorCode`), however it is possible to return any arbitrary type. The arguments of
1807: this macro are placed before the `return` statement as-is.
1809: Any routine which returns via `PetscFunctionReturn()` must begin with a corresponding
1810: `PetscFunctionBegin`.
1812: For routines which return `void` use `PetscFunctionReturnVoid()` instead.
1814: Example Usage:
1815: .vb
1816: PetscErrorCode foo(int *x)
1817: {
1818: PetscFunctionBegin; // don't forget the begin!
1819: *x = 10;
1820: PetscFunctionReturn(PETSC_SUCCESS);
1821: }
1822: .ve
1824: May return any arbitrary type\:
1825: .vb
1826: struct Foo
1827: {
1828: int x;
1829: };
1831: struct Foo make_foo(int value)
1832: {
1833: struct Foo f;
1835: PetscFunctionBegin;
1836: f.x = value;
1837: PetscFunctionReturn(f);
1838: }
1839: .ve
1841: .seealso: `PetscFunctionBegin`, `PetscFunctionBeginUser`, `PetscFunctionReturnVoid()`,
1842: `PetscStackPopNoCheck()`
1843: M*/
1844: #define PetscFunctionReturn(...) \
1845: do { \
1846: PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \
1847: return __VA_ARGS__; \
1848: } while (0)
1850: /*MC
1851: PetscFunctionReturnVoid - Like `PetscFunctionReturn()` but returns `void`
1853: Synopsis:
1854: #include <petscsys.h>
1855: void PetscFunctionReturnVoid()
1857: Not Collective
1859: Level: beginner
1861: Note:
1862: Behaves identically to `PetscFunctionReturn()` except that it returns `void`. That is, this
1863: macro culminates with `return`.
1865: Example Usage:
1866: .vb
1867: void foo()
1868: {
1869: PetscFunctionBegin; // must start with PetscFunctionBegin!
1870: bar();
1871: baz();
1872: PetscFunctionReturnVoid();
1873: }
1874: .ve
1876: .seealso: `PetscFunctionReturn()`, `PetscFunctionBegin`, PetscFunctionBeginUser`
1877: M*/
1878: #define PetscFunctionReturnVoid() \
1879: do { \
1880: PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \
1881: return; \
1882: } while (0)
1883: #else /* PETSC_USE_DEBUG */
1884: #define PetscStackPushNoCheck(funct, petsc_routine, hot)
1885: #define PetscStackUpdateLine
1886: #define PetscStackPushExternal(funct)
1887: #define PetscStackPopNoCheck(...)
1888: #define PetscStackClearTop
1889: #define PetscFunctionBegin
1890: #define PetscFunctionBeginUser
1891: #define PetscFunctionBeginHot
1892: #define PetscFunctionReturn(...) return __VA_ARGS__
1893: #define PetscFunctionReturnVoid() return
1894: #define PetscStackPop CHKMEMQ
1895: #define PetscStackPush(f) CHKMEMQ
1896: #endif /* PETSC_USE_DEBUG */
1898: #if defined(PETSC_CLANG_STATIC_ANALYZER)
1899: #define PetscStackCallExternalVoid(...)
1900: template <typename F, typename... Args>
1901: void PetscCallExternal(F, Args...);
1902: template <typename F, typename... Args>
1903: void PetscCallExternalAbort(F, Args...);
1904: #else
1905: /*MC
1906: PetscStackCallExternalVoid - Calls an external library routine or user function after pushing the name of the routine on the stack.
1908: Input Parameters:
1909: + name - string that gives the name of the function being called
1910: - routine - actual call to the routine, for example, functionname(a,b)
1912: Level: developer
1914: Notes:
1915: Often one should use `PetscCallExternal()` instead. This routine is intended for external library routines that DO NOT return error codes
1917: In debug mode this also checks the memory for corruption at the end of the function call.
1919: Certain external packages, such as BLAS/LAPACK may have their own macros, `PetscCallBLAS()` for managing the call, error checking, etc.
1921: Developer Note:
1922: This is so that when a user or external library routine results in a crash or corrupts memory, they get blamed instead of PETSc.
1924: .seealso: `PetscCall()`, `PetscStackPushNoCheck()`, `PetscStackPush()`, `PetscCallExternal()`, `PetscCallBLAS()`
1925: @*/
1926: #define PetscStackCallExternalVoid(name, ...) \
1927: do { \
1928: PetscStackPushExternal(name); \
1929: __VA_ARGS__; \
1930: PetscStackPop; \
1931: } while (0)
1933: /*MC
1934: PetscCallExternal - Calls an external library routine that returns an error code after pushing the name of the routine on the stack.
1936: Input Parameters:
1937: + func - name of the routine
1938: - args - arguments to the routine
1940: Level: developer
1942: Notes:
1943: This is intended for external package routines that return error codes. Use `PetscStackCallExternalVoid()` for those that do not.
1945: In debug mode this also checks the memory for corruption at the end of the function call.
1947: Assumes the error return code of the function is an integer and that a value of 0 indicates success
1949: Developer Note:
1950: This is so that when an external package routine results in a crash or corrupts memory, they get blamed instead of PETSc.
1952: .seealso: `PetscCall()`, `PetscStackPushNoCheck()`, `PetscStackPush()`, `PetscStackCallExternalVoid()`, `PetscCallExternalAbort()`
1953: M*/
1954: #define PetscCallExternal(func, ...) \
1955: do { \
1956: PetscStackPush(PetscStringize(func)); \
1957: int ierr_petsc_call_external_ = (int)func(__VA_ARGS__); \
1958: PetscStackPop; \
1959: PetscCheck(ierr_petsc_call_external_ == 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "Error in %s(): error code %d", PetscStringize(func), ierr_petsc_call_external_); \
1960: } while (0)
1962: /*MC
1963: PetscCallExternalAbort - Calls an external library routine that returns an error code after pushing the name of the routine on the stack. If the external library function return code indicates an error, this prints the error and aborts
1965: Input Parameters:
1966: + func - name of the routine
1967: - args - arguments to the routine
1969: Level: developer
1971: Notes:
1972: This is intended for external package routines that return error codes. Use `PetscStackCallExternalVoid()` for those that do not.
1974: In debug mode this also checks the memory for corruption at the end of the function call.
1976: Assumes the error return code of the function is an integer and that a value of 0 indicates success
1978: Developer Note:
1979: This is so that when an external package routine results in a crash or corrupts memory, they get blamed instead of PETSc.
1981: .seealso: `PetscCall()`, `PetscStackPushNoCheck()`, `PetscStackPush()`, `PetscStackCallExternalVoid()`, `PetscCallExternal()`
1982: M*/
1983: #define PetscCallExternalAbort(func, ...) \
1984: do { \
1985: PetscStackUpdateLine; \
1986: int ierr_petsc_call_external_ = func(__VA_ARGS__); \
1987: if (PetscUnlikely(ierr_petsc_call_external_ != 0)) { \
1988: (void)PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, PETSC_ERR_LIB, PETSC_ERROR_INITIAL, "Error in %s(): error code %d", PetscStringize(func), ierr_petsc_call_external_); \
1989: PETSCABORTWITHIERR_Private(PETSC_COMM_SELF, PETSC_ERR_LIB); \
1990: } \
1991: } while (0)
1992: #endif /* PETSC_CLANG_STATIC_ANALYZER */