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