xref: /petsc/src/sys/objects/init.c (revision 012f15ecc4dc796db0a1e2b6985160785acae46c)
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 #if defined(PETSC_HAVE_CUDA)
267   int               device = 0;
268   PetscBool         cuda_view_flag = PETSC_FALSE;
269 #endif
270   PetscFunctionBegin;
271   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
272 
273 #if !defined(PETSC_HAVE_THREADSAFETY)
274   /*
275       Setup the memory management; support for tracing malloc() usage
276   */
277   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
278   logthreshold = 0.0;
279   ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_log_threshold",&logthreshold,&flg1);CHKERRQ(ierr);
280   if (flg1) flg3 = PETSC_TRUE;
281 #if defined(PETSC_USE_DEBUG)
282   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
283   if ((!flg2 || flg1) && !petscsetmallocvisited) {
284     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
285       /* turn off default -malloc if valgrind is being used */
286       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
287     }
288   }
289 #else
290   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&flg1,NULL);CHKERRQ(ierr);
291   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&flg2,NULL);CHKERRQ(ierr);
292   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
293 #endif
294   if (flg3) {
295     ierr = PetscMallocSetDumpLogThreshold((PetscLogDouble)logthreshold);CHKERRQ(ierr);
296   }
297   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
298   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
299   flg1 = PETSC_FALSE;
300   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg1,NULL);CHKERRQ(ierr);
301   if (flg1) {
302     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
303     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
304   }
305   flg1 = PETSC_FALSE;
306   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg1,NULL);CHKERRQ(ierr);
307 #if defined(PETSC_USE_DEBUG)
308   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
309     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
310     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
311     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
312   }
313 #endif
314   flg1 = PETSC_FALSE;
315   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
316   /* ignore this option if malloc is already set */
317   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
318 
319   flg1 = PETSC_FALSE;
320   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
321   if (!flg1) {
322     flg1 = PETSC_FALSE;
323     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
324   }
325   if (flg1) {
326     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
327   }
328 #endif
329 
330 #if defined(PETSC_USE_LOG)
331   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
332 #endif
333 
334   /*
335       Set the display variable for graphics
336   */
337   ierr = PetscSetDisplay();CHKERRQ(ierr);
338 
339   /*
340       Print the PETSc version information
341   */
342   ierr = PetscOptionsHasName(NULL,NULL,"-v",&flg1);CHKERRQ(ierr);
343   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg2);CHKERRQ(ierr);
344   ierr = PetscOptionsHasHelp(NULL,&flg3);CHKERRQ(ierr);
345   if (flg1 || flg2 || flg3) {
346 
347     /*
348        Print "higher-level" package version message
349     */
350     if (PetscExternalVersionFunction) {
351       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
352     }
353 
354     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
355     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
356     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
357     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
358     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
359     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
360     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
361     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
362     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------------------------------------\n");CHKERRQ(ierr);
363   }
364 
365   /*
366        Print "higher-level" package help message
367   */
368   if (flg3) {
369     if (PetscExternalHelpFunction) {
370       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
371     }
372   }
373 
374   ierr = PetscOptionsGetString(NULL,NULL,"-help",helpoptions,sizeof(helpoptions),&flg1);CHKERRQ(ierr);
375   if (flg1) {
376     ierr = PetscStrcmp(helpoptions,"intro",&flg2);CHKERRQ(ierr);
377     if (flg2) {
378       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
379       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
380       ierr = MPI_Finalize();CHKERRQ(ierr);
381       exit(0);
382     }
383   }
384 
385   /*
386       Setup the error handling
387   */
388   flg1 = PETSC_FALSE;
389   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
390   if (flg1) {
391     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
392     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
393   }
394   flg1 = PETSC_FALSE;
395   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
396   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
397   flg1 = PETSC_FALSE;
398   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
399   if (flg1) {
400     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
401   }
402   flg1 = PETSC_FALSE;
403   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
404   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
405   flg1 = PETSC_FALSE;
406   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,NULL);CHKERRQ(ierr);
407   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
408   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
409   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
410 
411   /*
412       Setup debugger information
413   */
414   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
415   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
416   if (flg1) {
417     MPI_Errhandler err_handler;
418 
419     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
420     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
421     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
422     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
423   }
424   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
425   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
426   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
427   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
428   if (flg1 || flg2) {
429     PetscMPIInt    size;
430     PetscInt       lsize,*nodes;
431     MPI_Errhandler err_handler;
432     /*
433        we have to make sure that all processors have opened
434        connections to all other processors, otherwise once the
435        debugger has stated it is likely to receive a SIGUSR1
436        and kill the program.
437     */
438     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
439     if (size > 2) {
440       PetscMPIInt dummy = 0;
441       MPI_Status  status;
442       for (i=0; i<size; i++) {
443         if (rank != i) {
444           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRQ(ierr);
445         }
446       }
447       for (i=0; i<size; i++) {
448         if (rank != i) {
449           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRQ(ierr);
450         }
451       }
452     }
453     /* check if this processor node should be in debugger */
454     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
455     lsize = size;
456     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
457     if (flag) {
458       for (i=0; i<lsize; i++) {
459         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
460       }
461     }
462     if (!flag) {
463       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
464       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
465       if (flg1) {
466         ierr = PetscAttachDebugger();CHKERRQ(ierr);
467       } else {
468         ierr = PetscStopForDebugger();CHKERRQ(ierr);
469       }
470       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
471       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
472     }
473     ierr = PetscFree(nodes);CHKERRQ(ierr);
474   }
475 
476   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
477   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
478 
479   /*
480         Setup profiling and logging
481   */
482 #if defined(PETSC_USE_INFO)
483   {
484     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
485     ierr = PetscOptionsGetString(NULL,NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
486     if (flg1 && logname[0]) {
487       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
488     } else if (flg1) {
489       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
490     }
491   }
492 #endif
493 #if defined(PETSC_USE_LOG)
494   mname[0] = 0;
495   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
496   if (flg1) {
497     if (mname[0]) {
498       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
499     } else {
500       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
501     }
502   }
503 
504   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
505 
506 #if defined(PETSC_HAVE_MPE)
507   flg1 = PETSC_FALSE;
508   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
509   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
510 #endif
511   flg1 = PETSC_FALSE;
512   flg3 = PETSC_FALSE;
513   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
514   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
515   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
516   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
517 
518   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
519   if (flg1) {
520     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
521     FILE *file;
522     if (mname[0]) {
523       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
524       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
525       file = fopen(fname,"w");
526       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
527     } else file = PETSC_STDOUT;
528     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
529   }
530 
531   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
532   if (flg4) {
533     if (format == PETSC_VIEWER_ASCII_XML) {
534       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
535     } else {
536       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
537     }
538     PetscLogMemory = PETSC_FALSE;
539     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&PetscLogMemory,NULL);CHKERRQ(ierr);
540     if (PetscLogMemory) {
541       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
542     }
543   }
544   if (flg4 && format == PETSC_VIEWER_ASCII_XML) {
545     PetscReal threshold = PetscRealConstant(0.01);
546     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
547     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
548   }
549 #endif
550 
551   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
552 
553 #if defined(PETSC_HAVE_CUDA)
554   ierr = PetscOptionsBegin(comm,NULL,"CUDA options","Sys");CHKERRQ(ierr);
555   ierr = PetscOptionsInt("-cuda_set_device","Set all MPI ranks to use the specified CUDA device",NULL,device,&device,&flg1);CHKERRQ(ierr);
556   ierr = PetscOptionsDeprecated("-cuda_show_devices","-cuda_view","3.12",NULL);CHKERRQ(ierr);
557   ierr = PetscOptionsName("-cuda_view","Display CUDA device information and assignments",NULL,&cuda_view_flag);CHKERRQ(ierr);
558   ierr = PetscOptionsEnd();CHKERRQ(ierr);
559   if (!PetscCUDAInitialized) {
560     PetscMPIInt size;
561     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
562 
563     if (size>1) {
564       int         devCount;
565       PetscMPIInt rank;
566       cudaError_t err = cudaSuccess;
567 
568       /* check to see if we force multiple ranks to hit the same GPU */
569       if (flg1) {
570         err = cudaSetDevice((int)device);
571         if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
572       } else {
573         /* we're not using the same GPU on multiple MPI threads. So try to allocated different   GPUs to different processes */
574 
575         /* First get the device count */
576         err   = cudaGetDeviceCount(&devCount);
577         if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
578 
579         /* next determine the rank and then set the device via a mod */
580         ierr   = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
581         device = rank % devCount;
582         err    = cudaSetDevice((int)device);
583         if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
584       }
585 
586       /* set the device flags so that it can map host memory ... do NOT throw exception on err!=cudaSuccess
587        multiple devices may try to set the flags on the same device. So long as one of them succeeds, things
588        are ok. */
589       err = cudaSetDeviceFlags(cudaDeviceMapHost);
590       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
591     } else {
592       cudaError_t err = cudaSuccess;
593 
594       /* the code below works for serial GPU simulations */
595       if (flg1) {
596         err = cudaSetDevice((int)device);
597         if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
598       }
599 
600       /* set the device flags so that it can map host memory ... here, we error check. */
601       err = cudaSetDeviceFlags(cudaDeviceMapHost);
602       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDeviceFlags %s",cudaGetErrorString(err));
603     }
604 
605     PetscCUDAInitialized = PETSC_TRUE;
606   }
607   if (cuda_view_flag) {
608     struct cudaDeviceProp prop;
609     int                   devCount;
610     PetscInt              device;
611     cudaError_t           err = cudaSuccess;
612 
613     err = cudaGetDeviceCount(&devCount);
614     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
615     for (device = 0; device < devCount; ++device) {
616       err = cudaGetDeviceProperties(&prop, (int)device);
617       if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
618       ierr = PetscPrintf(comm, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
619     }
620     err = cudaGetDevice(&device);
621     if (err != cudaSuccess) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDevice %s",cudaGetErrorString(err));
622     ierr = PetscSynchronizedPrintf(PETSC_COMM_WORLD,"[%d] Using CUDA device %d.\n",rank,device);CHKERRQ(ierr);
623     ierr = PetscSynchronizedFlush(PETSC_COMM_WORLD,PETSC_STDOUT);CHKERRQ(ierr);
624   }
625 
626 #endif
627 
628 
629   /*
630        Print basic help message
631   */
632   ierr = PetscOptionsHasHelp(NULL,&flg1);CHKERRQ(ierr);
633   if (flg1) {
634     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
635     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
636     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
637     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
638     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
639     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
640     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
641     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
642     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
643     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
644     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
645     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
646     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
647     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
648     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
649     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
650     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
651     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
652     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
653     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
654     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
655     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
656     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
657     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
658     ierr = (*PetscHelpPrintf)(comm," -malloc_log: keeps log of all memory allocations\n");CHKERRQ(ierr);
659     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
660     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
661     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
662     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
663     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
664     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
665     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
666     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
667 #if defined(PETSC_USE_LOG)
668     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
669     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
670     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
671 #if defined(PETSC_HAVE_MPE)
672     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
673 #endif
674     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
675 #endif
676     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
677     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
678     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
679     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
680   }
681 
682 #if defined(PETSC_HAVE_POPEN)
683   {
684   char machine[128];
685   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
686   if (flg1) {
687     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
688   }
689   }
690 #endif
691 
692   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
693   if (flg1) {
694     ierr = PetscSleep(si);CHKERRQ(ierr);
695   }
696 
697   ierr = PetscOptionsGetString(NULL,NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
698   if (flg1) {
699     ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
700     if (f) {
701       ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
702     }
703   }
704 
705 #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
706   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
707   if (!flg3) {
708     ierr = PetscOptionsHasName(NULL,NULL,"-log_view",&flg3);CHKERRQ(ierr);
709   }
710 #endif
711 #if defined(PETSC_HAVE_VIENNACL)
712   ierr = PetscOptionsGetBool(NULL,NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
713   PetscViennaCLSynchronize = flg3;
714 #endif
715 #if defined(PETSC_HAVE_CUDA)
716   ierr = PetscOptionsGetBool(NULL,NULL,"-cuda_synchronize",&flg3,NULL);CHKERRQ(ierr);
717   PetscCUDASynchronize = flg3;
718 #endif
719 
720 #if defined(PETSC_HAVE_VIENNACL)
721   ierr = PetscViennaCLInit();CHKERRQ(ierr);
722 #endif
723 
724   PetscFunctionReturn(0);
725 }
726