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