1 /* 2 Contains all error handling interfaces for PETSc. 3 */ 4 #ifndef PETSCERROR_H 5 #define PETSCERROR_H 6 7 #include <petscmacros.h> 8 #include <petscsystypes.h> 9 10 /* SUBMANSEC = Sys */ 11 12 /* 13 These are the generic error codes. These error codes are used 14 many different places in the PETSc source code. The string versions are 15 at src/sys/error/err.c any changes here must also be made there 16 These are also define in src/sys/f90-mod/petscerror.h any CHANGES here 17 must be also made there. 18 19 */ 20 #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 21 22 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 23 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 24 #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 25 #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 26 #define PETSC_ERR_SIG 59 /* signal received */ 27 #define PETSC_ERR_FP 72 /* floating point exception */ 28 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 29 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 30 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 31 #define PETSC_ERR_MEMC 78 /* memory corruption */ 32 #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 33 #define PETSC_ERR_USER 83 /* user has not provided needed function */ 34 #define PETSC_ERR_SYS 88 /* error in system call */ 35 #define PETSC_ERR_POINTER 70 /* pointer does not point to valid address */ 36 #define PETSC_ERR_MPI_LIB_INCOMP 87 /* MPI library at runtime is not compatible with MPI user compiled with */ 37 38 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 39 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 40 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 41 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 42 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 43 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 44 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 45 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 46 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 47 #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 48 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 49 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 50 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 51 52 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 53 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 54 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 55 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 56 57 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 58 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 59 60 #define PETSC_ERR_INT_OVERFLOW 84 61 62 #define PETSC_ERR_FLOP_COUNT 90 63 #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 64 #define PETSC_ERR_MISSING_FACTOR 92 /* MatGetFactor() failed */ 65 #define PETSC_ERR_OPT_OVERWRITE 93 /* attempted to over write options which should not be changed */ 66 #define PETSC_ERR_WRONG_MPI_SIZE 94 /* example/application run with number of MPI ranks it does not support */ 67 #define PETSC_ERR_USER_INPUT 95 /* missing or incorrect user input */ 68 #define PETSC_ERR_GPU_RESOURCE 96 /* unable to load a GPU resource, for example cuBLAS */ 69 #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 */ 70 #define PETSC_ERR_MPI 98 /* general MPI error */ 71 #define PETSC_ERR_RETURN 99 /* PetscError() incorrectly returned an error code of 0 */ 72 #define PETSC_ERR_MAX_VALUE 100 /* this is always the one more than the largest error code */ 73 74 #define SETERRQ1(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 75 #define SETERRQ2(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 76 #define SETERRQ3(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 77 #define SETERRQ4(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 78 #define SETERRQ5(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 79 #define SETERRQ6(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 80 #define SETERRQ7(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 81 #define SETERRQ8(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 82 #define SETERRQ9(...) PETSC_DEPRECATED_MACRO("GCC warning \"Use SETERRQ() (since version 3.17)\"") SETERRQ(__VA_ARGS__) 83 84 /*MC 85 SETERRQ - Macro to be called when an error has been detected, 86 87 Synopsis: 88 #include <petscsys.h> 89 PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode ierr,char *message,...) 90 91 Collective 92 93 Input Parameters: 94 + comm - A communicator, use `PETSC_COMM_SELF` unless you know all ranks of another communicator will detect the error 95 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 96 - message - error message 97 98 Level: beginner 99 100 Notes: 101 This is rarely needed, one should use `PetscCheck()` and `PetscCall()` and friends to automatically handle error conditions. 102 Once the error handler is called the calling function is then returned from with the given error code. 103 104 Experienced users can set the error handler with `PetscPushErrorHandler()`. 105 106 Fortran Notes: 107 SETERRQ() may be called from Fortran subroutines but SETERRA() must be called from the 108 Fortran main program. 109 110 .seealso: `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, 111 `PetscError()`, `PetscCall()`, `CHKMEMQ`, `CHKERRA()`, `PetscCallMPI()` 112 M*/ 113 #define SETERRQ(comm, ierr, ...) \ 114 do { \ 115 PetscErrorCode ierr_seterrq_petsc_ = PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__); \ 116 return ierr_seterrq_petsc_ ? ierr_seterrq_petsc_ : PETSC_ERR_RETURN; \ 117 } while (0) 118 119 /* 120 Returned from PETSc functions that are called from MPI, such as related to attributes 121 Do not confuse PETSC_MPI_ERROR_CODE and PETSC_ERR_MPI, the first is registered with MPI and returned to MPI as 122 an error code, the latter is a regular PETSc error code passed within PETSc code indicating an error was detected in an MPI call. 123 */ 124 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS; 125 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE; 126 127 /*MC 128 SETERRMPI - Macro to be called when an error has been detected within an MPI callback function 129 130 Synopsis: 131 #include <petscsys.h> 132 PetscErrorCode SETERRMPI(MPI_Comm comm,PetscErrorCode ierr,char *message,...) 133 134 Collective 135 136 Input Parameters: 137 + comm - A communicator, use `PETSC_COMM_SELF` unless you know all ranks of another communicator will detect the error 138 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 139 - message - error message 140 141 Level: developer 142 143 Notes: 144 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` 145 which is registered with `MPI_Add_error_code()` when PETSc is initialized. 146 147 .seealso: `SETERRQ()`, `PetscCall()`, `PetscCallMPI()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ` 148 M*/ 149 #define SETERRMPI(comm, ierr, ...) return (PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__), PETSC_MPI_ERROR_CODE) 150 151 /*MC 152 SETERRA - Fortran-only macro that can be called when an error has been detected from the main program 153 154 Synopsis: 155 #include <petscsys.h> 156 PetscErrorCode SETERRA(MPI_Comm comm,PetscErrorCode ierr,char *message) 157 158 Collective 159 160 Input Parameters: 161 + comm - A communicator, so that the error can be collective 162 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 163 - message - error message in the printf format 164 165 Level: beginner 166 167 Notes: 168 This should only be used with Fortran. With C/C++, use `SETERRQ()`. 169 170 Fortran Notes: 171 `SETERRQ()` may be called from Fortran subroutines but `SETERRA()` must be called from the 172 Fortran main program. 173 174 .seealso: `SETERRQ()`, `SETERRABORT()`, `PetscCall()`, `CHKERRA()`, `PetscCallAbort()` 175 M*/ 176 177 /*MC 178 SETERRABORT - Macro that can be called when an error has been detected, 179 180 Synopsis: 181 #include <petscsys.h> 182 PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode ierr,char *message,...) 183 184 Collective 185 186 Input Parameters: 187 + comm - A communicator, so that the error can be collective 188 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 189 - message - error message in the printf format 190 191 Level: beginner 192 193 Notes: 194 This function just calls `MPI_Abort()`. 195 196 This should only be called in routines that cannot return an error code, such as in C++ constructors. 197 198 .seealso: `SETERRQ()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `PetscCall()`, `CHKMEMQ` 199 M*/ 200 #define SETERRABORT(comm, ierr, ...) \ 201 do { \ 202 PetscError(comm, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr, PETSC_ERROR_INITIAL, __VA_ARGS__); \ 203 MPI_Abort(comm, ierr); \ 204 } while (0) 205 206 /*MC 207 PetscCheck - Check that a particular condition is true 208 209 Synopsis: 210 #include <petscerror.h> 211 void PetscCheck(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...) 212 213 Collective 214 215 Input Parameters: 216 + cond - The boolean condition 217 . comm - The communicator on which the check can be collective on 218 . ierr - A nonzero error code, see include/petscerror.h for the complete list 219 - message - Error message in printf format 220 221 Notes: 222 Enabled in both optimized and debug builds. 223 224 Calls `SETERRQ()` if the assertion fails, so can only be called from functions returning a 225 `PetscErrorCode` (or equivalent type after conversion). 226 227 Level: beginner 228 229 .seealso: `PetscAssert()`, `SETERRQ()`, `PetscError()`, `PetscCall()`, `PetscCheckAbort()` 230 M*/ 231 #define PetscCheck(cond, comm, ierr, ...) \ 232 do { \ 233 if (PetscUnlikely(!(cond))) SETERRQ(comm, ierr, __VA_ARGS__); \ 234 } while (0) 235 236 /*MC 237 PetscCheckAbort - Check that a particular condition is true, otherwise prints error and aborts 238 239 Synopsis: 240 #include <petscerror.h> 241 void PetscCheckAbort(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...) 242 243 Collective 244 245 Input Parameters: 246 + cond - The boolean condition 247 . comm - The communicator on which the check can be collective on 248 . ierr - A nonzero error code, see include/petscerror.h for the complete list 249 - message - Error message in printf format 250 251 Notes: 252 Enabled in both optimized and debug builds. 253 254 Calls `SETERRABORT()` if the assertion fails, can be called from a function that does not return an 255 error code, such as a C++ constructor. usually `PetscCheck()` should be used. 256 257 Level: developer 258 259 .seealso: `PetscAssertAbort()`, `PetscAssert()`, `SETERRQ()`, `PetscError()`, `PetscCall()`, `PetscCheck()`, `SETTERRABORT()` 260 M*/ 261 #define PetscCheckAbort(cond, comm, ierr, ...) \ 262 do { \ 263 if (PetscUnlikely(!(cond))) SETERRABORT(comm, ierr, __VA_ARGS__); \ 264 } while (0) 265 266 /*MC 267 PetscAssert - Assert that a particular condition is true 268 269 Synopsis: 270 #include <petscerror.h> 271 void PetscAssert(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...) 272 273 Collective 274 275 Input Parameters: 276 + cond - The boolean condition 277 . comm - The communicator on which the check can be collective on 278 . ierr - A nonzero error code, see include/petscerror.h for the complete list 279 - message - Error message in printf format 280 281 Notes: 282 Equivalent to `PetscCheck()` if debugging is enabled, and `PetscAssume(cond)` otherwise. 283 284 See `PetscCheck()` for usage and behaviour. 285 286 This is needed instead of simply using `assert()` because this correctly handles the collective nature of errors under MPI 287 288 Level: beginner 289 290 .seealso: `PetscCheck()`, `SETERRQ()`, `PetscError()`, `PetscAssertAbort()` 291 M*/ 292 #if PetscDefined(USE_DEBUG) 293 #define PetscAssert(cond, comm, ierr, ...) PetscCheck(cond, comm, ierr, __VA_ARGS__) 294 #else 295 #define PetscAssert(cond, ...) PetscAssume(cond) 296 #endif 297 298 /*MC 299 PetscAssertAbort - Assert that a particular condition is true, otherwise prints error and aborts 300 301 Synopsis: 302 #include <petscerror.h> 303 void PetscAssertAbort(bool cond, MPI_Comm comm, PetscErrorCode ierr, const char *message, ...) 304 305 Collective 306 307 Input Parameters: 308 + cond - The boolean condition 309 . comm - The communicator on which the check can be collective on 310 . ierr - A nonzero error code, see include/petscerror.h for the complete list 311 - message - Error message in printf format 312 313 Notes: 314 Enabled only in debug builds. See `PetscCheckAbort()` for usage. 315 316 Level: beginner 317 318 .seealso: `PetscCheckAbort()`, `PetscAssert()`, `PetscCheck()`, `SETERRABORT()`, `PetscError()` 319 M*/ 320 #define PetscAssertAbort(cond, comm, ierr, ...) \ 321 do { \ 322 if (PetscUnlikelyDebug(!(cond))) SETERRABORT(comm, ierr, __VA_ARGS__); \ 323 } while (0) 324 325 /*MC 326 PetscCall - Calls a PETSc function and then checks the resulting error code, if it is non-zero it calls the error 327 handler and returns from the current function with the error code. 328 329 Synopsis: 330 #include <petscerror.h> 331 void PetscCall(PetscFunction(args)) 332 333 Not Collective 334 335 Input Parameter: 336 . PetscFunction - any PETSc function that returns an error code 337 338 Notes: 339 Once the error handler is called the calling function is then returned from with the given 340 error code. Experienced users can set the error handler with `PetscPushErrorHandler()`. 341 342 `PetscCall()` cannot be used in functions returning a datatype not convertible to 343 `PetscErrorCode`. For example, `PetscCall()` may not be used in functions returning void, use 344 `PetscCallVoid()` in this case. 345 346 Example Usage: 347 .vb 348 PetscCall(PetscInitiailize(...)); // OK to call even when PETSc is not yet initialized! 349 350 struct my_struct 351 { 352 void *data; 353 } my_complex_type; 354 355 struct my_struct bar(void) 356 { 357 PetscCall(foo(15)); // ERROR PetscErrorCode not convertible to struct my_struct! 358 } 359 360 PetscCall(bar()) // ERROR input not convertible to PetscErrorCode 361 .ve 362 363 It is also possible to call this directly on a `PetscErrorCode` variable 364 .vb 365 PetscCall(ierr); // check if ierr is nonzero 366 .ve 367 368 Should not be used to call callback functions provided by users, `PetscCallBack()` should be used in that situation. 369 370 `PetscUseTypeMethod()` or `PetscTryTypeMethod()` should be used when calling functions pointers contained in a PETSc object's `ops` array 371 372 Fortran Notes: 373 The Fortran function from which this is used must declare a variable PetscErrorCode ierr and ierr must be 374 the final argument to the PETSc function being called. 375 376 In the main program and in Fortran subroutines that do not have ierr as the final return parameter one 377 should use `PetscCallA()` 378 379 Example Fortran Usage: 380 .vb 381 PetscErrorCode ierr 382 Vec v 383 384 ... 385 PetscCall(VecShift(v,1.0,ierr)) 386 PetscCallA(VecShift(v,1.0,ierr)) 387 .ve 388 389 Level: beginner 390 391 .seealso: `SETERRQ()`, `PetscCheck()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()` 392 `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`, `CHKERRMPI()`, `PetscCallBack()` 393 M*/ 394 395 /*MC 396 PetscCallBack - Calls a user provided PETSc callback function and then checks the resulting error code, if it is non-zero it calls the error 397 handler and returns from the current function with the error code. 398 399 Synopsis: 400 #include <petscerror.h> 401 void PetscCallBack(const char *functionname,PetscFunction(args)) 402 403 Not Collective 404 405 Input Parameters: 406 + functionname - the name of the function being called, this can be a string with spaces that describes the meaning of the callback 407 - PetscFunction - user provided callback function that returns an error code 408 409 Notes: 410 Once the error handler is called the calling function is then returned from with the given 411 error code. Experienced users can set the error handler with `PetscPushErrorHandler()`. 412 413 `PetscCallBack()` should only be called in PETSc when a call is being made to a user provided call-back routine. 414 415 Example Usage: 416 .vb 417 PetscCallBack("XXX callback to do something",a->callback(...)); 418 .ve 419 420 Level: developer 421 422 .seealso: `SETERRQ()`, `PetscCheck()`, `PetscCall()`, `PetscAssert()`, `PetscTraceBackErrorHandler()`, `PetscCallMPI()` 423 `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ`, `CHKERRA()`, `CHKERRMPI()`, `PetscCall()` 424 M*/ 425 426 #if defined(PETSC_CLANG_STATIC_ANALYZER) 427 void PetscCall(PetscErrorCode); 428 void PetscCallBack(const char *, PetscErrorCode); 429 void PetscCallVoid(PetscErrorCode); 430 #else 431 #define PetscCall(...) \ 432 do { \ 433 PetscErrorCode ierr_q_; \ 434 PetscStackUpdateLine; \ 435 ierr_q_ = __VA_ARGS__; \ 436 if (PetscUnlikely(ierr_q_)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_q_, PETSC_ERROR_REPEAT, " "); \ 437 } while (0) 438 #define PetscCallBack(function, ...) \ 439 do { \ 440 PetscErrorCode ierr_q_; \ 441 PetscStackUpdateLine; \ 442 PetscStackPushExternal(function); \ 443 ierr_q_ = __VA_ARGS__; \ 444 PetscStackPop; \ 445 if (PetscUnlikely(ierr_q_)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_q_, PETSC_ERROR_REPEAT, " "); \ 446 } while (0) 447 #define PetscCallVoid(...) \ 448 do { \ 449 PetscErrorCode ierr_void_; \ 450 PetscStackUpdateLine; \ 451 ierr_void_ = __VA_ARGS__; \ 452 if (PetscUnlikely(ierr_void_)) { \ 453 (void)PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_void_, PETSC_ERROR_REPEAT, " "); \ 454 return; \ 455 } \ 456 } while (0) 457 #endif 458 459 /*MC 460 CHKERRQ - Checks error code returned from PETSc function 461 462 Synopsis: 463 #include <petscsys.h> 464 void CHKERRQ(PetscErrorCode ierr) 465 466 Not Collective 467 468 Input Parameters: 469 . ierr - nonzero error code 470 471 Notes: 472 Deprecated in favor of `PetscCall()`. This routine behaves identically to it. 473 474 Level: deprecated 475 476 .seealso: `PetscCall()` 477 M*/ 478 #define CHKERRQ(...) PetscCall(__VA_ARGS__) 479 #define CHKERRV(...) PetscCallVoid(__VA_ARGS__) 480 481 PETSC_EXTERN void PetscMPIErrorString(PetscMPIInt, char *); 482 483 /*MC 484 PetscCallMPI - Checks error code returned from MPI calls, if non-zero it calls the error 485 handler and then returns 486 487 Synopsis: 488 #include <petscerror.h> 489 void PetscCallMPI(MPI_Function(args)) 490 491 Not Collective 492 493 Input Parameters: 494 . MPI_Function - an MPI function that returns an MPI error code 495 496 Notes: 497 Always returns the error code `PETSC_ERR_MPI`; the MPI error code and string are embedded in 498 the string error message. Do not use this to call any other routines (for example PETSc 499 routines), it should only be used for direct MPI calls. Due to limitations of the 500 preprocessor this can unfortunately not easily be enforced, so the user should take care to 501 check this themselves. 502 503 Example Usage: 504 .vb 505 PetscCallMPI(MPI_Comm_size(...)); // OK, calling MPI function 506 507 PetscCallMPI(PetscFunction(...)); // ERROR, use PetscCall() instead! 508 .ve 509 510 Fortran Notes: 511 The Fortran function from which this is used must declare a variable `PetscErrorCode` ierr and ierr must be 512 the final argument to the MPI function being called. 513 514 In the main program and in Fortran subroutines that do not have ierr as the final return parameter one 515 should use `PetscCallMPIA()` 516 517 Fortran Usage: 518 .vb 519 PetscErrorCode ierr or integer ierr 520 ... 521 PetscCallMPI(MPI_Comm_size(...,ierr)) 522 PetscCallMPIA(MPI_Comm_size(...,ierr)) ! Will abort after calling error handler 523 524 PetscCallMPI(MPI_Comm_size(...,eflag)) ! ERROR, final argument must be ierr 525 .ve 526 527 Level: beginner 528 529 .seealso: `SETERRMPI()`, `PetscCall()`, `SETERRQ()`, `SETERRABORT()`, `PetscCallAbort()`, 530 `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ` 531 M*/ 532 #if defined(PETSC_CLANG_STATIC_ANALYZER) 533 void PetscCallMPI(PetscMPIInt); 534 #else 535 #define PetscCallMPI(...) \ 536 do { \ 537 PetscMPIInt _7_errorcode; \ 538 char _7_errorstring[2 * MPI_MAX_ERROR_STRING]; \ 539 PetscStackUpdateLine; \ 540 PetscStackPushExternal("MPI function"); \ 541 { \ 542 _7_errorcode = __VA_ARGS__; \ 543 } \ 544 PetscStackPop; \ 545 if (PetscUnlikely(_7_errorcode)) { \ 546 PetscMPIErrorString(_7_errorcode, (char *)_7_errorstring); \ 547 SETERRQ(PETSC_COMM_SELF, PETSC_ERR_MPI, "MPI error %d %s", (int)_7_errorcode, _7_errorstring); \ 548 } \ 549 } while (0) 550 #endif 551 552 /*MC 553 CHKERRMPI - Checks error code returned from MPI calls, if non-zero it calls the error 554 handler and then returns 555 556 Synopsis: 557 #include <petscerror.h> 558 void CHKERRMPI(PetscErrorCode ierr) 559 560 Not Collective 561 562 Input Parameter: 563 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 564 565 Notes: 566 Deprecated in favor of `PetscCallMPI()`. This routine behaves identically to it. 567 568 Level: deprecated 569 570 .seealso: `PetscCallMPI()` 571 M*/ 572 #define CHKERRMPI(...) PetscCallMPI(__VA_ARGS__) 573 574 /*MC 575 PetscCallAbort - Checks error code returned from PETSc function, if non-zero it aborts immediately 576 577 Synopsis: 578 #include <petscerror.h> 579 void PetscCallAbort(MPI_Comm comm, PetscErrorCode ierr) 580 581 Collective on comm 582 583 Input Parameters: 584 + comm - the MPI communicator on which to abort 585 - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 586 587 Notes: 588 This macro has identical type and usage semantics to `PetscCall()` with the important caveat 589 that this macro does not return. Instead, if ierr is nonzero it calls the PETSc error handler 590 and then immediately calls `MPI_Abort()`. It can therefore be used anywhere. 591 592 As per `MPI_Abort()` semantics the communicator passed must be valid, although there is currently 593 no attempt made at handling any potential errors from `MPI_Abort()`. Note that while 594 `MPI_Abort()` is required to terminate only those processes which reside on comm, it is often 595 the case that `MPI_Abort()` terminates *all* processes. 596 597 Example Usage: 598 .vb 599 PetscErrorCode boom(void) { return PETSC_ERR_MEM; } 600 601 void foo(void) 602 { 603 PetscCallAbort(PETSC_COMM_WORLD,boom()); // OK, does not return a type 604 } 605 606 double bar(void) 607 { 608 PetscCallAbort(PETSC_COMM_WORLD,boom()); // OK, does not return a type 609 } 610 611 PetscCallAbort(MPI_COMM_NULL,boom()); // ERROR, communicator should be valid 612 613 struct baz 614 { 615 baz() 616 { 617 PetscCallAbort(PETSC_COMM_SELF,boom()); // OK 618 } 619 620 ~baz() 621 { 622 PetscCallAbort(PETSC_COMM_SELF,boom()); // OK (in fact the only way to handle PETSc errors) 623 } 624 }; 625 .ve 626 627 Level: intermediate 628 629 .seealso: `SETERRABORT()`, `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, 630 `SETERRQ()`, `CHKMEMQ`, `PetscCallMPI()` 631 M*/ 632 #if defined(PETSC_CLANG_STATIC_ANALYZER) 633 void PetscCallAbort(MPI_Comm, PetscErrorCode); 634 void PetscCallContinue(PetscErrorCode); 635 #else 636 #define PetscCallAbort(comm, ...) \ 637 do { \ 638 PetscErrorCode ierr_abort_ = __VA_ARGS__; \ 639 if (PetscUnlikely(ierr_abort_)) { \ 640 PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_abort_, PETSC_ERROR_REPEAT, " "); \ 641 MPI_Abort(comm, ierr_abort_); \ 642 } \ 643 } while (0) 644 #define PetscCallContinue(...) \ 645 do { \ 646 PetscErrorCode ierr_continue_ = __VA_ARGS__; \ 647 if (PetscUnlikely(ierr_continue_)) PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_continue_, PETSC_ERROR_REPEAT, " "); \ 648 } while (0) 649 #endif 650 651 /*MC 652 CHKERRABORT - Checks error code returned from PETSc function. If non-zero it aborts immediately. 653 654 Synopsis: 655 #include <petscerror.h> 656 void CHKERRABORT(MPI_Comm comm, PetscErrorCode ierr) 657 658 Not Collective 659 660 Input Parameters: 661 + comm - the MPI communicator 662 - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 663 664 Notes: 665 Deprecated in favor of `PetscCallAbort()`. This routine behaves identically to it. 666 667 Level: deprecated 668 669 .seealso: `PetscCallAbort()` 670 M*/ 671 #define CHKERRABORT(comm, ...) PetscCallAbort(comm, __VA_ARGS__) 672 #define CHKERRCONTINUE(...) PetscCallContinue(__VA_ARGS__) 673 674 /*MC 675 CHKERRA - Fortran-only replacement for use of `CHKERRQ()` in the main program, which aborts immediately 676 677 Synopsis: 678 #include <petscsys.h> 679 PetscErrorCode CHKERRA(PetscErrorCode ierr) 680 681 Not Collective 682 683 Input Parameters: 684 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 685 686 Level: deprecated 687 688 Note: 689 This macro is rarely needed, normal usage is `PetscCallA()` in the main Fortran program. 690 691 .seealso: `PetscCall()`, `PetscCallA()`, `PetscCallAbort()`, `CHKERRQ()`, `SETERRA()`, `SETERRQ()`, `SETERRABORT()` 692 M*/ 693 694 PETSC_EXTERN PetscBool petscwaitonerrorflg; 695 PETSC_EXTERN PetscBool petscindebugger; 696 697 /*MC 698 PETSCABORT - Call MPI_Abort with an informative error code 699 700 Synopsis: 701 #include <petscsys.h> 702 PETSCABORT(MPI_Comm comm, PetscErrorCode ierr) 703 704 Collective 705 706 Input Parameters: 707 + comm - A communicator, so that the error can be collective 708 - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 709 710 Level: advanced 711 712 Notes: 713 If the option -start_in_debugger was used then this calls abort() to stop the program in the debugger. 714 715 if `PetscCIEnabledPortableErrorOutput` is set it strives to exit cleanly without call `MPI_Abort()` 716 717 M*/ 718 #define PETSCABORT(comm, ...) \ 719 do { \ 720 if (petscwaitonerrorflg) PetscSleep(1000); \ 721 if (petscindebugger) abort(); \ 722 else { \ 723 PetscErrorCode ierr_petsc_abort_ = __VA_ARGS__; \ 724 PetscMPIInt size; \ 725 MPI_Comm_size(comm, &size); \ 726 if (PetscCIEnabledPortableErrorOutput && size == PetscGlobalSize && ierr_petsc_abort_ != PETSC_ERR_SIG) { \ 727 MPI_Finalize(); \ 728 exit(0); \ 729 } else if (PetscCIEnabledPortableErrorOutput && PetscGlobalSize == 1) { \ 730 exit(0); \ 731 } else { \ 732 MPI_Abort(comm, (PetscMPIInt)ierr_petsc_abort_); \ 733 } \ 734 } \ 735 } while (0) 736 737 #ifdef PETSC_CLANGUAGE_CXX 738 /*MC 739 PetscCallThrow - Checks error code, if non-zero it calls the C++ error handler which throws 740 an exception 741 742 Synopsis: 743 #include <petscerror.h> 744 void PetscCallThrow(PetscErrorCode ierr) 745 746 Not Collective 747 748 Input Parameter: 749 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 750 751 Notes: 752 Requires PETSc to be configured with clanguage = c++. Throws a std::runtime_error() on error. 753 754 Once the error handler throws the exception you can use `PetscCallVoid()` which returns without 755 an error code (bad idea since the error is ignored) or `PetscCallAbort()` to have `MPI_Abort()` 756 called immediately. 757 758 Level: beginner 759 760 .seealso: `SETERRQ()`, `PetscCall()`, `SETERRABORT()`, `PetscCallAbort()`, `PetscTraceBackErrorHandler()`, 761 `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ` 762 M*/ 763 #define PetscCallThrow(...) \ 764 do { \ 765 PetscErrorCode ierr_cxx_ = __VA_ARGS__; \ 766 if (PetscUnlikely(ierr_cxx_)) PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_cxx_, PETSC_ERROR_IN_CXX, PETSC_NULLPTR); \ 767 } while (0) 768 769 /*MC 770 CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception 771 772 Synopsis: 773 #include <petscerror.h> 774 void CHKERRXX(PetscErrorCode ierr) 775 776 Not Collective 777 778 Input Parameter: 779 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 780 781 Notes: 782 Deprecated in favor of `PetscCallThrow()`. This routine behaves identically to it. 783 784 Level: deprecated 785 786 .seealso: `PetscCallThrow()` 787 M*/ 788 #define CHKERRXX(...) PetscCallThrow(__VA_ARGS__) 789 #endif 790 791 /*MC 792 PetscCallCXX - Checks C++ function calls and if they throw an exception, catch it and then 793 return a PETSc error code 794 795 Synopsis: 796 #include <petscerror.h> 797 void PetscCallCXX(expr) noexcept; 798 799 Not Collective 800 801 Input Parameter: 802 . expr - An arbitrary expression 803 804 Notes: 805 PetscCallCXX(expr) is a macro replacement for 806 .vb 807 try { 808 expr; 809 } catch (const std::exception& e) { 810 return ConvertToPetscErrorCode(e); 811 } 812 .ve 813 Due to the fact that it catches any (reasonable) exception, it is essentially noexcept. 814 815 Example Usage: 816 .vb 817 void foo(void) { throw std::runtime_error("error"); } 818 819 void bar() 820 { 821 PetscCallCXX(foo()); // ERROR bar() does not return PetscErrorCode 822 } 823 824 PetscErrorCode baz() 825 { 826 PetscCallCXX(foo()); // OK 827 828 PetscCallCXX( 829 bar(); 830 foo(); // OK multiple statements allowed 831 ); 832 } 833 834 struct bop 835 { 836 bop() 837 { 838 PetscCallCXX(foo()); // ERROR returns PetscErrorCode, cannot be used in constructors 839 } 840 }; 841 842 // ERROR contains do-while, cannot be used as function-try block 843 PetscErrorCode qux() PetscCallCXX( 844 bar(); 845 baz(); 846 foo(); 847 return 0; 848 ) 849 .ve 850 851 Level: beginner 852 853 .seealso: `PetscCallThrow()`, `SETERRQ()`, `PetscCall()`, `SETERRABORT()`, `PetscCallAbort()`, 854 `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `CHKMEMQ` 855 M*/ 856 #define PetscCallCXX(...) \ 857 do { \ 858 PetscStackUpdateLine; \ 859 try { \ 860 __VA_ARGS__; \ 861 } catch (const std::exception &e) { \ 862 SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "%s", e.what()); \ 863 } \ 864 } while (0) 865 866 /*MC 867 CHKERRCXX - Checks C++ function calls and if they throw an exception, catch it and then 868 return a PETSc error code 869 870 Synopsis: 871 #include <petscerror.h> 872 void CHKERRCXX(func) noexcept; 873 874 Not Collective 875 876 Input Parameter: 877 . func - C++ function calls 878 879 Notes: 880 Deprecated in favor of `PetscCallCXX()`. This routine behaves identically to it. 881 882 Level: deprecated 883 884 .seealso: `PetscCallCXX()` 885 M*/ 886 #define CHKERRCXX(...) PetscCallCXX(__VA_ARGS__) 887 888 /*MC 889 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 890 891 Synopsis: 892 #include <petscsys.h> 893 CHKMEMQ; 894 895 Not Collective 896 897 Level: beginner 898 899 Notes: 900 We highly recommend using Valgrind https://petsc.org/release/faq/#valgrind or for NVIDIA CUDA systems 901 https://docs.nvidia.com/cuda/cuda-memcheck/index.html for finding memory problems. The ``CHKMEMQ`` macro is useful on systems that 902 do not have valgrind, but is not as good as valgrind or cuda-memcheck. 903 904 Must run with the option -malloc_debug (-malloc_test in debug mode; or if `PetscMallocSetDebug()` called) to enable this option 905 906 Once the error handler is called the calling function is then returned from with the given error code. 907 908 By defaults prints location where memory that is corrupted was allocated. 909 910 Use `CHKMEMA` for functions that return void 911 912 .seealso: `PetscTraceBackErrorHandler()`, `PetscPushErrorHandler()`, `PetscError()`, `SETERRQ()`, `PetscMallocValidate()` 913 M*/ 914 #if defined(PETSC_CLANG_STATIC_ANALYZER) 915 #define CHKMEMQ 916 #define CHKMEMA 917 #else 918 #define CHKMEMQ \ 919 do { \ 920 PetscErrorCode ierr_memq_ = PetscMallocValidate(__LINE__, PETSC_FUNCTION_NAME, __FILE__); \ 921 if (PetscUnlikely(ierr_memq_)) return PetscError(PETSC_COMM_SELF, __LINE__, PETSC_FUNCTION_NAME, __FILE__, ierr_memq_, PETSC_ERROR_REPEAT, " "); \ 922 } while (0) 923 #define CHKMEMA PetscMallocValidate(__LINE__, PETSC_FUNCTION_NAME, __FILE__) 924 #endif 925 926 /*E 927 PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers 928 929 Level: advanced 930 931 `PETSC_ERROR_IN_CXX` indicates the error was detected in C++ and an exception should be generated 932 933 Developer Notes: 934 This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler() 935 936 .seealso: `PetscError()`, `SETERRQ()` 937 E*/ 938 typedef enum { 939 PETSC_ERROR_INITIAL = 0, 940 PETSC_ERROR_REPEAT = 1, 941 PETSC_ERROR_IN_CXX = 2 942 } PetscErrorType; 943 944 #if defined(__clang_analyzer__) 945 __attribute__((analyzer_noreturn)) 946 #endif 947 PETSC_EXTERN PetscErrorCode 948 PetscError(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, ...) PETSC_ATTRIBUTE_COLD PETSC_ATTRIBUTE_FORMAT(7, 8); 949 950 PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void); 951 PETSC_EXTERN PetscErrorCode PetscErrorMessage(int, const char *[], char **); 952 PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 953 PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 954 PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 955 PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 956 PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 957 PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 958 PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *) PETSC_ATTRIBUTE_COLD; 959 PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm, int, const char *, const char *, PetscErrorCode, PetscErrorType, const char *, void *), void *); 960 PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void); 961 PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int, void *); 962 PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int, void *), void *); 963 PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void); 964 PETSC_EXTERN PetscErrorCode PetscCheckPointerSetIntensity(PetscInt); 965 PETSC_EXTERN void PetscSignalSegvCheckPointerOrMpi(void); 966 PETSC_DEPRECATED_FUNCTION("Use PetscSignalSegvCheckPointerOrMpi() (since version 3.13)") static inline void PetscSignalSegvCheckPointer(void) 967 { 968 PetscSignalSegvCheckPointerOrMpi(); 969 } 970 971 /*MC 972 PetscErrorPrintf - Prints error messages. 973 974 Synopsis: 975 #include <petscsys.h> 976 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 977 978 Not Collective 979 980 Input Parameter: 981 . format - the usual printf() format string 982 983 Options Database Keys: 984 + -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr 985 - -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.) 986 987 Notes: 988 Use 989 $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the 990 $ error is handled.) and 991 $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function 992 993 Use 994 `PETSC_STDERR` = FILE* obtained from a file open etc. to have stderr printed to the file. 995 `PETSC_STDOUT` = FILE* obtained from a file open etc. to have stdout printed to the file. 996 997 Use 998 `PetscPushErrorHandler()` to provide your own error handler that determines what kind of messages to print 999 1000 Level: developer 1001 1002 Fortran Note: 1003 This routine is not supported in Fortran. 1004 1005 .seealso: `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscHelpPrintf()`, `PetscPrintf()`, `PetscPushErrorHandler()`, `PetscVFPrintf()`, `PetscHelpPrintf()` 1006 M*/ 1007 PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[], ...) PETSC_ATTRIBUTE_FORMAT(1, 2); 1008 1009 /*E 1010 PetscFPTrap - types of floating point exceptions that may be trapped 1011 1012 Currently only `PETSC_FP_TRAP_OFF` and `PETSC_FP_TRAP_ON` are handled. All others are treated as `PETSC_FP_TRAP_ON`. 1013 1014 Level: intermediate 1015 1016 .seealso: `PetscSetFPTrap()`, `PetscPushFPTrap()` 1017 E*/ 1018 typedef enum { 1019 PETSC_FP_TRAP_OFF = 0, 1020 PETSC_FP_TRAP_INDIV = 1, 1021 PETSC_FP_TRAP_FLTOPERR = 2, 1022 PETSC_FP_TRAP_FLTOVF = 4, 1023 PETSC_FP_TRAP_FLTUND = 8, 1024 PETSC_FP_TRAP_FLTDIV = 16, 1025 PETSC_FP_TRAP_FLTINEX = 32 1026 } PetscFPTrap; 1027 #define PETSC_FP_TRAP_ON (PetscFPTrap)(PETSC_FP_TRAP_INDIV | PETSC_FP_TRAP_FLTOPERR | PETSC_FP_TRAP_FLTOVF | PETSC_FP_TRAP_FLTDIV | PETSC_FP_TRAP_FLTINEX) 1028 PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap); 1029 PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap); 1030 PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void); 1031 PETSC_EXTERN PetscErrorCode PetscDetermineInitialFPTrap(void); 1032 1033 /* 1034 Allows the code to build a stack frame as it runs 1035 */ 1036 1037 #if defined(PETSC_USE_DEBUG) 1038 #define PETSCSTACKSIZE 64 1039 typedef struct { 1040 const char *function[PETSCSTACKSIZE]; 1041 const char *file[PETSCSTACKSIZE]; 1042 int line[PETSCSTACKSIZE]; 1043 int petscroutine[PETSCSTACKSIZE]; /* 0 external called from petsc, 1 petsc functions, 2 petsc user functions */ 1044 int currentsize; 1045 int hotdepth; 1046 PetscBool check; /* option to check for correct Push/Pop semantics, true for default petscstack but not other stacks */ 1047 } PetscStack; 1048 PETSC_EXTERN PetscStack petscstack; 1049 #else 1050 typedef struct { 1051 char Silence_empty_struct_has_size_0_in_C_size_1_in_Cpp; 1052 } PetscStack; 1053 #endif 1054 1055 #if defined(PETSC_SERIALIZE_FUNCTIONS) 1056 #include <petsc/private/petscfptimpl.h> 1057 /* 1058 Registers the current function into the global function pointer to function name table 1059 1060 Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc 1061 */ 1062 #define PetscRegister__FUNCT__() \ 1063 do { \ 1064 static PetscBool __chked = PETSC_FALSE; \ 1065 if (!__chked) { \ 1066 void *ptr; \ 1067 PetscDLSym(NULL, PETSC_FUNCTION_NAME, &ptr); \ 1068 __chked = PETSC_TRUE; \ 1069 } \ 1070 } while (0) 1071 #else 1072 #define PetscRegister__FUNCT__() 1073 #endif 1074 1075 #if defined(PETSC_CLANG_STATIC_ANALYZER) 1076 #define PetscStackPushNoCheck(funct, petsc_routine, hot) 1077 #define PetscStackUpdateLine 1078 #define PetscStackPushExternal(funct) 1079 #define PetscStackPopNoCheck 1080 #define PetscStackClearTop 1081 #define PetscFunctionBegin 1082 #define PetscFunctionBeginUser 1083 #define PetscFunctionBeginHot 1084 #define PetscFunctionReturn(a) return a 1085 #define PetscFunctionReturnVoid() return 1086 #define PetscStackPop 1087 #define PetscStackPush(f) 1088 #elif defined(PETSC_USE_DEBUG) 1089 1090 #define PetscStackPush_Private(stack__, file__, func__, line__, petsc_routine__, hot__) \ 1091 do { \ 1092 if (stack__.currentsize < PETSCSTACKSIZE) { \ 1093 stack__.function[stack__.currentsize] = func__; \ 1094 if (petsc_routine__) { \ 1095 stack__.file[stack__.currentsize] = file__; \ 1096 stack__.line[stack__.currentsize] = line__; \ 1097 } else { \ 1098 stack__.file[stack__.currentsize] = PETSC_NULLPTR; \ 1099 stack__.line[stack__.currentsize] = 0; \ 1100 } \ 1101 stack__.petscroutine[stack__.currentsize] = petsc_routine__; \ 1102 } \ 1103 ++stack__.currentsize; \ 1104 stack__.hotdepth += (hot__ || stack__.hotdepth); \ 1105 } while (0) 1106 1107 /* uses PetscCheckAbort() because may be used in a function that does not return an error code */ 1108 #define PetscStackPop_Private(stack__, func__) \ 1109 do { \ 1110 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__); \ 1111 if (--stack__.currentsize < PETSCSTACKSIZE) { \ 1112 PetscCheckAbort(!stack__.check || stack__.petscroutine[stack__.currentsize] != 1 || stack__.function[stack__.currentsize] == (const char *)(func__), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Invalid stack: push from %s %s:%d. Pop from %s %s:%d.\n", \ 1113 stack__.function[stack__.currentsize], stack__.file[stack__.currentsize], stack__.line[stack__.currentsize], func__, __FILE__, __LINE__); \ 1114 stack__.function[stack__.currentsize] = PETSC_NULLPTR; \ 1115 stack__.file[stack__.currentsize] = PETSC_NULLPTR; \ 1116 stack__.line[stack__.currentsize] = 0; \ 1117 stack__.petscroutine[stack__.currentsize] = 0; \ 1118 } \ 1119 stack__.hotdepth = PetscMax(stack__.hotdepth - 1, 0); \ 1120 } while (0) 1121 1122 /*MC 1123 PetscStackPushNoCheck - Pushes a new function name and line number onto the PETSc default stack that tracks where the running program is 1124 currently in the source code. 1125 1126 Not Collective 1127 1128 Synopsis: 1129 #include <petscsys.h> 1130 void PetscStackPushNoCheck(char *funct,int petsc_routine,PetscBool hot); 1131 1132 Input Parameters: 1133 + funct - the function name 1134 . petsc_routine - 2 user function, 1 PETSc function, 0 some other function 1135 - hot - indicates that the function may be called often so expensive error checking should be turned off inside the function 1136 1137 Level: developer 1138 1139 Notes: 1140 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 1141 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 1142 help debug the problem. 1143 1144 This version does not check the memory corruption (an expensive operation), use `PetscStackPush()` to check the memory. 1145 1146 Use `PetscStackPushExternal()` for a function call that is about to be made to a non-PETSc or user function (such as BLAS etc). 1147 1148 The default stack is a global variable called `petscstack`. 1149 1150 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`, 1151 `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPush()`, `PetscStackPop`, 1152 `PetscStackPushExternal()` 1153 M*/ 1154 #define PetscStackPushNoCheck(funct, petsc_routine, hot) \ 1155 do { \ 1156 PetscStackSAWsTakeAccess(); \ 1157 PetscStackPush_Private(petscstack, __FILE__, funct, __LINE__, petsc_routine, hot); \ 1158 PetscStackSAWsGrantAccess(); \ 1159 } while (0) 1160 1161 /*MC 1162 PetscStackUpdateLine - in a function that has a `PetscFunctionBegin` or `PetscFunctionBeginUser` updates the stack line number to the 1163 current line number. 1164 1165 Not Collective 1166 1167 Synopsis: 1168 #include <petscsys.h> 1169 void PetscStackUpdateLine 1170 1171 Level: developer 1172 1173 Notes: 1174 Using `PetscCall()` and friends automatically handles this process 1175 1176 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 1177 occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to 1178 help debug the problem. 1179 1180 The default stack is a global variable called petscstack. 1181 1182 This is used by `PetscCall()` and is otherwise not like to be needed 1183 1184 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPop`, `PetscCall()` 1185 M*/ 1186 #define PetscStackUpdateLine \ 1187 if (petscstack.currentsize > 0 && petscstack.function[petscstack.currentsize - 1] == PETSC_FUNCTION_NAME) { petscstack.line[petscstack.currentsize - 1] = __LINE__; } 1188 1189 /*MC 1190 PetscStackPushExternal - Pushes a new function name onto the PETSc default stack that tracks where the running program is 1191 currently in the source code. Does not include the filename or line number since this is called by the calling routine 1192 for non-PETSc or user functions. 1193 1194 Not Collective 1195 1196 Synopsis: 1197 #include <petscsys.h> 1198 void PetscStackPushExternal(char *funct); 1199 1200 Input Parameters: 1201 . funct - the function name 1202 1203 Level: developer 1204 1205 Notes: 1206 Using `PetscCallExternal()` and friends automatically handles this process 1207 1208 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 1209 occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to 1210 help debug the problem. 1211 1212 The default stack is a global variable called `petscstack`. 1213 1214 This is to be used when calling an external package function such as a BLAS function. 1215 1216 This also updates the stack line number for the current stack function. 1217 1218 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`, 1219 `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()`, `PetscStackPop` 1220 M*/ 1221 #define PetscStackPushExternal(funct) \ 1222 do { \ 1223 PetscStackUpdateLine; \ 1224 PetscStackPushNoCheck(funct, 0, PETSC_TRUE); \ 1225 } while (0); 1226 1227 /*MC 1228 PetscStackPopNoCheck - Pops a function name from the PETSc default stack that tracks where the running program is 1229 currently in the source code. 1230 1231 Not Collective 1232 1233 Synopsis: 1234 #include <petscsys.h> 1235 void PetscStackPopNoCheck(char *funct); 1236 1237 Input Parameter: 1238 . funct - the function name 1239 1240 Level: developer 1241 1242 Notes: 1243 Using `PetscCall()`, `PetscCallExternal()`, `PetscCallBack()` and friends negates the need to call this 1244 1245 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 1246 occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to 1247 help debug the problem. 1248 1249 The default stack is a global variable called petscstack. 1250 1251 Developer Note: 1252 `PetscStackPopNoCheck()` takes a function argument while `PetscStackPop` does not, this difference is likely just historical. 1253 1254 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPop` 1255 M*/ 1256 #define PetscStackPopNoCheck(funct) \ 1257 do { \ 1258 PetscStackSAWsTakeAccess(); \ 1259 PetscStackPop_Private(petscstack, funct); \ 1260 PetscStackSAWsGrantAccess(); \ 1261 } while (0) 1262 1263 #define PetscStackClearTop \ 1264 do { \ 1265 PetscStackSAWsTakeAccess(); \ 1266 if (petscstack.currentsize > 0 && --petscstack.currentsize < PETSCSTACKSIZE) { \ 1267 petscstack.function[petscstack.currentsize] = PETSC_NULLPTR; \ 1268 petscstack.file[petscstack.currentsize] = PETSC_NULLPTR; \ 1269 petscstack.line[petscstack.currentsize] = 0; \ 1270 petscstack.petscroutine[petscstack.currentsize] = 0; \ 1271 } \ 1272 petscstack.hotdepth = PetscMax(petscstack.hotdepth - 1, 0); \ 1273 PetscStackSAWsGrantAccess(); \ 1274 } while (0) 1275 1276 /*MC 1277 PetscFunctionBegin - First executable line of each PETSc function, used for error handling. Final 1278 line of PETSc functions should be `PetscFunctionReturn`(0); 1279 1280 Synopsis: 1281 #include <petscsys.h> 1282 void PetscFunctionBegin; 1283 1284 Not Collective 1285 1286 Usage: 1287 .vb 1288 int something; 1289 1290 PetscFunctionBegin; 1291 .ve 1292 1293 Notes: 1294 Use `PetscFunctionBeginUser` for application codes. 1295 1296 Not available in Fortran 1297 1298 Level: developer 1299 1300 .seealso: `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()` 1301 1302 M*/ 1303 #define PetscFunctionBegin \ 1304 do { \ 1305 PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 1, PETSC_FALSE); \ 1306 PetscRegister__FUNCT__(); \ 1307 } while (0) 1308 1309 /*MC 1310 PetscFunctionBeginHot - Substitute for `PetscFunctionBegin` to be used in functions that are called in 1311 performance-critical circumstances. Use of this function allows for lighter profiling by default. 1312 1313 Synopsis: 1314 #include <petscsys.h> 1315 void PetscFunctionBeginHot; 1316 1317 Not Collective 1318 1319 Usage: 1320 .vb 1321 int something; 1322 1323 PetscFunctionBeginHot; 1324 .ve 1325 1326 Notes: 1327 Not available in Fortran 1328 1329 Level: developer 1330 1331 .seealso: `PetscFunctionBegin`, `PetscFunctionReturn()`, `PetscStackPushNoCheck()` 1332 1333 M*/ 1334 #define PetscFunctionBeginHot \ 1335 do { \ 1336 PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 1, PETSC_TRUE); \ 1337 PetscRegister__FUNCT__(); \ 1338 } while (0) 1339 1340 /*MC 1341 PetscFunctionBeginUser - First executable line of user provided routines 1342 1343 Synopsis: 1344 #include <petscsys.h> 1345 void PetscFunctionBeginUser; 1346 1347 Not Collective 1348 1349 Usage: 1350 .vb 1351 int something; 1352 1353 PetscFunctionBeginUser; 1354 .ve 1355 1356 Notes: 1357 Functions that incorporate this must call `PetscFunctionReturn()` instead of return except for main(). 1358 1359 May be used before `PetscInitialize()` 1360 1361 Not available in Fortran 1362 1363 This is identical to `PetscFunctionBegin` except it labels the routine as a user 1364 routine instead of as a PETSc library routine. 1365 1366 Level: intermediate 1367 1368 .seealso: `PetscFunctionReturn()`, `PetscFunctionBegin`, `PetscFunctionBeginHot`, `PetscStackPushNoCheck()` 1369 1370 M*/ 1371 #define PetscFunctionBeginUser \ 1372 do { \ 1373 PetscStackPushNoCheck(PETSC_FUNCTION_NAME, 2, PETSC_FALSE); \ 1374 PetscRegister__FUNCT__(); \ 1375 } while (0) 1376 1377 /*MC 1378 PetscStackPush - Pushes a new function name and line number onto the PETSc default stack that tracks where the running program is 1379 currently in the source code and verifies the memory is not corrupted. 1380 1381 Not Collective 1382 1383 Synopsis: 1384 #include <petscsys.h> 1385 void PetscStackPush(char *funct) 1386 1387 Input Parameter: 1388 . funct - the function name 1389 1390 Level: developer 1391 1392 Notes: 1393 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 1394 occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to 1395 help debug the problem. 1396 1397 The default stack is a global variable called petscstack. 1398 1399 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPopNoCheck()`, `PetscCall()`, `PetscFunctionBegin()`, 1400 `PetscFunctionReturn()`, `PetscFunctionBeginHot()`, `PetscFunctionBeginUser()`, `PetscStackPushNoCheck()`, `PetscStackPop` 1401 M*/ 1402 #define PetscStackPush(n) \ 1403 do { \ 1404 PetscStackPushNoCheck(n, 0, PETSC_FALSE); \ 1405 CHKMEMQ; \ 1406 } while (0) 1407 1408 /*MC 1409 PetscStackPop - Pops a function name from the PETSc default stack that tracks where the running program is 1410 currently in the source code and verifies the memory is not corrupted. 1411 1412 Not Collective 1413 1414 Synopsis: 1415 #include <petscsys.h> 1416 void PetscStackPop 1417 1418 Level: developer 1419 1420 Notes: 1421 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 1422 occurred, for example, when a signal is received. It is recommended to use the debugger if extensive information is needed to 1423 help debug the problem. 1424 1425 The default stack is a global variable called petscstack. 1426 1427 .seealso: `PetscAttachDebugger()`, `PetscStackCopy()`, `PetscStackView()`, `PetscStackPushNoCheck()`, `PetscStackPopNoCheck()`, `PetscStackPush()` 1428 M*/ 1429 #define PetscStackPop \ 1430 do { \ 1431 CHKMEMQ; \ 1432 PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \ 1433 } while (0) 1434 1435 /*MC 1436 PetscFunctionReturn - Last executable line of each PETSc function 1437 used for error handling. Replaces `return()` 1438 1439 Synopsis: 1440 #include <petscsys.h> 1441 void PetscFunctionReturn(0); 1442 1443 Not Collective 1444 1445 Usage: 1446 .vb 1447 .... 1448 PetscFunctionReturn(0); 1449 } 1450 .ve 1451 1452 Note: 1453 Not available in Fortran 1454 1455 Level: developer 1456 1457 .seealso: `PetscFunctionBegin()`, `PetscStackPopNoCheck()` 1458 1459 M*/ 1460 #define PetscFunctionReturn(a) \ 1461 do { \ 1462 PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \ 1463 return a; \ 1464 } while (0) 1465 1466 #define PetscFunctionReturnVoid() \ 1467 do { \ 1468 PetscStackPopNoCheck(PETSC_FUNCTION_NAME); \ 1469 return; \ 1470 } while (0) 1471 #else /* PETSC_USE_DEBUG */ 1472 #define PetscStackPushNoCheck(funct, petsc_routine, hot) 1473 #define PetscStackUpdateLine 1474 #define PetscStackPushExternal(funct) 1475 #define PetscStackPopNoCheck 1476 #define PetscStackClearTop 1477 #define PetscFunctionBegin 1478 #define PetscFunctionBeginUser 1479 #define PetscFunctionBeginHot 1480 #define PetscFunctionReturn(a) return a 1481 #define PetscFunctionReturnVoid() return 1482 #define PetscStackPop CHKMEMQ 1483 #define PetscStackPush(f) CHKMEMQ 1484 #endif /* PETSC_USE_DEBUG */ 1485 1486 #if defined(PETSC_CLANG_STATIC_ANALYZER) 1487 #define PetscStackCallExternalVoid(name, routine) 1488 #define PetscCallExternal(func, ...) 1489 #else 1490 /*MC 1491 PetscStackCallExternalVoid - Calls an external library routine or user function after pushing the name of the routine on the stack. 1492 1493 Input Parameters: 1494 + name - string that gives the name of the function being called 1495 - routine - actual call to the routine, for example, functionname(a,b) 1496 1497 Level: developer 1498 1499 Note: 1500 Often one should use `PetscCallExternal()` instead. This routine is intended for external library routines that DO NOT return error codes 1501 1502 In debug mode this also checks the memory for corruption at the end of the function call. 1503 1504 Certain external packages, such as BLAS/LAPACK may have their own macros for managing the call, error checking, etc. 1505 1506 Developer Note: 1507 This is so that when a user or external library routine results in a crash or corrupts memory, they get blamed instead of PETSc. 1508 1509 .seealso: `PetscCall()`, `PetscStackPushNoCheck()`, `PetscStackPush()`, `PetscCallExternal()`, `PetscCallBLAS()` 1510 @*/ 1511 #define PetscStackCallExternalVoid(name, routine) \ 1512 do { \ 1513 PetscStackPush(name); \ 1514 routine; \ 1515 PetscStackPop; \ 1516 } while (0) 1517 1518 /*MC 1519 PetscCallExternal - Calls an external library routine that returns an error code after pushing the name of the routine on the stack. 1520 1521 Input Parameters: 1522 + func- name of the routine 1523 - args - arguments to the routine 1524 1525 Level: developer 1526 1527 Notes: 1528 This is intended for external package routines that return error codes. Use `PetscStackCallExternalVoid()` for those that do not. 1529 1530 In debug mode this also checks the memory for corruption at the end of the function call. 1531 1532 Assumes the error return code of the function is an integer and that a value of 0 indicates success 1533 1534 Developer Note: 1535 This is so that when an external package routine results in a crash or corrupts memory, they get blamed instead of PETSc. 1536 1537 .seealso: `PetscCall()`, `PetscStackPushNoCheck()`, `PetscStackPush()`, `PetscStackCallExternalVoid()` 1538 M*/ 1539 #define PetscCallExternal(func, ...) \ 1540 do { \ 1541 PetscStackPush(PetscStringize(func)); \ 1542 PetscErrorCode __ierr = func(__VA_ARGS__); \ 1543 PetscStackPop; \ 1544 PetscCheck(!__ierr, PETSC_COMM_SELF, PETSC_ERR_LIB, "Error in %s(): error code %d", PetscStringize(func), __ierr); \ 1545 } while (0) 1546 #endif /* PETSC_CLANG_STATIC_ANALYZER */ 1547 1548 #endif 1549