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