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