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