xref: /petsc/src/sys/error/errstop.c (revision a69119a591a03a9d906b29c0a4e9802e4d7c9795)
1 
2 #include <petscsys.h> /*I "petscsys.h" I*/
3 
4 /*@C
5    PetscMPIAbortErrorHandler - Calls PETSCABORT and exits.
6 
7    Not Collective
8 
9    Input Parameters:
10 +  comm - communicator over which error occurred
11 .  line - the line number of the error (indicated by __LINE__)
12 .  file - the file in which the error was detected (indicated by __FILE__)
13 .  mess - an error text string, usually just printed to the screen
14 .  n - the generic error number
15 .  p - PETSC_ERROR_INITIAL if error just detected, otherwise PETSC_ERROR_REPEAT
16 -  ctx - error handler context
17 
18    Level: developer
19 
20    Notes:
21    Most users need not directly employ this routine and the other error
22    handlers, but can instead use the simplified interface SETERRQ, which has
23    the calling sequence
24 $     SETERRQ(comm,n,p,mess)
25 
26    Notes for experienced users:
27    Use PetscPushErrorHandler() to set the desired error handler.  The
28    currently available PETSc error handlers include PetscTraceBackErrorHandler(),
29    PetscMPIAbortErrorHandler(), PetscAttachDebuggerErrorHandler(), and PetscAbortErrorHandler().
30 
31 .seealso: `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscAttachDebuggerErrorHandler()`,
32           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscTraceBackErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`
33  @*/
34 PetscErrorCode PetscMPIAbortErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode n, PetscErrorType p, const char *mess, void *ctx) {
35   PetscBool      flg1 = PETSC_FALSE, flg2 = PETSC_FALSE, flg3 = PETSC_FALSE;
36   PetscLogDouble mem, rss;
37 
38   PetscFunctionBegin;
39   if (!mess) mess = " ";
40 
41   if (n == PETSC_ERR_MEM) {
42     (*PetscErrorPrintf)("%s() at %s:%d\n", fun, file, line);
43     (*PetscErrorPrintf)("Out of memory. This could be due to allocating\n");
44     (*PetscErrorPrintf)("too large an object or bleeding by not properly\n");
45     (*PetscErrorPrintf)("destroying unneeded objects.\n");
46     PetscMallocGetCurrentUsage(&mem);
47     PetscMemoryGetCurrentUsage(&rss);
48     PetscOptionsGetBool(NULL, NULL, "-malloc_dump", &flg1, NULL);
49     PetscOptionsGetBool(NULL, NULL, "-malloc_view", &flg2, NULL);
50     PetscOptionsHasName(NULL, NULL, "-malloc_view_threshold", &flg3);
51     if (flg2 || flg3) PetscMallocView(stdout);
52     else {
53       (*PetscErrorPrintf)("Memory allocated %.0f Memory used by process %.0f\n", mem, rss);
54       if (flg1) PetscMallocDump(stdout);
55       else (*PetscErrorPrintf)("Try running with -malloc_dump or -malloc_view for info.\n");
56     }
57   } else if (n == PETSC_ERR_SUP) {
58     (*PetscErrorPrintf)("%s() at %s:%d\n", fun, file, line);
59     (*PetscErrorPrintf)("No support for this operation for this object type!\n");
60     (*PetscErrorPrintf)("%s\n", mess);
61   } else if (n == PETSC_ERR_SIG) (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
62   else (*PetscErrorPrintf)("%s() at %s:%d\n    %s\n", fun, file, line, mess);
63 
64   PETSCABORT(PETSC_COMM_WORLD, n);
65   PetscFunctionReturn(0);
66 }
67