1 /* 2 Contains all error handling interfaces for PETSc. 3 */ 4 #if !defined(__PETSCERROR_H) 5 #define __PETSCERROR_H 6 7 #if defined(PETSC_HAVE_STRING_H) 8 #include <string.h> /* for strcmp */ 9 #endif 10 11 PETSC_EXTERN_CXX_BEGIN 12 13 /* 14 Defines the directory where the compiled source is located; used 15 in printing error messages. Each makefile has an entry 16 LOCDIR = thedirectory 17 and bmake/common_variables includes in CCPPFLAGS -D__SDIR__=${LOCDIR} 18 which is a flag passed to the C/C++ compilers. This declaration below 19 is only needed if some code is compiled without the -D__SDIR__ 20 */ 21 #if !defined(__INSDIR__) 22 #define __INSDIR__ "unknowndirectory/" 23 #endif 24 25 /* 26 Defines the function where the compiled source is located; used 27 in printing error messages. This is defined here in case the user 28 does not declare it. 29 */ 30 #if !defined(__FUNCT__) 31 #define __FUNCT__ "User provided function" 32 #endif 33 34 /* 35 These are the generic error codes. These error codes are used 36 many different places in the PETSc source code. The string versions are 37 at src/sys/error/err.c any changes here must also be made there 38 These are also define in include/finclude/petscerror.h any CHANGES here 39 must be also made there. 40 41 */ 42 #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 43 44 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 45 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 46 #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 47 #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 48 #define PETSC_ERR_SIG 59 /* signal received */ 49 #define PETSC_ERR_FP 72 /* floating point exception */ 50 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 51 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 52 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 53 #define PETSC_ERR_MEMC 78 /* memory corruption */ 54 #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 55 #define PETSC_ERR_USER 83 /* user has not provided needed function */ 56 #define PETSC_ERR_SYS 88 /* error in system call */ 57 58 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 59 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 60 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 61 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 62 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 63 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 64 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 65 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 66 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 67 #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 68 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 69 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 70 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 71 72 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 73 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 74 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 75 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 76 77 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 78 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 79 80 #define PETSC_ERR_INT_OVERFLOW 84 /* should always be one less then the smallest value */ 81 82 #define PETSC_ERR_FLOP_COUNT 90 83 #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 84 #define PETSC_ERR_MAX_VALUE 92 /* this is always the one more than the largest error code */ 85 86 #define PetscStringizeArg(a) #a 87 #define PetscStringize(a) PetscStringizeArg(a) 88 #define __SDIR__ PetscStringize(__INSDIR__) 89 90 #if defined(PETSC_USE_ERRORCHECKING) 91 92 /*MC 93 SETERRQ - Macro that is called when an error has been detected, 94 95 Synopsis: 96 PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message) 97 98 Not Collective 99 100 Input Parameters: 101 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 102 - message - error message 103 104 Level: beginner 105 106 Notes: 107 Once the error handler is called the calling function is then returned from with the given error code. 108 109 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 110 111 In Fortran MPI_Abort() is always called 112 113 Experienced users can set the error handler with PetscPushErrorHandler(). 114 115 Concepts: error^setting condition 116 117 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 118 M*/ 119 #define SETERRQ(comm,n,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s) 120 121 /*MC 122 SETERRQ1 - Macro that is called when an error has been detected, 123 124 Synopsis: 125 PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg) 126 127 Not Collective 128 129 Input Parameters: 130 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 131 . message - error message in the printf format 132 - arg - argument (for example an integer, string or double) 133 134 Level: beginner 135 136 Notes: 137 Once the error handler is called the calling function is then returned from with the given error code. 138 139 Experienced users can set the error handler with PetscPushErrorHandler(). 140 141 Concepts: error^setting condition 142 143 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 144 M*/ 145 #define SETERRQ1(comm,n,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1) 146 147 /*MC 148 SETERRQ2 - Macro that is called when an error has been detected, 149 150 Synopsis: 151 PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 152 153 Not Collective 154 155 Input Parameters: 156 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 157 . message - error message in the printf format 158 . arg1 - argument (for example an integer, string or double) 159 - arg2 - argument (for example an integer, string or double) 160 161 Level: beginner 162 163 Notes: 164 Once the error handler is called the calling function is then returned from with the given error code. 165 166 Experienced users can set the error handler with PetscPushErrorHandler(). 167 168 Concepts: error^setting condition 169 170 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 171 M*/ 172 #define SETERRQ2(comm,n,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2) 173 174 /*MC 175 SETERRQ3 - Macro that is called when an error has been detected, 176 177 Synopsis: 178 PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 179 180 Not Collective 181 182 Input Parameters: 183 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 184 . message - error message in the printf format 185 . arg1 - argument (for example an integer, string or double) 186 . arg2 - argument (for example an integer, string or double) 187 - arg3 - argument (for example an integer, string or double) 188 189 Level: beginner 190 191 Notes: 192 Once the error handler is called the calling function is then returned from with the given error code. 193 194 There are also versions for 4, 5, 6 and 7 arguments. 195 196 Experienced users can set the error handler with PetscPushErrorHandler(). 197 198 Concepts: error^setting condition 199 200 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 201 M*/ 202 #define SETERRQ3(comm,n,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3) 203 204 #define SETERRQ4(comm,n,s,a1,a2,a3,a4) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4) 205 #define SETERRQ5(comm,n,s,a1,a2,a3,a4,a5) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5) 206 #define SETERRQ6(comm,n,s,a1,a2,a3,a4,a5,a6) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6) 207 #define SETERRQ7(comm,n,s,a1,a2,a3,a4,a5,a6,a7) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7) 208 #define SETERRQ8(comm,n,s,a1,a2,a3,a4,a5,a6,a7,a8) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8) 209 #define SETERRABORT(comm,n,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,n);} while (0) 210 211 /*MC 212 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 213 214 Synopsis: 215 PetscErrorCode CHKERRQ(PetscErrorCode errorcode) 216 217 Not Collective 218 219 Input Parameters: 220 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 221 222 Level: beginner 223 224 Notes: 225 Once the error handler is called the calling function is then returned from with the given error code. 226 227 Experienced users can set the error handler with PetscPushErrorHandler(). 228 229 CHKERRQ(n) is fundamentally a macro replacement for 230 if (n) return(PetscError(...,n,...)); 231 232 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 233 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 234 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 235 you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 236 if (n) {PetscError(....); return(YourReturnType);} 237 where you may pass back a PETSC_NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 238 MPI_Abort() returned immediately. 239 240 In Fortran MPI_Abort() is always called 241 242 Concepts: error^setting condition 243 244 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 245 M*/ 246 #define CHKERRQ(n) do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");} while (0) 247 248 #define CHKERRV(n) do {if (PetscUnlikely(n)) {n = PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");return;}} while(0) 249 #define CHKERRABORT(comm,n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,n);}} while (0) 250 #define CHKERRCONTINUE(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");}} while (0) 251 252 #ifdef PETSC_CLANGUAGE_CXX 253 254 /*MC 255 CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception 256 257 Synopsis: 258 void CHKERRXX(PetscErrorCode errorcode) 259 260 Not Collective 261 262 Input Parameters: 263 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 264 265 Level: beginner 266 267 Notes: 268 Once the error handler throws a ??? exception. 269 270 You can use CHKERRV() which returns without an error code (bad idea since the error is ignored) 271 or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. 272 273 Concepts: error^setting condition 274 275 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ 276 M*/ 277 #define CHKERRXX(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_IN_CXX,0);}} while(0) 278 279 #endif 280 281 /*MC 282 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 283 284 Synopsis: 285 CHKMEMQ; 286 287 Not Collective 288 289 Level: beginner 290 291 Notes: 292 Must run with the option -malloc_debug to enable this option 293 294 Once the error handler is called the calling function is then returned from with the given error code. 295 296 By defaults prints location where memory that is corrupted was allocated. 297 298 Use CHKMEMA for functions that return void 299 300 Concepts: memory corruption 301 302 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 303 PetscMallocValidate() 304 M*/ 305 #define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} while(0) 306 307 #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) 308 309 #if defined(PETSC_UNDERSCORE_CHKERR) 310 extern PetscErrorCode __gierr; 311 #define _ __gierr = 312 #define ___ CHKERRQ(__gierr); 313 #endif 314 315 #else /* PETSC_USE_ERRORCHECKING */ 316 317 /* 318 These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0 319 */ 320 321 #define SETERRQ(c,n,s) 322 #define SETERRQ1(c,n,s,a1) 323 #define SETERRQ2(c,n,s,a1,a2) 324 #define SETERRQ3(c,n,s,a1,a2,a3) 325 #define SETERRQ4(c,n,s,a1,a2,a3,a4) 326 #define SETERRQ5(c,n,s,a1,a2,a3,a4,a5) 327 #define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6) 328 #define SETERRABORT(comm,n,s) 329 330 #define CHKERRQ(n) ; 331 #define CHKERRABORT(comm,n) ; 332 #define CHKERRCONTINUE(n) ; 333 #define CHKMEMQ ; 334 335 #ifdef PETSC_CLANGUAGE_CXX 336 #define CHKERRXX(n) ; 337 #endif 338 339 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 340 #define _ 341 #define ___ 342 #endif 343 344 #endif /* PETSC_USE_ERRORCHECKING */ 345 346 /*E 347 PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers 348 349 Level: advanced 350 351 PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated 352 353 Developer Notes: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandling() 354 355 .seealso: PetscError(), SETERRXX() 356 E*/ 357 typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType; 358 359 extern PetscErrorCode PetscErrorPrintfInitialize(void); 360 extern PetscErrorCode PetscErrorMessage(int,const char*[],char **); 361 extern PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 362 extern PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 363 extern PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 364 extern PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 365 extern PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 366 extern PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 367 extern PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 368 extern PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...); 369 extern PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*); 370 extern PetscErrorCode PetscPopErrorHandler(void); 371 extern PetscErrorCode PetscDefaultSignalHandler(int,void*); 372 extern PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 373 extern PetscErrorCode PetscPopSignalHandler(void); 374 375 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 376 extern PetscErrorCode PetscSetFPTrap(PetscFPTrap); 377 378 /* 379 Allows the code to build a stack frame as it runs 380 */ 381 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD) 382 383 #define PETSCSTACKSIZE 64 384 385 typedef struct { 386 const char *function[PETSCSTACKSIZE]; 387 const char *file[PETSCSTACKSIZE]; 388 const char *directory[PETSCSTACKSIZE]; 389 int line[PETSCSTACKSIZE]; 390 int currentsize; 391 } PetscStack; 392 393 extern PetscStack *petscstack; 394 extern PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); 395 extern PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp); 396 397 #define PetscStackActive (petscstack != 0) 398 399 /*MC 400 PetscFunctionBegin - First executable line of each PETSc function 401 used for error handling. 402 403 Synopsis: 404 void PetscFunctionBegin; 405 406 Not Collective 407 408 Usage: 409 .vb 410 int something; 411 412 PetscFunctionBegin; 413 .ve 414 415 Notes: 416 Not available in Fortran 417 418 Level: developer 419 420 .seealso: PetscFunctionReturn() 421 422 .keywords: traceback, error handling 423 M*/ 424 #define PetscFunctionBegin \ 425 do { \ 426 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 427 petscstack->function[petscstack->currentsize] = PETSC_FUNCTION_NAME; \ 428 petscstack->file[petscstack->currentsize] = __FILE__; \ 429 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 430 petscstack->line[petscstack->currentsize] = __LINE__; \ 431 petscstack->currentsize++; \ 432 } \ 433 PetscCheck__FUNCT__(); \ 434 } while (0) 435 436 #define PetscCheck__FUNCT__() do { \ 437 if (strcmp(PETSC_FUNCTION_NAME,__FUNCT__) && strcmp(__FUNCT__,"User provided function")) { \ 438 (*PetscErrorPrintf)("%s%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__SDIR__,__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \ 439 } \ 440 } while (0) 441 442 #define PetscStackPush(n) \ 443 do {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 444 petscstack->function[petscstack->currentsize] = n; \ 445 petscstack->file[petscstack->currentsize] = "unknown"; \ 446 petscstack->directory[petscstack->currentsize] = "unknown"; \ 447 petscstack->line[petscstack->currentsize] = 0; \ 448 petscstack->currentsize++; \ 449 } CHKMEMQ;} while (0) 450 451 #define PetscStackPop \ 452 do {CHKMEMQ; if (petscstack && petscstack->currentsize > 0) { \ 453 petscstack->currentsize--; \ 454 petscstack->function[petscstack->currentsize] = 0; \ 455 petscstack->file[petscstack->currentsize] = 0; \ 456 petscstack->directory[petscstack->currentsize] = 0; \ 457 petscstack->line[petscstack->currentsize] = 0; \ 458 }} while (0) 459 460 /*MC 461 PetscFunctionReturn - Last executable line of each PETSc function 462 used for error handling. Replaces return() 463 464 Synopsis: 465 void PetscFunctionReturn(0); 466 467 Not Collective 468 469 Usage: 470 .vb 471 .... 472 PetscFunctionReturn(0); 473 } 474 .ve 475 476 Notes: 477 Not available in Fortran 478 479 Level: developer 480 481 .seealso: PetscFunctionBegin() 482 483 .keywords: traceback, error handling 484 M*/ 485 #define PetscFunctionReturn(a) \ 486 do {\ 487 if (petscstack && petscstack->currentsize > 0) { \ 488 petscstack->currentsize--; \ 489 petscstack->function[petscstack->currentsize] = 0; \ 490 petscstack->file[petscstack->currentsize] = 0; \ 491 petscstack->directory[petscstack->currentsize] = 0; \ 492 petscstack->line[petscstack->currentsize] = 0; \ 493 }\ 494 return(a);} while (0) 495 496 #define PetscFunctionReturnVoid() \ 497 do {\ 498 if (petscstack && petscstack->currentsize > 0) { \ 499 petscstack->currentsize--; \ 500 petscstack->function[petscstack->currentsize] = 0; \ 501 petscstack->file[petscstack->currentsize] = 0; \ 502 petscstack->directory[petscstack->currentsize] = 0; \ 503 petscstack->line[petscstack->currentsize] = 0; \ 504 }\ 505 return;} while (0) 506 507 #else 508 509 #define PetscFunctionBegin 510 #define PetscFunctionReturn(a) return(a) 511 #define PetscFunctionReturnVoid() return 512 #define PetscStackPop CHKMEMQ 513 #define PetscStackPush(f) CHKMEMQ 514 #define PetscStackActive 0 515 516 #endif 517 518 /* 519 PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack. 520 521 Input Parameters: 522 + name - string that gives the name of the function being called 523 - routine - actual call to the routine 524 525 Developer Note: this is so that when a user or external library routine results in a crash or corrupts memory, they get blamed instead of PETSc. 526 527 */ 528 #define PetscStackCall(name,routine) PetscStackPush(name);routine;PetscStackPop; 529 530 extern PetscErrorCode PetscStackCreate(void); 531 extern PetscErrorCode PetscStackView(PetscViewer); 532 extern PetscErrorCode PetscStackDestroy(void); 533 extern PetscErrorCode PetscStackPublish(void); 534 extern PetscErrorCode PetscStackDepublish(void); 535 536 537 PETSC_EXTERN_CXX_END 538 #endif 539