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