xref: /petsc/src/sys/objects/init.c (revision 48fab83121dacf6e81dbee320f7bc1ce367ccca9)
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 #endif
50 MPI_Datatype   MPIU_2SCALAR = 0;
51 MPI_Datatype   MPIU_2INT = 0;
52 
53 /*
54        Function that is called to display all error messages
55 */
56 PetscErrorCode  (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
57 PetscErrorCode  (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
58 #if defined(PETSC_HAVE_MATLAB_ENGINE)
59 PetscErrorCode  (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintf_Matlab;
60 #else
61 PetscErrorCode  (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
62 #endif
63 /*
64   This is needed to turn on/off cusp synchronization
65 */
66 PetscBool   PetscCUSPSynchronize = PETSC_FALSE;
67 
68 /* pthread_key for PetscStack */
69 #if defined(PETSC_HAVE_PTHREADCLASSES) && !defined(PETSC_PTHREAD_LOCAL)
70 pthread_key_t petscstack_key;
71 #endif
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 #if defined(PETSC_HAVE_PTHREADCLASSES)
238 extern PetscErrorCode PetscOptionsCheckInitial_Private_Pthread(void);
239 #endif
240 
241 #if defined(PETSC_HAVE_CUDA)
242 #include <cublas.h>
243 #endif
244 
245 #undef __FUNCT__
246 #define __FUNCT__ "PetscOptionsCheckInitial_Private"
247 PetscErrorCode  PetscOptionsCheckInitial_Private(void)
248 {
249   char           string[64],mname[PETSC_MAX_PATH_LEN],*f;
250   MPI_Comm       comm = PETSC_COMM_WORLD;
251   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flg4 = PETSC_FALSE,flag;
252   PetscErrorCode ierr;
253   PetscReal      si,logthreshold;
254   int            i;
255   PetscMPIInt    rank;
256   char           version[256];
257 #if defined(PETSC_USE_SERVER)
258   PetscBool      flgz;
259 #endif
260 
261   PetscFunctionBegin;
262   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
263 
264   /*
265       Setup the memory management; support for tracing malloc() usage
266   */
267   ierr = PetscOptionsHasName(PETSC_NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
268   logthreshold = 0.0;
269   ierr = PetscOptionsGetReal(PETSC_NULL,"-malloc_log_threshold",&logthreshold,&flg1);CHKERRQ(ierr);
270   if (flg1) flg3 = PETSC_TRUE;
271 #if defined(PETSC_USE_DEBUG)
272   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
273   if ((!flg2 || flg1) && !petscsetmallocvisited) {
274     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
275       /* turn off default -malloc if valgrind is being used */
276       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
277     }
278   }
279 #else
280   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_dump",&flg1,PETSC_NULL);CHKERRQ(ierr);
281   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc",&flg2,PETSC_NULL);CHKERRQ(ierr);
282   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
283 #endif
284   if (flg3) {
285     ierr = PetscMallocSetDumpLogThreshold((PetscLogDouble)logthreshold);CHKERRQ(ierr);
286   }
287   flg1 = PETSC_FALSE;
288   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_debug",&flg1,PETSC_NULL);CHKERRQ(ierr);
289   if (flg1) {
290     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
291     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
292   }
293   flg1 = PETSC_FALSE;
294   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_test",&flg1,PETSC_NULL);CHKERRQ(ierr);
295 #if defined(PETSC_USE_DEBUG)
296   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
297     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
298     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
299     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
300   }
301 #endif
302 
303   flg1 = PETSC_FALSE;
304   ierr = PetscOptionsGetBool(PETSC_NULL,"-malloc_info",&flg1,PETSC_NULL);CHKERRQ(ierr);
305   if (!flg1) {
306     flg1 = PETSC_FALSE;
307     ierr = PetscOptionsGetBool(PETSC_NULL,"-memory_info",&flg1,PETSC_NULL);CHKERRQ(ierr);
308   }
309   if (flg1) {
310     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
311   }
312 
313   /*
314       Set the display variable for graphics
315   */
316   ierr = PetscSetDisplay();CHKERRQ(ierr);
317 
318   /*
319       Print the PETSc version information
320   */
321   ierr = PetscOptionsHasName(PETSC_NULL,"-v",&flg1);CHKERRQ(ierr);
322   ierr = PetscOptionsHasName(PETSC_NULL,"-version",&flg2);CHKERRQ(ierr);
323   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg3);CHKERRQ(ierr);
324   if (flg1 || flg2 || flg3){
325 
326     /*
327        Print "higher-level" package version message
328     */
329     if (PetscExternalVersionFunction) {
330       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
331     }
332 
333     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
334     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
335 ------------------------------\n");CHKERRQ(ierr);
336     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
337     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
338     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
339     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
340     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
341     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
342     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
343 ------------------------------\n");CHKERRQ(ierr);
344   }
345 
346   /*
347        Print "higher-level" package help message
348   */
349   if (flg3){
350     if (PetscExternalHelpFunction) {
351       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
352     }
353   }
354 
355   /*
356       Setup the error handling
357   */
358   flg1 = PETSC_FALSE;
359   ierr = PetscOptionsGetBool(PETSC_NULL,"-on_error_abort",&flg1,PETSC_NULL);CHKERRQ(ierr);
360   if (flg1) {
361     ierr = MPI_Errhandler_set(PETSC_COMM_WORLD,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
362     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
363   }
364   flg1 = PETSC_FALSE;
365   ierr = PetscOptionsGetBool(PETSC_NULL,"-on_error_mpiabort",&flg1,PETSC_NULL);CHKERRQ(ierr);
366   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
367   flg1 = PETSC_FALSE;
368   ierr = PetscOptionsGetBool(PETSC_NULL,"-mpi_return_on_error",&flg1,PETSC_NULL);CHKERRQ(ierr);
369   if (flg1) {
370     ierr = MPI_Errhandler_set(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
371   }
372   flg1 = PETSC_FALSE;
373   ierr = PetscOptionsGetBool(PETSC_NULL,"-no_signal_handler",&flg1,PETSC_NULL);CHKERRQ(ierr);
374   if (!flg1) {ierr = PetscPushSignalHandler(PetscDefaultSignalHandler,(void*)0);CHKERRQ(ierr);}
375   flg1 = PETSC_FALSE;
376   ierr = PetscOptionsGetBool(PETSC_NULL,"-fp_trap",&flg1,PETSC_NULL);CHKERRQ(ierr);
377   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
378 
379   /*
380       Setup debugger information
381   */
382   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
383   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
384   if (flg1) {
385     MPI_Errhandler err_handler;
386 
387     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
388     ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
389     ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
390     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
391   }
392   ierr = PetscOptionsGetString(PETSC_NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
393   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
394   ierr = PetscOptionsGetString(PETSC_NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
395   ierr = PetscOptionsGetString(PETSC_NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
396   if (flg1 || flg2) {
397     PetscMPIInt    size;
398     PetscInt       lsize,*nodes;
399     MPI_Errhandler err_handler;
400     /*
401        we have to make sure that all processors have opened
402        connections to all other processors, otherwise once the
403        debugger has stated it is likely to receive a SIGUSR1
404        and kill the program.
405     */
406     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
407     if (size > 2) {
408       PetscMPIInt dummy = 0;
409       MPI_Status  status;
410       for (i=0; i<size; i++) {
411         if (rank != i) {
412           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
413         }
414       }
415       for (i=0; i<size; i++) {
416         if (rank != i) {
417           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
418         }
419       }
420     }
421     /* check if this processor node should be in debugger */
422     ierr  = PetscMalloc(size*sizeof(PetscInt),&nodes);CHKERRQ(ierr);
423     lsize = size;
424     ierr  = PetscOptionsGetIntArray(PETSC_NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
425     if (flag) {
426       for (i=0; i<lsize; i++) {
427         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
428       }
429     }
430     if (!flag) {
431       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
432       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
433       if (flg1) {
434         ierr = PetscAttachDebugger();CHKERRQ(ierr);
435       } else {
436         ierr = PetscStopForDebugger();CHKERRQ(ierr);
437       }
438       ierr = MPI_Errhandler_create((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
439       ierr = MPI_Errhandler_set(comm,err_handler);CHKERRQ(ierr);
440     }
441     ierr = PetscFree(nodes);CHKERRQ(ierr);
442   }
443 
444   ierr = PetscOptionsGetString(PETSC_NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
445   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
446 
447 #if defined(PETSC_USE_SERVER)
448   ierr = PetscOptionsHasName(PETSC_NULL,"-server", &flgz);CHKERRQ(ierr);
449   if (flgz){
450     PetscInt port = PETSC_DECIDE;
451     ierr = PetscOptionsGetInt(PETSC_NULL,"-server",&port,PETSC_NULL);CHKERRQ(ierr);
452     ierr = PetscWebServe(PETSC_COMM_WORLD,(int)port);CHKERRQ(ierr);
453   }
454 #endif
455 
456   /*
457         Setup profiling and logging
458   */
459 #if defined (PETSC_USE_INFO)
460   {
461     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
462     ierr = PetscOptionsGetString(PETSC_NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
463     if (flg1 && logname[0]) {
464       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
465     } else if (flg1) {
466       ierr = PetscInfoAllow(PETSC_TRUE,PETSC_NULL);CHKERRQ(ierr);
467     }
468   }
469 #endif
470 #if defined(PETSC_USE_LOG)
471   mname[0] = 0;
472   ierr = PetscOptionsGetString(PETSC_NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
473   if (flg1) {
474     if (mname[0]) {
475       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
476     } else {
477       ierr = PetscOpenHistoryFile(0,&petsc_history);CHKERRQ(ierr);
478     }
479   }
480 #if defined(PETSC_HAVE_MPE)
481   flg1 = PETSC_FALSE;
482   ierr = PetscOptionsHasName(PETSC_NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
483   if (flg1) PetscLogMPEBegin();
484 #endif
485   flg1 = PETSC_FALSE;
486   flg2 = PETSC_FALSE;
487   flg3 = PETSC_FALSE;
488   ierr = PetscOptionsGetBool(PETSC_NULL,"-log_all",&flg1,PETSC_NULL);CHKERRQ(ierr);
489   ierr = PetscOptionsGetBool(PETSC_NULL,"-log",&flg2,PETSC_NULL);CHKERRQ(ierr);
490   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary",&flg3);CHKERRQ(ierr);
491   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary_python",&flg4);CHKERRQ(ierr);
492   if (flg1)                      {  ierr = PetscLogAllBegin();CHKERRQ(ierr); }
493   else if (flg2 || flg3 || flg4) {  ierr = PetscLogBegin();CHKERRQ(ierr);}
494 
495   ierr = PetscOptionsGetString(PETSC_NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
496   if (flg1) {
497     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
498     FILE *file;
499     if (mname[0]) {
500       sprintf(name,"%s.%d",mname,rank);
501       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
502       file = fopen(fname,"w");
503       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
504     } else {
505       file = PETSC_STDOUT;
506     }
507     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
508   }
509 #endif
510 
511   /*
512       Setup building of stack frames for all function calls
513   */
514 #if defined(PETSC_USE_DEBUG)
515   PetscThreadLocalRegister(petscstack); /* Creates petscstack_key if needed */
516   ierr = PetscStackCreate();CHKERRQ(ierr);
517 #endif
518 
519   ierr = PetscOptionsGetBool(PETSC_NULL,"-options_gui",&PetscOptionsPublish,PETSC_NULL);CHKERRQ(ierr);
520 
521 #if defined(PETSC_HAVE_CUDA)
522   ierr = PetscOptionsHasName(PETSC_NULL,"-cuda_show_devices",&flg1);CHKERRQ(ierr);
523   if (flg1) {
524     struct cudaDeviceProp prop;
525     int devCount;
526     int device;
527 
528     ierr = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
529     for(device = 0; device < devCount; ++device) {
530       ierr = cudaGetDeviceProperties(&prop, device);CHKERRQ(ierr);
531       ierr = PetscPrintf(PETSC_COMM_WORLD, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
532     }
533   }
534   {
535     int size;
536     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
537     if (size>1) {
538       int devCount, device, rank;
539       ierr = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
540       ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
541       device = rank % devCount;
542       ierr = cudaSetDevice(device);CHKERRQ(ierr);
543     }
544     else {
545       int device;
546       /* the code below works for serial GPU simulations */
547       ierr = PetscOptionsGetInt(PETSC_NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
548       if (flg1) {
549         ierr = cudaSetDevice(device);CHKERRQ(ierr);
550       }
551     }
552   }
553 #endif
554 
555 
556 #if defined(PETSC_HAVE_PTHREADCLASSES)
557   ierr = PetscOptionsCheckInitial_Private_Pthread();
558 #endif
559   /*
560        Print basic help message
561   */
562   ierr = PetscOptionsHasName(PETSC_NULL,"-help",&flg1);CHKERRQ(ierr);
563   if (flg1) {
564     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
565     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
566     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
567     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
568     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
569     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
570     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
571     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
572     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
573     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
574     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
575     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
576     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
577     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
578     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
579     ierr = (*PetscHelpPrintf)(comm," -display display: Location where graphics and debuggers are displayed\n");CHKERRQ(ierr);
580     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
581     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
582     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
583     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
584     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
585     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
586     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
587     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
588     ierr = (*PetscHelpPrintf)(comm," -malloc_log: keeps log of all memory allocations\n");CHKERRQ(ierr);
589     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
590     ierr = (*PetscHelpPrintf)(comm," -options_table: dump list of options inputted\n");CHKERRQ(ierr);
591     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
592     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
593     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
594     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
595     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
596     ierr = (*PetscHelpPrintf)(comm," -memory_info: print memory usage at end of run\n");CHKERRQ(ierr);
597     ierr = (*PetscHelpPrintf)(comm," -server <port>: Run PETSc webserver (default port is 8080) see PetscWebServe()\n");CHKERRQ(ierr);
598 #if defined(PETSC_USE_LOG)
599     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
600     ierr = (*PetscHelpPrintf)(comm," -log[_all _summary _summary_python]: logging objects and events\n");CHKERRQ(ierr);
601     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
602 #if defined(PETSC_HAVE_MPE)
603     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through upshot\n");CHKERRQ(ierr);
604 #endif
605     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
606 #endif
607     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
608     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
609     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
610     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
611   }
612 
613   ierr = PetscOptionsGetReal(PETSC_NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
614   if (flg1) {
615     ierr = PetscSleep(si);CHKERRQ(ierr);
616   }
617 
618   ierr = PetscOptionsGetString(PETSC_NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
619   ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
620   if (f) {
621     ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
622   }
623 
624 #if defined(PETSC_HAVE_CUSP)
625   ierr = PetscOptionsHasName(PETSC_NULL,"-log_summary",&flg3);CHKERRQ(ierr);
626   if (flg3) flg1 = PETSC_TRUE;
627   else flg1 = PETSC_FALSE;
628   ierr = PetscOptionsGetBool(PETSC_NULL,"-cusp_synchronize",&flg1,PETSC_NULL);CHKERRQ(ierr);
629   if (flg1) PetscCUSPSynchronize = PETSC_TRUE;
630 #endif
631 
632   PetscFunctionReturn(0);
633 }
634 
635