1 /* 2 Contains all error handling interfaces for PETSc. 3 */ 4 #if !defined(__PETSCERROR_H) 5 #define __PETSCERROR_H 6 #include "petsc.h" 7 PETSC_EXTERN_CXX_BEGIN 8 9 /* 10 Defines the directory where the compiled source is located; used 11 in printing error messages. Each makefile has an entry 12 LOCDIR = thedirectory 13 and bmake/common_variables includes in CCPPFLAGS -D__SDIR__='"${LOCDIR}"' 14 which is a flag passed to the C/C++ compilers. This declaration below 15 is only needed if some code is compiled without the -D__SDIR__ 16 */ 17 #if !defined(__SDIR__) 18 #define __SDIR__ "unknowndirectory/" 19 #endif 20 21 /* 22 Defines the function where the compiled source is located; used 23 in printing error messages. This is defined here in case the user 24 does not declare it. 25 */ 26 #if !defined(__FUNCT__) 27 #define __FUNCT__ "User provided function" 28 #endif 29 30 /* 31 These are the generic error codes. These error codes are used 32 many different places in the PETSc source code. The string versions are 33 at src/sys/error/err.c any changes here must also be made there 34 These are also define in include/finclude/petscerror.h any CHANGES here 35 must be also made there. 36 37 */ 38 #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 39 40 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 41 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 42 #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 43 #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 44 #define PETSC_ERR_SIG 59 /* signal received */ 45 #define PETSC_ERR_FP 72 /* floating point exception */ 46 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 47 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 48 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 49 #define PETSC_ERR_MEMC 78 /* memory corruption */ 50 #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 51 #define PETSC_ERR_USER 83 /* user has not provided needed function */ 52 #define PETSC_ERR_SYS 88 /* error in system call */ 53 54 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 55 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 56 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 57 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 58 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 59 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 60 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 61 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 62 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 63 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 64 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 65 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 66 #define PETSC_ERR_ARG_DOMAIN 87 /* argument is not in domain of function */ 67 68 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 69 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 70 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 71 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 72 73 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 74 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 75 76 #define PETSC_ERR_MAX_VALUE 89 /* this is always the one more than the largest error code */ 77 78 #if defined(PETSC_USE_ERRORCHECKING) 79 80 /*MC 81 SETERRQ - Macro that is called when an error has been detected, 82 83 Not Collective 84 85 Synopsis: 86 PetscErrorCode SETERRQ(PetscErrorCode errorcode,char *message) 87 88 89 Input Parameters: 90 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 91 - message - error message 92 93 Level: beginner 94 95 Notes: 96 Once the error handler is called the calling function is then returned from with the given error code. 97 98 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 99 100 In Fortran MPI_Abort() is always called 101 102 Experienced users can set the error handler with PetscPushErrorHandler(). 103 104 Concepts: error^setting condition 105 106 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 107 M*/ 108 #define SETERRQ(n,s) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);} 109 110 /*MC 111 SETERRQ1 - Macro that is called when an error has been detected, 112 113 Not Collective 114 115 Synopsis: 116 PetscErrorCode SETERRQ1(PetscErrorCode errorcode,char *formatmessage,arg) 117 118 119 Input Parameters: 120 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 121 . message - error message in the printf format 122 - arg - argument (for example an integer, string or double) 123 124 Level: beginner 125 126 Notes: 127 Once the error handler is called the calling function is then returned from with the given error code. 128 129 Experienced users can set the error handler with PetscPushErrorHandler(). 130 131 Concepts: error^setting condition 132 133 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 134 M*/ 135 #define SETERRQ1(n,s,a1) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1);} 136 137 /*MC 138 SETERRQ2 - Macro that is called when an error has been detected, 139 140 Not Collective 141 142 Synopsis: 143 PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 144 145 146 Input Parameters: 147 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 148 . message - error message in the printf format 149 . arg1 - argument (for example an integer, string or double) 150 - arg2 - argument (for example an integer, string or double) 151 152 Level: beginner 153 154 Notes: 155 Once the error handler is called the calling function is then returned from with the given error code. 156 157 Experienced users can set the error handler with PetscPushErrorHandler(). 158 159 Concepts: error^setting condition 160 161 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 162 M*/ 163 #define SETERRQ2(n,s,a1,a2) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2);} 164 165 /*MC 166 SETERRQ3 - Macro that is called when an error has been detected, 167 168 Not Collective 169 170 Synopsis: 171 PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 172 173 174 Input Parameters: 175 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 176 . message - error message in the printf format 177 . arg1 - argument (for example an integer, string or double) 178 . arg2 - argument (for example an integer, string or double) 179 - arg3 - argument (for example an integer, string or double) 180 181 Level: beginner 182 183 Notes: 184 Once the error handler is called the calling function is then returned from with the given error code. 185 186 There are also versions for 4, 5, 6 and 7 arguments. 187 188 Experienced users can set the error handler with PetscPushErrorHandler(). 189 190 Concepts: error^setting condition 191 192 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 193 M*/ 194 #define SETERRQ3(n,s,a1,a2,a3) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3);} 195 196 #define SETERRQ4(n,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4);} 197 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5);} 198 #define SETERRQ6(n,s,a1,a2,a3,a4,a5,a6) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5,a6);} 199 #define SETERRQ7(n,s,a1,a2,a3,a4,a5,a6,a7) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5,a6,a7);} 200 #define SETERRABORT(comm,n,s) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);MPI_Abort(comm,n);} 201 202 /*MC 203 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 204 205 Not Collective 206 207 Synopsis: 208 PetscErrorCode CHKERRQ(PetscErrorCode errorcode) 209 210 211 Input Parameters: 212 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 213 214 Level: beginner 215 216 Notes: 217 Once the error handler is called the calling function is then returned from with the given error code. 218 219 Experienced users can set the error handler with PetscPushErrorHandler(). 220 221 CHKERRQ(n) is fundamentally a macro replacement for 222 if (n) return(PetscError(...,n,...)); 223 224 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 225 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 226 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 227 you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 228 if (n) {PetscError(....); return(YourReturnType);} 229 where you may pass back a PETSC_NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 230 MPI_Abort() returned immediately. 231 232 In Fortran MPI_Abort() is always called 233 234 Concepts: error^setting condition 235 236 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 237 M*/ 238 #define CHKERRQ(n) if (n) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 239 240 #define CHKERRV(n) if (n) {n = PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");return;} 241 #define CHKERRABORT(comm,n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");MPI_Abort(comm,n);} 242 #define CHKERRCONTINUE(n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 243 #define CHKFPQ(f) if PetscIsInfOrNan(f) {SETERRQ(PETSC_ERR_FP, "Invalid value: Inf or NaN");} 244 245 #ifdef PETSC_CLANGUAGE_CXX 246 247 #define CHKERRXX(n) if (n) {PetscErrorCxx(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0);} 248 249 #endif 250 251 /*MC 252 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 253 254 Not Collective 255 256 Synopsis: 257 CHKMEMQ; 258 259 Level: beginner 260 261 Notes: 262 Must run with the option -malloc_debug to enable this option 263 264 Once the error handler is called the calling function is then returned from with the given error code. 265 266 By defaults prints location where memory that is corrupted was allocated. 267 268 Use CHKMEMA for functions that return void 269 270 Concepts: memory corruption 271 272 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 273 PetscMallocValidate() 274 M*/ 275 #define CHKMEMQ {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,__FUNCT__,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} 276 277 #define CHKMEMA {PetscMallocValidate(__LINE__,__FUNCT__,__FILE__,__SDIR__);} 278 279 #if defined(PETSC_UNDERSCORE_CHKERR) 280 extern PetscErrorCode __gierr; 281 #define _ __gierr = 282 #define ___ CHKERRQ(__gierr); 283 #endif 284 285 #define PETSC_EXCEPTIONS_MAX 256 286 extern PetscErrorCode PetscErrorUncatchable[PETSC_EXCEPTIONS_MAX]; 287 extern PetscInt PetscErrorUncatchableCount; 288 extern PetscErrorCode PetscExceptions[PETSC_EXCEPTIONS_MAX]; 289 extern PetscInt PetscExceptionsCount; 290 291 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscExceptionPush(PetscErrorCode); 292 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscExceptionPop(PetscErrorCode); 293 294 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorSetCatchable(PetscErrorCode,PetscTruth); 295 EXTERN PetscTruth PETSC_DLLEXPORT PetscErrorIsCatchable(PetscErrorCode); 296 /*MC 297 PetscExceptionCaught - Indicates if a specific exception zierr was caught. 298 299 Not Collective 300 301 Synopsis: 302 PetscTruth PetscExceptionCaught(PetscErrorCode xierr,PetscErrorCode zierr); 303 304 Input Parameters: 305 + xierr - error code returned from PetscExceptionTry1() or other PETSc routine 306 - zierr - error code you want it to be 307 308 Level: advanced 309 310 Notes: 311 PETSc must not be configured using the option --with-errorchecking=0 for this to work 312 313 Use PetscExceptionValue() to see if an error code is being "tried" 314 315 Concepts: exceptions, exception handling 316 317 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 318 CHKERRQ(), PetscExceptionTry1(), PetscExceptionValue() 319 M*/ 320 PETSC_STATIC_INLINE PetscTruth PetscExceptionCaught(PetscErrorCode xierr,PetscErrorCode zierr) { 321 PetscInt i; 322 if (xierr != zierr) return PETSC_FALSE; 323 for (i=0; i<PetscErrorUncatchableCount; i++) { 324 if (PetscErrorUncatchable[i] == zierr) { 325 return PETSC_FALSE; 326 } 327 } 328 return PETSC_TRUE; 329 } 330 331 /*MC 332 PetscExceptionValue - Indicates if the error code is one that is currently being tried 333 334 Not Collective 335 336 Synopsis: 337 PetscTruth PetscExceptionValue(PetscErrorCode xierr); 338 339 Input Parameters: 340 . xierr - error code 341 342 Level: developer 343 344 Notes: 345 PETSc must not be configured using the option --with-errorchecking=0 for this to work 346 347 Use PetscExceptionCaught() to see if the current error code is EXACTLY the one you want 348 349 Concepts: exceptions, exception hanlding 350 351 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 352 CHKERRQ(), PetscExceptionTry1(), PetscExceptionCaught() 353 M*/ 354 PETSC_STATIC_INLINE PetscTruth PetscExceptionValue(PetscErrorCode zierr) { 355 PetscInt i; 356 for (i=0; i<PetscExceptionsCount; i++) { 357 if (PetscExceptions[i] == zierr) { 358 return PETSC_TRUE; 359 } 360 } 361 return PETSC_FALSE; 362 } 363 364 /*MC 365 PetscExceptionTry1 - Runs the routine, causing a particular error code to be treated as an exception, 366 rather than an error. That is if that error code is treated the program returns to this level, 367 but does not call the error handlers 368 369 Not Collective 370 371 Synopsis: 372 PetscErrorCode PetscExceptionTry1(PetscErrorCode routine(....),PetscErrorCode); 373 374 Level: advanced 375 376 No Fortran Equivalent (see PetscExceptionPush() for Fortran) 377 378 Notes: 379 PETSc must not be configured using the option --with-errorchecking=0 for this to work 380 381 Note: In general, the outer most try on an exception is the one that will be caught (that is trys down in 382 PETSc code will not usually handle an exception that was issued above). See SNESSolve() for an example 383 of how the local try is ignored if a higher (in the stack) one is also in effect. 384 385 Concepts: exceptions, exception hanlding 386 387 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 388 CHKERRQ(), PetscExceptionCaught(), PetscExceptionPush(), PetscExceptionPop() 389 M*/ 390 extern PetscErrorCode PetscExceptionTmp,PetscExceptionTmp1; 391 #define PetscExceptionTry1(a,b) (PetscExceptionTmp1 = PetscExceptionPush(b)) ? PetscExceptionTmp1 : (PetscExceptionTmp1 = a, (PetscExceptionTmp = PetscExceptionPop(b)) ? PetscExceptionTmp : PetscExceptionTmp1) 392 393 /* 394 Used by PetscExceptionTrySync(). Returns zierr on ALL processes in comm iff xierr is zierr on at least one process and zero on all others. 395 */ 396 PETSC_STATIC_INLINE PetscErrorCode PetscExceptionTrySync_Private(MPI_Comm comm,PetscErrorCode xierr,PetscErrorCode zierr) 397 { 398 PetscReal in[2],out[2]; 399 PetscErrorCode ierr; 400 401 if (xierr != zierr) return xierr; 402 403 in[0] = xierr; 404 in[1] = 0.0; /* dummy value */ 405 406 ierr = MPI_Allreduce(in,out,2,MPIU_REAL,0,comm); if (ierr) {;} 407 return xierr; 408 } 409 410 /*MC 411 PetscExceptionTrySyncNorm - Runs the routine, causing a particular error code to be treated as an exception, 412 rather than an error. That is if that error code is treated the program returns to this level, 413 but does not call the error handlers 414 415 Collective on Comm 416 417 Synopsis: 418 PetscExceptionTrySyncNorm(MPI_Comm comm,PetscErrorCode routine(....),PetscErrorCode); 419 420 Level: advanced 421 422 Notes: This synchronizes the error code across all processes in the communicator IF the code matches PetscErrorCode. The next 423 call with an MPI_Reduce()/MPI_Allreduce() MUST be VecNorm() [We can added VecDot() and maybe others as needed]. 424 425 PETSc must not be configured using the option --with-errorchecking=0 for this to work 426 427 Note: In general, the outer most try on an exception is the one that will be caught (that is trys down in 428 PETSc code will not usually handle an exception that was issued above). See SNESSolve() for an example 429 of how the local try is ignored if a higher (in the stack) one is also in effect. 430 431 Concepts: exceptions, exception hanlding 432 433 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 434 CHKERRQ(), PetscExceptionCaught(), PetscExceptionPush(), PetscExceptionPop(), PetscExceptionTry1() 435 M*/ 436 extern PetscErrorCode PetscExceptionTmp; 437 #define PetscExceptionTrySyncNorm(comm,a,b) (PetscExceptionTmp = PetscExceptionPush(b)) ? PetscExceptionTmp : \ 438 (PetscExceptionTmp = a , PetscExceptionPop(b),PetscExceptionTrySyncNorm_Private(comm,PetscExceptionTmp,b)) 439 440 #else 441 442 /* 443 These are defined to be empty for when error checking is turned off, with config/configure.py --with-errorchecking=0 444 */ 445 446 #define SETERRQ(n,s) ; 447 #define SETERRQ1(n,s,a1) ; 448 #define SETERRQ2(n,s,a1,a2) ; 449 #define SETERRQ3(n,s,a1,a2,a3) ; 450 #define SETERRQ4(n,s,a1,a2,a3,a4) ; 451 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) ; 452 #define SETERRQ6(n,s,a1,a2,a3,a4,a5,a6) ; 453 #define SETERRABORT(comm,n,s) ; 454 455 #define CHKERRQ(n) ; 456 #define CHKERRABORT(comm,n) ; 457 #define CHKERRCONTINUE(n) ; 458 #define CHKFPQ(f) ; 459 #define CHKMEMQ ; 460 461 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 462 #define _ 463 #define ___ 464 #endif 465 466 #define PetscExceptionPush(a) 0 467 #define PetscExceptionPop(a) 0 468 #define PetscErrorSetCatchable(a,b) 0 469 #define PetscErrorIsCatchable(a) PETSC_FALSE 470 471 #define PetscExceptionCaught(a,b) PETSC_FALSE 472 #define PetscExceptionValue(a) PETSC_FALSE 473 #define PetscExceptionTry1(a,b) a 474 #define PetscExceptionTrySyncNorm(comm,a,b) a 475 476 #endif 477 478 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorPrintfInitialize(void); 479 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorMessage(int,const char*[],char **); 480 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTraceBackErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 481 #ifdef PETSC_CLANGUAGE_CXX 482 #include <sstream> 483 EXTERN void PETSC_DLLEXPORT PetscTraceBackErrorHandlerCxx(int,const char *,const char *,const char *,PetscErrorCode,int, std::ostringstream&); 484 #endif 485 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIgnoreErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 486 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEmacsClientErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 487 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 488 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 489 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAttachDebuggerErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 490 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscReturnErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 491 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscError(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,...) PETSC_PRINTF_FORMAT_CHECK(7,8); 492 EXTERN void PETSC_DLLEXPORT PetscErrorCxx(int,const char*,const char*,const char*,PetscErrorCode,int); 493 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushErrorHandler(PetscErrorCode (*handler)(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*),void*); 494 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopErrorHandler(void); 495 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDefaultSignalHandler(int,void*); 496 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 497 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopSignalHandler(void); 498 499 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 500 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetFPTrap(PetscFPTrap); 501 502 /* 503 Allows the code to build a stack frame as it runs 504 */ 505 #if defined(PETSC_USE_DEBUG) 506 507 #define PETSCSTACKSIZE 15 508 509 typedef struct { 510 const char *function[PETSCSTACKSIZE]; 511 const char *file[PETSCSTACKSIZE]; 512 const char *directory[PETSCSTACKSIZE]; 513 int line[PETSCSTACKSIZE]; 514 int currentsize; 515 } PetscStack; 516 517 extern PETSC_DLLEXPORT PetscStack *petscstack; 518 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCopy(PetscStack*,PetscStack*); 519 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPrint(PetscStack*,FILE* fp); 520 521 #define PetscStackActive (petscstack != 0) 522 523 524 /*MC 525 PetscFunctionBegin - First executable line of each PETSc function 526 used for error handling. 527 528 Synopsis: 529 void PetscFunctionBegin; 530 531 Usage: 532 .vb 533 int something; 534 535 PetscFunctionBegin; 536 .ve 537 538 Notes: 539 Not available in Fortran 540 541 Level: developer 542 543 .seealso: PetscFunctionReturn() 544 545 .keywords: traceback, error handling 546 M*/ 547 #define PetscFunctionBegin \ 548 {\ 549 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 550 petscstack->function[petscstack->currentsize] = __FUNCT__; \ 551 petscstack->file[petscstack->currentsize] = __FILE__; \ 552 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 553 petscstack->line[petscstack->currentsize] = __LINE__; \ 554 petscstack->currentsize++; \ 555 }} 556 557 #define PetscStackPush(n) \ 558 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 559 petscstack->function[petscstack->currentsize] = n; \ 560 petscstack->file[petscstack->currentsize] = "unknown"; \ 561 petscstack->directory[petscstack->currentsize] = "unknown"; \ 562 petscstack->line[petscstack->currentsize] = 0; \ 563 petscstack->currentsize++; \ 564 }} 565 566 #define PetscStackPop \ 567 {if (petscstack && petscstack->currentsize > 0) { \ 568 petscstack->currentsize--; \ 569 petscstack->function[petscstack->currentsize] = 0; \ 570 petscstack->file[petscstack->currentsize] = 0; \ 571 petscstack->directory[petscstack->currentsize] = 0; \ 572 petscstack->line[petscstack->currentsize] = 0; \ 573 }}; 574 575 /*MC 576 PetscFunctionReturn - Last executable line of each PETSc function 577 used for error handling. Replaces return() 578 579 Synopsis: 580 void PetscFunctionReturn(0); 581 582 Usage: 583 .vb 584 .... 585 PetscFunctionReturn(0); 586 } 587 .ve 588 589 Notes: 590 Not available in Fortran 591 592 Level: developer 593 594 .seealso: PetscFunctionBegin() 595 596 .keywords: traceback, error handling 597 M*/ 598 #define PetscFunctionReturn(a) \ 599 {\ 600 PetscStackPop; \ 601 return(a);} 602 603 #define PetscFunctionReturnVoid() \ 604 {\ 605 PetscStackPop; \ 606 return;} 607 608 609 #else 610 611 #define PetscFunctionBegin 612 #define PetscFunctionReturn(a) return(a) 613 #define PetscFunctionReturnVoid() return 614 #define PetscStackPop 615 #define PetscStackPush(f) 616 #define PetscStackActive 0 617 618 #endif 619 620 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCreate(void); 621 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackView(PetscViewer); 622 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDestroy(void); 623 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPublish(void); 624 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDepublish(void); 625 626 627 PETSC_EXTERN_CXX_END 628 #endif 629