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