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