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