xref: /petsc/src/sys/error/errstop.c (revision a3b724e88d046d3fedf46cc78f622355d8be981f)
1c6db04a5SJed Brown #include <petscsys.h> /*I "petscsys.h" I*/
29beb8f72SToby Isaac #include "err.h"
3e5c89e4eSSatish Balay 
4e5c89e4eSSatish Balay /*@C
5*a3b724e8SBarry Smith   PetscMPIAbortErrorHandler - Calls `PETSCABORT()` and exits.
6e5c89e4eSSatish Balay 
7*a3b724e8SBarry Smith   Not Collective, No Fortran Support
8e5c89e4eSSatish Balay 
9e5c89e4eSSatish Balay   Input Parameters:
10e32f2f54SBarry Smith + comm - communicator over which error occurred
11*a3b724e8SBarry Smith . line - the line number of the error (indicated by `__LINE__`)
1210450e9eSJacob Faibussowitsch . fun  - the function name
13*a3b724e8SBarry Smith . file - the file in which the error was detected (indicated by `__FILE__`)
14e5c89e4eSSatish Balay . mess - an error text string, usually just printed to the screen
15e5c89e4eSSatish Balay . n    - the generic error number
16811af0c4SBarry Smith . p    - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
17e5c89e4eSSatish Balay - ctx  - error handler context
18e5c89e4eSSatish Balay 
19e5c89e4eSSatish Balay   Level: developer
20e5c89e4eSSatish Balay 
21811af0c4SBarry Smith   Note:
22811af0c4SBarry Smith   Users do not directly call this routine
23e5c89e4eSSatish Balay 
24811af0c4SBarry Smith   Use `PetscPushErrorHandler()` to set the desired error handler.  The
25811af0c4SBarry Smith   currently available PETSc error handlers include `PetscTraceBackErrorHandler()`,
26811af0c4SBarry Smith   `PetscMPIAbortErrorHandler()`, `PetscAttachDebuggerErrorHandler()`, and `PetscAbortErrorHandler()`.
27e5c89e4eSSatish Balay 
28db781477SPatrick Sanan .seealso: `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscAttachDebuggerErrorHandler()`,
2942747ad1SJacob Faibussowitsch           `PetscAbortErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`
30e5c89e4eSSatish Balay  @*/
31d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx)
32d71ae5a4SJacob Faibussowitsch {
333ba16761SJacob Faibussowitsch   PetscErrorCode ierr;
34e5c89e4eSSatish Balay 
35e5c89e4eSSatish Balay   PetscFunctionBegin;
36e5c89e4eSSatish Balay   if (!mess) mess = " ";
37e5c89e4eSSatish Balay 
389beb8f72SToby Isaac   if (n == PETSC_ERR_MEM || n == PETSC_ERR_MEM_LEAK) ierr = PetscErrorMemoryMessage(n);
399beb8f72SToby Isaac   else if (n == PETSC_ERR_SUP) {
403ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("%s() at %s:%d\n", fun, file, line);
413ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("No support for this operation for this object type!\n");
423ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("%s\n", mess);
433ba16761SJacob Faibussowitsch   } else if (n == PETSC_ERR_SIG) ierr = (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
443ba16761SJacob Faibussowitsch   else ierr = (*PetscErrorPrintf)("%s() at %s:%d\n    %s\n", fun, file, line, mess);
45a297a907SKarl Rupp 
463ba16761SJacob Faibussowitsch   (void)ierr;
4741e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, n);
483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
49e5c89e4eSSatish Balay }
50