1 /* 2 Contains all error handling interfaces for PETSc. 3 */ 4 #if !defined(PETSCERROR_H) 5 #define PETSCERROR_H 6 7 /* 8 These are the generic error codes. These error codes are used 9 many different places in the PETSc source code. The string versions are 10 at src/sys/error/err.c any changes here must also be made there 11 These are also define in src/sys/f90-mod/petscerror.h any CHANGES here 12 must be also made there. 13 14 */ 15 #define PETSC_ERR_MIN_VALUE 54 /* should always be one less then the smallest value */ 16 17 #define PETSC_ERR_MEM 55 /* unable to allocate requested memory */ 18 #define PETSC_ERR_SUP 56 /* no support for requested operation */ 19 #define PETSC_ERR_SUP_SYS 57 /* no support for requested operation on this computer system */ 20 #define PETSC_ERR_ORDER 58 /* operation done in wrong order */ 21 #define PETSC_ERR_SIG 59 /* signal received */ 22 #define PETSC_ERR_FP 72 /* floating point exception */ 23 #define PETSC_ERR_COR 74 /* corrupted PETSc object */ 24 #define PETSC_ERR_LIB 76 /* error in library called by PETSc */ 25 #define PETSC_ERR_PLIB 77 /* PETSc library generated inconsistent data */ 26 #define PETSC_ERR_MEMC 78 /* memory corruption */ 27 #define PETSC_ERR_CONV_FAILED 82 /* iterative method (KSP or SNES) failed */ 28 #define PETSC_ERR_USER 83 /* user has not provided needed function */ 29 #define PETSC_ERR_SYS 88 /* error in system call */ 30 #define PETSC_ERR_POINTER 70 /* pointer does not point to valid address */ 31 #define PETSC_ERR_MPI_LIB_INCOMP 87 /* MPI library at runtime is not compatible with MPI user compiled with */ 32 33 #define PETSC_ERR_ARG_SIZ 60 /* nonconforming object sizes used in operation */ 34 #define PETSC_ERR_ARG_IDN 61 /* two arguments not allowed to be the same */ 35 #define PETSC_ERR_ARG_WRONG 62 /* wrong argument (but object probably ok) */ 36 #define PETSC_ERR_ARG_CORRUPT 64 /* null or corrupted PETSc object as argument */ 37 #define PETSC_ERR_ARG_OUTOFRANGE 63 /* input argument, out of range */ 38 #define PETSC_ERR_ARG_BADPTR 68 /* invalid pointer argument */ 39 #define PETSC_ERR_ARG_NOTSAMETYPE 69 /* two args must be same object type */ 40 #define PETSC_ERR_ARG_NOTSAMECOMM 80 /* two args must be same communicators */ 41 #define PETSC_ERR_ARG_WRONGSTATE 73 /* object in argument is in wrong state, e.g. unassembled mat */ 42 #define PETSC_ERR_ARG_TYPENOTSET 89 /* the type of the object has not yet been set */ 43 #define PETSC_ERR_ARG_INCOMP 75 /* two arguments are incompatible */ 44 #define PETSC_ERR_ARG_NULL 85 /* argument is null that should not be */ 45 #define PETSC_ERR_ARG_UNKNOWN_TYPE 86 /* type name doesn't match any registered type */ 46 47 #define PETSC_ERR_FILE_OPEN 65 /* unable to open file */ 48 #define PETSC_ERR_FILE_READ 66 /* unable to read from file */ 49 #define PETSC_ERR_FILE_WRITE 67 /* unable to write to file */ 50 #define PETSC_ERR_FILE_UNEXPECTED 79 /* unexpected data in file */ 51 52 #define PETSC_ERR_MAT_LU_ZRPVT 71 /* detected a zero pivot during LU factorization */ 53 #define PETSC_ERR_MAT_CH_ZRPVT 81 /* detected a zero pivot during Cholesky factorization */ 54 55 #define PETSC_ERR_INT_OVERFLOW 84 56 57 #define PETSC_ERR_FLOP_COUNT 90 58 #define PETSC_ERR_NOT_CONVERGED 91 /* solver did not converge */ 59 #define PETSC_ERR_MISSING_FACTOR 92 /* MatGetFactor() failed */ 60 #define PETSC_ERR_OPT_OVERWRITE 93 /* attempted to over write options which should not be changed */ 61 #define PETSC_ERR_WRONG_MPI_SIZE 94 /* example/application run with number of MPI ranks it does not support */ 62 #define PETSC_ERR_USER_INPUT 95 /* missing or incorrect user input */ 63 #define PETSC_ERR_GPU_RESOURCE 96 /* unable to load a GPU resource, for example cuBLAS */ 64 #define PETSC_ERR_GPU 97 /* An error from a GPU call, this may be due to lack of resources on the GPU or a true error in the call */ 65 #define PETSC_ERR_MPI 98 /* general MPI error */ 66 #define PETSC_ERR_MAX_VALUE 99 /* this is always the one more than the largest error code */ 67 68 #define PetscStringizeArg(a) #a 69 #define PetscStringize(a) PetscStringizeArg(a) 70 71 72 /*MC 73 SETERRQ - Macro to be called when an error has been detected, 74 75 Synopsis: 76 #include <petscsys.h> 77 PetscErrorCode SETERRQ(MPI_Comm comm,PetscErrorCode ierr,char *message) 78 79 Collective 80 81 Input Parameters: 82 + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error 83 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 84 - message - error message 85 86 Level: beginner 87 88 Notes: 89 Once the error handler is called the calling function is then returned from with the given error code. 90 91 See SETERRQ1(), SETERRQ2(), SETERRQ3() for versions that take arguments 92 93 Experienced users can set the error handler with PetscPushErrorHandler(). 94 95 Fortran Notes: 96 SETERRQ() may be called from Fortran subroutines but SETERRA() must be called from the 97 Fortran main program. 98 99 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), CHKERRMPI() 100 M*/ 101 #define SETERRQ(comm,ierr,s) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s) 102 103 /* 104 Returned from PETSc functions that are called from MPI, such as related to attributes 105 Do not confuse PETSC_MPI_ERROR_CODE and PETSC_ERR_MPI, the first is registered with MPI and returned to MPI as 106 an error code, the latter is a regular PETSc error code passed within PETSc code indicating an error was detected in an MPI call. 107 */ 108 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CLASS; 109 PETSC_EXTERN PetscMPIInt PETSC_MPI_ERROR_CODE; 110 111 112 /*MC 113 SETERRMPI - Macro to be called when an error has been detected within an MPI callback function 114 115 Synopsis: 116 #include <petscsys.h> 117 PetscErrorCode SETERRMPI(MPI_Comm comm,PetscErrorCode ierr,char *message) 118 119 Collective 120 121 Input Parameters: 122 + comm - A communicator, use PETSC_COMM_SELF unless you know all ranks of another communicator will detect the error 123 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 124 - message - error message 125 126 Level: developer 127 128 Notes: 129 This macro is FOR USE IN MPI CALLBACK FUNCTIONS ONLY, such as those passed to MPI_Comm_create_keyval(). It always returns the error code PETSC_MPI_ERROR_CODE 130 which is registered with MPI_Add_error_code() when PETSc is initialized. 131 132 .seealso: SETERRQ(), CHKERRQ(), CHKERRMPI(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3() 133 M*/ 134 #define SETERRMPI(comm,ierr,s) return (PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s),PETSC_MPI_ERROR_CODE) 135 136 /*MC 137 SETERRQ1 - Macro that is called when an error has been detected, 138 139 Synopsis: 140 #include <petscsys.h> 141 PetscErrorCode SETERRQ1(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg) 142 143 Collective 144 145 Input Parameters: 146 + comm - A communicator, so that the error can be collective 147 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 148 . message - error message in the printf format 149 - arg - argument (for example an integer, string or double) 150 151 Level: beginner 152 153 Notes: 154 Once the error handler is called the calling function is then returned from with the given error code. 155 156 Experienced users can set the error handler with PetscPushErrorHandler(). 157 158 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ(), SETERRQ2(), SETERRQ3() 159 M*/ 160 #define SETERRQ1(comm,ierr,s,a1) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1) 161 162 /*MC 163 SETERRQ2 - Macro that is called when an error has been detected, 164 165 Synopsis: 166 #include <petscsys.h> 167 PetscErrorCode SETERRQ2(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2) 168 169 Collective 170 171 Input Parameters: 172 + comm - A communicator, so that the error can be collective 173 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 174 . message - error message in the printf format 175 . arg1 - argument (for example an integer, string or double) 176 - arg2 - argument (for example an integer, string or double) 177 178 Level: beginner 179 180 Notes: 181 Once the error handler is called the calling function is then returned from with the given error code. 182 183 Experienced users can set the error handler with PetscPushErrorHandler(). 184 185 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ3() 186 M*/ 187 #define SETERRQ2(comm,ierr,s,a1,a2) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2) 188 189 /*MC 190 SETERRQ3 - Macro that is called when an error has been detected, 191 192 Synopsis: 193 #include <petscsys.h> 194 PetscErrorCode SETERRQ3(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3) 195 196 Collective 197 198 Input Parameters: 199 + comm - A communicator, so that the error can be collective 200 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 201 . message - error message in the printf format 202 . arg1 - argument (for example an integer, string or double) 203 . arg2 - argument (for example an integer, string or double) 204 - arg3 - argument (for example an integer, string or double) 205 206 Level: beginner 207 208 Notes: 209 Once the error handler is called the calling function is then returned from with the given error code. 210 211 There are also versions for 4, 5, 6 and 7 arguments. 212 213 Experienced users can set the error handler with PetscPushErrorHandler(). 214 215 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 216 M*/ 217 #define SETERRQ3(comm,ierr,s,a1,a2,a3) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3) 218 219 /*MC 220 SETERRQ4 - Macro that is called when an error has been detected, 221 222 Synopsis: 223 #include <petscsys.h> 224 PetscErrorCode SETERRQ4(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4) 225 226 Collective 227 228 Input Parameters: 229 + comm - A communicator, so that the error can be collective 230 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 231 . message - error message in the printf format 232 . arg1 - argument (for example an integer, string or double) 233 . arg2 - argument (for example an integer, string or double) 234 . arg3 - argument (for example an integer, string or double) 235 - arg4 - argument (for example an integer, string or double) 236 237 Level: beginner 238 239 Notes: 240 Once the error handler is called the calling function is then returned from with the given error code. 241 242 There are also versions for 4, 5, 6 and 7 arguments. 243 244 Experienced users can set the error handler with PetscPushErrorHandler(). 245 246 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 247 M*/ 248 #define SETERRQ4(comm,ierr,s,a1,a2,a3,a4) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4) 249 250 /*MC 251 SETERRQ5 - Macro that is called when an error has been detected, 252 253 Synopsis: 254 #include <petscsys.h> 255 PetscErrorCode SETERRQ5(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5) 256 257 Collective 258 259 Input Parameters: 260 + comm - A communicator, so that the error can be collective 261 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 262 . message - error message in the printf format 263 . arg1 - argument (for example an integer, string or double) 264 . arg2 - argument (for example an integer, string or double) 265 . arg3 - argument (for example an integer, string or double) 266 . arg4 - argument (for example an integer, string or double) 267 - arg5 - argument (for example an integer, string or double) 268 269 Level: beginner 270 271 Notes: 272 Once the error handler is called the calling function is then returned from with the given error code. 273 274 There are also versions for 4, 5, 6 and 7 arguments. 275 276 Experienced users can set the error handler with PetscPushErrorHandler(). 277 278 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 279 M*/ 280 #define SETERRQ5(comm,ierr,s,a1,a2,a3,a4,a5) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5) 281 282 /*MC 283 SETERRQ6 - Macro that is called when an error has been detected, 284 285 Synopsis: 286 #include <petscsys.h> 287 PetscErrorCode SETERRQ6(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6) 288 289 Collective 290 291 Input Parameters: 292 + comm - A communicator, so that the error can be collective 293 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 294 . message - error message in the printf format 295 . arg1 - argument (for example an integer, string or double) 296 . arg2 - argument (for example an integer, string or double) 297 . arg3 - argument (for example an integer, string or double) 298 . arg4 - argument (for example an integer, string or double) 299 . arg5 - argument (for example an integer, string or double) 300 - arg6 - argument (for example an integer, string or double) 301 302 Level: beginner 303 304 Notes: 305 Once the error handler is called the calling function is then returned from with the given error code. 306 307 There are also versions for 4, 5, 6 and 7 arguments. 308 309 Experienced users can set the error handler with PetscPushErrorHandler(). 310 311 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 312 M*/ 313 #define SETERRQ6(comm,ierr,s,a1,a2,a3,a4,a5,a6) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6) 314 315 /*MC 316 SETERRQ7 - Macro that is called when an error has been detected, 317 318 Synopsis: 319 #include <petscsys.h> 320 PetscErrorCode SETERRQ7(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7) 321 322 Collective 323 324 Input Parameters: 325 + comm - A communicator, so that the error can be collective 326 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 327 . message - error message in the printf format 328 . arg1 - argument (for example an integer, string or double) 329 . arg2 - argument (for example an integer, string or double) 330 . arg3 - argument (for example an integer, string or double) 331 . arg4 - argument (for example an integer, string or double) 332 . arg5 - argument (for example an integer, string or double) 333 . arg6 - argument (for example an integer, string or double) 334 - arg7 - argument (for example an integer, string or double) 335 336 Level: beginner 337 338 Notes: 339 Once the error handler is called the calling function is then returned from with the given error code. 340 341 There are also versions for 4, 5, 6 and 7 arguments. 342 343 Experienced users can set the error handler with PetscPushErrorHandler(). 344 345 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 346 M*/ 347 #define SETERRQ7(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7) 348 349 /*MC 350 SETERRQ8 - Macro that is called when an error has been detected, 351 352 Synopsis: 353 #include <petscsys.h> 354 PetscErrorCode SETERRQ8(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8) 355 356 Collective 357 358 Input Parameters: 359 + comm - A communicator, so that the error can be collective 360 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 361 . message - error message in the printf format 362 . arg1 - argument (for example an integer, string or double) 363 . arg2 - argument (for example an integer, string or double) 364 . arg3 - argument (for example an integer, string or double) 365 . arg4 - argument (for example an integer, string or double) 366 . arg5 - argument (for example an integer, string or double) 367 . arg6 - argument (for example an integer, string or double) 368 . arg7 - argument (for example an integer, string or double) 369 - arg8 - argument (for example an integer, string or double) 370 371 Level: beginner 372 373 Notes: 374 Once the error handler is called the calling function is then returned from with the given error code. 375 376 There are also versions for 4, 5, 6 and 7 arguments. 377 378 Experienced users can set the error handler with PetscPushErrorHandler(). 379 380 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 381 M*/ 382 #define SETERRQ8(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8) 383 384 /*MC 385 SETERRQ9 - Macro that is called when an error has been detected, 386 387 Synopsis: 388 #include <petscsys.h> 389 PetscErrorCode SETERRQ9(MPI_Comm comm,PetscErrorCode ierr,char *formatmessage,arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9) 390 391 Collective 392 393 Input Parameters: 394 + comm - A communicator, so that the error can be collective 395 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 396 . message - error message in the printf format 397 . arg1 - argument (for example an integer, string or double) 398 . arg2 - argument (for example an integer, string or double) 399 . arg3 - argument (for example an integer, string or double) 400 . arg4 - argument (for example an integer, string or double) 401 . arg5 - argument (for example an integer, string or double) 402 . arg6 - argument (for example an integer, string or double) 403 . arg7 - argument (for example an integer, string or double) 404 . arg8 - argument (for example an integer, string or double) 405 - arg9 - argument (for example an integer, string or double) 406 407 Level: beginner 408 409 Notes: 410 Once the error handler is called the calling function is then returned from with the given error code. 411 412 There are also versions for 0 to 9 arguments. 413 414 Experienced users can set the error handler with PetscPushErrorHandler(). 415 416 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 417 M*/ 418 #define SETERRQ9(comm,ierr,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) return PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) 419 420 /*MC 421 SETERRABORT - Macro that can be called when an error has been detected, 422 423 Synopsis: 424 #include <petscsys.h> 425 PetscErrorCode SETERRABORT(MPI_Comm comm,PetscErrorCode ierr,char *message) 426 427 Collective 428 429 Input Parameters: 430 + comm - A communicator, so that the error can be collective 431 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 432 - message - error message in the printf format 433 434 Level: beginner 435 436 Notes: 437 This function just calls MPI_Abort(). 438 439 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), CHKERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2() 440 M*/ 441 #define SETERRABORT(comm,ierr,s) do {PetscError(comm,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_INITIAL,s);MPI_Abort(comm,ierr);} while (0) 442 443 /*MC 444 CHKERRQ - Checks error code returned from PETSc function, if non-zero it calls the error handler and then returns. Use CHKERRMPI() for checking errors from MPI calls 445 446 Synopsis: 447 #include <petscsys.h> 448 PetscErrorCode CHKERRQ(PetscErrorCode ierr) 449 450 Not Collective 451 452 Input Parameters: 453 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 454 455 Level: beginner 456 457 Notes: 458 Once the error handler is called the calling function is then returned from with the given error code. 459 460 Experienced users can set the error handler with PetscPushErrorHandler(). 461 462 CHKERRQ(ierr) is fundamentally a macro replacement for 463 if (ierr) return(PetscError(...,ierr,...)); 464 465 Although typical usage resembles "void CHKERRQ(PetscErrorCode)" as described above, for certain uses it is 466 highly inappropriate to use it in this manner as it invokes return(PetscErrorCode). In particular, 467 it cannot be used in functions which return(void) or any other datatype. In these types of functions, 468 you can use CHKERRV() which returns without an error code (bad idea since the error is ignored or 469 if (ierr) {PetscError(....); return(YourReturnType);} 470 where you may pass back a NULL to indicate an error. You can also call CHKERRABORT(comm,n) to have 471 MPI_Abort() returned immediately. 472 473 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2() 474 M*/ 475 #define CHKERRQ(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) return PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");} while (0) 476 #define CHKERRV(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");return;}} while (0) 477 #define CHKERRABORT(comm,ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");MPI_Abort(comm,ierr);}} while (0) 478 #define CHKERRCONTINUE(ierr) do {PetscErrorCode ierr__ = (ierr); if (PetscUnlikely(ierr__)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr__,PETSC_ERROR_REPEAT," ");}} while (0) 479 480 PETSC_EXTERN PetscErrorCode PetscAbortFindSourceFile_Private(const char*,PetscInt*); 481 PETSC_EXTERN PetscBool petscwaitonerrorflg,petscindebugger; 482 483 /*MC 484 PETSCABORT - Call MPI_Abort with an informative error code 485 486 Synopsis: 487 #include <petscsys.h> 488 PETSCABORT(MPI_Comm comm, PetscErrorCode ierr) 489 490 Collective 491 492 Input Parameters: 493 + comm - A communicator, so that the error can be collective 494 - ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 495 496 Level: advanced 497 498 Notes: 499 We pass MPI_Abort() an error code of format XX_YYYY_ZZZ, where XX, YYYY are an index and line number of the file 500 where PETSCABORT is called, respectively. ZZZ is the PETSc error code. 501 502 If XX is zero, this means that the call was made in the routine main(). 503 If XX is one, that means 1) the file is not in PETSc (it may be in users code); OR 2) the file is in PETSc but PetscAbortSourceFiles[] 504 is out of date. PETSc developers have to update it. 505 Otherwise, look up the value of XX in the table PetscAbortSourceFiles[] in src/sys/error/err.c to map XX back to the source file where the PETSCABORT() was called. 506 507 If the option -start_in_debugger was used then this calls abort() to stop the program in the debugger. 508 509 M*/ 510 #define PETSCABORT(comm,ierr) \ 511 do { \ 512 PetscInt idx = 0; \ 513 PetscMPIInt errcode; \ 514 PetscAbortFindSourceFile_Private(__FILE__,&idx); \ 515 errcode = (PetscMPIInt)(idx*10000000 + __LINE__*1000 + ierr); \ 516 if (petscwaitonerrorflg) PetscSleep(1000); \ 517 if (petscindebugger) abort(); \ 518 else MPI_Abort(comm,errcode); \ 519 } while (0) 520 521 /*MC 522 CHKERRMPI - Checks error code returned from MPI calls, if non-zero it calls the error handler and then returns 523 524 Synopsis: 525 #include <petscsys.h> 526 PetscErrorCode CHKERRMPI(PetscErrorCode ierr) 527 528 Not Collective 529 530 Input Parameters: 531 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 532 533 Level: intermediate 534 535 Notes: 536 Always returns the error code PETSC_ERR_MPI; the MPI error code and string are embedded in the string error message 537 538 .seealso: CHKERRQ(), PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ2(), SETERRMPI() 539 M*/ 540 #define CHKERRMPI(ierr) \ 541 do { \ 542 if (PetscUnlikely(ierr)) { \ 543 char name[MPI_MAX_ERROR_STRING]; \ 544 PetscMPIInt dlength;\ 545 MPI_Error_string(ierr,(char*)name,&dlength); \ 546 SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_MPI,"MPI error %d %s",(int)ierr,name); \ 547 } \ 548 } while (0) 549 550 #ifdef PETSC_CLANGUAGE_CXX 551 552 /*MC 553 CHKERRXX - Checks error code, if non-zero it calls the C++ error handler which throws an exception 554 555 Synopsis: 556 #include <petscsys.h> 557 void CHKERRXX(PetscErrorCode ierr) 558 559 Not Collective 560 561 Input Parameters: 562 . ierr - nonzero error code, see the list of standard error codes in include/petscerror.h 563 564 Level: beginner 565 566 Notes: 567 Once the error handler throws a ??? exception. 568 569 You can use CHKERRV() which returns without an error code (bad idea since the error is ignored) 570 or CHKERRABORT(comm,n) to have MPI_Abort() returned immediately. 571 572 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKERRQ(), CHKMEMQ 573 M*/ 574 #define CHKERRXX(ierr) do {if (PetscUnlikely(ierr)) {PetscError(PETSC_COMM_SELF,__LINE__,PETSC_FUNCTION_NAME,__FILE__,ierr,PETSC_ERROR_IN_CXX,0);}} while (0) 575 576 #endif 577 578 #if defined(PETSC_HAVE_CUDA) 579 #define CHKERRCUSOLVER(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"CUSOLVER error %d",err);} while (0) 580 #endif 581 /* TODO: SEK: Need to figure out the hipsolver issues */ 582 #if defined(PETSC_HAVE_HIP) 583 #define CHKERRHIPSOLVER(err) do {if (PetscUnlikely(err)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"HIPSOLVER error %d",err);} while (0) 584 #endif 585 /*MC 586 CHKMEMQ - Checks the memory for corruption, calls error handler if any is detected 587 588 Synopsis: 589 #include <petscsys.h> 590 CHKMEMQ; 591 592 Not Collective 593 594 Level: beginner 595 596 Notes: 597 We highly recommend using valgrind https://www.mcs.anl.gov/petsc/documentation/faq.html#valgrind for finding memory problems. This is useful 598 on systems that do not have valgrind, but much much less useful. 599 600 Must run with the option -malloc_debug (-malloc_test in debug mode; or if PetscMallocSetDebug() called) to enable this option 601 602 Once the error handler is called the calling function is then returned from with the given error code. 603 604 By defaults prints location where memory that is corrupted was allocated. 605 606 Use CHKMEMA for functions that return void 607 608 .seealso: PetscTraceBackErrorHandler(), PetscPushErrorHandler(), PetscError(), SETERRQ(), CHKMEMQ, SETERRQ1(), SETERRQ2(), SETERRQ3(), 609 PetscMallocValidate() 610 M*/ 611 #define CHKMEMQ do {PetscErrorCode _7_ierr = PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__);CHKERRQ(_7_ierr);} while (0) 612 613 #define CHKMEMA PetscMallocValidate(__LINE__,PETSC_FUNCTION_NAME,__FILE__) 614 615 /*E 616 PetscErrorType - passed to the PETSc error handling routines indicating if this is the first or a later call to the error handlers 617 618 Level: advanced 619 620 PETSC_ERROR_IN_CXX indicates the error was detected in C++ and an exception should be generated 621 622 Developer Notes: 623 This is currently used to decide when to print the detailed information about the run in PetscTraceBackErrorHandler() 624 625 .seealso: PetscError(), SETERRXX() 626 E*/ 627 typedef enum {PETSC_ERROR_INITIAL=0,PETSC_ERROR_REPEAT=1,PETSC_ERROR_IN_CXX = 2} PetscErrorType; 628 629 #if defined(__clang_analyzer__) 630 __attribute__((analyzer_noreturn)) 631 #endif 632 PETSC_EXTERN PetscErrorCode PetscError(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,...); 633 634 PETSC_EXTERN PetscErrorCode PetscErrorPrintfInitialize(void); 635 PETSC_EXTERN PetscErrorCode PetscErrorMessage(int,const char*[],char **); 636 PETSC_EXTERN PetscErrorCode PetscTraceBackErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 637 PETSC_EXTERN PetscErrorCode PetscIgnoreErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 638 PETSC_EXTERN PetscErrorCode PetscEmacsClientErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 639 PETSC_EXTERN PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 640 PETSC_EXTERN PetscErrorCode PetscAbortErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 641 PETSC_EXTERN PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 642 PETSC_EXTERN PetscErrorCode PetscReturnErrorHandler(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*); 643 PETSC_EXTERN PetscErrorCode PetscPushErrorHandler(PetscErrorCode (*handler)(MPI_Comm,int,const char*,const char*,PetscErrorCode,PetscErrorType,const char*,void*),void*); 644 PETSC_EXTERN PetscErrorCode PetscPopErrorHandler(void); 645 PETSC_EXTERN PetscErrorCode PetscSignalHandlerDefault(int,void*); 646 PETSC_EXTERN PetscErrorCode PetscPushSignalHandler(PetscErrorCode (*)(int,void *),void*); 647 PETSC_EXTERN PetscErrorCode PetscPopSignalHandler(void); 648 PETSC_EXTERN PetscErrorCode PetscCheckPointerSetIntensity(PetscInt); 649 PETSC_EXTERN void PetscSignalSegvCheckPointerOrMpi(void); 650 PETSC_DEPRECATED_FUNCTION("Use PetscSignalSegvCheckPointerOrMpi() (since version 3.13)") PETSC_STATIC_INLINE void PetscSignalSegvCheckPointer(void) {PetscSignalSegvCheckPointerOrMpi();} 651 652 /*MC 653 PetscErrorPrintf - Prints error messages. 654 655 Synopsis: 656 #include <petscsys.h> 657 PetscErrorCode (*PetscErrorPrintf)(const char format[],...); 658 659 Not Collective 660 661 Input Parameters: 662 . format - the usual printf() format string 663 664 Options Database Keys: 665 + -error_output_stdout - cause error messages to be printed to stdout instead of the (default) stderr 666 - -error_output_none - to turn off all printing of error messages (does not change the way the error is handled.) 667 668 Notes: 669 Use 670 $ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the 671 $ error is handled.) and 672 $ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on or you can use your own function 673 674 Use 675 PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file. 676 PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file. 677 678 Use 679 PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print 680 681 Level: developer 682 683 Fortran Note: 684 This routine is not supported in Fortran. 685 686 687 .seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscPushErrorHandler(), PetscVFPrintf(), PetscHelpPrintf() 688 M*/ 689 PETSC_EXTERN PetscErrorCode (*PetscErrorPrintf)(const char[],...); 690 691 typedef enum {PETSC_FP_TRAP_OFF=0,PETSC_FP_TRAP_ON=1} PetscFPTrap; 692 PETSC_EXTERN PetscErrorCode PetscSetFPTrap(PetscFPTrap); 693 PETSC_EXTERN PetscErrorCode PetscFPTrapPush(PetscFPTrap); 694 PETSC_EXTERN PetscErrorCode PetscFPTrapPop(void); 695 PETSC_EXTERN PetscErrorCode PetscDetermineInitialFPTrap(void); 696 697 /* 698 Allows the code to build a stack frame as it runs 699 */ 700 701 #define PETSCSTACKSIZE 64 702 703 typedef struct { 704 const char *function[PETSCSTACKSIZE]; 705 const char *file[PETSCSTACKSIZE]; 706 int line[PETSCSTACKSIZE]; 707 PetscBool petscroutine[PETSCSTACKSIZE]; 708 int currentsize; 709 int hotdepth; 710 } PetscStack; 711 712 PETSC_EXTERN PetscStack *petscstack; 713 714 PetscErrorCode PetscStackCopy(PetscStack*,PetscStack*); 715 PetscErrorCode PetscStackPrint(PetscStack *,FILE*); 716 #if defined(PETSC_SERIALIZE_FUNCTIONS) 717 #include <petsc/private/petscfptimpl.h> 718 /* 719 Registers the current function into the global function pointer to function name table 720 721 Have to fix this to handle errors but cannot return error since used in PETSC_VIEWER_DRAW_() etc 722 */ 723 #define PetscRegister__FUNCT__() do { \ 724 static PetscBool __chked = PETSC_FALSE; \ 725 if (!__chked) {\ 726 void *ptr; PetscDLSym(NULL,PETSC_FUNCTION_NAME,&ptr);\ 727 __chked = PETSC_TRUE;\ 728 }} while (0) 729 #else 730 #define PetscRegister__FUNCT__() 731 #endif 732 733 #if defined(PETSC_USE_DEBUG) 734 PETSC_STATIC_INLINE PetscBool PetscStackActive(void) 735 { 736 return(petscstack ? PETSC_TRUE : PETSC_FALSE); 737 } 738 739 /* Stack handling is based on the following two "NoCheck" macros. These should only be called directly by other error 740 * handling macros. We record the line of the call, which may or may not be the location of the definition. But is at 741 * least more useful than "unknown" because it can distinguish multiple calls from the same function. 742 */ 743 744 #define PetscStackPushNoCheck(funct,petsc_routine,hot) \ 745 do { \ 746 PetscStackSAWsTakeAccess(); \ 747 if (petscstack && (petscstack->currentsize < PETSCSTACKSIZE)) { \ 748 petscstack->function[petscstack->currentsize] = funct; \ 749 petscstack->file[petscstack->currentsize] = __FILE__; \ 750 petscstack->line[petscstack->currentsize] = __LINE__; \ 751 petscstack->petscroutine[petscstack->currentsize] = petsc_routine; \ 752 petscstack->currentsize++; \ 753 } \ 754 if (petscstack) { \ 755 petscstack->hotdepth += (hot || petscstack->hotdepth); \ 756 } \ 757 PetscStackSAWsGrantAccess(); \ 758 } while (0) 759 760 #define PetscStackPopNoCheck \ 761 do { \ 762 PetscStackSAWsTakeAccess(); \ 763 if (petscstack && petscstack->currentsize > 0) { \ 764 petscstack->currentsize--; \ 765 petscstack->function[petscstack->currentsize] = NULL; \ 766 petscstack->file[petscstack->currentsize] = NULL; \ 767 petscstack->line[petscstack->currentsize] = 0; \ 768 petscstack->petscroutine[petscstack->currentsize] = PETSC_FALSE;\ 769 } \ 770 if (petscstack) { \ 771 petscstack->hotdepth = PetscMax(petscstack->hotdepth-1,0); \ 772 } \ 773 PetscStackSAWsGrantAccess(); \ 774 } while (0) 775 776 /*MC 777 PetscFunctionBegin - First executable line of each PETSc function, used for error handling. Final 778 line of PETSc functions should be PetscFunctionReturn(0); 779 780 Synopsis: 781 #include <petscsys.h> 782 void PetscFunctionBegin; 783 784 Not Collective 785 786 Usage: 787 .vb 788 int something; 789 790 PetscFunctionBegin; 791 .ve 792 793 Notes: 794 Use PetscFunctionBeginUser for application codes. 795 796 Not available in Fortran 797 798 Level: developer 799 800 .seealso: PetscFunctionReturn(), PetscFunctionBeginHot(), PetscFunctionBeginUser() 801 802 M*/ 803 #define PetscFunctionBegin do { \ 804 PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_FALSE); \ 805 PetscRegister__FUNCT__(); \ 806 } while (0) 807 808 /*MC 809 PetscFunctionBeginHot - Substitute for PetscFunctionBegin to be used in functions that are called in 810 performance-critical circumstances. Use of this function allows for lighter profiling by default. 811 812 Synopsis: 813 #include <petscsys.h> 814 void PetscFunctionBeginHot; 815 816 Not Collective 817 818 Usage: 819 .vb 820 int something; 821 822 PetscFunctionBeginHot; 823 .ve 824 825 Notes: 826 Not available in Fortran 827 828 Level: developer 829 830 .seealso: PetscFunctionBegin, PetscFunctionReturn() 831 832 M*/ 833 #define PetscFunctionBeginHot do { \ 834 PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_TRUE,PETSC_TRUE); \ 835 PetscRegister__FUNCT__(); \ 836 } while (0) 837 838 /*MC 839 PetscFunctionBeginUser - First executable line of user provided PETSc routine 840 841 Synopsis: 842 #include <petscsys.h> 843 void PetscFunctionBeginUser; 844 845 Not Collective 846 847 Usage: 848 .vb 849 int something; 850 851 PetscFunctionBeginUser; 852 .ve 853 854 Notes: 855 Final line of PETSc functions should be PetscFunctionReturn(0) except for main(). 856 857 Not available in Fortran 858 859 This is identical to PetscFunctionBegin except it labels the routine as a user 860 routine instead of as a PETSc library routine. 861 862 Level: intermediate 863 864 .seealso: PetscFunctionReturn(), PetscFunctionBegin, PetscFunctionBeginHot 865 866 M*/ 867 #define PetscFunctionBeginUser \ 868 do { \ 869 PetscStackPushNoCheck(PETSC_FUNCTION_NAME,PETSC_FALSE,PETSC_FALSE); \ 870 PetscRegister__FUNCT__(); \ 871 } while (0) 872 873 874 #define PetscStackPush(n) \ 875 do { \ 876 PetscStackPushNoCheck(n,PETSC_FALSE,PETSC_FALSE); \ 877 CHKMEMQ; \ 878 } while (0) 879 880 #define PetscStackPop \ 881 do { \ 882 CHKMEMQ; \ 883 PetscStackPopNoCheck; \ 884 } while (0) 885 886 /*MC 887 PetscFunctionReturn - Last executable line of each PETSc function 888 used for error handling. Replaces return() 889 890 Synopsis: 891 #include <petscsys.h> 892 void PetscFunctionReturn(0); 893 894 Not Collective 895 896 Usage: 897 .vb 898 .... 899 PetscFunctionReturn(0); 900 } 901 .ve 902 903 Notes: 904 Not available in Fortran 905 906 Level: developer 907 908 .seealso: PetscFunctionBegin() 909 910 M*/ 911 #define PetscFunctionReturn(a) \ 912 do { \ 913 PetscStackPopNoCheck; \ 914 return(a);} while (0) 915 916 #define PetscFunctionReturnVoid() \ 917 do { \ 918 PetscStackPopNoCheck; \ 919 return;} while (0) 920 921 #else 922 923 PETSC_STATIC_INLINE PetscBool PetscStackActive(void) {return PETSC_FALSE;} 924 #define PetscStackPushNoCheck(funct,petsc_routine,hot) do {} while (0) 925 #define PetscStackPopNoCheck do {} while (0) 926 #define PetscFunctionBegin 927 #define PetscFunctionBeginUser 928 #define PetscFunctionBeginHot 929 #define PetscFunctionReturn(a) return(a) 930 #define PetscFunctionReturnVoid() return 931 #define PetscStackPop CHKMEMQ 932 #define PetscStackPush(f) CHKMEMQ 933 934 #endif 935 936 /* 937 PetscStackCall - Calls an external library routine or user function after pushing the name of the routine on the stack. 938 939 Input Parameters: 940 + name - string that gives the name of the function being called 941 - routine - actual call to the routine, including ierr = and CHKERRQ(ierr); 942 943 Note: Often one should use PetscStackCallStandard() instead. This routine is intended for external library routines that DO NOT return error codes 944 945 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. 946 947 948 949 */ 950 #define PetscStackCall(name,routine) do { PetscStackPush(name);routine;PetscStackPop; } while (0) 951 952 /* 953 PetscStackCallStandard - Calls an external library routine after pushing the name of the routine on the stack. 954 955 Input Parameters: 956 + func- name of the routine 957 - args - arguments to the routine surrounded by () 958 959 Notes: 960 This is intended for external package routines that return error codes. Use PetscStackCall() for those that do not. 961 962 Developer Note: this is so that when an external packge routine results in a crash or corrupts memory, they get blamed instead of PETSc. 963 964 */ 965 #define PetscStackCallStandard(func,args) do { \ 966 PetscErrorCode __ierr; \ 967 PetscStackPush(#func); \ 968 __ierr = func args; \ 969 PetscStackPop; \ 970 if (__ierr) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error in %s(): error code %d",#func,(int)__ierr); \ 971 } while (0) 972 973 PETSC_EXTERN PetscErrorCode PetscStackCreate(void); 974 PETSC_EXTERN PetscErrorCode PetscStackView(FILE*); 975 PETSC_EXTERN PetscErrorCode PetscStackDestroy(void); 976 977 #endif 978