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