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