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 61 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 62 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 63 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 64 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 65 66 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 67 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 68 69 #if defined(PETSC_USE_DEBUG) 70 71 /*MC 72 SETERRQ - Macro that is called when an error has been detected, 73 74 Not Collective 75 76 Synopsis: 77 void SETERRQ(int errorcode,char *message) 78 79 80 Input Parameters: 81 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 82 - message - error message 83 84 Level: beginner 85 86 Notes: 87 Once the error handler is called the calling function is then returned from with the given error code. 88 89 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 90 91 92 Experienced users can set the error handler with PetscPushErrorHandler(). 93 94 Concepts: error^setting condition 95 96 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 97 M*/ 98 #define SETERRQ(n,s) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);} 99 100 /*MC 101 SETERRQ1 - Macro that is called when an error has been detected, 102 103 Not Collective 104 105 Synopsis: 106 void SETERRQ1(int errorcode,char *formatmessage,arg) 107 108 109 Input Parameters: 110 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 111 . message - error message in the printf format 112 - arg - argument (for example an integer, string or double) 113 114 Level: beginner 115 116 Notes: 117 Once the error handler is called the calling function is then returned from with the given error code. 118 119 Experienced users can set the error handler with PetscPushErrorHandler(). 120 121 Concepts: error^setting condition 122 123 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 124 M*/ 125 #define SETERRQ1(n,s,a1) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1);} 126 127 /*MC 128 SETERRQ2 - Macro that is called when an error has been detected, 129 130 Not Collective 131 132 Synopsis: 133 void SETERRQ2(int errorcode,char *formatmessage,arg1,arg2) 134 135 136 Input Parameters: 137 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 138 . message - error message in the printf format 139 . arg1 - argument (for example an integer, string or double) 140 - arg2 - argument (for example an integer, string or double) 141 142 Level: beginner 143 144 Notes: 145 Once the error handler is called the calling function is then returned from with the given error code. 146 147 Experienced users can set the error handler with PetscPushErrorHandler(). 148 149 Concepts: error^setting condition 150 151 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 152 M*/ 153 #define SETERRQ2(n,s,a1,a2) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2);} 154 155 /*MC 156 SETERRQ3 - Macro that is called when an error has been detected, 157 158 Not Collective 159 160 Synopsis: 161 void SETERRQ3(int errorcode,char *formatmessage,arg1,arg2,arg3) 162 163 164 Input Parameters: 165 + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 166 . message - error message in the printf format 167 . arg1 - argument (for example an integer, string or double) 168 . arg2 - argument (for example an integer, string or double) 169 - arg3 - argument (for example an integer, string or double) 170 171 Level: beginner 172 173 Notes: 174 Once the error handler is called the calling function is then returned from with the given error code. 175 176 Experienced users can set the error handler with PetscPushErrorHandler(). 177 178 Concepts: error^setting condition 179 180 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 181 M*/ 182 #define SETERRQ3(n,s,a1,a2,a3) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3);} 183 184 #define SETERRQ4(n,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4);} 185 #define SETERRQ5(n,s,a1,a2,a3,a4,a5) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s,a1,a2,a3,a4,a5);} 186 #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);} 187 #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);} 188 #define SETERRABORT(comm,n,s) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,1,s);MPI_Abort(comm,n);} 189 190 /*MC 191 CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 192 193 Not Collective 194 195 Synopsis: 196 void CHKERRQ(int errorcode) 197 198 199 Input Parameters: 200 . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 201 202 Level: beginner 203 204 Notes: 205 Once the error handler is called the calling function is then returned from with the given error code. 206 207 Experienced users can set the error handler with PetscPushErrorHandler(). 208 209 Concepts: error^setting condition 210 211 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 212 M*/ 213 #define CHKERRQ(n) if (n) {return PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 214 215 #define CHKERRABORT(comm,n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");MPI_Abort(comm,n);} 216 #define CHKERRCONTINUE(n) if (n) {PetscError(__LINE__,__FUNCT__,__FILE__,__SDIR__,n,0," ");} 217 218 /*MC 219 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 220 221 Not Collective 222 223 Synopsis: 224 CHKMEMQ; 225 226 Level: beginner 227 228 Notes: 229 Must run with the option -trdebug to enable this option 230 231 Once the error handler is called the calling function is then returned from with the given error code. 232 233 By defaults prints location where memory that is corrupted was allocated. 234 235 Concepts: memory corruption 236 237 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2(), 238 PetscTrValid() 239 M*/ 240 #define CHKMEMQ {int _7_ierr = PetscTrValid(__LINE__,__FUNCT__,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} 241 242 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 243 extern PetscErrorCode __gierr; 244 #define _ __gierr = 245 #define ___ CHKERRQ(__gierr); 246 #endif 247 248 #else 249 #define SETERRQ(n,s) ; 250 #define SETERRQ1(n,s,a1) ; 251 #define SETERRQ2(n,s,a1,a2) ; 252 #define SETERRQ3(n,s,a1,a2,a3) ; 253 #define SETERRQ4(n,s,a1,a2,a3,a4) ; 254 #define SETERRABORT(comm,n,s) ; 255 256 #define CHKERRQ(n) ; 257 #define CHKERRABORT(comm,n) ; 258 #define CHKERRCONTINUE(n) ; 259 260 #define CHKMEMQ ; 261 262 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 263 #define _ 264 #define ___ 265 #endif 266 267 #endif 268 269 EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **); 270 EXTERN PetscErrorCode PetscTraceBackErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 271 EXTERN PetscErrorCode PetscIgnoreErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 272 EXTERN PetscErrorCode PetscEmacsClientErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 273 EXTERN PetscErrorCode PetscStopErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 274 EXTERN PetscErrorCode PetscAbortErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 275 EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(int,const char*,const char*,const char*,int,int,const char*,void*); 276 EXTERN PetscErrorCode PetscError(int,const char*,const char*,const char*,int,int,const char*,...) PETSC_PRINTF_FORMAT_CHECK(7,8); 277 EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(int,const char*,const char*,const char*,int,int,const char*,void*),void*); 278 EXTERN PetscErrorCode PetscPopErrorHandler(void); 279 EXTERN PetscErrorCode PetscDefaultSignalHandler(int,void*); 280 EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 281 EXTERN PetscErrorCode PetscPopSignalHandler(void); 282 283 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 284 EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap); 285 286 /* 287 Allows the code to build a stack frame as it runs 288 */ 289 #if defined(PETSC_USE_STACK) 290 291 #define PETSCSTACKSIZE 15 292 293 typedef struct { 294 const char *function[PETSCSTACKSIZE]; 295 const char *file[PETSCSTACKSIZE]; 296 const char *directory[PETSCSTACKSIZE]; 297 int line[PETSCSTACKSIZE]; 298 int currentsize; 299 } PetscStack; 300 301 extern PetscStack *petscstack; 302 EXTERN PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); 303 EXTERN PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp); 304 305 #define PetscStackActive (petscstack != 0) 306 307 308 /*MC 309 PetscFunctionBegin - First executable line of each PETSc function 310 used for error handling. 311 312 Synopsis: 313 void PetscFunctionBegin; 314 315 Usage: 316 .vb 317 int something; 318 319 PetscFunctionBegin; 320 .ve 321 322 Notes: 323 Not available in Fortran 324 325 Level: developer 326 327 .seealso: PetscFunctionReturn() 328 329 .keywords: traceback, error handling 330 M*/ 331 #define PetscFunctionBegin \ 332 {\ 333 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 334 petscstack->function[petscstack->currentsize] = __FUNCT__; \ 335 petscstack->file[petscstack->currentsize] = __FILE__; \ 336 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 337 petscstack->line[petscstack->currentsize] = __LINE__; \ 338 petscstack->currentsize++; \ 339 }} 340 341 #define PetscStackPush(n) \ 342 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 343 petscstack->function[petscstack->currentsize] = n; \ 344 petscstack->file[petscstack->currentsize] = "unknown"; \ 345 petscstack->directory[petscstack->currentsize] = "unknown"; \ 346 petscstack->line[petscstack->currentsize] = 0; \ 347 petscstack->currentsize++; \ 348 }} 349 350 #define PetscStackPop \ 351 {if (petscstack && petscstack->currentsize > 0) { \ 352 petscstack->currentsize--; \ 353 petscstack->function[petscstack->currentsize] = 0; \ 354 petscstack->file[petscstack->currentsize] = 0; \ 355 petscstack->directory[petscstack->currentsize] = 0; \ 356 petscstack->line[petscstack->currentsize] = 0; \ 357 }}; 358 359 /*MC 360 PetscFunctionReturn - Last executable line of each PETSc function 361 used for error handling. Replaces return() 362 363 Synopsis: 364 void PetscFunctionReturn(0); 365 366 Usage: 367 .vb 368 .... 369 PetscFunctionReturn(0); 370 } 371 .ve 372 373 Notes: 374 Not available in Fortran 375 376 Level: developer 377 378 .seealso: PetscFunctionBegin() 379 380 .keywords: traceback, error handling 381 M*/ 382 #define PetscFunctionReturn(a) \ 383 {\ 384 PetscStackPop; \ 385 return(a);} 386 387 #define PetscFunctionReturnVoid() \ 388 {\ 389 PetscStackPop; \ 390 return;} 391 392 393 #else 394 395 #define PetscFunctionBegin 396 #define PetscFunctionReturn(a) return(a) 397 #define PetscFunctionReturnVoid() return() 398 #define PetscStackPop 399 #define PetscStackPush(f) 400 #define PetscStackActive 0 401 402 #endif 403 404 EXTERN PetscErrorCode PetscStackCreate(void); 405 EXTERN PetscErrorCode PetscStackView(PetscViewer); 406 EXTERN PetscErrorCode PetscStackDestroy(void); 407 EXTERN PetscErrorCode PetscStackPublish(void); 408 EXTERN PetscErrorCode PetscStackDepublish(void); 409 410 411 PETSC_EXTERN_CXX_END 412 #endif 413