xref: /petsc/src/sys/error/errstop.c (revision e8fb0fc05573aa974b3f79797ad519d0316ca217)
1e5c89e4eSSatish Balay #define PETSC_DLL
2e5c89e4eSSatish Balay 
3e5c89e4eSSatish Balay #include "petsc.h"           /*I "petsc.h" I*/
4e5c89e4eSSatish Balay 
5e5c89e4eSSatish Balay #undef __FUNCT__
6*e8fb0fc0SBarry Smith #define __FUNCT__ "PetscMPIAbortErrorHandler"
7e5c89e4eSSatish Balay /*@C
8*e8fb0fc0SBarry Smith    PetscMPIAbortErrorHandler - Calls MPI_abort() and exits.
9e5c89e4eSSatish Balay 
10e5c89e4eSSatish Balay    Not Collective
11e5c89e4eSSatish Balay 
12e5c89e4eSSatish Balay    Input Parameters:
13e5c89e4eSSatish Balay +  line - the line number of the error (indicated by __LINE__)
14e5c89e4eSSatish Balay .  fun - the function where the error occurred (indicated by __FUNCT__)
15e5c89e4eSSatish Balay .  file - the file in which the error was detected (indicated by __FILE__)
16e5c89e4eSSatish Balay .  dir - the directory of the file (indicated by __SDIR__)
17e5c89e4eSSatish Balay .  mess - an error text string, usually just printed to the screen
18e5c89e4eSSatish Balay .  n - the generic error number
19e5c89e4eSSatish Balay .  p - the specific error number
20e5c89e4eSSatish Balay -  ctx - error handler context
21e5c89e4eSSatish Balay 
22e5c89e4eSSatish Balay    Level: developer
23e5c89e4eSSatish Balay 
24e5c89e4eSSatish Balay    Notes:
25e5c89e4eSSatish Balay    Most users need not directly employ this routine and the other error
26e5c89e4eSSatish Balay    handlers, but can instead use the simplified interface SETERRQ, which has
27e5c89e4eSSatish Balay    the calling sequence
28e5c89e4eSSatish Balay $     SETERRQ(n,p,mess)
29e5c89e4eSSatish Balay 
30e5c89e4eSSatish Balay    Notes for experienced users:
31e5c89e4eSSatish Balay    Use PetscPushErrorHandler() to set the desired error handler.  The
32e5c89e4eSSatish Balay    currently available PETSc error handlers include PetscTraceBackErrorHandler(),
33*e8fb0fc0SBarry Smith    PetscMPIAbortErrorHandler(), PetscAttachDebuggerErrorHandler(), and PetscAbortErrorHandler().
34e5c89e4eSSatish Balay 
35e5c89e4eSSatish Balay    Concepts: error handler^stopping
36e5c89e4eSSatish Balay 
37e5c89e4eSSatish Balay .seealso:  PetscPushErrorHandler(), PetscAttachDebuggerErrorHandler(),
38e5c89e4eSSatish Balay            PetscAbortErrorHandler(), PetscTraceBackErrorHandler()
39e5c89e4eSSatish Balay  @*/
40*e8fb0fc0SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscMPIAbortErrorHandler(int line,const char *fun,const char *file,const char *dir,PetscErrorCode n,int p,const char *mess,void *ctx)
41e5c89e4eSSatish Balay {
42e5c89e4eSSatish Balay   PetscTruth     flg1,flg2;
43e5c89e4eSSatish Balay   PetscLogDouble mem,rss;
44e5c89e4eSSatish Balay 
45e5c89e4eSSatish Balay   PetscFunctionBegin;
46e5c89e4eSSatish Balay   if (!mess) mess = " ";
47e5c89e4eSSatish Balay 
48e5c89e4eSSatish Balay   if (n == PETSC_ERR_MEM) {
49e5c89e4eSSatish Balay     (*PetscErrorPrintf)("%s() line %d in %s%s\n",fun,line,dir,file);
50e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Out of memory. This could be due to allocating\n");
51e5c89e4eSSatish Balay     (*PetscErrorPrintf)("too large an object or bleeding by not properly\n");
52e5c89e4eSSatish Balay     (*PetscErrorPrintf)("destroying unneeded objects.\n");
53e5c89e4eSSatish Balay     PetscMallocGetCurrentUsage(&mem); PetscMemoryGetCurrentUsage(&rss);
54e5c89e4eSSatish Balay     PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);
55e5c89e4eSSatish Balay     PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg2);
56e5c89e4eSSatish Balay     if (flg2) {
57e5c89e4eSSatish Balay       PetscMallocDumpLog(stdout);
58e5c89e4eSSatish Balay     } else {
59e5c89e4eSSatish Balay       (*PetscErrorPrintf)("Memory allocated %D Memory used by process %D\n",(PetscInt)mem,(PetscInt)rss);
60e5c89e4eSSatish Balay       if (flg1) {
61e5c89e4eSSatish Balay         PetscMallocDump(stdout);
62e5c89e4eSSatish Balay       }  else {
63e5c89e4eSSatish Balay         (*PetscErrorPrintf)("Try running with -malloc_dump or -malloc_log for info.\n");
64e5c89e4eSSatish Balay       }
65e5c89e4eSSatish Balay     }
66e5c89e4eSSatish Balay   } else if (n == PETSC_ERR_SUP) {
67e5c89e4eSSatish Balay     (*PetscErrorPrintf)("%s() line %d in %s%s\n",fun,line,dir,file);
68e5c89e4eSSatish Balay     (*PetscErrorPrintf)("No support for this operation for this object type!\n");
69e5c89e4eSSatish Balay     (*PetscErrorPrintf)("%s\n",mess);
70e5c89e4eSSatish Balay   } else if (n == PETSC_ERR_SIG) {
71e5c89e4eSSatish Balay     (*PetscErrorPrintf)("%s() line %d in %s%s %s\n",fun,line,dir,file,mess);
72e5c89e4eSSatish Balay   } else {
73e5c89e4eSSatish Balay     (*PetscErrorPrintf)("%s() line %d in %s%s\n    %s\n",fun,line,dir,file,mess);
74e5c89e4eSSatish Balay   }
75e5c89e4eSSatish Balay   MPI_Abort(PETSC_COMM_WORLD,n);
76e5c89e4eSSatish Balay   PetscFunctionReturn(0);
77e5c89e4eSSatish Balay }
78e5c89e4eSSatish Balay 
79