xref: /petsc/src/sys/error/errstop.c (revision 9beb8f72dd58d2ce55d44622ce71b2d5a78570d3)
1e5c89e4eSSatish Balay 
2c6db04a5SJed Brown #include <petscsys.h> /*I "petscsys.h" I*/
3*9beb8f72SToby Isaac #include "err.h"
4e5c89e4eSSatish Balay 
5e5c89e4eSSatish Balay /*@C
641e02c4dSJunchao Zhang   PetscMPIAbortErrorHandler - Calls PETSCABORT and exits.
7e5c89e4eSSatish Balay 
8e5c89e4eSSatish Balay   Not Collective
9e5c89e4eSSatish Balay 
10e5c89e4eSSatish Balay   Input Parameters:
11e32f2f54SBarry Smith + comm - communicator over which error occurred
12e32f2f54SBarry Smith . line - the line number of the error (indicated by __LINE__)
1310450e9eSJacob Faibussowitsch . fun  - the function name
14e5c89e4eSSatish Balay . file - the file in which the error was detected (indicated by __FILE__)
15e5c89e4eSSatish Balay . mess - an error text string, usually just printed to the screen
16e5c89e4eSSatish Balay . n    - the generic error number
17811af0c4SBarry Smith . p    - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
18e5c89e4eSSatish Balay - ctx  - error handler context
19e5c89e4eSSatish Balay 
20e5c89e4eSSatish Balay   Level: developer
21e5c89e4eSSatish Balay 
22811af0c4SBarry Smith   Note:
23811af0c4SBarry Smith   Users do not directly call this routine
24e5c89e4eSSatish Balay 
25811af0c4SBarry Smith   Use `PetscPushErrorHandler()` to set the desired error handler.  The
26811af0c4SBarry Smith   currently available PETSc error handlers include `PetscTraceBackErrorHandler()`,
27811af0c4SBarry Smith   `PetscMPIAbortErrorHandler()`, `PetscAttachDebuggerErrorHandler()`, and `PetscAbortErrorHandler()`.
28e5c89e4eSSatish Balay 
29db781477SPatrick Sanan .seealso: `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscAttachDebuggerErrorHandler()`,
3042747ad1SJacob Faibussowitsch           `PetscAbortErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`
31e5c89e4eSSatish Balay  @*/
32d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx)
33d71ae5a4SJacob Faibussowitsch {
343ba16761SJacob Faibussowitsch   PetscErrorCode ierr;
35e5c89e4eSSatish Balay 
36e5c89e4eSSatish Balay   PetscFunctionBegin;
37e5c89e4eSSatish Balay   if (!mess) mess = " ";
38e5c89e4eSSatish Balay 
39*9beb8f72SToby Isaac   if (n == PETSC_ERR_MEM || n == PETSC_ERR_MEM_LEAK) ierr = PetscErrorMemoryMessage(n);
40*9beb8f72SToby Isaac   else if (n == PETSC_ERR_SUP) {
413ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("%s() at %s:%d\n", fun, file, line);
423ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("No support for this operation for this object type!\n");
433ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("%s\n", mess);
443ba16761SJacob Faibussowitsch   } else if (n == PETSC_ERR_SIG) ierr = (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
453ba16761SJacob Faibussowitsch   else ierr = (*PetscErrorPrintf)("%s() at %s:%d\n    %s\n", fun, file, line, mess);
46a297a907SKarl Rupp 
473ba16761SJacob Faibussowitsch   (void)ierr;
4841e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, n);
493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
50e5c89e4eSSatish Balay }
51