xref: /petsc/src/sys/objects/init.c (revision da9f1d6b25924a16baf1fafcd5e58fa8eaafd3cf)
1e5c89e4eSSatish Balay #define PETSC_DLL
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay 
4e5c89e4eSSatish Balay    This file defines part of the initialization of PETSc
5e5c89e4eSSatish Balay 
6e5c89e4eSSatish Balay   This file uses regular malloc and free because it cannot know
7e5c89e4eSSatish Balay   what malloc is being used until it has already processed the input.
8e5c89e4eSSatish Balay */
9e5c89e4eSSatish Balay 
10e5c89e4eSSatish Balay #include "petsc.h"        /*I  "petsc.h"   I*/
11e5c89e4eSSatish Balay #include "petscsys.h"
12e5c89e4eSSatish Balay #if defined(PETSC_HAVE_STDLIB_H)
13e5c89e4eSSatish Balay #include <stdlib.h>
14e5c89e4eSSatish Balay #endif
15e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MALLOC_H)
16e5c89e4eSSatish Balay #include <malloc.h>
17e5c89e4eSSatish Balay #endif
18e5c89e4eSSatish Balay #include "petscfix.h"
19e5c89e4eSSatish Balay 
20e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
21e5c89e4eSSatish Balay /*
22e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
23e5c89e4eSSatish Balay    already started before PETSc was initialized.
24e5c89e4eSSatish Balay */
25e5c89e4eSSatish Balay PetscTruth  PETSC_DLLEXPORT PetscBeganMPI         = PETSC_FALSE;
26e5c89e4eSSatish Balay PetscTruth  PETSC_DLLEXPORT PetscInitializeCalled = PETSC_FALSE;
27e5c89e4eSSatish Balay PetscTruth  PETSC_DLLEXPORT PetscFinalizeCalled   = PETSC_FALSE;
28e5c89e4eSSatish Balay PetscMPIInt PETSC_DLLEXPORT PetscGlobalRank = -1;
29e5c89e4eSSatish Balay PetscMPIInt PETSC_DLLEXPORT PetscGlobalSize = -1;
30e5c89e4eSSatish Balay 
31e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
32e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
33e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
34e5c89e4eSSatish Balay #endif
35e5c89e4eSSatish Balay MPI_Datatype  PETSC_DLLEXPORT MPIU_COMPLEX;
36e5c89e4eSSatish Balay PetscScalar   PETSC_DLLEXPORT PETSC_i;
37e5c89e4eSSatish Balay #else
38e5c89e4eSSatish Balay PetscScalar   PETSC_DLLEXPORT PETSC_i = 0.0;
39e5c89e4eSSatish Balay #endif
40e5c89e4eSSatish Balay MPI_Datatype  PETSC_DLLEXPORT MPIU_2SCALAR = 0;
41e5c89e4eSSatish Balay MPI_Datatype  PETSC_DLLEXPORT MPIU_2INT = 0;
42e5c89e4eSSatish Balay /*
43e5c89e4eSSatish Balay      These are needed by petscbt.h
44e5c89e4eSSatish Balay */
45e5c89e4eSSatish Balay char     PETSC_DLLEXPORT _BT_mask = ' ';
46e5c89e4eSSatish Balay char     PETSC_DLLEXPORT _BT_c = ' ';
47e5c89e4eSSatish Balay PetscInt PETSC_DLLEXPORT _BT_idx  = 0;
48e5c89e4eSSatish Balay 
49e5c89e4eSSatish Balay /*
50e5c89e4eSSatish Balay        Function that is called to display all error messages
51e5c89e4eSSatish Balay */
52e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
53e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
54e5c89e4eSSatish Balay 
55e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
56e5c89e4eSSatish Balay /*
57e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
58e5c89e4eSSatish Balay */
59e5c89e4eSSatish Balay FILE *petsc_history = PETSC_NULL;
60e5c89e4eSSatish Balay 
61e5c89e4eSSatish Balay #undef __FUNCT__
62e5c89e4eSSatish Balay #define __FUNCT__ "PetscLogOpenHistoryFile"
63e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscLogOpenHistoryFile(const char filename[],FILE **fd)
64e5c89e4eSSatish Balay {
65e5c89e4eSSatish Balay   PetscErrorCode ierr;
66e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
67e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
68e5c89e4eSSatish Balay   char           version[256];
69e5c89e4eSSatish Balay 
70e5c89e4eSSatish Balay   PetscFunctionBegin;
71e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
72e5c89e4eSSatish Balay   if (!rank) {
73e5c89e4eSSatish Balay     char arch[10];
74e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
75e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
763f6e4ae9SSatish Balay     ierr = PetscGetVersion(&version,256);CHKERRQ(ierr);
77e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
78e5c89e4eSSatish Balay     if (filename) {
79e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
80e5c89e4eSSatish Balay     } else {
81e5c89e4eSSatish Balay       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
82e5c89e4eSSatish Balay       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
83e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
84e5c89e4eSSatish Balay     }
85e5c89e4eSSatish Balay 
86e5c89e4eSSatish Balay     *fd = fopen(fname,"a"); if (!fd) SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
87e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
88e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
89e5c89e4eSSatish Balay     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
90e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
91e5c89e4eSSatish Balay     ierr = PetscOptionsPrint(*fd);CHKERRQ(ierr);
92e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
93e5c89e4eSSatish Balay     fflush(*fd);
94e5c89e4eSSatish Balay   }
95e5c89e4eSSatish Balay   PetscFunctionReturn(0);
96e5c89e4eSSatish Balay }
97e5c89e4eSSatish Balay 
98e5c89e4eSSatish Balay #undef __FUNCT__
99e5c89e4eSSatish Balay #define __FUNCT__ "PetscLogCloseHistoryFile"
100e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscLogCloseHistoryFile(FILE **fd)
101e5c89e4eSSatish Balay {
102e5c89e4eSSatish Balay   PetscErrorCode ierr;
103e5c89e4eSSatish Balay   PetscMPIInt    rank;
104e5c89e4eSSatish Balay   char           date[64];
105e5c89e4eSSatish Balay 
106e5c89e4eSSatish Balay   PetscFunctionBegin;
107e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
108e5c89e4eSSatish Balay   if (!rank) {
109e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
110e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
111e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
112e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
113e5c89e4eSSatish Balay     fflush(*fd);
114e5c89e4eSSatish Balay     fclose(*fd);
115e5c89e4eSSatish Balay   }
116e5c89e4eSSatish Balay   PetscFunctionReturn(0);
117e5c89e4eSSatish Balay }
118e5c89e4eSSatish Balay 
119e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
120e5c89e4eSSatish Balay 
121e5c89e4eSSatish Balay /*
122e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
123e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
124e5c89e4eSSatish Balay 
125e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
126e5c89e4eSSatish Balay   frames. The default abort cleans up and exits.
127e5c89e4eSSatish Balay */
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay #undef __FUNCT__
130e5c89e4eSSatish Balay #define __FUNCT__ "Petsc_MPI_AbortOnError"
131e5c89e4eSSatish Balay void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag)
132e5c89e4eSSatish Balay {
133e5c89e4eSSatish Balay   PetscFunctionBegin;
134e5c89e4eSSatish Balay   (*PetscErrorPrintf)("MPI error %d\n",(int)*flag);
135e5c89e4eSSatish Balay   abort();
136e5c89e4eSSatish Balay }
137e5c89e4eSSatish Balay 
138e5c89e4eSSatish Balay #undef __FUNCT__
139e5c89e4eSSatish Balay #define __FUNCT__ "Petsc_MPI_DebuggerOnError"
140e5c89e4eSSatish Balay void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag)
141e5c89e4eSSatish Balay {
142e5c89e4eSSatish Balay   PetscErrorCode ierr;
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay   PetscFunctionBegin;
145e5c89e4eSSatish Balay   (*PetscErrorPrintf)("MPI error %d\n",(int)*flag);
146e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
147e5c89e4eSSatish Balay   if (ierr) { /* hopeless so get out */
148e5c89e4eSSatish Balay     MPI_Finalize();
149e5c89e4eSSatish Balay     exit(*flag);
150e5c89e4eSSatish Balay   }
151e5c89e4eSSatish Balay }
152e5c89e4eSSatish Balay 
153e5c89e4eSSatish Balay #undef __FUNCT__
154e5c89e4eSSatish Balay #define __FUNCT__ "PetscEnd"
155e5c89e4eSSatish Balay /*@C
156e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
157e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
160e5c89e4eSSatish Balay 
161e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay    Level: advanced
164e5c89e4eSSatish Balay 
165e5c89e4eSSatish Balay    Note:
166e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
167e5c89e4eSSatish Balay 
168e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscOptionsPrint(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
169e5c89e4eSSatish Balay @*/
170e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscEnd(void)
171e5c89e4eSSatish Balay {
172e5c89e4eSSatish Balay   PetscFunctionBegin;
173e5c89e4eSSatish Balay   PetscFinalize();
174e5c89e4eSSatish Balay   exit(0);
175e5c89e4eSSatish Balay   return 0;
176e5c89e4eSSatish Balay }
177e5c89e4eSSatish Balay 
178e5c89e4eSSatish Balay PetscTruth   PetscOptionsPublish = PETSC_FALSE;
179e5c89e4eSSatish Balay EXTERN PetscErrorCode        PetscSetUseTrMalloc_Private(void);
180e5c89e4eSSatish Balay extern PetscTruth petscsetmallocvisited;
181e5c89e4eSSatish Balay static char       emacsmachinename[256];
182e5c89e4eSSatish Balay 
183e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
184e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay #undef __FUNCT__
187e5c89e4eSSatish Balay #define __FUNCT__ "PetscSetHelpVersionFunctions"
188e5c89e4eSSatish Balay /*@C
189e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
190e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
191e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
192e5c89e4eSSatish Balay 
193e5c89e4eSSatish Balay    Input Parameter:
194e5c89e4eSSatish Balay +  help - the help function (may be PETSC_NULL)
195e5c89e4eSSatish Balay -  version - the version function (may be PETSc null)
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay    Level: developer
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay    Concepts: package help message
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay @*/
202e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
203e5c89e4eSSatish Balay {
204e5c89e4eSSatish Balay   PetscFunctionBegin;
205e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
206e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
207e5c89e4eSSatish Balay   PetscFunctionReturn(0);
208e5c89e4eSSatish Balay }
209e5c89e4eSSatish Balay 
210e5c89e4eSSatish Balay #undef __FUNCT__
211e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Private"
212e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscOptionsCheckInitial_Private(void)
213e5c89e4eSSatish Balay {
214e5c89e4eSSatish Balay   char           string[64],mname[PETSC_MAX_PATH_LEN],*f;
215e5c89e4eSSatish Balay   MPI_Comm       comm = PETSC_COMM_WORLD;
216e5c89e4eSSatish Balay   PetscTruth     flg1,flg2,flg3,flag;
217e5c89e4eSSatish Balay   PetscErrorCode ierr;
218e5c89e4eSSatish Balay   PetscInt       si;
219e5c89e4eSSatish Balay   int            i;
220e5c89e4eSSatish Balay   PetscMPIInt    rank;
221e5c89e4eSSatish Balay   char           version[256];
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay   PetscFunctionBegin;
224e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay   /*
227e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
228e5c89e4eSSatish Balay   */
229e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
230e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
231e5c89e4eSSatish Balay   ierr = PetscOptionsGetTruth(PETSC_NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
232e5c89e4eSSatish Balay   if ((!flg2 || flg1) && !petscsetmallocvisited) {
233e5c89e4eSSatish Balay     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
234e5c89e4eSSatish Balay   }
235e5c89e4eSSatish Balay #else
236e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
237e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc",&flg2);CHKERRQ(ierr);
238e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
239e5c89e4eSSatish Balay #endif
240e5c89e4eSSatish Balay   if (flg3) {
241e5c89e4eSSatish Balay     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
242e5c89e4eSSatish Balay   }
243e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_debug",&flg1);CHKERRQ(ierr);
244e5c89e4eSSatish Balay   if (flg1) {
245e5c89e4eSSatish Balay     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
246e5c89e4eSSatish Balay     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
247e5c89e4eSSatish Balay   }
248e5c89e4eSSatish Balay 
2497783f70dSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_info",&flg1);CHKERRQ(ierr);
2507783f70dSSatish Balay   if (!flg1) {
251e5c89e4eSSatish Balay     ierr = PetscOptionsHasName(PETSC_NULL,"-memory_info",&flg1);CHKERRQ(ierr);
2527783f70dSSatish Balay   }
253e5c89e4eSSatish Balay   if (flg1) {
254e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
255e5c89e4eSSatish Balay   }
256e5c89e4eSSatish Balay 
257e5c89e4eSSatish Balay   /*
258e5c89e4eSSatish Balay       Set the display variable for graphics
259e5c89e4eSSatish Balay   */
260e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
261e5c89e4eSSatish Balay 
262e5c89e4eSSatish Balay   /*
263e5c89e4eSSatish Balay       Print the PETSc version information
264e5c89e4eSSatish Balay   */
265e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-v",&flg1);CHKERRQ(ierr);
266e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-version",&flg2);CHKERRQ(ierr);
267e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg3);CHKERRQ(ierr);
268e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3){
269e5c89e4eSSatish Balay 
270e5c89e4eSSatish Balay     /*
271e5c89e4eSSatish Balay        Print "higher-level" package version message
272e5c89e4eSSatish Balay     */
273e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
274e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
275e5c89e4eSSatish Balay     }
276e5c89e4eSSatish Balay 
2773f6e4ae9SSatish Balay     ierr = PetscGetVersion(&version,256);CHKERRQ(ierr);
278e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
279e5c89e4eSSatish Balay ------------------------------\n");CHKERRQ(ierr);
280e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
281e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
282e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/copyright.html for copyright information\n");CHKERRQ(ierr);
283e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
284e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/troubleshooting.html for problems.\n");CHKERRQ(ierr);
285e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
286e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
287e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
288e5c89e4eSSatish Balay ------------------------------\n");CHKERRQ(ierr);
289e5c89e4eSSatish Balay   }
290e5c89e4eSSatish Balay 
291e5c89e4eSSatish Balay   /*
292e5c89e4eSSatish Balay        Print "higher-level" package help message
293e5c89e4eSSatish Balay   */
294e5c89e4eSSatish Balay   if (flg3){
295e5c89e4eSSatish Balay     if (PetscExternalHelpFunction) {
296e5c89e4eSSatish Balay       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
297e5c89e4eSSatish Balay     }
298e5c89e4eSSatish Balay   }
299e5c89e4eSSatish Balay 
300e5c89e4eSSatish Balay   /*
301e5c89e4eSSatish Balay       Setup the error handling
302e5c89e4eSSatish Balay   */
303e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-fp_trap",&flg1);CHKERRQ(ierr);
304e5c89e4eSSatish Balay   if (flg1) { ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr); }
305e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-on_error_abort",&flg1);CHKERRQ(ierr);
306e5c89e4eSSatish Balay   if (flg1) { ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr)}
307e8fb0fc0SBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-on_error_mpiabort",&flg1);CHKERRQ(ierr);
308e8fb0fc0SBarry Smith   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr)}
309e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-mpi_return_on_error",&flg1);CHKERRQ(ierr);
310e5c89e4eSSatish Balay   if (flg1) {
311e5c89e4eSSatish Balay     ierr = MPI_Errhandler_set(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
312e5c89e4eSSatish Balay   }
313e8fb0fc0SBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-error_output_none",&flg1);CHKERRQ(ierr);
314e8fb0fc0SBarry Smith   if (flg1) {
315e8fb0fc0SBarry Smith     PetscErrorPrintf = PetscErrorPrintfNone;
316e8fb0fc0SBarry Smith   }
317e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-no_signal_handler",&flg1);CHKERRQ(ierr);
318e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPushSignalHandler(PetscDefaultSignalHandler,(void*)0);CHKERRQ(ierr) }
319e5c89e4eSSatish Balay 
320e5c89e4eSSatish Balay   /*
321e5c89e4eSSatish Balay       Setup debugger information
322e5c89e4eSSatish Balay   */
323e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
324e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
325e5c89e4eSSatish Balay   if (flg1) {
326e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
327e5c89e4eSSatish Balay 
328e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
329e5c89e4eSSatish Balay     ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
330e5c89e4eSSatish Balay     ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
331e5c89e4eSSatish Balay     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
332e5c89e4eSSatish Balay   }
333e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
334e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
335e5c89e4eSSatish Balay   if (flg1 || flg2) {
336e5c89e4eSSatish Balay     PetscMPIInt    size;
337e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
338e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
339e5c89e4eSSatish Balay     /*
340e5c89e4eSSatish Balay        we have to make sure that all processors have opened
341e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
342e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
343e5c89e4eSSatish Balay        and kill the program.
344e5c89e4eSSatish Balay     */
345e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
346e5c89e4eSSatish Balay     if (size > 2) {
347e5c89e4eSSatish Balay       PetscMPIInt dummy;
348e5c89e4eSSatish Balay       MPI_Status  status;
349e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
350e5c89e4eSSatish Balay         if (rank != i) {
351e5c89e4eSSatish Balay           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
352e5c89e4eSSatish Balay         }
353e5c89e4eSSatish Balay       }
354e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
355e5c89e4eSSatish Balay         if (rank != i) {
356e5c89e4eSSatish Balay           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
357e5c89e4eSSatish Balay         }
358e5c89e4eSSatish Balay       }
359e5c89e4eSSatish Balay     }
360e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
361e5c89e4eSSatish Balay     ierr  = PetscMalloc(size*sizeof(PetscInt),&nodes);CHKERRQ(ierr);
362e5c89e4eSSatish Balay     lsize = size;
363e5c89e4eSSatish Balay     ierr  = PetscOptionsGetIntArray(PETSC_NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
364e5c89e4eSSatish Balay     if (flag) {
365e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
366e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
367e5c89e4eSSatish Balay       }
368e5c89e4eSSatish Balay     }
369e5c89e4eSSatish Balay     if (!flag) {
370e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
371e5c89e4eSSatish Balay       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
372e5c89e4eSSatish Balay       if (flg1) {
373e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
374e5c89e4eSSatish Balay       } else {
375e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
376e5c89e4eSSatish Balay       }
377e5c89e4eSSatish Balay       ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
378e5c89e4eSSatish Balay       ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
379e5c89e4eSSatish Balay     }
380e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
381e5c89e4eSSatish Balay   }
382e5c89e4eSSatish Balay 
383e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
384e5c89e4eSSatish Balay   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr)}
385e5c89e4eSSatish Balay 
386e5c89e4eSSatish Balay   /*
387e5c89e4eSSatish Balay         Setup profiling and logging
388e5c89e4eSSatish Balay   */
3896cf91177SBarry Smith #if defined (PETSC_USE_INFO)
3906cf91177SBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-info",&flg1);CHKERRQ(ierr);
391e5c89e4eSSatish Balay   if (flg1) {
392e5c89e4eSSatish Balay     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
3936cf91177SBarry Smith     ierr = PetscOptionsGetString(PETSC_NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
394e5c89e4eSSatish Balay     if (logname[0]) {
3956cf91177SBarry Smith       PetscInfoAllow(PETSC_TRUE,logname);
396e5c89e4eSSatish Balay     } else {
3976cf91177SBarry Smith       PetscInfoAllow(PETSC_TRUE,PETSC_NULL);
398e5c89e4eSSatish Balay     }
399e5c89e4eSSatish Balay   }
400865f6aa8SSatish Balay #endif
401865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
402865f6aa8SSatish Balay   mname[0] = 0;
403865f6aa8SSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
404865f6aa8SSatish Balay   if (flg1) {
405865f6aa8SSatish Balay     if (mname[0]) {
406865f6aa8SSatish Balay       ierr = PetscLogOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
407865f6aa8SSatish Balay     } else {
408865f6aa8SSatish Balay       ierr = PetscLogOpenHistoryFile(0,&petsc_history);CHKERRQ(ierr);
409865f6aa8SSatish Balay     }
410865f6aa8SSatish Balay   }
411e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
412e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
413e5c89e4eSSatish Balay   if (flg1) PetscLogMPEBegin();
414e5c89e4eSSatish Balay #endif
415e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-log_all",&flg1);CHKERRQ(ierr);
416e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-log",&flg2);CHKERRQ(ierr);
417e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary",&flg3);CHKERRQ(ierr);
418e5c89e4eSSatish Balay   if (flg1)              {  ierr = PetscLogAllBegin();CHKERRQ(ierr); }
419e5c89e4eSSatish Balay   else if (flg2 || flg3) {  ierr = PetscLogBegin();CHKERRQ(ierr);}
420e5c89e4eSSatish Balay 
421e5c89e4eSSatish Balay   ierr = PetscOptionsGetString(PETSC_NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
422e5c89e4eSSatish Balay   if (flg1) {
423e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
424e5c89e4eSSatish Balay     FILE *file;
425e5c89e4eSSatish Balay     if (mname[0]) {
426e5c89e4eSSatish Balay       sprintf(name,"%s.%d",mname,rank);
427e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
428e5c89e4eSSatish Balay       file = fopen(fname,"w");
429e5c89e4eSSatish Balay       if (!file) {
430e5c89e4eSSatish Balay         SETERRQ1(PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
431e5c89e4eSSatish Balay       }
432e5c89e4eSSatish Balay     } else {
433*da9f1d6bSBarry Smith       file = PETSC_STDOUT;
434e5c89e4eSSatish Balay     }
435e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
436e5c89e4eSSatish Balay   }
437e5c89e4eSSatish Balay #endif
438e5c89e4eSSatish Balay 
439e5c89e4eSSatish Balay   /*
440e5c89e4eSSatish Balay       Setup building of stack frames for all function calls
441e5c89e4eSSatish Balay   */
442e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
443e5c89e4eSSatish Balay   ierr = PetscStackCreate();CHKERRQ(ierr);
444e5c89e4eSSatish Balay #endif
445e5c89e4eSSatish Balay 
44653acd3b1SBarry Smith   ierr = PetscOptionsHasName(PETSC_NULL,"-options_gui",&PetscOptionsPublish);CHKERRQ(ierr);
447e5c89e4eSSatish Balay 
448e5c89e4eSSatish Balay   /*
449e5c89e4eSSatish Balay        Print basic help message
450e5c89e4eSSatish Balay   */
451e5c89e4eSSatish Balay   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
452e5c89e4eSSatish Balay   if (flg1) {
453e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
454e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is");CHKERRQ(ierr);
455e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," detected. Useful \n       only when run in the debugger\n");CHKERRQ(ierr);
456e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
457e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
458e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
459e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
460e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
461e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
462e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
463e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
464e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
465e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
466e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
467e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -display display: Location where graphics and debuggers are displayed\n");CHKERRQ(ierr);
468e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
469e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
470e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
471e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
472e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
473e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
474e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
475e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mallocinfo: prints total memory usage\n");CHKERRQ(ierr);
476e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
477e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_table: dump list of options inputted\n");CHKERRQ(ierr);
478e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
479e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
480e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
481e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
482a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
483e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -memory_info: print memory usage at end of run\n");CHKERRQ(ierr);
484e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
485e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
486e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log[_all _summary]: logging objects and events\n");CHKERRQ(ierr);
487e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
488e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
489e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through upshot\n");CHKERRQ(ierr);
490e5c89e4eSSatish Balay #endif
4916cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
492e5c89e4eSSatish Balay #endif
493e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
494e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
495e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
496e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
497e5c89e4eSSatish Balay   }
498e5c89e4eSSatish Balay 
499e5c89e4eSSatish Balay   ierr = PetscOptionsGetInt(PETSC_NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
500e5c89e4eSSatish Balay   if (flg1) {
501e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
502e5c89e4eSSatish Balay   }
503e5c89e4eSSatish Balay 
5046cf91177SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
505e5c89e4eSSatish Balay   ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
506e5c89e4eSSatish Balay   if (f) {
5076cf91177SBarry Smith     ierr = PetscInfoDeactivateClass(PETSC_NULL);CHKERRQ(ierr);
508e5c89e4eSSatish Balay   }
509e5c89e4eSSatish Balay 
510e5c89e4eSSatish Balay   PetscFunctionReturn(0);
511e5c89e4eSSatish Balay }
512e5c89e4eSSatish Balay 
513e5c89e4eSSatish Balay 
514