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_TYPENOTSET 89 /* the type of the object has not yet been set */ 64 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 65 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 66 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 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_FLOP_COUNT 90 77 #define PETSC_ERR_MAX_VALUE 91 /* this is always the one more than the largest error code */ 78 79 #if defined(PETSC_USE_ERRORCHECKING) 80 81 /*MC 82 SETERRQ - Macro that is called when an error has been detected, 83 84 Not Collective 85 86 Synopsis: 87 PetscErrorCode SETERRQ(PetscErrorCode errorcode,char *message) 88 89 90 Input Parameters: 91 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 92 - message - error message 93 94 Level: beginner 95 96 Notes: 97 Once the error handler is called the calling function is then returned from with the given error code. 98 99 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 100 101 In Fortran MPI_Abort() is always called 102 103 Experienced users can set the error handler with PetscPushErrorHandler(). 104 105 Concepts: error^setting condition 106 107 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 108 M*/ 109 #define SETERRQ(n,s) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);} 110 111 /*MC 112 SETERRQ1 - Macro that is called when an error has been detected, 113 114 Not Collective 115 116 Synopsis: 117 PetscErrorCode SETERRQ1(PetscErrorCode errorcode,char *formatmessage,arg) 118 119 120 Input Parameters: 121 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 122 . message - error message in the printf format 123 - arg - argument (for example an integer, string or double) 124 125 Level: beginner 126 127 Notes: 128 Once the error handler is called the calling function is then returned from with the given error code. 129 130 Experienced users can set the error handler with PetscPushErrorHandler(). 131 132 Concepts: error^setting condition 133 134 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 135 M*/ 136 #define SETERRQ1(n,s,a1) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1);} 137 138 /*MC 139 SETERRQ2 - Macro that is called when an error has been detected, 140 141 Not Collective 142 143 Synopsis: 144 PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 145 146 147 Input Parameters: 148 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 149 . message - error message in the printf format 150 . arg1 - argument (for example an integer, string or double) 151 - arg2 - argument (for example an integer, string or double) 152 153 Level: beginner 154 155 Notes: 156 Once the error handler is called the calling function is then returned from with the given error code. 157 158 Experienced users can set the error handler with PetscPushErrorHandler(). 159 160 Concepts: error^setting condition 161 162 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 163 M*/ 164 #define SETERRQ2(n,s,a1,a2) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2);} 165 166 /*MC 167 SETERRQ3 - Macro that is called when an error has been detected, 168 169 Not Collective 170 171 Synopsis: 172 PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 173 174 175 Input Parameters: 176 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 177 . message - error message in the printf format 178 . arg1 - argument (for example an integer, string or double) 179 . arg2 - argument (for example an integer, string or double) 180 - arg3 - argument (for example an integer, string or double) 181 182 Level: beginner 183 184 Notes: 185 Once the error handler is called the calling function is then returned from with the given error code. 186 187 There are also versions for 4, 5, 6 and 7 arguments. 188 189 Experienced users can set the error handler with PetscPushErrorHandler(). 190 191 Concepts: error^setting condition 192 193 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 194 M*/ 195 #define SETERRQ3(n,s,a1,a2,a3) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3);} 196 197 #define SETERRQ4(n,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4);} 198 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5);} 199 #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);} 200 #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);} 201 #define SETERRABORT(comm,n,s) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);MPI_Abort(comm,n);} 202 203 /*MC 204 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 205 206 Not Collective 207 208 Synopsis: 209 PetscErrorCode CHKERRQ(PetscErrorCode errorcode) 210 211 212 Input Parameters: 213 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 214 215 Level: beginner 216 217 Notes: 218 Once the error handler is called the calling function is then returned from with the given error code. 219 220 Experienced users can set the error handler with PetscPushErrorHandler(). 221 222 CHKERRQ(n) is fundamentally a macro replacement for 223 if (n) return(PetscError(...,n,...)); 224 225 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 226 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 227 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 228 you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 229 if (n) {PetscError(....); return(YourReturnType);} 230 where you may pass back a PETSC_NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 231 MPI_Abort() returned immediately. 232 233 In Fortran MPI_Abort() is always called 234 235 Concepts: error^setting condition 236 237 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 238 M*/ 239 #define CHKERRQ(n) if (n) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 240 241 #define CHKERRV(n) if (n) {n = PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");return;} 242 #define CHKERRABORT(comm,n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");MPI_Abort(comm,n);} 243 #define CHKERRCONTINUE(n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 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 CHKMEMQ ; 459 460 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 461 #define _ 462 #define ___ 463 #endif 464 465 #define PetscExceptionPush(a) 0 466 #define PetscExceptionPop(a) 0 467 #define PetscErrorSetCatchable(a,b) 0 468 #define PetscErrorIsCatchable(a) PETSC_FALSE 469 470 #define PetscExceptionCaught(a,b) PETSC_FALSE 471 #define PetscExceptionValue(a) PETSC_FALSE 472 #define PetscExceptionTry1(a,b) a 473 #define PetscExceptionTrySyncNorm(comm,a,b) a 474 475 #endif 476 477 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorPrintfInitialize(void); 478 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorMessage(int,const char*[],char **); 479 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTraceBackErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 480 #ifdef PETSC_CLANGUAGE_CXX 481 #include <sstream> 482 EXTERN void PETSC_DLLEXPORT PetscTraceBackErrorHandlerCxx(int,const char *,const char *,const char *,PetscErrorCode,int, std::ostringstream&); 483 #endif 484 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIgnoreErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 485 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEmacsClientErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 486 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 487 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 488 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAttachDebuggerErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 489 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscReturnErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 490 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscError(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,...) PETSC_PRINTF_FORMAT_CHECK(7,8); 491 EXTERN void PETSC_DLLEXPORT PetscErrorCxx(int,const char*,const char*,const char*,PetscErrorCode,int); 492 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushErrorHandler(PetscErrorCode (*handler)(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*),void*); 493 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopErrorHandler(void); 494 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDefaultSignalHandler(int,void*); 495 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 496 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopSignalHandler(void); 497 498 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 499 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetFPTrap(PetscFPTrap); 500 501 /* 502 Allows the code to build a stack frame as it runs 503 */ 504 #if defined(PETSC_USE_DEBUG) 505 506 #define PETSCSTACKSIZE 15 507 508 typedef struct { 509 const char *function[PETSCSTACKSIZE]; 510 const char *file[PETSCSTACKSIZE]; 511 const char *directory[PETSCSTACKSIZE]; 512 int line[PETSCSTACKSIZE]; 513 int currentsize; 514 } PetscStack; 515 516 extern PETSC_DLLEXPORT PetscStack *petscstack; 517 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCopy(PetscStack*,PetscStack*); 518 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPrint(PetscStack*,FILE* fp); 519 520 #define PetscStackActive (petscstack != 0) 521 522 523 /*MC 524 PetscFunctionBegin - First executable line of each PETSc function 525 used for error handling. 526 527 Synopsis: 528 void PetscFunctionBegin; 529 530 Usage: 531 .vb 532 int something; 533 534 PetscFunctionBegin; 535 .ve 536 537 Notes: 538 Not available in Fortran 539 540 Level: developer 541 542 .seealso: PetscFunctionReturn() 543 544 .keywords: traceback, error handling 545 M*/ 546 #define PetscFunctionBegin \ 547 {\ 548 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 549 petscstack->function[petscstack->currentsize] = __FUNCT__; \ 550 petscstack->file[petscstack->currentsize] = __FILE__; \ 551 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 552 petscstack->line[petscstack->currentsize] = __LINE__; \ 553 petscstack->currentsize++; \ 554 }} 555 556 #define PetscStackPush(n) \ 557 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 558 petscstack->function[petscstack->currentsize] = n; \ 559 petscstack->file[petscstack->currentsize] = "unknown"; \ 560 petscstack->directory[petscstack->currentsize] = "unknown"; \ 561 petscstack->line[petscstack->currentsize] = 0; \ 562 petscstack->currentsize++; \ 563 }} 564 565 #define PetscStackPop \ 566 {if (petscstack && petscstack->currentsize > 0) { \ 567 petscstack->currentsize--; \ 568 petscstack->function[petscstack->currentsize] = 0; \ 569 petscstack->file[petscstack->currentsize] = 0; \ 570 petscstack->directory[petscstack->currentsize] = 0; \ 571 petscstack->line[petscstack->currentsize] = 0; \ 572 }}; 573 574 /*MC 575 PetscFunctionReturn - Last executable line of each PETSc function 576 used for error handling. Replaces return() 577 578 Synopsis: 579 void PetscFunctionReturn(0); 580 581 Usage: 582 .vb 583 .... 584 PetscFunctionReturn(0); 585 } 586 .ve 587 588 Notes: 589 Not available in Fortran 590 591 Level: developer 592 593 .seealso: PetscFunctionBegin() 594 595 .keywords: traceback, error handling 596 M*/ 597 #define PetscFunctionReturn(a) \ 598 {\ 599 PetscStackPop; \ 600 return(a);} 601 602 #define PetscFunctionReturnVoid() \ 603 {\ 604 PetscStackPop; \ 605 return;} 606 607 608 #else 609 610 #define PetscFunctionBegin 611 #define PetscFunctionReturn(a) return(a) 612 #define PetscFunctionReturnVoid() return 613 #define PetscStackPop 614 #define PetscStackPush(f) 615 #define PetscStackActive 0 616 617 #endif 618 619 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCreate(void); 620 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackView(PetscViewer); 621 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDestroy(void); 622 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPublish(void); 623 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDepublish(void); 624 625 626 PETSC_EXTERN_CXX_END 627 #endif 628