1 /* 2 Contains all error handling code 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. 15 */ 16 #if !defined(__SDIR__) 17 #define __SDIR__ "unknowndirectory/" 18 #endif 19 20 /* 21 Defines the function where the compiled source is located; used 22 in printing error messages. 23 */ 24 #if !defined(__FUNCT__) 25 #define __FUNCT__ "User provided function" 26 #endif 27 28 /* 29 These are the generic error codes. These error codes are used 30 many different places in the PETSc source code. The string versions are 31 at src/sys/src/error/err.c any changes here must also be made there 32 33 */ 34 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 35 #define PETSC_ERR_MEM_MALLOC_0 85 /* cannot malloc zero size */ 36 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 37 #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 38 #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 39 #define PETSC_ERR_SIG 59 /* signal received */ 40 #define PETSC_ERR_FP 72 /* floating point exception */ 41 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 42 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 43 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 44 #define PETSC_ERR_MEMC 78 /* memory corruption */ 45 #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 46 #define PETSC_ERR_USER 83 /* user has not provided needed function */ 47 48 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 49 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 50 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 51 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 52 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 53 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 54 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 55 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 56 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 57 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 58 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 59 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 60 #define PETSC_ERR_ARG_DOMAIN 87 /* argument is not in domain of function */ 61 62 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 63 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 64 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 65 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 66 67 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 68 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 69 70 #if defined(PETSC_USE_ERRORCHECKING) 71 72 /*MC 73 SETERRQ - Macro that is called when an error has been detected, 74 75 Not Collective 76 77 Synopsis: 78 void SETERRQ(PetscErrorCode errorcode,char *message) 79 80 81 Input Parameters: 82 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 83 - message - error message 84 85 Level: beginner 86 87 Notes: 88 Once the error handler is called the calling function is then returned from with the given error code. 89 90 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 91 92 93 Experienced users can set the error handler with PetscPushErrorHandler(). 94 95 Concepts: error^setting condition 96 97 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 98 M*/ 99 #define SETERRQ(n,s) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);} 100 101 /*MC 102 SETERRQ1 - Macro that is called when an error has been detected, 103 104 Not Collective 105 106 Synopsis: 107 void SETERRQ1(PetscErrorCode errorcode,char *formatmessage,arg) 108 109 110 Input Parameters: 111 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 112 . message - error message in the printf format 113 - arg - argument (for example an integer, string or double) 114 115 Level: beginner 116 117 Notes: 118 Once the error handler is called the calling function is then returned from with the given error code. 119 120 Experienced users can set the error handler with PetscPushErrorHandler(). 121 122 Concepts: error^setting condition 123 124 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 125 M*/ 126 #define SETERRQ1(n,s,a1) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1);} 127 128 /*MC 129 SETERRQ2 - Macro that is called when an error has been detected, 130 131 Not Collective 132 133 Synopsis: 134 void SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 135 136 137 Input Parameters: 138 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 139 . message - error message in the printf format 140 . arg1 - argument (for example an integer, string or double) 141 - arg2 - argument (for example an integer, string or double) 142 143 Level: beginner 144 145 Notes: 146 Once the error handler is called the calling function is then returned from with the given error code. 147 148 Experienced users can set the error handler with PetscPushErrorHandler(). 149 150 Concepts: error^setting condition 151 152 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 153 M*/ 154 #define SETERRQ2(n,s,a1,a2) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2);} 155 156 /*MC 157 SETERRQ3 - Macro that is called when an error has been detected, 158 159 Not Collective 160 161 Synopsis: 162 void SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 163 164 165 Input Parameters: 166 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 167 . message - error message in the printf format 168 . arg1 - argument (for example an integer, string or double) 169 . arg2 - argument (for example an integer, string or double) 170 - arg3 - argument (for example an integer, string or double) 171 172 Level: beginner 173 174 Notes: 175 Once the error handler is called the calling function is then returned from with the given error code. 176 177 Experienced users can set the error handler with PetscPushErrorHandler(). 178 179 Concepts: error^setting condition 180 181 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 182 M*/ 183 #define SETERRQ3(n,s,a1,a2,a3) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3);} 184 185 #define SETERRQ4(n,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4);} 186 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5);} 187 #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);} 188 #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);} 189 #define SETERRABORT(comm,n,s) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);MPI_Abort(comm,n);} 190 191 /*MC 192 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 193 194 Not Collective 195 196 Synopsis: 197 void CHKERRQ(PetscErrorCode errorcode) 198 199 200 Input Parameters: 201 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 202 203 Level: beginner 204 205 Notes: 206 Once the error handler is called the calling function is then returned from with the given error code. 207 208 Experienced users can set the error handler with PetscPushErrorHandler(). 209 210 CHKERRQ(n) is fundamentally a macro replacement for 211 if (n) return(PetscError(...,n,...)); 212 213 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 214 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 215 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 216 a more appropriate construct for using PETSc Error Handling would be 217 if (n) {PetscError(....); return(YourReturnType);} 218 219 Concepts: error^setting condition 220 221 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 222 M*/ 223 #define CHKERRQ(n) if (n) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 224 225 #define CHKERRABORT(comm,n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");MPI_Abort(comm,n);} 226 #define CHKERRCONTINUE(n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 227 228 /*MC 229 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 230 231 Not Collective 232 233 Synopsis: 234 CHKMEMQ; 235 236 Level: beginner 237 238 Notes: 239 Must run with the option -malloc_debug to enable this option 240 241 Once the error handler is called the calling function is then returned from with the given error code. 242 243 By defaults prints location where memory that is corrupted was allocated. 244 245 Concepts: memory corruption 246 247 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 248 PetscMallocValidate() 249 M*/ 250 #define CHKMEMQ {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,__FUNCT__,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} 251 252 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 253 extern PetscErrorCode __gierr; 254 #define _ __gierr = 255 #define ___ CHKERRQ(__gierr); 256 #endif 257 258 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscExceptionPush(PetscErrorCode); 259 EXTERN void PETSC_DLLEXPORT PetscExceptionPop(); 260 261 /*MC 262 PetscExceptionTry1 - Runs the routine, causing a particular error code to be treated as an exception, 263 rather than an error. That is if that error code is treated the program returns to this level, 264 but does not call the error handlers 265 266 Not Collective 267 268 Synopsis: 269 PetscExceptionTry1(PetscErrorCode routine(....),PetscErrorCode); 270 271 Level: advanced 272 273 Notes: 274 PETSc must not be configured using the option --with-errorchecking=0 for this to work 275 276 277 Concepts: exceptions, exception hanlding 278 279 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 280 CHKERRQ() 281 M*/ 282 extern PetscErrorCode PetscExceptionTmp; 283 #define PetscExceptionTry1(a,b) (PetscExceptionTmp = PetscExceptionPush(b)) ? PetscExceptionTmp : (PetscExceptionTmp = a , PetscExceptionPop(),PetscExceptionTmp) 284 285 #else 286 #define SETERRQ(n,s) ; 287 #define SETERRQ1(n,s,a1) ; 288 #define SETERRQ2(n,s,a1,a2) ; 289 #define SETERRQ3(n,s,a1,a2,a3) ; 290 #define SETERRQ4(n,s,a1,a2,a3,a4) ; 291 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) ; 292 #define SETERRQ6(n,s,a1,a2,a3,a4,a5,a6) ; 293 #define SETERRABORT(comm,n,s) ; 294 295 #define CHKERRQ(n) ; 296 #define CHKERRABORT(comm,n) ; 297 #define CHKERRCONTINUE(n) ; 298 299 #define CHKMEMQ ; 300 301 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 302 #define _ 303 #define ___ 304 #endif 305 306 #define PetscExceptionTry1(a,b) a 307 #endif 308 309 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorPrintfInitialize(void); 310 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscErrorMessage(int,const char*[],char **); 311 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTraceBackErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 312 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIgnoreErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 313 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEmacsClientErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 314 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStopErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 315 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAbortErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 316 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAttachDebuggerErrorHandler(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*); 317 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscError(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,...) PETSC_PRINTF_FORMAT_CHECK(7,8); 318 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushErrorHandler(PetscErrorCode (*handler)(int,const char*,const char*,const char*,PetscErrorCode,int,const char*,void*),void*); 319 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopErrorHandler(void); 320 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDefaultSignalHandler(int,void*); 321 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 322 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopSignalHandler(void); 323 324 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 325 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetFPTrap(PetscFPTrap); 326 327 /* 328 Allows the code to build a stack frame as it runs 329 */ 330 #if defined(PETSC_USE_DEBUG) 331 332 #define PETSCSTACKSIZE 15 333 334 typedef struct { 335 const char *function[PETSCSTACKSIZE]; 336 const char *file[PETSCSTACKSIZE]; 337 const char *directory[PETSCSTACKSIZE]; 338 int line[PETSCSTACKSIZE]; 339 int currentsize; 340 } PetscStack; 341 342 extern PETSC_DLLEXPORT PetscStack *petscstack; 343 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCopy(PetscStack*,PetscStack*); 344 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPrint(PetscStack*,FILE* fp); 345 346 #define PetscStackActive (petscstack != 0) 347 348 349 /*MC 350 PetscFunctionBegin - First executable line of each PETSc function 351 used for error handling. 352 353 Synopsis: 354 void PetscFunctionBegin; 355 356 Usage: 357 .vb 358 int something; 359 360 PetscFunctionBegin; 361 .ve 362 363 Notes: 364 Not available in Fortran 365 366 Level: developer 367 368 .seealso: PetscFunctionReturn() 369 370 .keywords: traceback, error handling 371 M*/ 372 #define PetscFunctionBegin \ 373 {\ 374 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 375 petscstack->function[petscstack->currentsize] = __FUNCT__; \ 376 petscstack->file[petscstack->currentsize] = __FILE__; \ 377 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 378 petscstack->line[petscstack->currentsize] = __LINE__; \ 379 petscstack->currentsize++; \ 380 }} 381 382 #define PetscStackPush(n) \ 383 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 384 petscstack->function[petscstack->currentsize] = n; \ 385 petscstack->file[petscstack->currentsize] = "unknown"; \ 386 petscstack->directory[petscstack->currentsize] = "unknown"; \ 387 petscstack->line[petscstack->currentsize] = 0; \ 388 petscstack->currentsize++; \ 389 }} 390 391 #define PetscStackPop \ 392 {if (petscstack && petscstack->currentsize > 0) { \ 393 petscstack->currentsize--; \ 394 petscstack->function[petscstack->currentsize] = 0; \ 395 petscstack->file[petscstack->currentsize] = 0; \ 396 petscstack->directory[petscstack->currentsize] = 0; \ 397 petscstack->line[petscstack->currentsize] = 0; \ 398 }}; 399 400 /*MC 401 PetscFunctionReturn - Last executable line of each PETSc function 402 used for error handling. Replaces return() 403 404 Synopsis: 405 void PetscFunctionReturn(0); 406 407 Usage: 408 .vb 409 .... 410 PetscFunctionReturn(0); 411 } 412 .ve 413 414 Notes: 415 Not available in Fortran 416 417 Level: developer 418 419 .seealso: PetscFunctionBegin() 420 421 .keywords: traceback, error handling 422 M*/ 423 #define PetscFunctionReturn(a) \ 424 {\ 425 PetscStackPop; \ 426 return(a);} 427 428 #define PetscFunctionReturnVoid() \ 429 {\ 430 PetscStackPop; \ 431 return;} 432 433 434 #else 435 436 #define PetscFunctionBegin 437 #define PetscFunctionReturn(a) return(a) 438 #define PetscFunctionReturnVoid() return 439 #define PetscStackPop 440 #define PetscStackPush(f) 441 #define PetscStackActive 0 442 443 #endif 444 445 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackCreate(void); 446 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackView(PetscViewer); 447 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDestroy(void); 448 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackPublish(void); 449 EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStackDepublish(void); 450 451 452 PETSC_EXTERN_CXX_END 453 #endif 454