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