xref: /petsc/src/sys/objects/init.c (revision 6187e55b7be868de3dab288e5aecadaea4c1b258)
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 <petscviewer.h>
11 
12 #if defined(PETSC_HAVE_SYS_SYSINFO_H)
13 #include <sys/sysinfo.h>
14 #endif
15 #if defined(PETSC_HAVE_UNISTD_H)
16 #include <unistd.h>
17 #endif
18 
19 /* ------------------------Nasty global variables -------------------------------*/
20 /*
21      Indicates if PETSc started up MPI, or it was
22    already started before PETSc was initialized.
23 */
24 PetscBool   PetscBeganMPI         = PETSC_FALSE;
25 PetscBool   PetscInitializeCalled = PETSC_FALSE;
26 PetscBool   PetscFinalizeCalled   = PETSC_FALSE;
27 
28 PetscMPIInt PetscGlobalRank       = -1;
29 PetscMPIInt PetscGlobalSize       = -1;
30 
31 #if defined(PETSC_HAVE_COMPLEX)
32 #if defined(PETSC_COMPLEX_INSTANTIATE)
33 template <> class std::complex<double>; /* instantiate complex template class */
34 #endif
35 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
36 MPI_Datatype MPIU_C_DOUBLE_COMPLEX;
37 MPI_Datatype MPIU_C_COMPLEX;
38 #endif
39 
40 /*MC
41    PETSC_i - the imaginary number i
42 
43    Synopsis:
44    #include <petscsys.h>
45    PetscComplex PETSC_i;
46 
47    Level: beginner
48 
49    Note:
50    Complex numbers are automatically available if PETSc located a working complex implementation
51 
52 .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
53 M*/
54 PetscComplex PETSC_i;
55 #endif
56 #if defined(PETSC_USE_REAL___FLOAT128)
57 MPI_Datatype MPIU___FLOAT128 = 0;
58 #if defined(PETSC_HAVE_COMPLEX)
59 MPI_Datatype MPIU___COMPLEX128 = 0;
60 #endif
61 #endif
62 MPI_Datatype MPIU_2SCALAR = 0;
63 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
64 MPI_Datatype MPIU_2INT = 0;
65 #endif
66 MPI_Datatype MPIU_BOOL;
67 MPI_Datatype MPIU_ENUM;
68 
69 /*
70        Function that is called to display all error messages
71 */
72 PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
73 PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
74 #if defined(PETSC_HAVE_MATLAB_ENGINE)
75 PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintf_Matlab;
76 #else
77 PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
78 #endif
79 /*
80   This is needed to turn on/off GPU synchronization
81 */
82 PetscBool PetscCUSPSynchronize = PETSC_FALSE;
83 PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
84 
85 /* ------------------------------------------------------------------------------*/
86 /*
87    Optional file where all PETSc output from various prints is saved
88 */
89 FILE *petsc_history = NULL;
90 
91 #undef __FUNCT__
92 #define __FUNCT__ "PetscOpenHistoryFile"
93 PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
94 {
95   PetscErrorCode ierr;
96   PetscMPIInt    rank,size;
97   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
98   char           version[256];
99 
100   PetscFunctionBegin;
101   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
102   if (!rank) {
103     char        arch[10];
104     int         err;
105 
106     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
107     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
108     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
109     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
110     if (filename) {
111       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
112     } else {
113       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
114       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
115       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
116     }
117 
118     *fd = fopen(fname,"a");
119     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
120 
121     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
122     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
123     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
124     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
125     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
126 
127     err = fflush(*fd);
128     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
129   }
130   PetscFunctionReturn(0);
131 }
132 
133 #undef __FUNCT__
134 #define __FUNCT__ "PetscCloseHistoryFile"
135 PetscErrorCode  PetscCloseHistoryFile(FILE **fd)
136 {
137   PetscErrorCode ierr;
138   PetscMPIInt    rank;
139   char           date[64];
140   int            err;
141 
142   PetscFunctionBegin;
143   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
144   if (!rank) {
145     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
146     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
147     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
148     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
149     err  = fflush(*fd);
150     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
151     err = fclose(*fd);
152     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
153   }
154   PetscFunctionReturn(0);
155 }
156 
157 /* ------------------------------------------------------------------------------*/
158 
159 /*
160    This is ugly and probably belongs somewhere else, but I want to
161   be able to put a true MPI abort error handler with command line args.
162 
163     This is so MPI errors in the debugger will leave all the stack
164   frames. The default MP_Abort() cleans up and exits thus providing no useful information
165   in the debugger hence we call abort() instead of MPI_Abort().
166 */
167 
168 #undef __FUNCT__
169 #define __FUNCT__ "Petsc_MPI_AbortOnError"
170 void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag)
171 {
172   PetscFunctionBegin;
173   (*PetscErrorPrintf)("MPI error %d\n",*flag);
174   abort();
175 }
176 
177 #undef __FUNCT__
178 #define __FUNCT__ "Petsc_MPI_DebuggerOnError"
179 void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag)
180 {
181   PetscErrorCode ierr;
182 
183   PetscFunctionBegin;
184   (*PetscErrorPrintf)("MPI error %d\n",*flag);
185   ierr = PetscAttachDebugger();
186   if (ierr) MPI_Abort(*comm,*flag); /* hopeless so get out */
187 }
188 
189 #undef __FUNCT__
190 #define __FUNCT__ "PetscEnd"
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 extern PetscErrorCode PetscSetUseTrMalloc_Private(void);
216 extern PetscBool      petscsetmallocvisited;
217 static char           emacsmachinename[256];
218 
219 PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
220 PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
221 
222 #undef __FUNCT__
223 #define __FUNCT__ "PetscSetHelpVersionFunctions"
224 /*@C
225    PetscSetHelpVersionFunctions - Sets functions that print help and version information
226    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
227    This routine enables a "higher-level" package that uses PETSc to print its messages first.
228 
229    Input Parameter:
230 +  help - the help function (may be NULL)
231 -  version - the version function (may be NULL)
232 
233    Level: developer
234 
235    Concepts: package help message
236 
237 @*/
238 PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
239 {
240   PetscFunctionBegin;
241   PetscExternalHelpFunction    = help;
242   PetscExternalVersionFunction = version;
243   PetscFunctionReturn(0);
244 }
245 
246 #if defined(PETSC_HAVE_CUDA)
247 #include <cublas.h>
248 #endif
249 
250 #undef __FUNCT__
251 #define __FUNCT__ "PetscOptionsCheckInitial_Private"
252 PetscErrorCode  PetscOptionsCheckInitial_Private(void)
253 {
254   char           string[64],mname[PETSC_MAX_PATH_LEN],*f;
255   MPI_Comm       comm = PETSC_COMM_WORLD;
256   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flg4 = PETSC_FALSE,flag;
257   PetscErrorCode ierr;
258   PetscReal      si,logthreshold;
259   PetscInt       intensity;
260   int            i;
261   PetscMPIInt    rank;
262   char           version[256];
263 
264   PetscFunctionBegin;
265   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
266 
267   /*
268       Setup the memory management; support for tracing malloc() usage
269   */
270   ierr = PetscOptionsHasName(NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
271   logthreshold = 0.0;
272   ierr = PetscOptionsGetReal(NULL,"-malloc_log_threshold",&logthreshold,&flg1);CHKERRQ(ierr);
273   if (flg1) flg3 = PETSC_TRUE;
274 #if defined(PETSC_USE_DEBUG)
275   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
276   if ((!flg2 || flg1) && !petscsetmallocvisited) {
277     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
278       /* turn off default -malloc if valgrind is being used */
279       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
280     }
281   }
282 #else
283   ierr = PetscOptionsGetBool(NULL,"-malloc_dump",&flg1,NULL);CHKERRQ(ierr);
284   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg2,NULL);CHKERRQ(ierr);
285   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
286 #endif
287   if (flg3) {
288     ierr = PetscMallocSetDumpLogThreshold((PetscLogDouble)logthreshold);CHKERRQ(ierr);
289   }
290   flg1 = PETSC_FALSE;
291   ierr = PetscOptionsGetBool(NULL,"-malloc_debug",&flg1,NULL);CHKERRQ(ierr);
292   if (flg1) {
293     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
294     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
295   }
296   flg1 = PETSC_FALSE;
297   ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg1,NULL);CHKERRQ(ierr);
298 #if defined(PETSC_USE_DEBUG)
299   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
300     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
301     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
302     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
303   }
304 #endif
305 
306   flg1 = PETSC_FALSE;
307   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
308   if (!flg1) {
309     flg1 = PETSC_FALSE;
310     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg1,NULL);CHKERRQ(ierr);
311   }
312   if (flg1) {
313     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
314   }
315 
316   /*
317       Set the display variable for graphics
318   */
319   ierr = PetscSetDisplay();CHKERRQ(ierr);
320 
321   /*
322       Print the PETSc version information
323   */
324   ierr = PetscOptionsHasName(NULL,"-v",&flg1);CHKERRQ(ierr);
325   ierr = PetscOptionsHasName(NULL,"-version",&flg2);CHKERRQ(ierr);
326   ierr = PetscOptionsHasName(NULL,"-help",&flg3);CHKERRQ(ierr);
327   if (flg1 || flg2 || flg3) {
328 
329     /*
330        Print "higher-level" package version message
331     */
332     if (PetscExternalVersionFunction) {
333       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
334     }
335 
336     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
337     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
338 ------------------------------\n");CHKERRQ(ierr);
339     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
340     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
341     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
342     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
343     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
344     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
345     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
346 ------------------------------\n");CHKERRQ(ierr);
347   }
348 
349   /*
350        Print "higher-level" package help message
351   */
352   if (flg3) {
353     if (PetscExternalHelpFunction) {
354       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
355     }
356   }
357 
358   /*
359       Setup the error handling
360   */
361   flg1 = PETSC_FALSE;
362   ierr = PetscOptionsGetBool(NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
363   if (flg1) {
364     ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
365     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
366   }
367   flg1 = PETSC_FALSE;
368   ierr = PetscOptionsGetBool(NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
369   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
370   flg1 = PETSC_FALSE;
371   ierr = PetscOptionsGetBool(NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
372   if (flg1) {
373     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
374   }
375   flg1 = PETSC_FALSE;
376   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
377   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
378   flg1 = PETSC_FALSE;
379   ierr = PetscOptionsGetBool(NULL,"-fp_trap",&flg1,NULL);CHKERRQ(ierr);
380   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
381   ierr = PetscOptionsGetInt(NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
382   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
383 
384   /*
385       Setup debugger information
386   */
387   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
388   ierr = PetscOptionsGetString(NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
389   if (flg1) {
390     MPI_Errhandler err_handler;
391 
392     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
393     ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
394     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
395     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
396   }
397   ierr = PetscOptionsGetString(NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
398   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
399   ierr = PetscOptionsGetString(NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
400   ierr = PetscOptionsGetString(NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
401   if (flg1 || flg2) {
402     PetscMPIInt    size;
403     PetscInt       lsize,*nodes;
404     MPI_Errhandler err_handler;
405     /*
406        we have to make sure that all processors have opened
407        connections to all other processors, otherwise once the
408        debugger has stated it is likely to receive a SIGUSR1
409        and kill the program.
410     */
411     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
412     if (size > 2) {
413       PetscMPIInt dummy = 0;
414       MPI_Status  status;
415       for (i=0; i<size; i++) {
416         if (rank != i) {
417           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
418         }
419       }
420       for (i=0; i<size; i++) {
421         if (rank != i) {
422           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
423         }
424       }
425     }
426     /* check if this processor node should be in debugger */
427     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
428     lsize = size;
429     ierr  = PetscOptionsGetIntArray(NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
430     if (flag) {
431       for (i=0; i<lsize; i++) {
432         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
433       }
434     }
435     if (!flag) {
436       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
437       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
438       if (flg1) {
439         ierr = PetscAttachDebugger();CHKERRQ(ierr);
440       } else {
441         ierr = PetscStopForDebugger();CHKERRQ(ierr);
442       }
443       ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
444       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
445     }
446     ierr = PetscFree(nodes);CHKERRQ(ierr);
447   }
448 
449   ierr = PetscOptionsGetString(NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
450   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
451 
452   /*
453         Setup profiling and logging
454   */
455 #if defined(PETSC_USE_INFO)
456   {
457     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
458     ierr = PetscOptionsGetString(NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
459     if (flg1 && logname[0]) {
460       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
461     } else if (flg1) {
462       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
463     }
464   }
465 #endif
466 #if defined(PETSC_USE_LOG)
467   mname[0] = 0;
468   ierr = PetscOptionsGetString(NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
469   if (flg1) {
470     if (mname[0]) {
471       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
472     } else {
473       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
474     }
475   }
476 #if defined(PETSC_HAVE_MPE)
477   flg1 = PETSC_FALSE;
478   ierr = PetscOptionsHasName(NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
479   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
480 #endif
481   flg1 = PETSC_FALSE;
482   flg2 = PETSC_FALSE;
483   flg3 = PETSC_FALSE;
484   ierr = PetscOptionsGetBool(NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
485   ierr = PetscOptionsGetBool(NULL,"-log",&flg2,NULL);CHKERRQ(ierr);
486   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
487   ierr = PetscOptionsHasName(NULL,"-log_view",&flg4);CHKERRQ(ierr);
488   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
489   else if (flg2 || flg3 || flg4) { ierr = PetscLogBegin();CHKERRQ(ierr);}
490 
491   ierr = PetscOptionsGetString(NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
492   if (flg1) {
493     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
494     FILE *file;
495     if (mname[0]) {
496       sprintf(name,"%s.%d",mname,rank);
497       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
498       file = fopen(fname,"w");
499       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
500     } else file = PETSC_STDOUT;
501 
502     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
503   }
504 #endif
505 
506   ierr = PetscOptionsGetBool(NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
507 
508 #if defined(PETSC_HAVE_CUDA)
509   ierr = PetscOptionsHasName(NULL,"-cuda_show_devices",&flg1);CHKERRQ(ierr);
510   if (flg1) {
511     struct cudaDeviceProp prop;
512     int                   devCount;
513     int                   device;
514     cudaError_t           err = cudaSuccess;
515     err = cudaGetDeviceCount(&devCount);
516     if (err != cudaSuccess)
517       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
518     for (device = 0; device < devCount; ++device) {
519       err = cudaGetDeviceProperties(&prop, device);
520       if (err != cudaSuccess)
521         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
522       ierr = PetscPrintf(PETSC_COMM_WORLD, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
523     }
524   }
525   {
526     int size;
527     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
528     if (size>1) {
529       int devCount, device, rank;
530       cudaError_t err = cudaSuccess;
531 
532       /* check to see if we force multiple ranks to hit the same GPU */
533       ierr = PetscOptionsGetInt(NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
534       if (flg1) {
535         ierr = cudaSetDevice(device);CHKERRQ(ierr);
536         if (err != cudaSuccess)
537           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
538       } else {
539         /* we're not using the same GPU on multiple MPI threads. So try to allocated different
540          GPUs to different threads */
541 
542         /* First get the device count */
543         err   = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
544         if (err != cudaSuccess)
545           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
546 
547         /* next determine the rank and then set the device via a mod */
548         ierr   = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
549         device = rank % devCount;
550         err   = cudaSetDevice(device);
551         if (err != cudaSuccess)
552           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
553       }
554 
555       /* set the device flags so that it can map host memory ... do NOT throw exception on err!=cudaSuccess
556        multiple devices may try to set the flags on the same device. So long as one of them succeeds, things
557        are ok. */
558       err = cudaSetDeviceFlags(cudaDeviceMapHost);
559 
560     } else {
561       int device;
562       cudaError_t err = cudaSuccess;
563 
564       /* the code below works for serial GPU simulations */
565       ierr = PetscOptionsGetInt(NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
566       if (flg1) {
567         ierr = cudaSetDevice(device);CHKERRQ(ierr);
568       }
569 
570       /* set the device flags so that it can map host memory ... here, we error check. */
571       err = cudaSetDeviceFlags(cudaDeviceMapHost);
572       if (err != cudaSuccess)
573         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
574     }
575   }
576 #endif
577 
578 
579   /*
580        Print basic help message
581   */
582   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
583   if (flg1) {
584     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
585     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
586     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
587     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
588     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
589     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
590     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
591     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
592     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
593     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
594     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
595     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
596     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
597     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
598     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
599     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
600     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
601     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
602     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
603     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
604     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
605     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
606     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
607     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
608     ierr = (*PetscHelpPrintf)(comm," -malloc_log: keeps log of all memory allocations\n");CHKERRQ(ierr);
609     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
610     ierr = (*PetscHelpPrintf)(comm," -options_table: dump list of options inputted\n");CHKERRQ(ierr);
611     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
612     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
613     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
614     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
615     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
616     ierr = (*PetscHelpPrintf)(comm," -memory_info: print memory usage at end of run\n");CHKERRQ(ierr);
617     ierr = (*PetscHelpPrintf)(comm," -server <port>: Run PETSc webserver (default port is 8080) see PetscWebServe()\n");CHKERRQ(ierr);
618 #if defined(PETSC_USE_LOG)
619     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
620     ierr = (*PetscHelpPrintf)(comm," -log[_summary _summary_python]: logging objects and events\n");CHKERRQ(ierr);
621     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
622 #if defined(PETSC_HAVE_MPE)
623     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
624 #endif
625     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
626 #endif
627     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
628     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
629     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
630     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
631   }
632 
633 #if defined(PETSC_HAVE_POPEN)
634   {
635   char machine[128];
636   ierr = PetscOptionsGetString(NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
637   if (flg1) {
638     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
639   }
640   }
641 #endif
642 
643   ierr = PetscOptionsGetReal(NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
644   if (flg1) {
645     ierr = PetscSleep(si);CHKERRQ(ierr);
646   }
647 
648   ierr = PetscOptionsGetString(NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
649   ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
650   if (f) {
651     ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
652   }
653 
654 #if defined(PETSC_HAVE_CUSP) || defined(PETSC_HAVE_VIENNACL)
655   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
656   if (!flg3) {
657   ierr = PetscOptionsHasName(NULL,"-log_view",&flg3);CHKERRQ(ierr);
658   }
659 #endif
660 #if defined(PETSC_HAVE_CUSP)
661   ierr = PetscOptionsGetBool(NULL,"-cusp_synchronize",&flg3,NULL);CHKERRQ(ierr);
662   PetscCUSPSynchronize = flg3;
663 #elif defined(PETSC_HAVE_VIENNACL)
664   ierr = PetscOptionsGetBool(NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
665   PetscViennaCLSynchronize = flg3;
666 #endif
667   PetscFunctionReturn(0);
668 }
669 
670