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