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