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