xref: /petsc/src/sys/objects/init.c (revision 15681b3c230c463e307d75c11a3a8bd005508ceb)
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 
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 
271   PetscFunctionBegin;
272   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
273 
274   /*
275       Setup the memory management; support for tracing malloc() usage
276   */
277   ierr = PetscOptionsHasName(NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
278   logthreshold = 0.0;
279   ierr = PetscOptionsGetReal(NULL,"-malloc_log_threshold",&logthreshold,&flg1);CHKERRQ(ierr);
280   if (flg1) flg3 = PETSC_TRUE;
281 #if defined(PETSC_USE_DEBUG)
282   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
283   if ((!flg2 || flg1) && !petscsetmallocvisited) {
284     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
285       /* turn off default -malloc if valgrind is being used */
286       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
287     }
288   }
289 #else
290   ierr = PetscOptionsGetBool(NULL,"-malloc_dump",&flg1,NULL);CHKERRQ(ierr);
291   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg2,NULL);CHKERRQ(ierr);
292   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
293 #endif
294   if (flg3) {
295     ierr = PetscMallocSetDumpLogThreshold((PetscLogDouble)logthreshold);CHKERRQ(ierr);
296   }
297   flg1 = PETSC_FALSE;
298   ierr = PetscOptionsGetBool(NULL,"-malloc_debug",&flg1,NULL);CHKERRQ(ierr);
299   if (flg1) {
300     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
301     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
302   }
303   flg1 = PETSC_FALSE;
304   ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg1,NULL);CHKERRQ(ierr);
305 #if defined(PETSC_USE_DEBUG)
306   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
307     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
308     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
309     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
310   }
311 #endif
312 
313   flg1 = PETSC_FALSE;
314   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
315   if (!flg1) {
316     flg1 = PETSC_FALSE;
317     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg1,NULL);CHKERRQ(ierr);
318   }
319   if (flg1) {
320     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
321   }
322 
323   /*
324       Set the display variable for graphics
325   */
326   ierr = PetscSetDisplay();CHKERRQ(ierr);
327 
328   /*
329       Print the PETSc version information
330   */
331   ierr = PetscOptionsHasName(NULL,"-v",&flg1);CHKERRQ(ierr);
332   ierr = PetscOptionsHasName(NULL,"-version",&flg2);CHKERRQ(ierr);
333   ierr = PetscOptionsHasName(NULL,"-help",&flg3);CHKERRQ(ierr);
334   if (flg1 || flg2 || flg3) {
335 
336     /*
337        Print "higher-level" package version message
338     */
339     if (PetscExternalVersionFunction) {
340       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
341     }
342 
343     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
344     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
345 ------------------------------\n");CHKERRQ(ierr);
346     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
347     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
348     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
349     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
350     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
351     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
352     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
353 ------------------------------\n");CHKERRQ(ierr);
354   }
355 
356   /*
357        Print "higher-level" package help message
358   */
359   if (flg3) {
360     if (PetscExternalHelpFunction) {
361       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
362     }
363   }
364 
365   /*
366       Setup the error handling
367   */
368   flg1 = PETSC_FALSE;
369   ierr = PetscOptionsGetBool(NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
370   if (flg1) {
371     ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
372     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
373   }
374   flg1 = PETSC_FALSE;
375   ierr = PetscOptionsGetBool(NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
376   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
377   flg1 = PETSC_FALSE;
378   ierr = PetscOptionsGetBool(NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
379   if (flg1) {
380     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
381   }
382   flg1 = PETSC_FALSE;
383   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
384   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
385   flg1 = PETSC_FALSE;
386   ierr = PetscOptionsGetBool(NULL,"-fp_trap",&flg1,NULL);CHKERRQ(ierr);
387   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
388 
389   /*
390       Setup debugger information
391   */
392   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
393   ierr = PetscOptionsGetString(NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
394   if (flg1) {
395     MPI_Errhandler err_handler;
396 
397     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
398     ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
399     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
400     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
401   }
402   ierr = PetscOptionsGetString(NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
403   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
404   ierr = PetscOptionsGetString(NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
405   ierr = PetscOptionsGetString(NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
406   if (flg1 || flg2) {
407     PetscMPIInt    size;
408     PetscInt       lsize,*nodes;
409     MPI_Errhandler err_handler;
410     /*
411        we have to make sure that all processors have opened
412        connections to all other processors, otherwise once the
413        debugger has stated it is likely to receive a SIGUSR1
414        and kill the program.
415     */
416     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
417     if (size > 2) {
418       PetscMPIInt dummy = 0;
419       MPI_Status  status;
420       for (i=0; i<size; i++) {
421         if (rank != i) {
422           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
423         }
424       }
425       for (i=0; i<size; i++) {
426         if (rank != i) {
427           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
428         }
429       }
430     }
431     /* check if this processor node should be in debugger */
432     ierr  = PetscMalloc(size*sizeof(PetscInt),&nodes);CHKERRQ(ierr);
433     lsize = size;
434     ierr  = PetscOptionsGetIntArray(NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
435     if (flag) {
436       for (i=0; i<lsize; i++) {
437         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
438       }
439     }
440     if (!flag) {
441       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
442       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
443       if (flg1) {
444         ierr = PetscAttachDebugger();CHKERRQ(ierr);
445       } else {
446         ierr = PetscStopForDebugger();CHKERRQ(ierr);
447       }
448       ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
449       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
450     }
451     ierr = PetscFree(nodes);CHKERRQ(ierr);
452   }
453 
454   ierr = PetscOptionsGetString(NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
455   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
456 
457   /*
458         Setup profiling and logging
459   */
460 #if defined(PETSC_USE_INFO)
461   {
462     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
463     ierr = PetscOptionsGetString(NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
464     if (flg1 && logname[0]) {
465       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
466     } else if (flg1) {
467       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
468     }
469   }
470 #endif
471 #if defined(PETSC_USE_LOG)
472   mname[0] = 0;
473   ierr = PetscOptionsGetString(NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
474   if (flg1) {
475     if (mname[0]) {
476       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
477     } else {
478       ierr = PetscOpenHistoryFile(0,&petsc_history);CHKERRQ(ierr);
479     }
480   }
481 #if defined(PETSC_HAVE_MPE)
482   flg1 = PETSC_FALSE;
483   ierr = PetscOptionsHasName(NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
484   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
485 #endif
486   flg1 = PETSC_FALSE;
487   flg2 = PETSC_FALSE;
488   flg3 = PETSC_FALSE;
489   ierr = PetscOptionsGetBool(NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
490   ierr = PetscOptionsGetBool(NULL,"-log",&flg2,NULL);CHKERRQ(ierr);
491   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
492   ierr = PetscOptionsHasName(NULL,"-log_summary_python",&flg4);CHKERRQ(ierr);
493   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
494   else if (flg2 || flg3 || flg4) { ierr = PetscLogBegin();CHKERRQ(ierr);}
495 
496   ierr = PetscOptionsGetString(NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
497   if (flg1) {
498     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
499     FILE *file;
500     if (mname[0]) {
501       sprintf(name,"%s.%d",mname,rank);
502       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
503       file = fopen(fname,"w");
504       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
505     } else file = PETSC_STDOUT;
506 
507     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
508   }
509 #endif
510 
511   ierr = PetscOptionsGetBool(NULL,"-options_gui",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
512 
513 #if defined(PETSC_HAVE_CUDA)
514   ierr = PetscOptionsHasName(NULL,"-cuda_show_devices",&flg1);CHKERRQ(ierr);
515   if (flg1) {
516     struct cudaDeviceProp prop;
517     int                   devCount;
518     int                   device;
519 
520     ierr = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
521     for (device = 0; device < devCount; ++device) {
522       ierr = cudaGetDeviceProperties(&prop, device);CHKERRQ(ierr);
523       ierr = PetscPrintf(PETSC_COMM_WORLD, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
524     }
525   }
526   {
527     int size;
528     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
529     if (size>1) {
530       int devCount, device, rank;
531       ierr   = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
532       ierr   = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
533       device = rank % devCount;
534       ierr   = cudaSetDevice(device);CHKERRQ(ierr);
535     } else {
536       int device;
537       /* the code below works for serial GPU simulations */
538       ierr = PetscOptionsGetInt(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(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 Jumpshot\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   flg1 = PETSC_FALSE;
602   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
603   if (flg1) {
604     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"${PETSC_DIR}/${PETSC_ARCH}/bin/petscwebserver","r",NULL);CHKERRQ(ierr);
605   }
606 
607   ierr = PetscOptionsGetReal(NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
608   if (flg1) {
609     ierr = PetscSleep(si);CHKERRQ(ierr);
610   }
611 
612   ierr = PetscOptionsGetString(NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
613   ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
614   if (f) {
615     ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
616   }
617 
618 #if defined(PETSC_HAVE_CUSP)
619   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
620   if (flg3) flg1 = PETSC_TRUE;
621   else flg1 = PETSC_FALSE;
622   ierr = PetscOptionsGetBool(NULL,"-cusp_synchronize",&flg1,NULL);CHKERRQ(ierr);
623   if (flg1) PetscCUSPSynchronize = PETSC_TRUE;
624 #endif
625   PetscFunctionReturn(0);
626 }
627 
628