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