1 /* 2 Contains all error handling interfaces for PETSc. 3 */ 4 #if !defined(__PETSCERROR_H) 5 #define __PETSCERROR_H 6 7 /* 8 Defines the function where the compiled source is located; used 9 in printing error messages. This is defined here in case the user 10 does not declare it. 11 */ 12 #if !defined(__FUNCT__) 13 #define __FUNCT__ "User provided function" 14 #endif 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 include/finclude/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 41 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 42 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 43 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 44 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 45 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 46 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 47 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 48 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 49 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 50 #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 51 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 52 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 53 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 54 55 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 56 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 57 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 58 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 59 60 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 61 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 62 63 #define PETSC_ERR_INT_OVERFLOW 84 /* should always be one less then the smallest value */ 64 65 #define PETSC_ERR_FLOP_COUNT 90 66 #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 67 #define PETSC_ERR_MAX_VALUE 92 /* this is always the one more than the largest error code */ 68 69 #define PetscStringizeArg(a) #a 70 #define PetscStringize(a) PetscStringizeArg(a) 71 #define __SDIR__ "" 72 73 #if defined(PETSC_USE_ERRORCHECKING) 74 75 /*MC 76 SETERRQ - Macro that is called when an error has been detected, 77 78 Synopsis: 79 #include "petscsys.h" 80 PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message) 81 82 Not Collective 83 84 Input Parameters: 85 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 86 - message - error message 87 88 Level: beginner 89 90 Notes: 91 Once the error handler is called the calling function is then returned from with the given error code. 92 93 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 94 95 In Fortran MPI_Abort() is always called 96 97 Experienced users can set the error handler with PetscPushErrorHandler(). 98 99 Concepts: error^setting condition 100 101 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 102 M*/ 103 #define SETERRQ(comm,n,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s) 104 105 /*MC 106 SETERRQ1 - Macro that is called when an error has been detected, 107 108 Synopsis: 109 #include "petscsys.h" 110 PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg) 111 112 Not Collective 113 114 Input Parameters: 115 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 116 . message - error message in the printf format 117 - arg - argument (for example an integer, string or double) 118 119 Level: beginner 120 121 Notes: 122 Once the error handler is called the calling function is then returned from with the given error code. 123 124 Experienced users can set the error handler with PetscPushErrorHandler(). 125 126 Concepts: error^setting condition 127 128 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 129 M*/ 130 #define SETERRQ1(comm,n,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1) 131 132 /*MC 133 SETERRQ2 - Macro that is called when an error has been detected, 134 135 Synopsis: 136 #include "petscsys.h" 137 PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 138 139 Not Collective 140 141 Input Parameters: 142 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 143 . message - error message in the printf format 144 . arg1 - argument (for example an integer, string or double) 145 - arg2 - argument (for example an integer, string or double) 146 147 Level: beginner 148 149 Notes: 150 Once the error handler is called the calling function is then returned from with the given error code. 151 152 Experienced users can set the error handler with PetscPushErrorHandler(). 153 154 Concepts: error^setting condition 155 156 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 157 M*/ 158 #define SETERRQ2(comm,n,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2) 159 160 /*MC 161 SETERRQ3 - Macro that is called when an error has been detected, 162 163 Synopsis: 164 #include "petscsys.h" 165 PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 166 167 Not Collective 168 169 Input Parameters: 170 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 171 . message - error message in the printf format 172 . arg1 - argument (for example an integer, string or double) 173 . arg2 - argument (for example an integer, string or double) 174 - arg3 - argument (for example an integer, string or double) 175 176 Level: beginner 177 178 Notes: 179 Once the error handler is called the calling function is then returned from with the given error code. 180 181 There are also versions for 4, 5, 6 and 7 arguments. 182 183 Experienced users can set the error handler with PetscPushErrorHandler(). 184 185 Concepts: error^setting condition 186 187 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 188 M*/ 189 #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) 190 191 #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) 192 #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) 193 #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) 194 #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) 195 #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) 196 #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) 197 198 /*MC 199 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 200 201 Synopsis: 202 #include "petscsys.h" 203 PetscErrorCode CHKERRQ(PetscErrorCode errorcode) 204 205 Not Collective 206 207 Input Parameters: 208 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 209 210 Level: beginner 211 212 Notes: 213 Once the error handler is called the calling function is then returned from with the given error code. 214 215 Experienced users can set the error handler with PetscPushErrorHandler(). 216 217 CHKERRQ(n) is fundamentally a macro replacement for 218 if (n) return(PetscError(...,n,...)); 219 220 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 221 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 222 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 223 you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 224 if (n) {PetscError(....); return(YourReturnType);} 225 where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 226 MPI_Abort() returned immediately. 227 228 In Fortran MPI_Abort() is always called 229 230 Concepts: error^setting condition 231 232 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 233 M*/ 234 #define CHKERRQ(n) do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");} while (0) 235 236 #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) 237 #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) 238 #define CHKERRCONTINUE(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");}} while (0) 239 240 #ifdef PETSC_CLANGUAGE_CXX 241 242 /*MC 243 CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception 244 245 Synopsis: 246 #include "petscsys.h" 247 void CHKERRXX(PetscErrorCode errorcode) 248 249 Not Collective 250 251 Input Parameters: 252 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 253 254 Level: beginner 255 256 Notes: 257 Once the error handler throws a ??? exception. 258 259 You can use CHKERRV() which returns without an error code (bad idea since the error is ignored) 260 or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. 261 262 Concepts: error^setting condition 263 264 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ 265 M*/ 266 #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) 267 268 #endif 269 270 /*MC 271 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 272 273 Synopsis: 274 #include "petscsys.h" 275 CHKMEMQ; 276 277 Not Collective 278 279 Level: beginner 280 281 Notes: 282 Must run with the option -malloc_debug to enable this option 283 284 Once the error handler is called the calling function is then returned from with the given error code. 285 286 By defaults prints location where memory that is corrupted was allocated. 287 288 Use CHKMEMA for functions that return void 289 290 Concepts: memory corruption 291 292 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 293 PetscMallocValidate() 294 M*/ 295 #define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} while(0) 296 297 #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) 298 299 #else /* PETSC_USE_ERRORCHECKING */ 300 301 /* 302 These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0 303 */ 304 305 #define SETERRQ(c,n,s) 306 #define SETERRQ1(c,n,s,a1) 307 #define SETERRQ2(c,n,s,a1,a2) 308 #define SETERRQ3(c,n,s,a1,a2,a3) 309 #define SETERRQ4(c,n,s,a1,a2,a3,a4) 310 #define SETERRQ5(c,n,s,a1,a2,a3,a4,a5) 311 #define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6) 312 #define SETERRQ7(c,n,s,a1,a2,a3,a4,a5,a6,a7) 313 #define SETERRQ8(c,n,s,a1,a2,a3,a4,a5,a6,a7,a8) 314 #define SETERRABORT(comm,n,s) 315 316 #define CHKERRQ(n) ; 317 #define CHKERRABORT(comm,n) ; 318 #define CHKERRCONTINUE(n) ; 319 #define CHKMEMQ ; 320 321 #ifdef PETSC_CLANGUAGE_CXX 322 #define CHKERRXX(n) ; 323 #endif 324 325 #endif /* PETSC_USE_ERRORCHECKING */ 326 327 /*E 328 PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers 329 330 Level: advanced 331 332 PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated 333 334 Developer Notes: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandling() 335 336 .seealso: PetscError(), SETERRXX() 337 E*/ 338 typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType; 339 340 PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void); 341 PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **); 342 PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 343 PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 344 PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 345 PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 346 PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 347 PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 348 PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 349 PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...); 350 PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*); 351 PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void); 352 PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*); 353 PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 354 PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void); 355 356 /*MC 357 PetscErrorPrintf - Prints error messages. 358 359 Synopsis: 360 #include "petscsys.h" 361 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 362 363 Not Collective 364 365 Input Parameters: 366 . format - the usual printf() format string 367 368 Options Database Keys: 369 + -error_output_stdout - cause error messages to be printed to stdout instead of the 370 (default) stderr 371 - -error_output_none to turn off all printing of error messages (does not change the way the 372 error is handled.) 373 374 Notes: Use 375 $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the 376 $ error is handled.) and 377 $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on 378 $ of you can use your own function 379 380 Use 381 PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file. 382 PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file. 383 384 Use 385 PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print 386 387 Level: developer 388 389 Fortran Note: 390 This routine is not supported in Fortran. 391 392 Concepts: error messages^printing 393 Concepts: printing^error messages 394 395 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush(), PetscVFPrintf(), PetscHelpPrintf() 396 M*/ 397 PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...); 398 399 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 400 PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap); 401 PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap); 402 PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void); 403 404 /* Linux functions CPU_SET and others don't work if sched.h is not included before 405 including pthread.h. Also, these functions are active only if either _GNU_SOURCE 406 or __USE_GNU is not set (see /usr/include/sched.h and /usr/include/features.h), hence 407 set these first. 408 */ 409 #if defined(PETSC_HAVE_PTHREADCLASSES) || defined (PETSC_HAVE_OPENMP) 410 #if defined(PETSC_HAVE_SCHED_H) 411 #ifndef _GNU_SOURCE 412 #define _GNU_SOURCE 413 #endif 414 #include <sched.h> 415 #endif 416 #include <pthread.h> 417 #endif 418 419 /* 420 This code is for managing thread local global variables. Each of Linux, Microsoft WINDOWS, OpenMP, and Apple OS X have 421 different ways to indicate this. On OS X each thread local global is accessed by using a pthread_key_t for that variable. 422 Thus we have functions for creating destroying and using the keys. Except for OS X these access functions merely directly 423 acess the thread local variable. 424 */ 425 426 #if defined(PETSC_HAVE_PTHREADCLASSES) && !defined(PETSC_PTHREAD_LOCAL) 427 typedef pthread_key_t PetscThreadKey; 428 /* Get the value associated with key */ 429 PETSC_STATIC_INLINE void* PetscThreadLocalGetValue(PetscThreadKey key) 430 { 431 return pthread_getspecific(key); 432 } 433 434 /* Set the value for key */ 435 PETSC_STATIC_INLINE void PetscThreadLocalSetValue(PetscThreadKey *key,void* value) 436 { 437 pthread_setspecific(*key,(void*)value); 438 } 439 440 /* Create pthread thread local key */ 441 PETSC_STATIC_INLINE void PetscThreadLocalRegister(PetscThreadKey *key) 442 { 443 pthread_key_create(key,NULL); 444 } 445 446 /* Delete pthread thread local key */ 447 PETSC_STATIC_INLINE void PetscThreadLocalDestroy(PetscThreadKey key) 448 { 449 pthread_key_delete(key); 450 } 451 #else 452 typedef void* PetscThreadKey; 453 PETSC_STATIC_INLINE void* PetscThreadLocalGetValue(PetscThreadKey key) 454 { 455 return key; 456 } 457 458 PETSC_STATIC_INLINE void PetscThreadLocalSetValue(PetscThreadKey *key,void* value) 459 { 460 *key = value; 461 } 462 463 PETSC_STATIC_INLINE void PetscThreadLocalRegister(PETSC_UNUSED PetscThreadKey *key) 464 { 465 } 466 467 PETSC_STATIC_INLINE void PetscThreadLocalDestroy(PETSC_UNUSED PetscThreadKey key) 468 { 469 } 470 #endif 471 472 /* 473 Allows the code to build a stack frame as it runs 474 */ 475 #if defined(PETSC_USE_DEBUG) 476 477 #define PETSCSTACKSIZE 64 478 479 typedef struct { 480 const char *function[PETSCSTACKSIZE]; 481 const char *file[PETSCSTACKSIZE]; 482 const char *directory[PETSCSTACKSIZE]; 483 int line[PETSCSTACKSIZE]; 484 PetscBool petscroutine[PETSCSTACKSIZE]; 485 int currentsize; 486 } PetscStack; 487 488 #if defined(PETSC_HAVE_PTHREADCLASSES) 489 #if defined(PETSC_PTHREAD_LOCAL) 490 PETSC_EXTERN PETSC_PTHREAD_LOCAL PetscStack *petscstack; 491 #else 492 PETSC_EXTERN PetscThreadKey petscstack; 493 #endif 494 #elif defined(PETSC_HAVE_OPENMP) 495 PETSC_EXTERN PetscStack *petscstack; 496 #pragma omp threadprivate(petscstack) 497 #else 498 PETSC_EXTERN PetscStack *petscstack; 499 #endif 500 501 PETSC_EXTERN PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); 502 PETSC_EXTERN PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp); 503 504 PETSC_STATIC_INLINE PetscBool PetscStackActive(void) 505 { 506 return(PetscThreadLocalGetValue(petscstack) ? PETSC_TRUE : PETSC_FALSE); 507 } 508 509 /* Stack handling is based on the following two "NoCheck" macros. These should only be called directly by other error 510 * handling macros. We record the line of the call, which may or may not be the location of the definition. But is at 511 * least more useful than "unknown" because it can distinguish multiple calls from the same function. 512 */ 513 514 #define PetscStackPushNoCheck(funct,petsc_routine) \ 515 do { \ 516 PetscStack* petscstackp; \ 517 PetscStackAMSTakeAccess(); \ 518 petscstackp = (PetscStack*)PetscThreadLocalGetValue(petscstack); \ 519 if (petscstackp && (petscstackp->currentsize < PETSCSTACKSIZE)) { \ 520 petscstackp->function[petscstackp->currentsize] = funct; \ 521 petscstackp->file[petscstackp->currentsize] = __FILE__; \ 522 petscstackp->directory[petscstackp->currentsize] = __SDIR__; \ 523 petscstackp->line[petscstackp->currentsize] = __LINE__; \ 524 petscstackp->petscroutine[petscstackp->currentsize] = petsc_routine; \ 525 petscstackp->currentsize++; \ 526 } \ 527 PetscStackAMSGrantAccess(); \ 528 } while (0) 529 530 #define PetscStackPopNoCheck \ 531 do {PetscStack* petscstackp; \ 532 PetscStackAMSTakeAccess(); \ 533 petscstackp = (PetscStack*)PetscThreadLocalGetValue(petscstack); \ 534 if (petscstackp && petscstackp->currentsize > 0) { \ 535 petscstackp->currentsize--; \ 536 petscstackp->function[petscstackp->currentsize] = 0; \ 537 petscstackp->file[petscstackp->currentsize] = 0; \ 538 petscstackp->directory[petscstackp->currentsize] = 0; \ 539 petscstackp->line[petscstackp->currentsize] = 0; \ 540 petscstackp->petscroutine[petscstackp->currentsize] = PETSC_FALSE;\ 541 } \ 542 PetscStackAMSGrantAccess(); \ 543 } while (0) 544 545 /*MC 546 PetscFunctionBegin - First executable line of each PETSc function 547 used for error handling. 548 549 Synopsis: 550 #include "petscsys.h" 551 void PetscFunctionBegin; 552 553 Not Collective 554 555 Usage: 556 .vb 557 int something; 558 559 PetscFunctionBegin; 560 .ve 561 562 Notes: 563 Not available in Fortran 564 565 Level: developer 566 567 .seealso: PetscFunctionReturn() 568 569 .keywords: traceback, error handling 570 M*/ 571 #define PetscFunctionBegin do { \ 572 PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE); \ 573 PetscCheck__FUNCT__(); \ 574 PetscRegister__FUNCT__(); \ 575 } while (0) 576 577 /*MC 578 PetscFunctionBeginUser - First executable line of user provided PETSc routine 579 580 Synopsis: 581 #include "petscsys.h" 582 void PetscFunctionBeginUser; 583 584 Not Collective 585 586 Usage: 587 .vb 588 int something; 589 590 PetscFunctionBegin; 591 .ve 592 593 Notes: 594 Not available in Fortran 595 596 Level: developer 597 598 .seealso: PetscFunctionReturn() 599 600 .keywords: traceback, error handling 601 M*/ 602 #define PetscFunctionBeginUser \ 603 do { \ 604 PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE); \ 605 PetscCheck__FUNCT__(); \ 606 PetscRegister__FUNCT__(); \ 607 } while (0) 608 609 610 #if defined(PETSC_SERIALIZE_FUNCTIONS) 611 #include <petsc-private/petscfptimpl.h> 612 /* 613 Registers the current function into the global function pointer to function name table 614 615 Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc 616 */ 617 #define PetscRegister__FUNCT__() do { \ 618 static PetscBool __chked = PETSC_FALSE; \ 619 if (!__chked) {\ 620 void *ptr; PetscDLSym(NULL,__FUNCT__,&ptr);\ 621 __chked = PETSC_TRUE;\ 622 }} while (0) 623 #else 624 #define PetscRegister__FUNCT__() 625 #endif 626 627 #define PetscCheck__FUNCT__() do { PetscBool _sc1,_sc2; \ 628 PetscStrcmpNoError(PETSC_FUNCTION_NAME,__FUNCT__,&_sc1);\ 629 PetscStrcmpNoError(__FUNCT__,"User provided function",&_sc2);\ 630 if (!_sc1 && !_sc2) { \ 631 printf("%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \ 632 } \ 633 } while (0) 634 635 #define PetscStackPush(n) \ 636 do { \ 637 PetscStackPushNoCheck(n,PETSC_FALSE); \ 638 CHKMEMQ; \ 639 } while (0) 640 641 #define PetscStackPop \ 642 do { \ 643 CHKMEMQ; \ 644 PetscStackPopNoCheck; \ 645 } while (0) 646 647 /*MC 648 PetscFunctionReturn - Last executable line of each PETSc function 649 used for error handling. Replaces return() 650 651 Synopsis: 652 #include "petscsys.h" 653 void PetscFunctionReturn(0); 654 655 Not Collective 656 657 Usage: 658 .vb 659 .... 660 PetscFunctionReturn(0); 661 } 662 .ve 663 664 Notes: 665 Not available in Fortran 666 667 Level: developer 668 669 .seealso: PetscFunctionBegin() 670 671 .keywords: traceback, error handling 672 M*/ 673 #define PetscFunctionReturn(a) \ 674 do { \ 675 PetscStackPopNoCheck; \ 676 return(a);} while (0) 677 678 #define PetscFunctionReturnVoid() \ 679 do { \ 680 PetscStackPopNoCheck; \ 681 return;} while (0) 682 683 #else 684 685 #if defined(PETSC_HAVE_PTHREADCLASSES) 686 #if defined(PETSC_PTHREAD_LOCAL) 687 PETSC_EXTERN PETSC_PTHREAD_LOCAL void *petscstack; 688 #else 689 PETSC_EXTERN PetscThreadKey petscstack; 690 #endif 691 #elif defined(PETSC_HAVE_OPENMP) 692 PETSC_EXTERN void *petscstack; 693 #pragma omp threadprivate(petscstack) 694 #else 695 PETSC_EXTERN void *petscstack; 696 #endif 697 698 #define PetscStackPushNoCheck(funct,petsc_routine) do {} while (0) 699 #define PetscStackPopNoCheck do {} while (0) 700 #define PetscFunctionBegin 701 #define PetscFunctionBeginUser 702 #define PetscFunctionReturn(a) return(a) 703 #define PetscFunctionReturnVoid() return 704 #define PetscStackPop CHKMEMQ 705 #define PetscStackPush(f) CHKMEMQ 706 #define PetscStackActive PETSC_FALSE 707 708 #endif 709 710 /* 711 PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack. 712 713 Input Parameters: 714 + name - string that gives the name of the function being called 715 - routine - actual call to the routine, including ierr = and CHKERRQ(ierr); 716 717 Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes 718 719 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. 720 721 722 723 */ 724 #define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while(0) 725 726 /* 727 PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack. 728 729 Input Parameters: 730 + func- name of the routine 731 - args - arguments to the routine surrounded by () 732 733 Notes: This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not. 734 735 Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc. 736 737 */ 738 #define PetscStackCallStandard(func,args) do { \ 739 PetscStackPush(#func);ierr = func args;PetscStackPop; if (ierr) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s()",#func); \ 740 } while (0) 741 742 PETSC_EXTERN PetscErrorCode PetscStackCreate(void); 743 PETSC_EXTERN PetscErrorCode PetscStackView(FILE*); 744 PETSC_EXTERN PetscErrorCode PetscStackDestroy(void); 745 746 #endif 747