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