1 /* $Id: petscerror.h,v 1.41 2000/01/11 21:04:04 bsmith Exp bsmith $ */ 2 /* 3 Contains all error handling code for PETSc. 4 */ 5 #if !defined(__PETSCERROR_H) 6 #define __PETSCERROR_H 7 8 #include "petsc.h" 9 10 #if defined(PETSC_HAVE_AMS) 11 #include "ams.h" 12 #endif 13 14 /* 15 Defines the directory where the compiled source is located; used 16 in printing error messages. Each makefile has an entry 17 LOCDIR = thedirectory 18 and bmake/common includes in CCPPFLAGS -D__SDIR__='"${LOCDIR}"' 19 which is a flag passed to the C/C++ compilers. 20 */ 21 #if !defined(__SDIR__) 22 #define __SDIR__ "unknowndirectory/" 23 #endif 24 25 /* 26 Defines the function where the compiled source is located; used 27 in printing error messages. 28 */ 29 #if !defined(__FUNC__) 30 #define __FUNC__ "unknownfunction" 31 #endif 32 33 /* 34 These are the generic error codes. These error codes are used 35 many different places in the PETSc source code. 36 37 In addition, each specific error in the code has an error 38 message: a specific, unique error code. (The specific error 39 code is not yet in use; these will be generated automatically and 40 embed an integer into the PetscError() calls. For non-English 41 error messages, that integer will be extracted and used to look up the 42 appropriate error message in the local language from a file.) 43 44 */ 45 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 46 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 47 #define PETSC_ERR_SIG 59 /* signal received */ 48 #define PETSC_ERR_FP 72 /* floating point exception */ 49 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 50 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 51 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 52 #define PETSC_ERR_MEMC 78 /* memory corruption */ 53 54 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 55 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 56 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 57 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 58 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 59 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 60 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 61 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 62 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 63 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 64 65 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 66 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 67 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 68 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 69 70 #define PETSC_ERR_KSP_BRKDWN 70 /* break down in a Krylov method */ 71 72 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 73 #define PETSC_ERR_MAT_CH_ZRPVT 71 /* detected a zero pivot during Cholesky factorization */ 74 75 #if defined(PETSC_USE_DEBUG) 76 #define SETERRA(n,p,s) {int _ierr = PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s);\ 77 MPI_Abort(PETSC_COMM_WORLD,_ierr);} 78 #define SETERRA1(n,p,s,a1) {int _ierr = PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s,a1);\ 79 MPI_Abort(PETSC_COMM_WORLD,_ierr);} 80 #define SETERRQ(n,p,s) {return PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s);} 81 #define SETERRQ1(n,p,s,a1) {return PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s,a1);} 82 #define SETERRQ2(n,p,s,a1,a2) {return PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s,a1,a2);} 83 #define SETERRQ3(n,p,s,a1,a2,a3) {return PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s,a1,a2,a3);} 84 #define SETERRQ4(n,p,s,a1,a2,a3,a4) {return PetscError(__LINE__,__FUNC__,__FILE__,__SDIR__,n,p,s,a1,a2,a3,a4);} 85 86 #define CHKERRQ(n) {if (n) SETERRQ(n,0,(char *)0);} 87 #define CHKERRA(n) {if (n) SETERRA(n,0,(char *)0);} 88 #define CHKPTRQ(p) if (!p) SETERRQ(PETSC_ERR_MEM,0,(char*)0); 89 #define CHKPTRA(p) if (!p) SETERRA(PETSC_ERR_MEM,0,(char*)0); 90 91 #define CHKMEMQ {int __ierr = PetscTrValid(__LINE__,__FUNC__,__FILE__,__SDIR__);CHKERRQ(__ierr);} 92 #define CHKMEMA {int __ierr = PetscTrValid(__LINE__,__FUNC__,__FILE__,__SDIR__);CHKERRA(__ierr);} 93 94 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 95 extern int __gierr; 96 #define _ __gierr = 97 #define ___ CHKERRA(__gierr); 98 #define ____ CHKERRQ(__gierr); 99 #endif 100 101 #else 102 #define SETERRQ(n,p,s) ; 103 #define SETERRQ1(n,p,s,a1) ; 104 #define SETERRQ2(n,p,s,a1,a2) ; 105 #define SETERRQ3(n,p,s,a1,a2,a3) ; 106 #define SETERRQ4(n,p,s,a1,a2,a3,a4) ; 107 #define SETERRA(n,p,s) ; 108 109 #define CHKERRQ(n) ; 110 #define CHKERRA(n) ; 111 #define CHKPTRQ(p) ; 112 #define CHKPTRA(p) ; 113 114 #define CHKMEMQ ; 115 #define CHKMEMA ; 116 117 #if !defined(PETSC_SKIP_UNDERSCORE_CHKERR) 118 #define _ 119 #define ___ 120 #define ____ 121 #endif 122 123 #endif 124 125 extern int PetscTraceBackErrorHandler(int,char*,char*,char*,int,int,char*,void*); 126 extern int PetscStopErrorHandler(int,char*,char*,char*,int,int,char*,void*); 127 extern int PetscAbortErrorHandler(int,char*,char*,char*,int,int,char*,void*); 128 extern int PetscAttachDebuggerErrorHandler(int,char*,char*,char*,int,int,char*,void*); 129 extern int PetscError(int,char*,char*,char*,int,int,char*,...); 130 extern int PetscPushErrorHandler(int (*handler)(int,char*,char*,char*,int,int,char*,void*),void*); 131 extern int PetscPopErrorHandler(void); 132 133 extern int PetscDefaultSignalHandler(int,void*); 134 extern int PetscPushSignalHandler(int (*)(int,void *),void*); 135 extern int PetscPopSignalHandler(void); 136 137 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 138 extern int PetscSetFPTrap(PetscFPTrap); 139 140 /* 141 Allows the code to build a stack frame as it runs 142 */ 143 #if defined(PETSC_USE_STACK) 144 145 #define PETSCSTACKSIZE 15 146 147 typedef struct { 148 char *function[PETSCSTACKSIZE]; 149 char *file[PETSCSTACKSIZE]; 150 char *directory[PETSCSTACKSIZE]; 151 int line[PETSCSTACKSIZE]; 152 int currentsize; 153 } PetscStack; 154 155 extern PetscStack *petscstack; 156 extern int PetscStackCopy(PetscStack*,PetscStack*); 157 extern int PetscStackPrint(PetscStack*,FILE* fp); 158 159 #define PetscStackActive (petscstack != 0) 160 161 #if !defined(PETSC_HAVE_AMS) 162 163 #define PetscFunctionBegin \ 164 {\ 165 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 166 petscstack->function[petscstack->currentsize] = __FUNC__; \ 167 petscstack->file[petscstack->currentsize] = __FILE__; \ 168 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 169 petscstack->line[petscstack->currentsize] = __LINE__; \ 170 petscstack->currentsize++; \ 171 }} 172 173 #define PetscStackPush(n) \ 174 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 175 petscstack->function[petscstack->currentsize] = n; \ 176 petscstack->file[petscstack->currentsize] = "unknown"; \ 177 petscstack->directory[petscstack->currentsize] = "unknown"; \ 178 petscstack->line[petscstack->currentsize] = 0; \ 179 petscstack->currentsize++; \ 180 }} 181 182 #define PetscStackPop \ 183 {if (petscstack && petscstack->currentsize > 0) { \ 184 petscstack->currentsize--; \ 185 petscstack->function[petscstack->currentsize] = 0; \ 186 petscstack->file[petscstack->currentsize] = 0; \ 187 petscstack->directory[petscstack->currentsize] = 0; \ 188 petscstack->line[petscstack->currentsize] = 0; \ 189 }}; 190 191 #define PetscFunctionReturn(a) \ 192 {\ 193 PetscStackPop; \ 194 return(a);} 195 196 #else 197 198 /* 199 Duplicate Code for when the ALICE Memory Snooper (AMS) 200 is being used. When PETSC_HAVE_AMS is defined. 201 202 stack_mem is the AMS memory that contains fields for the 203 number of stack frames and names of the stack frames 204 */ 205 206 extern AMS_Memory stack_mem; 207 extern int stack_err; 208 209 #define PetscFunctionBegin \ 210 {\ 211 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 212 if (!(stack_mem < 0)) stack_err = AMS_Memory_take_access(stack_mem);\ 213 petscstack->function[petscstack->currentsize] = __FUNC__; \ 214 petscstack->file[petscstack->currentsize] = __FILE__; \ 215 petscstack->directory[petscstack->currentsize] = __SDIR__; \ 216 petscstack->line[petscstack->currentsize] = __LINE__; \ 217 petscstack->currentsize++; \ 218 if (!(stack_mem < 0)) stack_err = AMS_Memory_grant_access(stack_mem);\ 219 }} 220 221 #define PetscStackPush(n) \ 222 {if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 223 if (!(stack_mem < 0)) stack_err = AMS_Memory_take_access(stack_mem);\ 224 petscstack->function[petscstack->currentsize] = n; \ 225 petscstack->file[petscstack->currentsize] = "unknown"; \ 226 petscstack->directory[petscstack->currentsize] = "unknown"; \ 227 petscstack->line[petscstack->currentsize] = 0; \ 228 petscstack->currentsize++; \ 229 if (!(stack_mem < 0)) stack_err = AMS_Memory_grant_access(stack_mem);\ 230 }} 231 232 #define PetscStackPop \ 233 {if (petscstack && petscstack->currentsize > 0) { \ 234 if (!(stack_mem < 0)) stack_err = AMS_Memory_take_access(stack_mem);\ 235 petscstack->currentsize--; \ 236 petscstack->function[petscstack->currentsize] = 0; \ 237 petscstack->file[petscstack->currentsize] = 0; \ 238 petscstack->directory[petscstack->currentsize] = 0; \ 239 petscstack->line[petscstack->currentsize] = 0; \ 240 if (!(stack_mem < 0)) stack_err = AMS_Memory_grant_access(stack_mem);\ 241 }}; 242 243 #define PetscFunctionReturn(a) \ 244 {\ 245 PetscStackPop; \ 246 return(a);} 247 248 #endif 249 250 #else 251 252 #define PetscFunctionBegin 253 #define PetscFunctionReturn(a) return(a) 254 #define PetscStackPop 255 #define PetscStackPush(f) 256 #define PetscStackActive 0 257 258 #endif 259 260 extern int PetscStackCreate(void); 261 extern int PetscStackView(Viewer); 262 extern int PetscStackDestroy(void); 263 extern int PetscStackPublish(void); 264 extern int PetscStackDepublish(void); 265 266 267 #endif 268 269 270