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