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