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