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