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