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