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