/* Contains all error handling interfaces for PETSc. */ #if !defined(__PETSCERROR_H) #define __PETSCERROR_H #if defined(PETSC_HAVE_STRING_H) #include /* for strcmp */ #endif PETSC_EXTERN_CXX_BEGIN /* Defines the directory where the compiled source is located; used in printing error messages. Each makefile has an entry LOCDIR = thedirectory and bmake/common_variables includes in CCPPFLAGS -D__SDIR__=${LOCDIR} which is a flag passed to the C/C++ compilers. This declaration below is only needed if some code is compiled without the -D__SDIR__ */ #if !defined(__INSDIR__) #define __INSDIR__ "unknowndirectory/" #endif /* Defines the function where the compiled source is located; used in printing error messages. This is defined here in case the user does not declare it. */ #if !defined(__FUNCT__) #define __FUNCT__ "User provided function" #endif /* These are the generic error codes. These error codes are used many different places in the PETSc source code. The string versions are at src/sys/error/err.c any changes here must also be made there These are also define in include/finclude/petscerror.h any CHANGES here must be also made there. */ #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ #define PETSC_ERR_SUP 56 /* no support for requested operation */ #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ #define PETSC_ERR_SIG 59 /* signal received */ #define PETSC_ERR_FP 72 /* floating point exception */ #define PETSC_ERR_COR 74 /* corrupted PETSc object */ #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ #define PETSC_ERR_MEMC 78 /* memory corruption */ #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ #define PETSC_ERR_USER 83 /* user has not provided needed function */ #define PETSC_ERR_SYS 88 /* error in system call */ #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ #define PETSC_ERR_INT_OVERFLOW 84 /* should always be one less then the smallest value */ #define PETSC_ERR_FLOP_COUNT 90 #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ #define PETSC_ERR_MAX_VALUE 92 /* this is always the one more than the largest error code */ #define PetscStringizeArg(a) #a #define PetscStringize(a) PetscStringizeArg(a) #define __SDIR__ PetscStringize(__INSDIR__) #if defined(PETSC_USE_ERRORCHECKING) /*MC SETERRQ - Macro that is called when an error has been detected, Synopsis: PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message) Not Collective Input Parameters: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h - message - error message Level: beginner Notes: Once the error handler is called the calling function is then returned from with the given error code. See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments In Fortran MPI_Abort() is always called Experienced users can set the error handler with PetscPushErrorHandler(). Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() M*/ #define SETERRQ(comm,n,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s) /*MC SETERRQ1 - Macro that is called when an error has been detected, Synopsis: PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg) Not Collective Input Parameters: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h . message - error message in the printf format - arg - argument (for example an integer, string or double) Level: beginner Notes: Once the error handler is called the calling function is then returned from with the given error code. Experienced users can set the error handler with PetscPushErrorHandler(). Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() M*/ #define SETERRQ1(comm,n,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1) /*MC SETERRQ2 - Macro that is called when an error has been detected, Synopsis: PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) Not Collective Input Parameters: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h . message - error message in the printf format . arg1 - argument (for example an integer, string or double) - arg2 - argument (for example an integer, string or double) Level: beginner Notes: Once the error handler is called the calling function is then returned from with the given error code. Experienced users can set the error handler with PetscPushErrorHandler(). Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() M*/ #define SETERRQ2(comm,n,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2) /*MC SETERRQ3 - Macro that is called when an error has been detected, Synopsis: PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) Not Collective Input Parameters: + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h . message - error message in the printf format . arg1 - argument (for example an integer, string or double) . arg2 - argument (for example an integer, string or double) - arg3 - argument (for example an integer, string or double) Level: beginner Notes: Once the error handler is called the calling function is then returned from with the given error code. There are also versions for 4, 5, 6 and 7 arguments. Experienced users can set the error handler with PetscPushErrorHandler(). Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() M*/ #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) #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) #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) #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) #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) #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) /*MC CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns Synopsis: PetscErrorCode CHKERRQ(PetscErrorCode errorcode) Not Collective Input Parameters: . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h Level: beginner Notes: Once the error handler is called the calling function is then returned from with the given error code. Experienced users can set the error handler with PetscPushErrorHandler(). CHKERRQ(n) is fundamentally a macro replacement for if (n) return(PetscError(...,n,...)); Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, it cannot be used in functions which return(void) or any other datatype. In these types of functions, you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or if (n) {PetscError(....); return(YourReturnType);} where you may pass back a PETSC_NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. In Fortran MPI_Abort() is always called Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() M*/ #define CHKERRQ(n) do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");} while (0) #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) #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) #define CHKERRCONTINUE(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");}} while (0) #ifdef PETSC_CLANGUAGE_CXX /*MC CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception Synopsis: void CHKERRXX(PetscErrorCode errorcode) Not Collective Input Parameters: . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h Level: beginner Notes: Once the error handler throws a ??? exception. You can use CHKERRV() which returns without an error code (bad idea since the error is ignored) or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. Concepts: error^setting condition .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ M*/ #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) #endif /*MC CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected Synopsis: CHKMEMQ; Not Collective Level: beginner Notes: Must run with the option -malloc_debug to enable this option Once the error handler is called the calling function is then returned from with the given error code. By defaults prints location where memory that is corrupted was allocated. Use CHKMEMA for functions that return void Concepts: memory corruption .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), PetscMallocValidate() M*/ #define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} while(0) #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) #if defined(PETSC_UNDERSCORE_CHKERR) extern PetscErrorCode __gierr; #define _ __gierr = #define ___ CHKERRQ(__gierr); #endif #else /* PETSC_USE_ERRORCHECKING */ /* These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0 */ #define SETERRQ(c,n,s) #define SETERRQ1(c,n,s,a1) #define SETERRQ2(c,n,s,a1,a2) #define SETERRQ3(c,n,s,a1,a2,a3) #define SETERRQ4(c,n,s,a1,a2,a3,a4) #define SETERRQ5(c,n,s,a1,a2,a3,a4,a5) #define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6) #define SETERRABORT(comm,n,s) #define CHKERRQ(n) ; #define CHKERRABORT(comm,n) ; #define CHKERRCONTINUE(n) ; #define CHKMEMQ ; #ifdef PETSC_CLANGUAGE_CXX #define CHKERRXX(n) ; #endif #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) #define _ #define ___ #endif #endif /* PETSC_USE_ERRORCHECKING */ /*E PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers Level: advanced PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated Developer Notes: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandling() .seealso: PetscError(), SETERRXX() E*/ typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType; extern PetscErrorCode PetscErrorPrintfInitialize(void); extern PetscErrorCode PetscErrorMessage(int,const char*[],char **); extern PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_EXTERN_CXX) #include extern PetscErrorCode PetscTraceBackErrorHandlerCxx(MPI_Comm,int,const char *,const char *,const char *,PetscErrorCode,PetscErrorType,const char*,void*); #endif extern PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); extern PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...); extern PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*); extern PetscErrorCode PetscPopErrorHandler(void); extern PetscErrorCode PetscDefaultSignalHandler(int,void*); extern PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); extern PetscErrorCode PetscPopSignalHandler(void); typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; extern PetscErrorCode PetscSetFPTrap(PetscFPTrap); /* Allows the code to build a stack frame as it runs */ #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD) #define PETSCSTACKSIZE 64 typedef struct { const char *function[PETSCSTACKSIZE]; const char *file[PETSCSTACKSIZE]; const char *directory[PETSCSTACKSIZE]; int line[PETSCSTACKSIZE]; int currentsize; } PetscStack; extern PetscStack *petscstack; extern PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); extern PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp); #define PetscStackActive (petscstack != 0) /*MC PetscFunctionBegin - First executable line of each PETSc function used for error handling. Synopsis: void PetscFunctionBegin; Not Collective Usage: .vb int something; PetscFunctionBegin; .ve Notes: Not available in Fortran Level: developer .seealso: PetscFunctionReturn() .keywords: traceback, error handling M*/ #define PetscFunctionBegin \ do { \ if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ petscstack->function[petscstack->currentsize] = PETSC_FUNCTION_NAME; \ petscstack->file[petscstack->currentsize] = __FILE__; \ petscstack->directory[petscstack->currentsize] = __SDIR__; \ petscstack->line[petscstack->currentsize] = __LINE__; \ petscstack->currentsize++; \ } \ PetscCheck__FUNCT__(); \ } while (0) #define PetscCheck__FUNCT__() do { \ if (strcmp(PETSC_FUNCTION_NAME,__FUNCT__) && strcmp(__FUNCT__,"User provided function")) { \ (*PetscErrorPrintf)("%s%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__SDIR__,__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \ } \ } while (0) #define PetscStackPush(n) \ do {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ petscstack->function[petscstack->currentsize] = n; \ petscstack->file[petscstack->currentsize] = "unknown"; \ petscstack->directory[petscstack->currentsize] = "unknown"; \ petscstack->line[petscstack->currentsize] = 0; \ petscstack->currentsize++; \ } CHKMEMQ;} while (0) #define PetscStackPop \ do {CHKMEMQ; if (petscstack && petscstack->currentsize > 0) { \ petscstack->currentsize--; \ petscstack->function[petscstack->currentsize] = 0; \ petscstack->file[petscstack->currentsize] = 0; \ petscstack->directory[petscstack->currentsize] = 0; \ petscstack->line[petscstack->currentsize] = 0; \ }} while (0) /*MC PetscFunctionReturn - Last executable line of each PETSc function used for error handling. Replaces return() Synopsis: void PetscFunctionReturn(0); Not Collective Usage: .vb .... PetscFunctionReturn(0); } .ve Notes: Not available in Fortran Level: developer .seealso: PetscFunctionBegin() .keywords: traceback, error handling M*/ #define PetscFunctionReturn(a) \ do {\ if (petscstack && petscstack->currentsize > 0) { \ petscstack->currentsize--; \ petscstack->function[petscstack->currentsize] = 0; \ petscstack->file[petscstack->currentsize] = 0; \ petscstack->directory[petscstack->currentsize] = 0; \ petscstack->line[petscstack->currentsize] = 0; \ }\ return(a);} while (0) #define PetscFunctionReturnVoid() \ do {\ if (petscstack && petscstack->currentsize > 0) { \ petscstack->currentsize--; \ petscstack->function[petscstack->currentsize] = 0; \ petscstack->file[petscstack->currentsize] = 0; \ petscstack->directory[petscstack->currentsize] = 0; \ petscstack->line[petscstack->currentsize] = 0; \ }\ return;} while (0) #else #define PetscFunctionBegin #define PetscFunctionReturn(a) return(a) #define PetscFunctionReturnVoid() return #define PetscStackPop CHKMEMQ #define PetscStackPush(f) CHKMEMQ #define PetscStackActive 0 #endif /* PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack. Input Parameters: + name - string that gives the name of the function being called - routine - actual call to the routine 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. */ #define PetscStackCall(name,routine) PetscStackPush(name);routine;PetscStackPop; extern PetscErrorCode PetscStackCreate(void); extern PetscErrorCode PetscStackView(PetscViewer); extern PetscErrorCode PetscStackDestroy(void); extern PetscErrorCode PetscStackPublish(void); extern PetscErrorCode PetscStackDepublish(void); PETSC_EXTERN_CXX_END #endif