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