xref: /petsc/src/sys/objects/init.c (revision 2479a3a64267ee9c446e990f589a897cbcc38eee)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay 
3e5c89e4eSSatish Balay    This file defines part of the initialization of PETSc
4e5c89e4eSSatish Balay 
5f2d66bcaSShri Abhyankar   This file uses regular malloc and free because it cannot known
6e5c89e4eSSatish Balay   what malloc is being used until it has already processed the input.
7e5c89e4eSSatish Balay */
8ef386f4bSSatish Balay 
9ef386f4bSSatish Balay #include <petscsys.h>        /*I  "petscsys.h"   I*/
10022afb99SBarry Smith #include <petscvalgrind.h>
11665c2dedSJed Brown #include <petscviewer.h>
12ef386f4bSSatish Balay 
13ba61063dSBarry Smith #if defined(PETSC_HAVE_SYS_SYSINFO_H)
1451d315f7SKerry Stevens #include <sys/sysinfo.h>
15ba61063dSBarry Smith #endif
16121deb67SSatish Balay #if defined(PETSC_HAVE_UNISTD_H)
1751d315f7SKerry Stevens #include <unistd.h>
18121deb67SSatish Balay #endif
19555d055bSBarry Smith 
20e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
21e5c89e4eSSatish Balay /*
22e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
23e5c89e4eSSatish Balay    already started before PETSc was initialized.
24e5c89e4eSSatish Balay */
250cbf60d0SJose E. Roman PetscBool   PetscBeganMPI         = PETSC_FALSE;
260cbf60d0SJose E. Roman PetscBool   PetscInitializeCalled = PETSC_FALSE;
270cbf60d0SJose E. Roman PetscBool   PetscFinalizeCalled   = PETSC_FALSE;
28d6f2c3cbSBarry Smith 
297087cfbeSBarry Smith PetscMPIInt PetscGlobalRank       = -1;
307087cfbeSBarry Smith PetscMPIInt PetscGlobalSize       = -1;
31ba61063dSBarry Smith 
3250f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
33e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
34e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
35e5c89e4eSSatish Balay #endif
362c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
37500d8756SSatish Balay MPI_Datatype MPIU_C_DOUBLE_COMPLEX;
38500d8756SSatish Balay MPI_Datatype MPIU_C_COMPLEX;
392c876bd9SBarry Smith #endif
408619c96cSJed Brown 
418619c96cSJed Brown /*MC
428619c96cSJed Brown    PETSC_i - the imaginary number i
438619c96cSJed Brown 
448619c96cSJed Brown    Synopsis:
458619c96cSJed Brown    #include <petscsys.h>
468619c96cSJed Brown    PetscComplex PETSC_i;
478619c96cSJed Brown 
488619c96cSJed Brown    Level: beginner
498619c96cSJed Brown 
508619c96cSJed Brown    Note:
518cd53115SBarry Smith    Complex numbers are automatically available if PETSc located a working complex implementation
528619c96cSJed Brown 
538619c96cSJed Brown .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
548619c96cSJed Brown M*/
5550f81f78SJed Brown PetscComplex PETSC_i;
56e5c89e4eSSatish Balay #endif
57ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
58c90a1750SBarry Smith MPI_Datatype MPIU___FLOAT128 = 0;
597c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
608c764dc5SJose Roman MPI_Datatype MPIU___COMPLEX128 = 0;
618c764dc5SJose Roman #endif
62c90a1750SBarry Smith #endif
637087cfbeSBarry Smith MPI_Datatype MPIU_2SCALAR = 0;
6444041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
657087cfbeSBarry Smith MPI_Datatype MPIU_2INT = 0;
6644041f26SJed Brown #endif
678ad47952SJed Brown MPI_Datatype MPIU_BOOL;
688ad47952SJed Brown MPI_Datatype MPIU_ENUM;
6975567043SBarry Smith 
70e5c89e4eSSatish Balay /*
71e5c89e4eSSatish Balay        Function that is called to display all error messages
72e5c89e4eSSatish Balay */
737087cfbeSBarry Smith PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
747087cfbeSBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
75238ccf28SShri Abhyankar #if defined(PETSC_HAVE_MATLAB_ENGINE)
767087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintf_Matlab;
77238ccf28SShri Abhyankar #else
787087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
79238ccf28SShri Abhyankar #endif
80bab1f7e6SVictor Minden /*
814cf1874eSKarl Rupp   This is needed to turn on/off GPU synchronization
828b5db460SBarry Smith */
838b5db460SBarry Smith PetscBool PetscCUSPSynchronize = PETSC_FALSE;
844cf1874eSKarl Rupp PetscBool PetscViennaCLSynchronize = PETSC_FALSE;
85bab1f7e6SVictor Minden 
86e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
87e5c89e4eSSatish Balay /*
88e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
89e5c89e4eSSatish Balay */
900298fd71SBarry Smith FILE *petsc_history = NULL;
91e5c89e4eSSatish Balay 
92e5c89e4eSSatish Balay #undef __FUNCT__
93f3dea69dSBarry Smith #define __FUNCT__ "PetscOpenHistoryFile"
947087cfbeSBarry Smith PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
95e5c89e4eSSatish Balay {
96e5c89e4eSSatish Balay   PetscErrorCode ierr;
97e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
98e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
99e5c89e4eSSatish Balay   char           version[256];
100e5c89e4eSSatish Balay 
101e5c89e4eSSatish Balay   PetscFunctionBegin;
102e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
103e5c89e4eSSatish Balay   if (!rank) {
104e5c89e4eSSatish Balay     char        arch[10];
105f56c2debSBarry Smith     int         err;
106f56c2debSBarry Smith 
107e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
108e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
109a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
110e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
111e5c89e4eSSatish Balay     if (filename) {
112e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
113e5c89e4eSSatish Balay     } else {
114e5c89e4eSSatish Balay       ierr = PetscGetHomeDirectory(pfile,240);CHKERRQ(ierr);
115e5c89e4eSSatish Balay       ierr = PetscStrcat(pfile,"/.petschistory");CHKERRQ(ierr);
116e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
117e5c89e4eSSatish Balay     }
118e5c89e4eSSatish Balay 
119a297a907SKarl Rupp     *fd = fopen(fname,"a");
120a297a907SKarl Rupp     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
121a297a907SKarl Rupp 
122e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
123e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
124e5c89e4eSSatish Balay     ierr = PetscGetProgramName(pname,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
125e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
126e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
127a297a907SKarl Rupp 
128f56c2debSBarry Smith     err = fflush(*fd);
129e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
130e5c89e4eSSatish Balay   }
131e5c89e4eSSatish Balay   PetscFunctionReturn(0);
132e5c89e4eSSatish Balay }
133e5c89e4eSSatish Balay 
134e5c89e4eSSatish Balay #undef __FUNCT__
135f3dea69dSBarry Smith #define __FUNCT__ "PetscCloseHistoryFile"
1367087cfbeSBarry Smith PetscErrorCode  PetscCloseHistoryFile(FILE **fd)
137e5c89e4eSSatish Balay {
138e5c89e4eSSatish Balay   PetscErrorCode ierr;
139e5c89e4eSSatish Balay   PetscMPIInt    rank;
140e5c89e4eSSatish Balay   char           date[64];
141f56c2debSBarry Smith   int            err;
142e5c89e4eSSatish Balay 
143e5c89e4eSSatish Balay   PetscFunctionBegin;
144e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
145e5c89e4eSSatish Balay   if (!rank) {
146e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
147e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
148e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
149e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"---------------------------------------------------------\n");CHKERRQ(ierr);
150f56c2debSBarry Smith     err  = fflush(*fd);
151e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
152f56c2debSBarry Smith     err = fclose(*fd);
153e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
154e5c89e4eSSatish Balay   }
155e5c89e4eSSatish Balay   PetscFunctionReturn(0);
156e5c89e4eSSatish Balay }
157e5c89e4eSSatish Balay 
158e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay /*
161e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
162e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
163e5c89e4eSSatish Balay 
164e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
1653c311c98SBarry Smith   frames. The default MP_Abort() cleans up and exits thus providing no useful information
1663c311c98SBarry Smith   in the debugger hence we call abort() instead of MPI_Abort().
167e5c89e4eSSatish Balay */
168e5c89e4eSSatish Balay 
169e5c89e4eSSatish Balay #undef __FUNCT__
170e5c89e4eSSatish Balay #define __FUNCT__ "Petsc_MPI_AbortOnError"
171e5c89e4eSSatish Balay void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag)
172e5c89e4eSSatish Balay {
173e5c89e4eSSatish Balay   PetscFunctionBegin;
1743c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
175e5c89e4eSSatish Balay   abort();
176e5c89e4eSSatish Balay }
177e5c89e4eSSatish Balay 
178e5c89e4eSSatish Balay #undef __FUNCT__
179e5c89e4eSSatish Balay #define __FUNCT__ "Petsc_MPI_DebuggerOnError"
180e5c89e4eSSatish Balay void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag)
181e5c89e4eSSatish Balay {
182e5c89e4eSSatish Balay   PetscErrorCode ierr;
183e5c89e4eSSatish Balay 
184e5c89e4eSSatish Balay   PetscFunctionBegin;
1853c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
186e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
187a297a907SKarl Rupp   if (ierr) MPI_Abort(*comm,*flag); /* hopeless so get out */
188e5c89e4eSSatish Balay }
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay #undef __FUNCT__
191e5c89e4eSSatish Balay #define __FUNCT__ "PetscEnd"
192e5c89e4eSSatish Balay /*@C
193e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
194e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
199e5c89e4eSSatish Balay 
200e5c89e4eSSatish Balay    Level: advanced
201e5c89e4eSSatish Balay 
202e5c89e4eSSatish Balay    Note:
203e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
204e5c89e4eSSatish Balay 
20588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
206e5c89e4eSSatish Balay @*/
2077087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
208e5c89e4eSSatish Balay {
209e5c89e4eSSatish Balay   PetscFunctionBegin;
210e5c89e4eSSatish Balay   PetscFinalize();
211e5c89e4eSSatish Balay   exit(0);
212e5c89e4eSSatish Balay   return 0;
213e5c89e4eSSatish Balay }
214e5c89e4eSSatish Balay 
215ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
21609573ac7SBarry Smith extern PetscErrorCode PetscSetUseTrMalloc_Private(void);
217ace3abfcSBarry Smith extern PetscBool      petscsetmallocvisited;
218e5c89e4eSSatish Balay static char           emacsmachinename[256];
219e5c89e4eSSatish Balay 
220e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = 0;
221e5c89e4eSSatish Balay PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = 0;
222e5c89e4eSSatish Balay 
223e5c89e4eSSatish Balay #undef __FUNCT__
224e5c89e4eSSatish Balay #define __FUNCT__ "PetscSetHelpVersionFunctions"
225e5c89e4eSSatish Balay /*@C
226e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
227e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
228e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
229e5c89e4eSSatish Balay 
230e5c89e4eSSatish Balay    Input Parameter:
2310298fd71SBarry Smith +  help - the help function (may be NULL)
2320298fd71SBarry Smith -  version - the version function (may be NULL)
233e5c89e4eSSatish Balay 
234e5c89e4eSSatish Balay    Level: developer
235e5c89e4eSSatish Balay 
236e5c89e4eSSatish Balay    Concepts: package help message
237e5c89e4eSSatish Balay 
238e5c89e4eSSatish Balay @*/
2397087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
240e5c89e4eSSatish Balay {
241e5c89e4eSSatish Balay   PetscFunctionBegin;
242e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
243e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
244e5c89e4eSSatish Balay   PetscFunctionReturn(0);
245e5c89e4eSSatish Balay }
246e5c89e4eSSatish Balay 
2474b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
2484b0a73b2SBarry Smith #include <cublas.h>
2494b0a73b2SBarry Smith #endif
2504b0a73b2SBarry Smith 
25105df10baSBarry Smith #if defined(PETSC_USE_LOG)
25205df10baSBarry Smith extern PetscBool   PetscObjectsLog;
25305df10baSBarry Smith #endif
25405df10baSBarry Smith 
255e5c89e4eSSatish Balay #undef __FUNCT__
256e5c89e4eSSatish Balay #define __FUNCT__ "PetscOptionsCheckInitial_Private"
2577087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Private(void)
258e5c89e4eSSatish Balay {
259e5c89e4eSSatish Balay   char              string[64],mname[PETSC_MAX_PATH_LEN],*f;
260e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
26167584ceeSBarry Smith   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag;
262e5c89e4eSSatish Balay   PetscErrorCode    ierr;
26367584ceeSBarry Smith   PetscReal         si;
26428559dc8SJed Brown   PetscInt          intensity;
265e5c89e4eSSatish Balay   int               i;
266e5c89e4eSSatish Balay   PetscMPIInt       rank;
267e5c89e4eSSatish Balay   char              version[256];
26867584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
26967584ceeSBarry Smith   PetscReal         logthreshold;
270*2479a3a6SBarry Smith #endif
271*2479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
272*2479a3a6SBarry Smith   PetscViewerFormat format;
27367584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
27467584ceeSBarry Smith #endif
275e5c89e4eSSatish Balay 
276e5c89e4eSSatish Balay   PetscFunctionBegin;
277e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
278e5c89e4eSSatish Balay 
27967584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
280e5c89e4eSSatish Balay   /*
281e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
282e5c89e4eSSatish Balay   */
2830298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-malloc_log",&flg3);CHKERRQ(ierr);
284574034a9SJed Brown   logthreshold = 0.0;
2850298fd71SBarry Smith   ierr = PetscOptionsGetReal(NULL,"-malloc_log_threshold",&logthreshold,&flg1);CHKERRQ(ierr);
286574034a9SJed Brown   if (flg1) flg3 = PETSC_TRUE;
2878bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
2880298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg1,&flg2);CHKERRQ(ierr);
289e5c89e4eSSatish Balay   if ((!flg2 || flg1) && !petscsetmallocvisited) {
290dc92acbaSJed Brown     if (flg2 || !(PETSC_RUNNING_ON_VALGRIND)) {
291555d055bSBarry Smith       /* turn off default -malloc if valgrind is being used */
292e5c89e4eSSatish Balay       ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
293555d055bSBarry Smith     }
294e5c89e4eSSatish Balay   }
295e5c89e4eSSatish Balay #else
2960298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_dump",&flg1,NULL);CHKERRQ(ierr);
2970298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc",&flg2,NULL);CHKERRQ(ierr);
298e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);}
299e5c89e4eSSatish Balay #endif
300e5c89e4eSSatish Balay   if (flg3) {
301574034a9SJed Brown     ierr = PetscMallocSetDumpLogThreshold((PetscLogDouble)logthreshold);CHKERRQ(ierr);
302e5c89e4eSSatish Balay   }
30390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3040298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_debug",&flg1,NULL);CHKERRQ(ierr);
305e5c89e4eSSatish Balay   if (flg1) {
306e5c89e4eSSatish Balay     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
307e5c89e4eSSatish Balay     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
308e5c89e4eSSatish Balay   }
309dc92acbaSJed Brown   flg1 = PETSC_FALSE;
3100298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg1,NULL);CHKERRQ(ierr);
3118bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
312dc92acbaSJed Brown   if (flg1 && !PETSC_RUNNING_ON_VALGRIND) {
313dc92acbaSJed Brown     ierr = PetscSetUseTrMalloc_Private();CHKERRQ(ierr);
314dc92acbaSJed Brown     ierr = PetscMallocSetDumpLog();CHKERRQ(ierr);
315dc92acbaSJed Brown     ierr = PetscMallocDebug(PETSC_TRUE);CHKERRQ(ierr);
316dc92acbaSJed Brown   }
317dc92acbaSJed Brown #endif
318e5c89e4eSSatish Balay 
31990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3200298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
3217783f70dSSatish Balay   if (!flg1) {
32290d69ab7SBarry Smith     flg1 = PETSC_FALSE;
3230841954dSBarry Smith     ierr = PetscOptionsGetBool(NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
3247783f70dSSatish Balay   }
325e5c89e4eSSatish Balay   if (flg1) {
326e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
327e5c89e4eSSatish Balay   }
32867584ceeSBarry Smith #endif
329e5c89e4eSSatish Balay 
330b4427426SBarry Smith #if defined(PETSC_USE_LOG)
33105df10baSBarry Smith   ierr = PetscOptionsHasName(NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
332b4427426SBarry Smith #endif
33305df10baSBarry Smith 
334e5c89e4eSSatish Balay   /*
335e5c89e4eSSatish Balay       Set the display variable for graphics
336e5c89e4eSSatish Balay   */
337e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
338e5c89e4eSSatish Balay 
33951dcc849SKerry Stevens   /*
340e5c89e4eSSatish Balay       Print the PETSc version information
341e5c89e4eSSatish Balay   */
3420298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-v",&flg1);CHKERRQ(ierr);
3430298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-version",&flg2);CHKERRQ(ierr);
3440298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg3);CHKERRQ(ierr);
345e5c89e4eSSatish Balay   if (flg1 || flg2 || flg3) {
346e5c89e4eSSatish Balay 
347e5c89e4eSSatish Balay     /*
348e5c89e4eSSatish Balay        Print "higher-level" package version message
349e5c89e4eSSatish Balay     */
350e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
351e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
352e5c89e4eSSatish Balay     }
353e5c89e4eSSatish Balay 
354a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
355e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
356e5c89e4eSSatish Balay ------------------------------\n");CHKERRQ(ierr);
357e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
358e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
359e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
36084e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
361e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
362e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
363e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"--------------------------------------------\
364e5c89e4eSSatish Balay ------------------------------\n");CHKERRQ(ierr);
365e5c89e4eSSatish Balay   }
366e5c89e4eSSatish Balay 
367e5c89e4eSSatish Balay   /*
368e5c89e4eSSatish Balay        Print "higher-level" package help message
369e5c89e4eSSatish Balay   */
370e5c89e4eSSatish Balay   if (flg3) {
371e5c89e4eSSatish Balay     if (PetscExternalHelpFunction) {
372e5c89e4eSSatish Balay       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
373e5c89e4eSSatish Balay     }
374e5c89e4eSSatish Balay   }
375e5c89e4eSSatish Balay 
376e5c89e4eSSatish Balay   /*
377e5c89e4eSSatish Balay       Setup the error handling
378e5c89e4eSSatish Balay   */
37990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3800298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
381b59baad1SJed Brown   if (flg1) {
382d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_ARE_FATAL);CHKERRQ(ierr);
383b59baad1SJed Brown     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
384b59baad1SJed Brown   }
38590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3860298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
387cb9801acSJed Brown   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,0);CHKERRQ(ierr);}
38890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3890298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
390e5c89e4eSSatish Balay   if (flg1) {
391d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRQ(ierr);
392e5c89e4eSSatish Balay   }
39390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3940298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
3958d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
39696cc47afSJed Brown   flg1 = PETSC_FALSE;
3970298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-fp_trap",&flg1,NULL);CHKERRQ(ierr);
39896cc47afSJed Brown   if (flg1) {ierr = PetscSetFPTrap(PETSC_FP_TRAP_ON);CHKERRQ(ierr);}
39928559dc8SJed Brown   ierr = PetscOptionsGetInt(NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
40028559dc8SJed Brown   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
401e5c89e4eSSatish Balay 
402e5c89e4eSSatish Balay   /*
403e5c89e4eSSatish Balay       Setup debugger information
404e5c89e4eSSatish Balay   */
405e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
4060298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-on_error_attach_debugger",string,64,&flg1);CHKERRQ(ierr);
407e5c89e4eSSatish Balay   if (flg1) {
408e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
409e5c89e4eSSatish Balay 
410e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
411d54338ecSKarl Rupp     ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_DebuggerOnError,&err_handler);CHKERRQ(ierr);
412d54338ecSKarl Rupp     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
413e5c89e4eSSatish Balay     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,0);CHKERRQ(ierr);
414e5c89e4eSSatish Balay   }
4150298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-debug_terminal",string,64,&flg1);CHKERRQ(ierr);
4165e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
4170298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-start_in_debugger",string,64,&flg1);CHKERRQ(ierr);
4180298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-stop_for_debugger",string,64,&flg2);CHKERRQ(ierr);
419e5c89e4eSSatish Balay   if (flg1 || flg2) {
420e5c89e4eSSatish Balay     PetscMPIInt    size;
421e5c89e4eSSatish Balay     PetscInt       lsize,*nodes;
422e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
423e5c89e4eSSatish Balay     /*
424e5c89e4eSSatish Balay        we have to make sure that all processors have opened
425e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
426e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
427e5c89e4eSSatish Balay        and kill the program.
428e5c89e4eSSatish Balay     */
429e5c89e4eSSatish Balay     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
430e5c89e4eSSatish Balay     if (size > 2) {
431533163c2SBarry Smith       PetscMPIInt dummy = 0;
432e5c89e4eSSatish Balay       MPI_Status  status;
433e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
434e5c89e4eSSatish Balay         if (rank != i) {
435e5c89e4eSSatish Balay           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD);CHKERRQ(ierr);
436e5c89e4eSSatish Balay         }
437e5c89e4eSSatish Balay       }
438e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
439e5c89e4eSSatish Balay         if (rank != i) {
440e5c89e4eSSatish Balay           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,PETSC_COMM_WORLD,&status);CHKERRQ(ierr);
441e5c89e4eSSatish Balay         }
442e5c89e4eSSatish Balay       }
443e5c89e4eSSatish Balay     }
444e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
445785e854fSJed Brown     ierr  = PetscMalloc1(size,&nodes);CHKERRQ(ierr);
446e5c89e4eSSatish Balay     lsize = size;
4470298fd71SBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,"-debugger_nodes",nodes,&lsize,&flag);CHKERRQ(ierr);
448e5c89e4eSSatish Balay     if (flag) {
449e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
450e5c89e4eSSatish Balay         if (nodes[i] == rank) { flag = PETSC_FALSE; break; }
451e5c89e4eSSatish Balay       }
452e5c89e4eSSatish Balay     }
453e5c89e4eSSatish Balay     if (!flag) {
454e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
455e5c89e4eSSatish Balay       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,0);CHKERRQ(ierr);
456e5c89e4eSSatish Balay       if (flg1) {
457e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
458e5c89e4eSSatish Balay       } else {
459e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
460e5c89e4eSSatish Balay       }
461d54338ecSKarl Rupp       ierr = MPI_Comm_create_errhandler((MPI_Handler_function*)Petsc_MPI_AbortOnError,&err_handler);CHKERRQ(ierr);
462d54338ecSKarl Rupp       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRQ(ierr);
463e5c89e4eSSatish Balay     }
464e5c89e4eSSatish Balay     ierr = PetscFree(nodes);CHKERRQ(ierr);
465e5c89e4eSSatish Balay   }
466e5c89e4eSSatish Balay 
4670298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-on_error_emacs",emacsmachinename,128,&flg1);CHKERRQ(ierr);
468cb9801acSJed Brown   if (flg1 && !rank) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay   /*
471e5c89e4eSSatish Balay         Setup profiling and logging
472e5c89e4eSSatish Balay   */
4736cf91177SBarry Smith #if defined(PETSC_USE_INFO)
4748bb29257SSatish Balay   {
475e5c89e4eSSatish Balay     char logname[PETSC_MAX_PATH_LEN]; logname[0] = 0;
4760298fd71SBarry Smith     ierr = PetscOptionsGetString(NULL,"-info",logname,250,&flg1);CHKERRQ(ierr);
4778bb29257SSatish Balay     if (flg1 && logname[0]) {
478fcc2139eSBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,logname);CHKERRQ(ierr);
4798bb29257SSatish Balay     } else if (flg1) {
4800298fd71SBarry Smith       ierr = PetscInfoAllow(PETSC_TRUE,NULL);CHKERRQ(ierr);
481e5c89e4eSSatish Balay     }
482e5c89e4eSSatish Balay   }
483865f6aa8SSatish Balay #endif
484865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
485865f6aa8SSatish Balay   mname[0] = 0;
4860298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-history",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
487865f6aa8SSatish Balay   if (flg1) {
488865f6aa8SSatish Balay     if (mname[0]) {
489f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
490865f6aa8SSatish Balay     } else {
491706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
492865f6aa8SSatish Balay     }
493865f6aa8SSatish Balay   }
494e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
49590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
4960298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
497495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
498e5c89e4eSSatish Balay #endif
49990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
50090d69ab7SBarry Smith   flg3 = PETSC_FALSE;
5010298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
5020298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
503e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
504bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
505e5c89e4eSSatish Balay 
5060298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-log_trace",mname,250,&flg1);CHKERRQ(ierr);
507e5c89e4eSSatish Balay   if (flg1) {
508e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
509e5c89e4eSSatish Balay     FILE *file;
510e5c89e4eSSatish Balay     if (mname[0]) {
511e5c89e4eSSatish Balay       sprintf(name,"%s.%d",mname,rank);
512e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
513e5c89e4eSSatish Balay       file = fopen(fname,"w");
514f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
515a297a907SKarl Rupp     } else file = PETSC_STDOUT;
516e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
517e5c89e4eSSatish Balay   }
518bb1d7374SBarry Smith 
519bb1d7374SBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
520bb1d7374SBarry Smith   if (flg4) {
521bb1d7374SBarry Smith     if (format == PETSC_VIEWER_ASCII_XML){
522bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
523bb1d7374SBarry Smith     } else {
524bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
525bb1d7374SBarry Smith     }
526bb1d7374SBarry Smith   }
527e5c89e4eSSatish Balay #endif
528e5c89e4eSSatish Balay 
529e78c4b8cSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
530e5c89e4eSSatish Balay 
5314b0a73b2SBarry Smith #if defined(PETSC_HAVE_CUDA)
5320298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-cuda_show_devices",&flg1);CHKERRQ(ierr);
5334b0a73b2SBarry Smith   if (flg1) {
5344b0a73b2SBarry Smith     struct cudaDeviceProp prop;
5354b0a73b2SBarry Smith     int                   devCount;
5364b0a73b2SBarry Smith     int                   device;
5372692e278SPaul Mullowney     cudaError_t           err = cudaSuccess;
5382692e278SPaul Mullowney     err = cudaGetDeviceCount(&devCount);
5392692e278SPaul Mullowney     if (err != cudaSuccess)
5402692e278SPaul Mullowney       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
5414b0a73b2SBarry Smith     for (device = 0; device < devCount; ++device) {
5422692e278SPaul Mullowney       err = cudaGetDeviceProperties(&prop, device);
5432692e278SPaul Mullowney       if (err != cudaSuccess)
5442692e278SPaul Mullowney         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceProperties %s",cudaGetErrorString(err));
5454b0a73b2SBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD, "CUDA device %d: %s\n", device, prop.name);CHKERRQ(ierr);
5464b0a73b2SBarry Smith     }
5474b0a73b2SBarry Smith   }
5484b0a73b2SBarry Smith   {
549bd72cc96SPaul Mullowney     int size;
550bd72cc96SPaul Mullowney     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
551bd72cc96SPaul Mullowney     if (size>1) {
552bd72cc96SPaul Mullowney       int devCount, device, rank;
5532692e278SPaul Mullowney       cudaError_t err = cudaSuccess;
5542692e278SPaul Mullowney 
5552692e278SPaul Mullowney       /* check to see if we force multiple ranks to hit the same GPU */
5562692e278SPaul Mullowney       ierr = PetscOptionsGetInt(NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
5572692e278SPaul Mullowney       if (flg1) {
5582692e278SPaul Mullowney         ierr = cudaSetDevice(device);CHKERRQ(ierr);
5592692e278SPaul Mullowney         if (err != cudaSuccess)
5602692e278SPaul Mullowney           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
5612692e278SPaul Mullowney       } else {
5622692e278SPaul Mullowney         /* we're not using the same GPU on multiple MPI threads. So try to allocated different
5632692e278SPaul Mullowney          GPUs to different threads */
5642692e278SPaul Mullowney 
5652692e278SPaul Mullowney         /* First get the device count */
5662692e278SPaul Mullowney         err   = cudaGetDeviceCount(&devCount);CHKERRQ(ierr);
5672692e278SPaul Mullowney         if (err != cudaSuccess)
5682692e278SPaul Mullowney           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaGetDeviceCount %s",cudaGetErrorString(err));
5692692e278SPaul Mullowney 
5702692e278SPaul Mullowney         /* next determine the rank and then set the device via a mod */
571bd72cc96SPaul Mullowney         ierr   = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
572bd72cc96SPaul Mullowney         device = rank % devCount;
5732692e278SPaul Mullowney         err   = cudaSetDevice(device);
5742692e278SPaul Mullowney         if (err != cudaSuccess)
5752692e278SPaul Mullowney           SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
5762692e278SPaul Mullowney       }
5772692e278SPaul Mullowney 
5782692e278SPaul Mullowney       /* set the device flags so that it can map host memory ... do NOT throw exception on err!=cudaSuccess
5792692e278SPaul Mullowney        multiple devices may try to set the flags on the same device. So long as one of them succeeds, things
5802692e278SPaul Mullowney        are ok. */
5812692e278SPaul Mullowney       err = cudaSetDeviceFlags(cudaDeviceMapHost);
5822692e278SPaul Mullowney 
583a297a907SKarl Rupp     } else {
5844b0a73b2SBarry Smith       int device;
5852692e278SPaul Mullowney       cudaError_t err = cudaSuccess;
5862692e278SPaul Mullowney 
587f297a14cSJed Brown       /* the code below works for serial GPU simulations */
5880298fd71SBarry Smith       ierr = PetscOptionsGetInt(NULL,"-cuda_set_device", &device, &flg1);CHKERRQ(ierr);
5894b0a73b2SBarry Smith       if (flg1) {
5904b0a73b2SBarry Smith         ierr = cudaSetDevice(device);CHKERRQ(ierr);
5914b0a73b2SBarry Smith       }
5922692e278SPaul Mullowney 
5932692e278SPaul Mullowney       /* set the device flags so that it can map host memory ... here, we error check. */
5942692e278SPaul Mullowney       err = cudaSetDeviceFlags(cudaDeviceMapHost);
5952692e278SPaul Mullowney       if (err != cudaSuccess)
5962692e278SPaul Mullowney         SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SYS,"error in cudaSetDevice %s",cudaGetErrorString(err));
5974b0a73b2SBarry Smith     }
598bd72cc96SPaul Mullowney   }
5994b0a73b2SBarry Smith #endif
6004b0a73b2SBarry Smith 
6014b0a73b2SBarry Smith 
602e5c89e4eSSatish Balay   /*
603e5c89e4eSSatish Balay        Print basic help message
604e5c89e4eSSatish Balay   */
6050298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
606e5c89e4eSSatish Balay   if (flg1) {
607e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
608301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -help: prints help method for each option\n");CHKERRQ(ierr);
609301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
610301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
611e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
612e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
613e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
614e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
615e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
616e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
617e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
618e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_nodes [n1,n2,..] Nodes to start in debugger\n");CHKERRQ(ierr);
619e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
620e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
621e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
6221cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
623e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
624e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
625e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
626e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
627e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
628e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc: use our error checking malloc\n");CHKERRQ(ierr);
629e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use error checking malloc\n");CHKERRQ(ierr);
6304161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
6314161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_log: keeps log of all memory allocations\n");CHKERRQ(ierr);
632e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_debug: enables extended checking for memory corruption\n");CHKERRQ(ierr);
633e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_table: dump list of options inputted\n");CHKERRQ(ierr);
634e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
635e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
636e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
637e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
638a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
6390841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
640e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
641e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
642a64a8e02SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log[_summary _summary_python]: logging objects and events\n");CHKERRQ(ierr);
643e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
644e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
645495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
646e5c89e4eSSatish Balay #endif
6476cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info <optional filename>: print informative messages about the calculations\n");CHKERRQ(ierr);
648e5c89e4eSSatish Balay #endif
649e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -v: prints PETSc version number and release date\n");CHKERRQ(ierr);
650e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
651e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
652e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
653e5c89e4eSSatish Balay   }
654e5c89e4eSSatish Balay 
65574ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
65674ba8654SBarry Smith   {
65774ba8654SBarry Smith   char machine[128];
65874ba8654SBarry Smith   ierr = PetscOptionsGetString(NULL,"-popen_machine",machine,128,&flg1);CHKERRQ(ierr);
65974ba8654SBarry Smith   if (flg1) {
66074ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
66174ba8654SBarry Smith   }
66274ba8654SBarry Smith   }
66374ba8654SBarry Smith #endif
66474ba8654SBarry Smith 
6650298fd71SBarry Smith   ierr = PetscOptionsGetReal(NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
666e5c89e4eSSatish Balay   if (flg1) {
667e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
668e5c89e4eSSatish Balay   }
669e5c89e4eSSatish Balay 
6700298fd71SBarry Smith   ierr = PetscOptionsGetString(NULL,"-info_exclude",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
6712ea1be5dSBarry Smith   if (flg1) {
672e5c89e4eSSatish Balay     ierr = PetscStrstr(mname,"null",&f);CHKERRQ(ierr);
673e5c89e4eSSatish Balay     if (f) {
674ecd8bba6SJed Brown       ierr = PetscInfoDeactivateClass(0);CHKERRQ(ierr);
675e5c89e4eSSatish Balay     }
6762ea1be5dSBarry Smith   }
677827f890bSBarry Smith 
678f14045dbSBarry Smith #if defined(PETSC_HAVE_CUSP) || defined(PETSC_HAVE_VIENNACL)
6790298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL,"-log_summary",&flg3);CHKERRQ(ierr);
680f14045dbSBarry Smith   if (!flg3) {
681f14045dbSBarry Smith   ierr = PetscOptionsHasName(NULL,"-log_view",&flg3);CHKERRQ(ierr);
682f14045dbSBarry Smith   }
683bab1f7e6SVictor Minden #endif
684f14045dbSBarry Smith #if defined(PETSC_HAVE_CUSP)
685f14045dbSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-cusp_synchronize",&flg3,NULL);CHKERRQ(ierr);
686f14045dbSBarry Smith   PetscCUSPSynchronize = flg3;
687f14045dbSBarry Smith #elif defined(PETSC_HAVE_VIENNACL)
688f14045dbSBarry Smith   ierr = PetscOptionsGetBool(NULL,"-viennacl_synchronize",&flg3,NULL);CHKERRQ(ierr);
689f14045dbSBarry Smith   PetscViennaCLSynchronize = flg3;
6904cf1874eSKarl Rupp #endif
691e5c89e4eSSatish Balay   PetscFunctionReturn(0);
692e5c89e4eSSatish Balay }
693df413903SBarry Smith 
694