154a8ef01SBarry Smith /* 2f621e05eSBarry Smith Contains all error handling interfaces for PETSc. 354a8ef01SBarry Smith */ 445d48df9SBarry Smith #if !defined(__PETSCERROR_H) 545d48df9SBarry Smith #define __PETSCERROR_H 66c7e564aSBarry Smith 7fcfd50ebSBarry Smith #if defined(PETSC_HAVE_STRING_H) 8fcfd50ebSBarry Smith #include <string.h> /* for strcmp */ 9fcfd50ebSBarry Smith #endif 10fcfd50ebSBarry Smith 11e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 12c22c1629SBarry Smith 1354a8ef01SBarry Smith /* 1454a8ef01SBarry Smith Defines the directory where the compiled source is located; used 155e97870eSBarry Smith in printing error messages. Each makefile has an entry 165e97870eSBarry Smith LOCDIR = thedirectory 17330cf3c9SBarry Smith and bmake/common_variables includes in CCPPFLAGS -D__SDIR__=${LOCDIR} 18f621e05eSBarry Smith which is a flag passed to the C/C++ compilers. This declaration below 19f621e05eSBarry Smith is only needed if some code is compiled without the -D__SDIR__ 2054a8ef01SBarry Smith */ 21330cf3c9SBarry Smith #if !defined(__INSDIR__) 22330cf3c9SBarry Smith #define __INSDIR__ "unknowndirectory/" 2354a8ef01SBarry Smith #endif 2454a8ef01SBarry Smith 2554a8ef01SBarry Smith /* 264f227f7cSBarry Smith Defines the function where the compiled source is located; used 27f621e05eSBarry Smith in printing error messages. This is defined here in case the user 28f621e05eSBarry Smith does not declare it. 294f227f7cSBarry Smith */ 304a2ae208SSatish Balay #if !defined(__FUNCT__) 31da9b6338SBarry Smith #define __FUNCT__ "User provided function" 324f227f7cSBarry Smith #endif 334f227f7cSBarry Smith 344f227f7cSBarry Smith /* 35329ffe3dSLois Curfman McInnes These are the generic error codes. These error codes are used 36e2d1d2b7SBarry Smith many different places in the PETSc source code. The string versions are 370e5e90baSSatish Balay at src/sys/error/err.c any changes here must also be made there 380f9cf654SBarry Smith These are also define in include/finclude/petscerror.h any CHANGES here 390f9cf654SBarry Smith must be also made there. 4045d48df9SBarry Smith 4154a8ef01SBarry Smith */ 422a6744ebSBarry Smith #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 432a6744ebSBarry Smith 4445d48df9SBarry Smith #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 4547794344SBarry Smith #define PETSC_ERR_SUP 56 /* no support for requested operation */ 46e2d1d2b7SBarry Smith #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 47e2d1d2b7SBarry Smith #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 4845d48df9SBarry Smith #define PETSC_ERR_SIG 59 /* signal received */ 49f1caa5a4SBarry Smith #define PETSC_ERR_FP 72 /* floating point exception */ 50a8c6a408SBarry Smith #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 51a8c6a408SBarry Smith #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 52329ffe3dSLois Curfman McInnes #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 53329ffe3dSLois Curfman McInnes #define PETSC_ERR_MEMC 78 /* memory corruption */ 54b3cc6726SBarry Smith #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 551302d50aSBarry Smith #define PETSC_ERR_USER 83 /* user has not provided needed function */ 564e2ffeddSBarry Smith #define PETSC_ERR_SYS 88 /* error in system call */ 5745d48df9SBarry Smith 5845d48df9SBarry Smith #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 5945d48df9SBarry Smith #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 60a8c6a408SBarry Smith #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 6145d48df9SBarry Smith #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 6245d48df9SBarry Smith #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 634f227f7cSBarry Smith #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 644f227f7cSBarry Smith #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 656831982aSBarry Smith #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 66d252947aSBarry Smith #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 678cda6cd7SBarry Smith #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 68a8c6a408SBarry Smith #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 694482741eSBarry Smith #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 70958c9bccSBarry Smith #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 714f227f7cSBarry Smith 724f227f7cSBarry Smith #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 734f227f7cSBarry Smith #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 744f227f7cSBarry Smith #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 75a8c6a408SBarry Smith #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 7645d48df9SBarry Smith 77329ffe3dSLois Curfman McInnes #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 789e3b2f23SBarry Smith #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 7954a8ef01SBarry Smith 803855c12bSBarry Smith #define PETSC_ERR_INT_OVERFLOW 84 /* should always be one less then the smallest value */ 813855c12bSBarry Smith 82bf3909cdSBarry Smith #define PETSC_ERR_FLOP_COUNT 90 83e113a28aSBarry Smith #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 84e113a28aSBarry Smith #define PETSC_ERR_MAX_VALUE 92 /* this is always the one more than the largest error code */ 852a6744ebSBarry Smith 8659aaf355SLisandro Dalcin #define PetscStringizeArg(a) #a 8759aaf355SLisandro Dalcin #define PetscStringize(a) PetscStringizeArg(a) 88330cf3c9SBarry Smith #define __SDIR__ PetscStringize(__INSDIR__) 89330cf3c9SBarry Smith 90e8b7e333SSatish Balay #if defined(PETSC_USE_ERRORCHECKING) 91e8b7e333SSatish Balay 9230de9b25SBarry Smith /*MC 9330de9b25SBarry Smith SETERRQ - Macro that is called when an error has been detected, 9430de9b25SBarry Smith 9530de9b25SBarry Smith Synopsis: 96e7e72b3dSBarry Smith PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode errorcode,char *message) 9730de9b25SBarry Smith 98eca87e8dSBarry Smith Not Collective 9930de9b25SBarry Smith 10030de9b25SBarry Smith Input Parameters: 10130de9b25SBarry Smith + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 10230de9b25SBarry Smith - message - error message 10330de9b25SBarry Smith 10430de9b25SBarry Smith Level: beginner 10530de9b25SBarry Smith 10630de9b25SBarry Smith Notes: 10730de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 10830de9b25SBarry Smith 10930de9b25SBarry Smith See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 11030de9b25SBarry Smith 11158ebbce7SBarry Smith In Fortran MPI_Abort() is always called 11230de9b25SBarry Smith 11330de9b25SBarry Smith Experienced users can set the error handler with PetscPushErrorHandler(). 11430de9b25SBarry Smith 11530de9b25SBarry Smith Concepts: error^setting condition 11630de9b25SBarry Smith 11791d3bdf4SKris Buschelman .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 11830de9b25SBarry Smith M*/ 11953c77d0aSJed Brown #define SETERRQ(comm,n,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s) 12030de9b25SBarry Smith 12130de9b25SBarry Smith /*MC 12230de9b25SBarry Smith SETERRQ1 - Macro that is called when an error has been detected, 12330de9b25SBarry Smith 12430de9b25SBarry Smith Synopsis: 125e32f2f54SBarry Smith PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode errorcode,char *formatmessage,arg) 12630de9b25SBarry Smith 127eca87e8dSBarry Smith Not Collective 12830de9b25SBarry Smith 12930de9b25SBarry Smith Input Parameters: 13030de9b25SBarry Smith + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 13130de9b25SBarry Smith . message - error message in the printf format 13230de9b25SBarry Smith - arg - argument (for example an integer, string or double) 13330de9b25SBarry Smith 13430de9b25SBarry Smith Level: beginner 13530de9b25SBarry Smith 13630de9b25SBarry Smith Notes: 13730de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 13830de9b25SBarry Smith 13930de9b25SBarry Smith Experienced users can set the error handler with PetscPushErrorHandler(). 14030de9b25SBarry Smith 14130de9b25SBarry Smith Concepts: error^setting condition 14230de9b25SBarry Smith 14391d3bdf4SKris Buschelman .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 14430de9b25SBarry Smith M*/ 14553c77d0aSJed Brown #define SETERRQ1(comm,n,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1) 14630de9b25SBarry Smith 14730de9b25SBarry Smith /*MC 14830de9b25SBarry Smith SETERRQ2 - Macro that is called when an error has been detected, 14930de9b25SBarry Smith 15030de9b25SBarry Smith Synopsis: 151f4442326SMatthew Knepley PetscErrorCode SETERRQ2(PetscErrorCode errorcode,char *formatmessage,arg1,arg2) 15230de9b25SBarry Smith 153eca87e8dSBarry Smith Not Collective 15430de9b25SBarry Smith 15530de9b25SBarry Smith Input Parameters: 15630de9b25SBarry Smith + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 15730de9b25SBarry Smith . message - error message in the printf format 15830de9b25SBarry Smith . arg1 - argument (for example an integer, string or double) 15930de9b25SBarry Smith - arg2 - argument (for example an integer, string or double) 16030de9b25SBarry Smith 16130de9b25SBarry Smith Level: beginner 16230de9b25SBarry Smith 16330de9b25SBarry Smith Notes: 16430de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 16530de9b25SBarry Smith 16630de9b25SBarry Smith Experienced users can set the error handler with PetscPushErrorHandler(). 16730de9b25SBarry Smith 16830de9b25SBarry Smith Concepts: error^setting condition 16930de9b25SBarry Smith 1706024bd2cSBarry Smith .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 17130de9b25SBarry Smith M*/ 17253c77d0aSJed Brown #define SETERRQ2(comm,n,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_INITIAL,s,a1,a2) 17330de9b25SBarry Smith 17430de9b25SBarry Smith /*MC 17530de9b25SBarry Smith SETERRQ3 - Macro that is called when an error has been detected, 17630de9b25SBarry Smith 17730de9b25SBarry Smith Synopsis: 178f4442326SMatthew Knepley PetscErrorCode SETERRQ3(PetscErrorCode errorcode,char *formatmessage,arg1,arg2,arg3) 17930de9b25SBarry Smith 180eca87e8dSBarry Smith Not Collective 18130de9b25SBarry Smith 18230de9b25SBarry Smith Input Parameters: 18330de9b25SBarry Smith + errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 18430de9b25SBarry Smith . message - error message in the printf format 18530de9b25SBarry Smith . arg1 - argument (for example an integer, string or double) 18630de9b25SBarry Smith . arg2 - argument (for example an integer, string or double) 18730de9b25SBarry Smith - arg3 - argument (for example an integer, string or double) 18830de9b25SBarry Smith 18930de9b25SBarry Smith Level: beginner 19030de9b25SBarry Smith 19130de9b25SBarry Smith Notes: 19230de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 19330de9b25SBarry Smith 194f621e05eSBarry Smith There are also versions for 4, 5, 6 and 7 arguments. 195f621e05eSBarry Smith 19630de9b25SBarry Smith Experienced users can set the error handler with PetscPushErrorHandler(). 19730de9b25SBarry Smith 19830de9b25SBarry Smith Concepts: error^setting condition 19930de9b25SBarry Smith 2006024bd2cSBarry Smith .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 20130de9b25SBarry Smith M*/ 20253c77d0aSJed Brown #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) 20330de9b25SBarry Smith 20453c77d0aSJed Brown #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) 20553c77d0aSJed Brown #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) 20653c77d0aSJed Brown #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) 20753c77d0aSJed Brown #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) 2082f3d0e1cSMatthew G Knepley #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) 20953c77d0aSJed Brown #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) 2109a00fa46SSatish Balay 21130de9b25SBarry Smith /*MC 21230de9b25SBarry Smith CHKERRQ - Checks error code, if non-zero it calls the error handler and then returns 21330de9b25SBarry Smith 21430de9b25SBarry Smith Synopsis: 215f4442326SMatthew Knepley PetscErrorCode CHKERRQ(PetscErrorCode errorcode) 21630de9b25SBarry Smith 217eca87e8dSBarry Smith Not Collective 21830de9b25SBarry Smith 21930de9b25SBarry Smith Input Parameters: 22030de9b25SBarry Smith . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 22130de9b25SBarry Smith 22230de9b25SBarry Smith Level: beginner 22330de9b25SBarry Smith 22430de9b25SBarry Smith Notes: 22530de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 22630de9b25SBarry Smith 22730de9b25SBarry Smith Experienced users can set the error handler with PetscPushErrorHandler(). 2285324ea47SKris Buschelman 229fcecf507SKris Buschelman CHKERRQ(n) is fundamentally a macro replacement for 2305324ea47SKris Buschelman if (n) return(PetscError(...,n,...)); 2315324ea47SKris Buschelman 2325324ea47SKris Buschelman Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 2335324ea47SKris Buschelman highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 2345324ea47SKris Buschelman it cannot be used in functions which return(void) or any other datatype. In these types of functions, 23558ebbce7SBarry Smith you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 2365324ea47SKris Buschelman if (n) {PetscError(....); return(YourReturnType);} 23758ebbce7SBarry Smith where you may pass back a PETSC_NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 23858ebbce7SBarry Smith MPI_Abort() returned immediately. 23958ebbce7SBarry Smith 24058ebbce7SBarry Smith In Fortran MPI_Abort() is always called 24130de9b25SBarry Smith 24230de9b25SBarry Smith Concepts: error^setting condition 24330de9b25SBarry Smith 24491d3bdf4SKris Buschelman .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 24530de9b25SBarry Smith M*/ 24653c77d0aSJed Brown #define CHKERRQ(n) do {if (PetscUnlikely(n)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");} while (0) 24730de9b25SBarry Smith 24853c77d0aSJed Brown #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) 24953c77d0aSJed Brown #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) 25053c77d0aSJed Brown #define CHKERRCONTINUE(n) do {if (PetscUnlikely(n)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__,n,PETSC_ERROR_REPEAT," ");}} while (0) 25185614651SBarry Smith 252fd705b32SMatthew Knepley #ifdef PETSC_CLANGUAGE_CXX 253fd705b32SMatthew Knepley 254cc26af49SMatthew Knepley /*MC 255cc26af49SMatthew Knepley CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception 256cc26af49SMatthew Knepley 257cc26af49SMatthew Knepley Synopsis: 258cc26af49SMatthew Knepley void CHKERRXX(PetscErrorCode errorcode) 259cc26af49SMatthew Knepley 260eca87e8dSBarry Smith Not Collective 261cc26af49SMatthew Knepley 262cc26af49SMatthew Knepley Input Parameters: 263cc26af49SMatthew Knepley . errorcode - nonzero error code, see the list of standard error codes in include/petscerror.h 264cc26af49SMatthew Knepley 265cc26af49SMatthew Knepley Level: beginner 266cc26af49SMatthew Knepley 267cc26af49SMatthew Knepley Notes: 268cc26af49SMatthew Knepley Once the error handler throws a ??? exception. 269cc26af49SMatthew Knepley 270cc26af49SMatthew Knepley You can use CHKERRV() which returns without an error code (bad idea since the error is ignored) 271cc26af49SMatthew Knepley or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. 272cc26af49SMatthew Knepley 273cc26af49SMatthew Knepley Concepts: error^setting condition 274cc26af49SMatthew Knepley 275cc26af49SMatthew Knepley .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ 276cc26af49SMatthew Knepley M*/ 27753c77d0aSJed Brown #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) 278fd705b32SMatthew Knepley 279fd705b32SMatthew Knepley #endif 280fd705b32SMatthew Knepley 28130de9b25SBarry Smith /*MC 28230de9b25SBarry Smith CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 28330de9b25SBarry Smith 28430de9b25SBarry Smith Synopsis: 28591d3bdf4SKris Buschelman CHKMEMQ; 28630de9b25SBarry Smith 287eca87e8dSBarry Smith Not Collective 288eca87e8dSBarry Smith 28930de9b25SBarry Smith Level: beginner 29030de9b25SBarry Smith 29130de9b25SBarry Smith Notes: 292ff002950SBarry Smith Must run with the option -malloc_debug to enable this option 29330de9b25SBarry Smith 29430de9b25SBarry Smith Once the error handler is called the calling function is then returned from with the given error code. 29530de9b25SBarry Smith 29630de9b25SBarry Smith By defaults prints location where memory that is corrupted was allocated. 29730de9b25SBarry Smith 298f621e05eSBarry Smith Use CHKMEMA for functions that return void 299f621e05eSBarry Smith 30030de9b25SBarry Smith Concepts: memory corruption 30130de9b25SBarry Smith 3026024bd2cSBarry Smith .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 303ff002950SBarry Smith PetscMallocValidate() 30430de9b25SBarry Smith M*/ 30553c77d0aSJed Brown #define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__);CHKERRQ(_7_ierr);} while(0) 30685614651SBarry Smith 30753c77d0aSJed Brown #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__,__SDIR__) 308e68848bdSBarry Smith 3099dd39edbSMatthew Knepley #if defined(PETSC_UNDERSCORE_CHKERR) 3106849ba73SBarry Smith extern PetscErrorCode __gierr; 311f1af5d2fSBarry Smith #define _ __gierr = 312ac355199SBarry Smith #define ___ CHKERRQ(__gierr); 313f1af5d2fSBarry Smith #endif 314f1af5d2fSBarry Smith 315f8e50935SSatish Balay #else /* PETSC_USE_ERRORCHECKING */ 316f621e05eSBarry Smith 317f621e05eSBarry Smith /* 318e2e64c6bSBarry Smith These are defined to be empty for when error checking is turned off, with ./configure --with-errorchecking=0 319f621e05eSBarry Smith */ 320f621e05eSBarry Smith 3214b209cf6SBarry Smith #define SETERRQ(c,n,s) 3224b209cf6SBarry Smith #define SETERRQ1(c,n,s,a1) 3234b209cf6SBarry Smith #define SETERRQ2(c,n,s,a1,a2) 3244b209cf6SBarry Smith #define SETERRQ3(c,n,s,a1,a2,a3) 3254b209cf6SBarry Smith #define SETERRQ4(c,n,s,a1,a2,a3,a4) 3264b209cf6SBarry Smith #define SETERRQ5(c,n,s,a1,a2,a3,a4,a5) 3274b209cf6SBarry Smith #define SETERRQ6(c,n,s,a1,a2,a3,a4,a5,a6) 3284b209cf6SBarry Smith #define SETERRABORT(comm,n,s) 32985614651SBarry Smith 3304f227f7cSBarry Smith #define CHKERRQ(n) ; 3311ee4faa0SMatthew Knepley #define CHKERRABORT(comm,n) ; 3321ee4faa0SMatthew Knepley #define CHKERRCONTINUE(n) ; 33385614651SBarry Smith #define CHKMEMQ ; 33485614651SBarry Smith 3358cabf42eSMatthew G Knepley #ifdef PETSC_CLANGUAGE_CXX 3368cabf42eSMatthew G Knepley #define CHKERRXX(n) ; 3378cabf42eSMatthew G Knepley #endif 3388cabf42eSMatthew G Knepley 339f1af5d2fSBarry Smith #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 340f1af5d2fSBarry Smith #define _ 341f1af5d2fSBarry Smith #define ___ 342f1af5d2fSBarry Smith #endif 343f1af5d2fSBarry Smith 344f8e50935SSatish Balay #endif /* PETSC_USE_ERRORCHECKING */ 34554a8ef01SBarry Smith 346668f157eSBarry Smith /*E 347668f157eSBarry Smith PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers 348668f157eSBarry Smith 349668f157eSBarry Smith Level: advanced 350668f157eSBarry Smith 351d736bfebSBarry Smith PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated 352d736bfebSBarry Smith 353668f157eSBarry Smith Developer Notes: This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandling() 354668f157eSBarry Smith 355d736bfebSBarry Smith .seealso: PetscError(), SETERRXX() 356668f157eSBarry Smith E*/ 357d736bfebSBarry Smith typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType; 3584b209cf6SBarry Smith 3597087cfbeSBarry Smith extern PetscErrorCode PetscErrorPrintfInitialize(void); 3607087cfbeSBarry Smith extern PetscErrorCode PetscErrorMessage(int,const char*[],char **); 3617087cfbeSBarry Smith extern PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3627087cfbeSBarry Smith extern PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3637087cfbeSBarry Smith extern PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3647087cfbeSBarry Smith extern PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3657087cfbeSBarry Smith extern PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3667087cfbeSBarry Smith extern PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3677087cfbeSBarry Smith extern PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 3687087cfbeSBarry Smith extern PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...); 3697087cfbeSBarry Smith extern PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*); 3707087cfbeSBarry Smith extern PetscErrorCode PetscPopErrorHandler(void); 3717087cfbeSBarry Smith extern PetscErrorCode PetscDefaultSignalHandler(int,void*); 3727087cfbeSBarry Smith extern PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 3737087cfbeSBarry Smith extern PetscErrorCode PetscPopSignalHandler(void); 374329f5518SBarry Smith 375329f5518SBarry Smith typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 3767087cfbeSBarry Smith extern PetscErrorCode PetscSetFPTrap(PetscFPTrap); 377*670f3ff9SJed Brown extern PetscErrorCode PetscFPTrapPush(PetscFPTrap); 378*670f3ff9SJed Brown extern PetscErrorCode PetscFPTrapPop(void); 37954a8ef01SBarry Smith 3803a40ed3dSBarry Smith /* 3813a40ed3dSBarry Smith Allows the code to build a stack frame as it runs 3823a40ed3dSBarry Smith */ 38363d6bff0SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_USE_PTHREAD) 3843a40ed3dSBarry Smith 38599cd645aSJed Brown #define PETSCSTACKSIZE 64 386184914b5SBarry Smith 3873a40ed3dSBarry Smith typedef struct { 3880e33f6ddSBarry Smith const char *function[PETSCSTACKSIZE]; 3890e33f6ddSBarry Smith const char *file[PETSCSTACKSIZE]; 3900e33f6ddSBarry Smith const char *directory[PETSCSTACKSIZE]; 391184914b5SBarry Smith int line[PETSCSTACKSIZE]; 392184914b5SBarry Smith int currentsize; 3933a40ed3dSBarry Smith } PetscStack; 3943a40ed3dSBarry Smith 3957087cfbeSBarry Smith extern PetscStack *petscstack; 3967087cfbeSBarry Smith extern PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); 3977087cfbeSBarry Smith extern PetscErrorCode PetscStackPrint(PetscStack*,FILE* fp); 398184914b5SBarry Smith 399184914b5SBarry Smith #define PetscStackActive (petscstack != 0) 4003a40ed3dSBarry Smith 40130de9b25SBarry Smith /*MC 40230de9b25SBarry Smith PetscFunctionBegin - First executable line of each PETSc function 40330de9b25SBarry Smith used for error handling. 40430de9b25SBarry Smith 40530de9b25SBarry Smith Synopsis: 40630de9b25SBarry Smith void PetscFunctionBegin; 40730de9b25SBarry Smith 408eca87e8dSBarry Smith Not Collective 409eca87e8dSBarry Smith 41030de9b25SBarry Smith Usage: 41130de9b25SBarry Smith .vb 41230de9b25SBarry Smith int something; 41330de9b25SBarry Smith 41430de9b25SBarry Smith PetscFunctionBegin; 41530de9b25SBarry Smith .ve 41630de9b25SBarry Smith 41730de9b25SBarry Smith Notes: 41830de9b25SBarry Smith Not available in Fortran 41930de9b25SBarry Smith 42030de9b25SBarry Smith Level: developer 42130de9b25SBarry Smith 42230de9b25SBarry Smith .seealso: PetscFunctionReturn() 42330de9b25SBarry Smith 42430de9b25SBarry Smith .keywords: traceback, error handling 42530de9b25SBarry Smith M*/ 4263a40ed3dSBarry Smith #define PetscFunctionBegin \ 4278246ba0dSJed Brown do { \ 428184914b5SBarry Smith if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 42953c77d0aSJed Brown petscstack->function[petscstack->currentsize] = PETSC_FUNCTION_NAME; \ 430184914b5SBarry Smith petscstack->file[petscstack->currentsize] = __FILE__; \ 431184914b5SBarry Smith petscstack->directory[petscstack->currentsize] = __SDIR__; \ 432184914b5SBarry Smith petscstack->line[petscstack->currentsize] = __LINE__; \ 433184914b5SBarry Smith petscstack->currentsize++; \ 43453c77d0aSJed Brown } \ 43553c77d0aSJed Brown PetscCheck__FUNCT__(); \ 43653c77d0aSJed Brown } while (0) 43753c77d0aSJed Brown 43853c77d0aSJed Brown #define PetscCheck__FUNCT__() do { \ 43953c77d0aSJed Brown if (strcmp(PETSC_FUNCTION_NAME,__FUNCT__) && strcmp(__FUNCT__,"User provided function")) { \ 44053c77d0aSJed Brown (*PetscErrorPrintf)("%s%s:%d: __FUNCT__=\"%s\" does not agree with %s=\"%s\"\n",__SDIR__,__FILE__,__LINE__,__FUNCT__,PetscStringize(PETSC_FUNCTION_NAME),PETSC_FUNCTION_NAME); \ 44153c77d0aSJed Brown } \ 44253c77d0aSJed Brown } while (0) 4433a40ed3dSBarry Smith 4445cd90555SBarry Smith #define PetscStackPush(n) \ 4458246ba0dSJed Brown do {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 446184914b5SBarry Smith petscstack->function[petscstack->currentsize] = n; \ 447184914b5SBarry Smith petscstack->file[petscstack->currentsize] = "unknown"; \ 448184914b5SBarry Smith petscstack->directory[petscstack->currentsize] = "unknown"; \ 449184914b5SBarry Smith petscstack->line[petscstack->currentsize] = 0; \ 450184914b5SBarry Smith petscstack->currentsize++; \ 451812af9f3SBarry Smith } CHKMEMQ;} while (0) 4523a40ed3dSBarry Smith 453d64ed03dSBarry Smith #define PetscStackPop \ 454812af9f3SBarry Smith do {CHKMEMQ; if (petscstack && petscstack->currentsize > 0) { \ 455184914b5SBarry Smith petscstack->currentsize--; \ 456184914b5SBarry Smith petscstack->function[petscstack->currentsize] = 0; \ 457184914b5SBarry Smith petscstack->file[petscstack->currentsize] = 0; \ 458184914b5SBarry Smith petscstack->directory[petscstack->currentsize] = 0; \ 459184914b5SBarry Smith petscstack->line[petscstack->currentsize] = 0; \ 4608246ba0dSJed Brown }} while (0) 461d64ed03dSBarry Smith 46230de9b25SBarry Smith /*MC 46330de9b25SBarry Smith PetscFunctionReturn - Last executable line of each PETSc function 46430de9b25SBarry Smith used for error handling. Replaces return() 46530de9b25SBarry Smith 46630de9b25SBarry Smith Synopsis: 46730de9b25SBarry Smith void PetscFunctionReturn(0); 46830de9b25SBarry Smith 469eca87e8dSBarry Smith Not Collective 470eca87e8dSBarry Smith 47130de9b25SBarry Smith Usage: 47230de9b25SBarry Smith .vb 47330de9b25SBarry Smith .... 47430de9b25SBarry Smith PetscFunctionReturn(0); 47530de9b25SBarry Smith } 47630de9b25SBarry Smith .ve 47730de9b25SBarry Smith 47830de9b25SBarry Smith Notes: 47930de9b25SBarry Smith Not available in Fortran 48030de9b25SBarry Smith 48130de9b25SBarry Smith Level: developer 48230de9b25SBarry Smith 48330de9b25SBarry Smith .seealso: PetscFunctionBegin() 48430de9b25SBarry Smith 48530de9b25SBarry Smith .keywords: traceback, error handling 48630de9b25SBarry Smith M*/ 4875cd90555SBarry Smith #define PetscFunctionReturn(a) \ 4888246ba0dSJed Brown do {\ 489812af9f3SBarry Smith if (petscstack && petscstack->currentsize > 0) { \ 490812af9f3SBarry Smith petscstack->currentsize--; \ 491812af9f3SBarry Smith petscstack->function[petscstack->currentsize] = 0; \ 492812af9f3SBarry Smith petscstack->file[petscstack->currentsize] = 0; \ 493812af9f3SBarry Smith petscstack->directory[petscstack->currentsize] = 0; \ 494812af9f3SBarry Smith petscstack->line[petscstack->currentsize] = 0; \ 495812af9f3SBarry Smith }\ 4968246ba0dSJed Brown return(a);} while (0) 497d64ed03dSBarry Smith 498ff94ddecSSatish Balay #define PetscFunctionReturnVoid() \ 4998246ba0dSJed Brown do {\ 500812af9f3SBarry Smith if (petscstack && petscstack->currentsize > 0) { \ 501812af9f3SBarry Smith petscstack->currentsize--; \ 502812af9f3SBarry Smith petscstack->function[petscstack->currentsize] = 0; \ 503812af9f3SBarry Smith petscstack->file[petscstack->currentsize] = 0; \ 504812af9f3SBarry Smith petscstack->directory[petscstack->currentsize] = 0; \ 505812af9f3SBarry Smith petscstack->line[petscstack->currentsize] = 0; \ 506812af9f3SBarry Smith }\ 5078246ba0dSJed Brown return;} while (0) 508ff94ddecSSatish Balay 5096d385327SIbrahima Ba #else 5106d385327SIbrahima Ba 5113a40ed3dSBarry Smith #define PetscFunctionBegin 5123a40ed3dSBarry Smith #define PetscFunctionReturn(a) return(a) 5135665465eSBarry Smith #define PetscFunctionReturnVoid() return 514812af9f3SBarry Smith #define PetscStackPop CHKMEMQ 515812af9f3SBarry Smith #define PetscStackPush(f) CHKMEMQ 516d64ed03dSBarry Smith #define PetscStackActive 0 5173a40ed3dSBarry Smith 5183a40ed3dSBarry Smith #endif 5193a40ed3dSBarry Smith 520eb6b5d47SBarry Smith /* 521eb6b5d47SBarry Smith PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack. 522eb6b5d47SBarry Smith 523eb6b5d47SBarry Smith Input Parameters: 524eb6b5d47SBarry Smith + name - string that gives the name of the function being called 525eb6b5d47SBarry Smith - routine - actual call to the routine 526eb6b5d47SBarry Smith 527eb6b5d47SBarry Smith 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. 528eb6b5d47SBarry Smith 529eb6b5d47SBarry Smith */ 530eb6b5d47SBarry Smith #define PetscStackCall(name,routine) PetscStackPush(name);routine;PetscStackPop; 531eb6b5d47SBarry Smith 5327087cfbeSBarry Smith extern PetscErrorCode PetscStackCreate(void); 5337087cfbeSBarry Smith extern PetscErrorCode PetscStackView(PetscViewer); 5347087cfbeSBarry Smith extern PetscErrorCode PetscStackDestroy(void); 5357087cfbeSBarry Smith extern PetscErrorCode PetscStackPublish(void); 5367087cfbeSBarry Smith extern PetscErrorCode PetscStackDepublish(void); 5373a40ed3dSBarry Smith 53806d1fe2cSBarry Smith 539e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 54006d1fe2cSBarry Smith #endif 541