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