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