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