xref: /petsc/src/sys/objects/init.c (revision a4af0ceea8a251db97ee0dc5c0d52d4adf50264a)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay 
3e5c89e4eSSatish Balay    This file defines part of the initialization of PETSc
4e5c89e4eSSatish Balay 
5540e20f2SPierre Jolivet   This file uses regular malloc and free because it cannot be known
6e5c89e4eSSatish Balay   what malloc is being used until it has already processed the input.
7e5c89e4eSSatish Balay */
8*a4af0ceeSJacob Faibussowitsch #include <petsc/private/petscimpl.h> /*I  "petscsys.h"   I*/
9ef386f4bSSatish Balay 
10ba61063dSBarry Smith #if defined(PETSC_HAVE_SYS_SYSINFO_H)
1151d315f7SKerry Stevens #include <sys/sysinfo.h>
12ba61063dSBarry Smith #endif
13121deb67SSatish Balay #if defined(PETSC_HAVE_UNISTD_H)
1451d315f7SKerry Stevens #include <unistd.h>
15121deb67SSatish Balay #endif
1605035670SJunchao Zhang 
17e5c89e4eSSatish Balay /* ------------------------Nasty global variables -------------------------------*/
18e5c89e4eSSatish Balay /*
19e5c89e4eSSatish Balay      Indicates if PETSc started up MPI, or it was
20e5c89e4eSSatish Balay    already started before PETSc was initialized.
21e5c89e4eSSatish Balay */
220cbf60d0SJose E. Roman PetscBool   PetscBeganMPI                 = PETSC_FALSE;
238ad20175SVaclav Hapla PetscBool   PetscErrorHandlingInitialized = PETSC_FALSE;
240cbf60d0SJose E. Roman PetscBool   PetscInitializeCalled         = PETSC_FALSE;
250cbf60d0SJose E. Roman PetscBool   PetscFinalizeCalled           = PETSC_FALSE;
26d6f2c3cbSBarry Smith 
277087cfbeSBarry Smith PetscMPIInt PetscGlobalRank               = -1;
287087cfbeSBarry Smith PetscMPIInt PetscGlobalSize               = -1;
29ba61063dSBarry Smith 
30c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS)
31c2b86a48SJunchao Zhang PetscBool   PetscBeganKokkos              = PETSC_FALSE;
32c2b86a48SJunchao Zhang #endif
33c2b86a48SJunchao Zhang 
3471438e86SJunchao Zhang #if defined(PETSC_HAVE_NVSHMEM)
3571438e86SJunchao Zhang PetscBool   PetscBeganNvshmem             = PETSC_FALSE;
3671438e86SJunchao Zhang PetscBool   PetscNvshmemInitialized       = PETSC_FALSE;
3771438e86SJunchao Zhang #endif
3871438e86SJunchao Zhang 
39*a4af0ceeSJacob Faibussowitsch PetscBool   use_gpu_aware_mpi             = PetscDefined(HAVE_MPIUNI) ? PETSC_FALSE : PETSC_TRUE;
40c2a741eeSJunchao Zhang 
4150f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
42e5c89e4eSSatish Balay #if defined(PETSC_COMPLEX_INSTANTIATE)
43e5c89e4eSSatish Balay template <> class std::complex<double>; /* instantiate complex template class */
44e5c89e4eSSatish Balay #endif
458619c96cSJed Brown 
468619c96cSJed Brown /*MC
478619c96cSJed Brown    PETSC_i - the imaginary number i
488619c96cSJed Brown 
498619c96cSJed Brown    Synopsis:
508619c96cSJed Brown    #include <petscsys.h>
518619c96cSJed Brown    PetscComplex PETSC_i;
528619c96cSJed Brown 
538619c96cSJed Brown    Level: beginner
548619c96cSJed Brown 
558619c96cSJed Brown    Note:
568cd53115SBarry Smith    Complex numbers are automatically available if PETSc located a working complex implementation
578619c96cSJed Brown 
588619c96cSJed Brown .seealso: PetscRealPart(), PetscImaginaryPart(), PetscRealPartComplex(), PetscImaginaryPartComplex()
598619c96cSJed Brown M*/
6050f81f78SJed Brown PetscComplex PETSC_i;
617a19d461SSatish Balay MPI_Datatype MPIU___COMPLEX128 = 0;
627a19d461SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
63ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
64c90a1750SBarry Smith MPI_Datatype MPIU___FLOAT128 = 0;
65570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
66570b7f6dSBarry Smith MPI_Datatype MPIU___FP16 = 0;
67c90a1750SBarry Smith #endif
687087cfbeSBarry Smith MPI_Datatype MPIU_2SCALAR = 0;
69092991acSStefano Zampini MPI_Datatype MPIU_REAL_INT = 0;
70092991acSStefano Zampini MPI_Datatype MPIU_SCALAR_INT = 0;
710354ff80SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
727087cfbeSBarry Smith MPI_Datatype MPIU_2INT = 0;
7344041f26SJed Brown #endif
74b5a892a1SMatthew G. Knepley MPI_Datatype MPI_4INT = 0;
75b5a892a1SMatthew G. Knepley MPI_Datatype MPIU_4INT = 0;
768ad47952SJed Brown MPI_Datatype MPIU_BOOL;
778ad47952SJed Brown MPI_Datatype MPIU_ENUM;
787cdaf61dSJed Brown MPI_Datatype MPIU_FORTRANADDR;
79e316c87fSJed Brown MPI_Datatype MPIU_SIZE_T;
8075567043SBarry Smith 
81e5c89e4eSSatish Balay /*
82e5c89e4eSSatish Balay        Function that is called to display all error messages
83e5c89e4eSSatish Balay */
847087cfbeSBarry Smith PetscErrorCode (*PetscErrorPrintf)(const char [],...)          = PetscErrorPrintfDefault;
857087cfbeSBarry Smith PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char [],...)  = PetscHelpPrintfDefault;
867087cfbeSBarry Smith PetscErrorCode (*PetscVFPrintf)(FILE*,const char[],va_list)    = PetscVFPrintfDefault;
87bab1f7e6SVictor Minden 
88e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
89e5c89e4eSSatish Balay /*
90e5c89e4eSSatish Balay    Optional file where all PETSc output from various prints is saved
91e5c89e4eSSatish Balay */
9295c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
930298fd71SBarry Smith FILE *petsc_history = NULL;
94e5c89e4eSSatish Balay 
957087cfbeSBarry Smith PetscErrorCode  PetscOpenHistoryFile(const char filename[],FILE **fd)
96e5c89e4eSSatish Balay {
97e5c89e4eSSatish Balay   PetscErrorCode ierr;
98e5c89e4eSSatish Balay   PetscMPIInt    rank,size;
99e5c89e4eSSatish Balay   char           pfile[PETSC_MAX_PATH_LEN],pname[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN],date[64];
100e5c89e4eSSatish Balay   char           version[256];
101e5c89e4eSSatish Balay 
102e5c89e4eSSatish Balay   PetscFunctionBegin;
103ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr);
104dd400576SPatrick Sanan   if (rank == 0) {
105e5c89e4eSSatish Balay     char        arch[10];
106f56c2debSBarry Smith     int         err;
107f56c2debSBarry Smith 
108e5c89e4eSSatish Balay     ierr = PetscGetArchType(arch,10);CHKERRQ(ierr);
109e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
110a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
111ffc4695bSBarry Smith     ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRMPI(ierr);
112e5c89e4eSSatish Balay     if (filename) {
113e5c89e4eSSatish Balay       ierr = PetscFixFilename(filename,fname);CHKERRQ(ierr);
114e5c89e4eSSatish Balay     } else {
115589a23caSBarry Smith       ierr = PetscGetHomeDirectory(pfile,sizeof(pfile));CHKERRQ(ierr);
116589a23caSBarry Smith       ierr = PetscStrlcat(pfile,"/.petschistory",sizeof(pfile));CHKERRQ(ierr);
117e5c89e4eSSatish Balay       ierr = PetscFixFilename(pfile,fname);CHKERRQ(ierr);
118e5c89e4eSSatish Balay     }
119e5c89e4eSSatish Balay 
120a297a907SKarl Rupp     *fd = fopen(fname,"a");
121a297a907SKarl Rupp     if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file: %s",fname);
122a297a907SKarl Rupp 
123c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
124e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s %s\n",version,date);CHKERRQ(ierr);
125589a23caSBarry Smith     ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
126e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"%s on a %s, %d proc. with options:\n",pname,arch,size);CHKERRQ(ierr);
127c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
128a297a907SKarl Rupp 
129f56c2debSBarry Smith     err = fflush(*fd);
130e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
131e5c89e4eSSatish Balay   }
132e5c89e4eSSatish Balay   PetscFunctionReturn(0);
133e5c89e4eSSatish Balay }
134e5c89e4eSSatish Balay 
13595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
136e5c89e4eSSatish Balay {
137e5c89e4eSSatish Balay   PetscErrorCode ierr;
138e5c89e4eSSatish Balay   PetscMPIInt    rank;
139e5c89e4eSSatish Balay   char           date[64];
140f56c2debSBarry Smith   int            err;
141e5c89e4eSSatish Balay 
142e5c89e4eSSatish Balay   PetscFunctionBegin;
143ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRMPI(ierr);
144dd400576SPatrick Sanan   if (rank == 0) {
145e5c89e4eSSatish Balay     ierr = PetscGetDate(date,64);CHKERRQ(ierr);
146c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
147e5c89e4eSSatish Balay     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"Finished at %s\n",date);CHKERRQ(ierr);
148c0bb3764SVaclav Hapla     ierr = PetscFPrintf(PETSC_COMM_SELF,*fd,"----------------------------------------\n");CHKERRQ(ierr);
149f56c2debSBarry Smith     err  = fflush(*fd);
150e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fflush() failed on file");
151f56c2debSBarry Smith     err = fclose(*fd);
152e32f2f54SBarry Smith     if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
153e5c89e4eSSatish Balay   }
154e5c89e4eSSatish Balay   PetscFunctionReturn(0);
155e5c89e4eSSatish Balay }
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay /* ------------------------------------------------------------------------------*/
158e5c89e4eSSatish Balay 
159e5c89e4eSSatish Balay /*
160e5c89e4eSSatish Balay    This is ugly and probably belongs somewhere else, but I want to
161e5c89e4eSSatish Balay   be able to put a true MPI abort error handler with command line args.
162e5c89e4eSSatish Balay 
163e5c89e4eSSatish Balay     This is so MPI errors in the debugger will leave all the stack
1643c311c98SBarry Smith   frames. The default MP_Abort() cleans up and exits thus providing no useful information
1653c311c98SBarry Smith   in the debugger hence we call abort() instead of MPI_Abort().
166e5c89e4eSSatish Balay */
167e5c89e4eSSatish Balay 
16833c7d699SBarry Smith void Petsc_MPI_AbortOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
169e5c89e4eSSatish Balay {
170e5c89e4eSSatish Balay   PetscFunctionBegin;
1713c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
172e5c89e4eSSatish Balay   abort();
173e5c89e4eSSatish Balay }
174e5c89e4eSSatish Balay 
17533c7d699SBarry Smith void Petsc_MPI_DebuggerOnError(MPI_Comm *comm,PetscMPIInt *flag,...)
176e5c89e4eSSatish Balay {
177e5c89e4eSSatish Balay   PetscErrorCode ierr;
178e5c89e4eSSatish Balay 
179e5c89e4eSSatish Balay   PetscFunctionBegin;
1803c311c98SBarry Smith   (*PetscErrorPrintf)("MPI error %d\n",*flag);
181e5c89e4eSSatish Balay   ierr = PetscAttachDebugger();
18241e02c4dSJunchao Zhang   if (ierr) PETSCABORT(*comm,*flag); /* hopeless so get out */
183e5c89e4eSSatish Balay }
184e5c89e4eSSatish Balay 
185e5c89e4eSSatish Balay /*@C
186e5c89e4eSSatish Balay    PetscEnd - Calls PetscFinalize() and then ends the program. This is useful if one
187e5c89e4eSSatish Balay      wishes a clean exit somewhere deep in the program.
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay    Options Database Keys are the same as for PetscFinalize()
192e5c89e4eSSatish Balay 
193e5c89e4eSSatish Balay    Level: advanced
194e5c89e4eSSatish Balay 
195e5c89e4eSSatish Balay    Note:
196e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
197e5c89e4eSSatish Balay 
19888c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscFinalize()
199e5c89e4eSSatish Balay @*/
2007087cfbeSBarry Smith PetscErrorCode  PetscEnd(void)
201e5c89e4eSSatish Balay {
202e5c89e4eSSatish Balay   PetscFunctionBegin;
203e5c89e4eSSatish Balay   PetscFinalize();
204e5c89e4eSSatish Balay   exit(0);
205e5c89e4eSSatish Balay   return 0;
206e5c89e4eSSatish Balay }
207e5c89e4eSSatish Balay 
208ace3abfcSBarry Smith PetscBool PetscOptionsPublish = PETSC_FALSE;
20995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
21095c0884eSLisandro Dalcin PETSC_INTERN PetscBool      petscsetmallocvisited;
211e5c89e4eSSatish Balay static       char           emacsmachinename[256];
212e5c89e4eSSatish Balay 
21302c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL;
21402c9f0b5SLisandro Dalcin PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm)    = NULL;
215e5c89e4eSSatish Balay 
216*a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG)
217*a4af0ceeSJacob Faibussowitsch #include <petscviewer.h>
218*a4af0ceeSJacob Faibussowitsch #endif
219*a4af0ceeSJacob Faibussowitsch 
220e5c89e4eSSatish Balay /*@C
221e5c89e4eSSatish Balay    PetscSetHelpVersionFunctions - Sets functions that print help and version information
222e5c89e4eSSatish Balay    before the PETSc help and version information is printed. Must call BEFORE PetscInitialize().
223e5c89e4eSSatish Balay    This routine enables a "higher-level" package that uses PETSc to print its messages first.
224e5c89e4eSSatish Balay 
225d8d19677SJose E. Roman    Input Parameters:
2260298fd71SBarry Smith +  help - the help function (may be NULL)
2270298fd71SBarry Smith -  version - the version function (may be NULL)
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay    Level: developer
230e5c89e4eSSatish Balay 
231e5c89e4eSSatish Balay @*/
2327087cfbeSBarry Smith PetscErrorCode  PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm),PetscErrorCode (*version)(MPI_Comm))
233e5c89e4eSSatish Balay {
234e5c89e4eSSatish Balay   PetscFunctionBegin;
235e5c89e4eSSatish Balay   PetscExternalHelpFunction    = help;
236e5c89e4eSSatish Balay   PetscExternalVersionFunction = version;
237e5c89e4eSSatish Balay   PetscFunctionReturn(0);
238e5c89e4eSSatish Balay }
239e5c89e4eSSatish Balay 
24005df10baSBarry Smith #if defined(PETSC_USE_LOG)
24195c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
24205df10baSBarry Smith #endif
24305df10baSBarry Smith 
24457171095SVaclav Hapla PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Private(const char help[])
245e5c89e4eSSatish Balay {
246e5ed2c37SJose E. Roman   char              string[64];
247e5c89e4eSSatish Balay   MPI_Comm          comm = PETSC_COMM_WORLD;
248*a4af0ceeSJacob Faibussowitsch   PetscBool         flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE,flag,hasHelp;
249e5c89e4eSSatish Balay   PetscErrorCode    ierr;
25067584ceeSBarry Smith   PetscReal         si;
25128559dc8SJed Brown   PetscInt          intensity;
252e5c89e4eSSatish Balay   int               i;
253e5c89e4eSSatish Balay   PetscMPIInt       rank;
254d314f959SVaclav Hapla   char              version[256];
2552479a3a6SBarry Smith #if defined(PETSC_USE_LOG)
256e5ed2c37SJose E. Roman   char              mname[PETSC_MAX_PATH_LEN];
2572479a3a6SBarry Smith   PetscViewerFormat format;
25867584ceeSBarry Smith   PetscBool         flg4 = PETSC_FALSE;
25967584ceeSBarry Smith #endif
2607381773fSBarry Smith 
261e5c89e4eSSatish Balay   PetscFunctionBegin;
262ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
263e5c89e4eSSatish Balay 
26427104ee2SJacob Faibussowitsch   /*
26527104ee2SJacob Faibussowitsch      Setup building of stack frames for all function calls
26627104ee2SJacob Faibussowitsch   */
26727104ee2SJacob Faibussowitsch   if (PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)) {
26827104ee2SJacob Faibussowitsch     ierr = PetscOptionsGetBool(NULL,NULL,"-checkstack",&flg1,NULL);CHKERRQ(ierr);
26927104ee2SJacob Faibussowitsch     ierr = PetscStackSetCheck(flg1);CHKERRQ(ierr);
27027104ee2SJacob Faibussowitsch   }
27127104ee2SJacob Faibussowitsch 
27267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
27392f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
274e5c89e4eSSatish Balay     /*
275e5c89e4eSSatish Balay       Setup the memory management; support for tracing malloc() usage
276e5c89e4eSSatish Balay     */
277244bdbccSBarry Smith     PetscBool mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
27892f119d6SBarry Smith 
27976bd3646SJed Brown     if (PetscDefined(USE_DEBUG)) {
28092f119d6SBarry Smith       mdebug        = PETSC_TRUE;
28192f119d6SBarry Smith       initializenan = PETSC_TRUE;
28292f119d6SBarry Smith       ierr   = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
28376bd3646SJed Brown     } else {
28492f119d6SBarry Smith       /* don't warn about unused option */
28592f119d6SBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-malloc_test",&flg1);CHKERRQ(ierr);
28692f119d6SBarry Smith       flg1 = PETSC_FALSE;
28776bd3646SJed Brown     }
28879dccf82SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg2,&flg3);CHKERRQ(ierr);
28992f119d6SBarry Smith     if (flg1 || flg2) {
29092f119d6SBarry Smith       mdebug        = PETSC_TRUE;
29192f119d6SBarry Smith       eachcall      = PETSC_TRUE;
29292f119d6SBarry Smith       initializenan = PETSC_TRUE;
29379dccf82SBarry Smith     } else if (flg3 && !flg2) {
29479dccf82SBarry Smith       mdebug        = PETSC_FALSE;
29579dccf82SBarry Smith       eachcall      = PETSC_FALSE;
29679dccf82SBarry Smith       initializenan = PETSC_FALSE;
297e5c89e4eSSatish Balay     }
29892f119d6SBarry Smith 
299608c71bfSMatthew G. Knepley     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_requested_size",&flg1,&flg2);CHKERRQ(ierr);
300608c71bfSMatthew G. Knepley     if (flg2) {ierr = PetscMallocLogRequestedSizeSet(flg1);CHKERRQ(ierr);}
301608c71bfSMatthew G. Knepley 
30292f119d6SBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_view",&mlog);CHKERRQ(ierr);
30392f119d6SBarry Smith     if (mlog) {
30492f119d6SBarry Smith       mdebug = PETSC_TRUE;
30592f119d6SBarry Smith     }
30679dccf82SBarry Smith     /* the next line is deprecated */
30792f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc",&mdebug,NULL);CHKERRQ(ierr);
30892f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_dump",&mdebug,NULL);CHKERRQ(ierr);
30992f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&mdebug,NULL);CHKERRQ(ierr);
31092f119d6SBarry Smith     if (mdebug) {
31192f119d6SBarry Smith       ierr = PetscMallocSetDebug(eachcall,initializenan);CHKERRQ(ierr);
31292f119d6SBarry Smith     }
31392f119d6SBarry Smith     if (mlog) {
31492f119d6SBarry Smith       PetscReal logthreshold = 0;
31592f119d6SBarry Smith       ierr = PetscOptionsGetReal(NULL,NULL,"-malloc_view_threshold",&logthreshold,NULL);CHKERRQ(ierr);
31692f119d6SBarry Smith       ierr = PetscMallocViewSet(logthreshold);CHKERRQ(ierr);
31792f119d6SBarry Smith     }
3188b254c29SBarry Smith #if defined(PETSC_USE_LOG)
3198b254c29SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-log_view_memory",&PetscLogMemory,NULL);CHKERRQ(ierr);
3208b254c29SBarry Smith #endif
32192f119d6SBarry Smith   }
32292f119d6SBarry Smith 
323ba282f50SJed Brown   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_coalesce",&flg1,&flg2);CHKERRQ(ierr);
324ba282f50SJed Brown   if (flg2) {ierr = PetscMallocSetCoalesce(flg1);CHKERRQ(ierr);}
32590d69ab7SBarry Smith   flg1 = PETSC_FALSE;
3262f21b5c6SHong Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_hbw",&flg1,NULL);CHKERRQ(ierr);
327cf6f3811SHong Zhang   /* ignore this option if malloc is already set */
328cf6f3811SHong Zhang   if (flg1 && !petscsetmallocvisited) {ierr = PetscSetUseHBWMalloc_Private();CHKERRQ(ierr);}
329e5c89e4eSSatish Balay 
33090d69ab7SBarry Smith   flg1 = PETSC_FALSE;
331c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg1,NULL);CHKERRQ(ierr);
3327783f70dSSatish Balay   if (!flg1) {
33390d69ab7SBarry Smith     flg1 = PETSC_FALSE;
334c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg1,NULL);CHKERRQ(ierr);
3357783f70dSSatish Balay   }
336e5c89e4eSSatish Balay   if (flg1) {
337e5c89e4eSSatish Balay     ierr = PetscMemorySetGetMaximumUsage();CHKERRQ(ierr);
338e5c89e4eSSatish Balay   }
33967584ceeSBarry Smith #endif
340e5c89e4eSSatish Balay 
341b4427426SBarry Smith #if defined(PETSC_USE_LOG)
342c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&PetscObjectsLog);CHKERRQ(ierr);
343b4427426SBarry Smith #endif
34405df10baSBarry Smith 
345e5c89e4eSSatish Balay   /*
346e5c89e4eSSatish Balay       Set the display variable for graphics
347e5c89e4eSSatish Balay   */
348e5c89e4eSSatish Balay   ierr = PetscSetDisplay();CHKERRQ(ierr);
349e5c89e4eSSatish Balay 
35051dcc849SKerry Stevens   /*
35157171095SVaclav Hapla      Print main application help message
35257171095SVaclav Hapla   */
35357171095SVaclav Hapla   ierr = PetscOptionsHasHelp(NULL,&hasHelp);CHKERRQ(ierr);
35457171095SVaclav Hapla   if (help && hasHelp) {
35557171095SVaclav Hapla     ierr = PetscPrintf(comm,help);CHKERRQ(ierr);
35657171095SVaclav Hapla     ierr = PetscPrintf(comm,"----------------------------------------\n");CHKERRQ(ierr);
35757171095SVaclav Hapla   }
35857171095SVaclav Hapla 
35957171095SVaclav Hapla   /*
360e5c89e4eSSatish Balay       Print the PETSc version information
361e5c89e4eSSatish Balay   */
362d314f959SVaclav Hapla   ierr = PetscOptionsHasName(NULL,NULL,"-version",&flg1);CHKERRQ(ierr);
363d314f959SVaclav Hapla   if (flg1 || hasHelp) {
364e5c89e4eSSatish Balay     /*
365e5c89e4eSSatish Balay        Print "higher-level" package version message
366e5c89e4eSSatish Balay     */
367e5c89e4eSSatish Balay     if (PetscExternalVersionFunction) {
368e5c89e4eSSatish Balay       ierr = (*PetscExternalVersionFunction)(comm);CHKERRQ(ierr);
369e5c89e4eSSatish Balay     }
370e5c89e4eSSatish Balay 
371a523d312SBarry Smith     ierr = PetscGetVersion(version,256);CHKERRQ(ierr);
372e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s\n",version);CHKERRQ(ierr);
373e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"%s",PETSC_AUTHOR_INFO);CHKERRQ(ierr);
374e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/changes/index.html for recent updates.\n");CHKERRQ(ierr);
37584e42920SBarry Smith     ierr = (*PetscHelpPrintf)(comm,"See docs/faq.html for problems.\n");CHKERRQ(ierr);
376e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"See docs/manualpages/index.html for help. \n");CHKERRQ(ierr);
377e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Libraries linked from %s\n",PETSC_LIB_DIR);CHKERRQ(ierr);
378c0bb3764SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm,"----------------------------------------\n");CHKERRQ(ierr);
3797ca660e7SBarry Smith   }
3807ca660e7SBarry Smith 
38194941ca7SBarry Smith   /*
38294941ca7SBarry Smith        Print "higher-level" package help message
38394941ca7SBarry Smith   */
38457171095SVaclav Hapla   if (hasHelp) {
385d314f959SVaclav Hapla     PetscBool hasHelpIntro;
386d314f959SVaclav Hapla 
38794941ca7SBarry Smith     if (PetscExternalHelpFunction) {
38894941ca7SBarry Smith       ierr = (*PetscExternalHelpFunction)(comm);CHKERRQ(ierr);
38994941ca7SBarry Smith     }
390d314f959SVaclav Hapla     ierr = PetscOptionsHasHelpIntro_Internal(NULL,&hasHelpIntro);CHKERRQ(ierr);
391d314f959SVaclav Hapla     if (hasHelpIntro) {
392bdb346e9SBarry Smith       ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
393008a6e76SBarry Smith       ierr = PetscFreeMPIResources();CHKERRQ(ierr);
394ffc4695bSBarry Smith       ierr = MPI_Finalize();CHKERRMPI(ierr);
3957ca660e7SBarry Smith       exit(0);
3967ca660e7SBarry Smith     }
397e5c89e4eSSatish Balay   }
398e5c89e4eSSatish Balay 
399e5c89e4eSSatish Balay   /*
400e5c89e4eSSatish Balay       Setup the error handling
401e5c89e4eSSatish Balay   */
40290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
403c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_abort",&flg1,NULL);CHKERRQ(ierr);
404b59baad1SJed Brown   if (flg1) {
405ffc4695bSBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_ARE_FATAL);CHKERRMPI(ierr);
40602c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
407b59baad1SJed Brown   }
40890d69ab7SBarry Smith   flg1 = PETSC_FALSE;
409c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-on_error_mpiabort",&flg1,NULL);CHKERRQ(ierr);
41002c9f0b5SLisandro Dalcin   if (flg1) { ierr = PetscPushErrorHandler(PetscMPIAbortErrorHandler,NULL);CHKERRQ(ierr);}
41190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
412c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpi_return_on_error",&flg1,NULL);CHKERRQ(ierr);
413e5c89e4eSSatish Balay   if (flg1) {
414ffc4695bSBarry Smith     ierr = MPI_Comm_set_errhandler(comm,MPI_ERRORS_RETURN);CHKERRMPI(ierr);
415e5c89e4eSSatish Balay   }
41690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
417c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
4188d359177SBarry Smith   if (!flg1) {ierr = PetscPushSignalHandler(PetscSignalHandlerDefault,(void*)0);CHKERRQ(ierr);}
419e5c89e4eSSatish Balay 
420e5c89e4eSSatish Balay   /*
421e5c89e4eSSatish Balay       Setup debugger information
422e5c89e4eSSatish Balay   */
423e5c89e4eSSatish Balay   ierr = PetscSetDefaultDebugger();CHKERRQ(ierr);
424589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_attach_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
425e5c89e4eSSatish Balay   if (flg1) {
426e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
427e5c89e4eSSatish Balay 
428e5c89e4eSSatish Balay     ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
429ffc4695bSBarry Smith     ierr = MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError,&err_handler);CHKERRMPI(ierr);
430ffc4695bSBarry Smith     ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRMPI(ierr);
43102c9f0b5SLisandro Dalcin     ierr = PetscPushErrorHandler(PetscAttachDebuggerErrorHandler,NULL);CHKERRQ(ierr);
432e5c89e4eSSatish Balay   }
433589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-debug_terminal",string,sizeof(string),&flg1);CHKERRQ(ierr);
4345e96ac45SJed Brown   if (flg1) { ierr = PetscSetDebugTerminal(string);CHKERRQ(ierr); }
435589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-start_in_debugger",string,sizeof(string),&flg1);CHKERRQ(ierr);
436589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-stop_for_debugger",string,sizeof(string),&flg2);CHKERRQ(ierr);
437e5c89e4eSSatish Balay   if (flg1 || flg2) {
438e5c89e4eSSatish Balay     PetscMPIInt    size;
439bf4d2887SBarry Smith     PetscInt       lsize,*ranks;
440e5c89e4eSSatish Balay     MPI_Errhandler err_handler;
441e5c89e4eSSatish Balay     /*
442e5c89e4eSSatish Balay        we have to make sure that all processors have opened
443e5c89e4eSSatish Balay        connections to all other processors, otherwise once the
444e5c89e4eSSatish Balay        debugger has stated it is likely to receive a SIGUSR1
445e5c89e4eSSatish Balay        and kill the program.
446e5c89e4eSSatish Balay     */
447ffc4695bSBarry Smith     ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
448e5c89e4eSSatish Balay     if (size > 2) {
449533163c2SBarry Smith       PetscMPIInt dummy = 0;
450e5c89e4eSSatish Balay       MPI_Status  status;
451e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
452e5c89e4eSSatish Balay         if (rank != i) {
453ffc4695bSBarry Smith           ierr = MPI_Send(&dummy,1,MPI_INT,i,109,comm);CHKERRMPI(ierr);
454e5c89e4eSSatish Balay         }
455e5c89e4eSSatish Balay       }
456e5c89e4eSSatish Balay       for (i=0; i<size; i++) {
457e5c89e4eSSatish Balay         if (rank != i) {
458ffc4695bSBarry Smith           ierr = MPI_Recv(&dummy,1,MPI_INT,i,109,comm,&status);CHKERRMPI(ierr);
459e5c89e4eSSatish Balay         }
460e5c89e4eSSatish Balay       }
461e5c89e4eSSatish Balay     }
462e5c89e4eSSatish Balay     /* check if this processor node should be in debugger */
463bf4d2887SBarry Smith     ierr  = PetscMalloc1(size,&ranks);CHKERRQ(ierr);
464e5c89e4eSSatish Balay     lsize = size;
465bf4d2887SBarry Smith     /* Deprecated in 3.14 */
466bf4d2887SBarry Smith     ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_nodes",ranks,&lsize,&flag);CHKERRQ(ierr);
467bf4d2887SBarry Smith     if (flag) {
468bf4d2887SBarry Smith       const char * const quietopt="-options_suppress_deprecated_warnings";
469bf4d2887SBarry Smith       char               msg[4096];
470bf4d2887SBarry Smith       PetscBool          quiet = PETSC_FALSE;
471bf4d2887SBarry Smith 
472bf4d2887SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,quietopt,&quiet,NULL);CHKERRQ(ierr);
473bf4d2887SBarry Smith       if (!quiet) {
474bf4d2887SBarry Smith         ierr = PetscStrcpy(msg,"** PETSc DEPRECATION WARNING ** : the option ");CHKERRQ(ierr);
475bf4d2887SBarry Smith         ierr = PetscStrcat(msg,"-debugger_nodes");CHKERRQ(ierr);
476bf4d2887SBarry Smith         ierr = PetscStrcat(msg," is deprecated as of version ");CHKERRQ(ierr);
477bf4d2887SBarry Smith         ierr = PetscStrcat(msg,"3.14");CHKERRQ(ierr);
478bf4d2887SBarry Smith         ierr = PetscStrcat(msg," and will be removed in a future release.");CHKERRQ(ierr);
479bf4d2887SBarry Smith         ierr = PetscStrcat(msg," Please use the option ");CHKERRQ(ierr);
480bf4d2887SBarry Smith         ierr = PetscStrcat(msg,"-debugger_ranks");CHKERRQ(ierr);
481bf4d2887SBarry Smith         ierr = PetscStrcat(msg," instead.");CHKERRQ(ierr);
482bf4d2887SBarry Smith         ierr = PetscStrcat(msg," (Silence this warning with ");CHKERRQ(ierr);
483bf4d2887SBarry Smith         ierr = PetscStrcat(msg,quietopt);CHKERRQ(ierr);
484bf4d2887SBarry Smith         ierr = PetscStrcat(msg,")\n");CHKERRQ(ierr);
485bf4d2887SBarry Smith         ierr = PetscPrintf(comm,msg);CHKERRQ(ierr);
486bf4d2887SBarry Smith       }
487bf4d2887SBarry Smith     } else {
488bf4d2887SBarry Smith       lsize = size;
489bf4d2887SBarry Smith       ierr  = PetscOptionsGetIntArray(NULL,NULL,"-debugger_ranks",ranks,&lsize,&flag);CHKERRQ(ierr);
490bf4d2887SBarry Smith     }
491e5c89e4eSSatish Balay     if (flag) {
492e5c89e4eSSatish Balay       for (i=0; i<lsize; i++) {
493bf4d2887SBarry Smith         if (ranks[i] == rank) { flag = PETSC_FALSE; break; }
494e5c89e4eSSatish Balay       }
495e5c89e4eSSatish Balay     }
496e5c89e4eSSatish Balay     if (!flag) {
497e5c89e4eSSatish Balay       ierr = PetscSetDebuggerFromString(string);CHKERRQ(ierr);
49802c9f0b5SLisandro Dalcin       ierr = PetscPushErrorHandler(PetscAbortErrorHandler,NULL);CHKERRQ(ierr);
499e5c89e4eSSatish Balay       if (flg1) {
500e5c89e4eSSatish Balay         ierr = PetscAttachDebugger();CHKERRQ(ierr);
501e5c89e4eSSatish Balay       } else {
502e5c89e4eSSatish Balay         ierr = PetscStopForDebugger();CHKERRQ(ierr);
503e5c89e4eSSatish Balay       }
504ffc4695bSBarry Smith       ierr = MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError,&err_handler);CHKERRMPI(ierr);
505ffc4695bSBarry Smith       ierr = MPI_Comm_set_errhandler(comm,err_handler);CHKERRMPI(ierr);
5062a2a2941SBarry Smith     } else {
5072a2a2941SBarry Smith       ierr = PetscWaitOnError();CHKERRQ(ierr);
508e5c89e4eSSatish Balay     }
509bf4d2887SBarry Smith     ierr = PetscFree(ranks);CHKERRQ(ierr);
510e5c89e4eSSatish Balay   }
511e5c89e4eSSatish Balay 
512589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-on_error_emacs",emacsmachinename,sizeof(emacsmachinename),&flg1);CHKERRQ(ierr);
513dd400576SPatrick Sanan   if (flg1 && rank == 0) {ierr = PetscPushErrorHandler(PetscEmacsClientErrorHandler,emacsmachinename);CHKERRQ(ierr);}
514e5c89e4eSSatish Balay 
515e5c89e4eSSatish Balay   /*
516e5c89e4eSSatish Balay         Setup profiling and logging
517e5c89e4eSSatish Balay   */
5186cf91177SBarry Smith #if defined(PETSC_USE_INFO)
5198bb29257SSatish Balay   {
520e94e781bSJacob Faibussowitsch     ierr = PetscInfoSetFromOptions(NULL);CHKERRQ(ierr);
521e5c89e4eSSatish Balay   }
522865f6aa8SSatish Balay #endif
523aba4c478SBarry Smith   ierr = PetscDetermineInitialFPTrap();
524cc9df77eSBarry Smith   flg1 = PETSC_FALSE;
525cc9df77eSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-fp_trap",&flg1,&flag);CHKERRQ(ierr);
526cc9df77eSBarry Smith   if (flag) {ierr = PetscSetFPTrap((PetscFPTrap)flg1);CHKERRQ(ierr);}
527cc9df77eSBarry Smith   ierr = PetscOptionsGetInt(NULL,NULL,"-check_pointer_intensity",&intensity,&flag);CHKERRQ(ierr);
528cc9df77eSBarry Smith   if (flag) {ierr = PetscCheckPointerSetIntensity(intensity);CHKERRQ(ierr);}
529865f6aa8SSatish Balay #if defined(PETSC_USE_LOG)
530865f6aa8SSatish Balay   mname[0] = 0;
531589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-history",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
532865f6aa8SSatish Balay   if (flg1) {
533865f6aa8SSatish Balay     if (mname[0]) {
534f3dea69dSBarry Smith       ierr = PetscOpenHistoryFile(mname,&petsc_history);CHKERRQ(ierr);
535865f6aa8SSatish Balay     } else {
536706d7a88SBarry Smith       ierr = PetscOpenHistoryFile(NULL,&petsc_history);CHKERRQ(ierr);
537865f6aa8SSatish Balay     }
538865f6aa8SSatish Balay   }
539217044c2SLisandro Dalcin 
540217044c2SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-log_sync",&PetscLogSyncOn,NULL);CHKERRQ(ierr);
541217044c2SLisandro Dalcin 
542e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
54390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
544c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_mpe",&flg1);CHKERRQ(ierr);
545495fc317SBarry Smith   if (flg1) {ierr = PetscLogMPEBegin();CHKERRQ(ierr);}
546e5c89e4eSSatish Balay #endif
54790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
54890d69ab7SBarry Smith   flg3 = PETSC_FALSE;
549c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-log_all",&flg1,NULL);CHKERRQ(ierr);
550c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-log_summary",&flg3);CHKERRQ(ierr);
551e5c89e4eSSatish Balay   if (flg1)                      { ierr = PetscLogAllBegin();CHKERRQ(ierr); }
552bb1d7374SBarry Smith   else if (flg3)                 { ierr = PetscLogDefaultBegin();CHKERRQ(ierr);}
553e5c89e4eSSatish Balay 
554589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_trace",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
555e5c89e4eSSatish Balay   if (flg1) {
556e5c89e4eSSatish Balay     char name[PETSC_MAX_PATH_LEN],fname[PETSC_MAX_PATH_LEN];
557e5c89e4eSSatish Balay     FILE *file;
558e5c89e4eSSatish Balay     if (mname[0]) {
5592e924ca5SSatish Balay       PetscSNPrintf(name,PETSC_MAX_PATH_LEN,"%s.%d",mname,rank);
560e5c89e4eSSatish Balay       ierr = PetscFixFilename(name,fname);CHKERRQ(ierr);
561e5c89e4eSSatish Balay       file = fopen(fname,"w");
562f3dea69dSBarry Smith       if (!file) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Unable to open trace file: %s",fname);
563a297a907SKarl Rupp     } else file = PETSC_STDOUT;
564e5c89e4eSSatish Balay     ierr = PetscLogTraceBegin(file);CHKERRQ(ierr);
565e5c89e4eSSatish Balay   }
566bb1d7374SBarry Smith 
56716413a6aSBarry Smith   ierr = PetscOptionsGetViewer(comm,NULL,NULL,"-log_view",NULL,&format,&flg4);CHKERRQ(ierr);
568bb1d7374SBarry Smith   if (flg4) {
569d0a29bd7SConnor Ward     if (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
570bb1d7374SBarry Smith       ierr = PetscLogNestedBegin();CHKERRQ(ierr);
571bb1d7374SBarry Smith     } else {
572bb1d7374SBarry Smith       ierr = PetscLogDefaultBegin();CHKERRQ(ierr);
573bb1d7374SBarry Smith     }
574eccbb886SLisandro Dalcin   }
575d0a29bd7SConnor Ward   if (flg4 && (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH)) {
576eccbb886SLisandro Dalcin     PetscReal threshold = PetscRealConstant(0.01);
577eccbb886SLisandro Dalcin     ierr = PetscOptionsGetReal(NULL,NULL,"-log_threshold",&threshold,&flg1);CHKERRQ(ierr);
578eccbb886SLisandro Dalcin     if (flg1) {ierr = PetscLogSetThreshold((PetscLogDouble)threshold,NULL);CHKERRQ(ierr);}
579bb1d7374SBarry Smith   }
580e5c89e4eSSatish Balay #endif
581e5c89e4eSSatish Balay 
582c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saws_options",&PetscOptionsPublish,NULL);CHKERRQ(ierr);
58305035670SJunchao Zhang   ierr = PetscOptionsGetBool(NULL,NULL,"-use_gpu_aware_mpi",&use_gpu_aware_mpi,NULL);CHKERRQ(ierr);
5844b0a73b2SBarry Smith 
585e5c89e4eSSatish Balay   /*
586e5c89e4eSSatish Balay        Print basic help message
587e5c89e4eSSatish Balay   */
58857171095SVaclav Hapla   if (hasHelp) {
589e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"Options for all PETSc programs:\n");CHKERRQ(ierr);
590d314f959SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -version: prints PETSc version\n");CHKERRQ(ierr);
591d314f959SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -help intro: prints example description and PETSc version, and exits\n");CHKERRQ(ierr);
592d314f959SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -help: prints example description, PETSc version, and available options for used routines\n");CHKERRQ(ierr);
593301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -on_error_abort: cause an abort when an error is detected. Useful \n ");CHKERRQ(ierr);
594301d30feSBarry Smith     ierr = (*PetscHelpPrintf)(comm,"       only when run in the debugger\n");CHKERRQ(ierr);
595e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
596e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start the debugger in new xterm\n");CHKERRQ(ierr);
597e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       unless noxterm is given\n");CHKERRQ(ierr);
598e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n");CHKERRQ(ierr);
599e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"       start all processes in the debugger\n");CHKERRQ(ierr);
600e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -on_error_emacs <machinename>\n");CHKERRQ(ierr);
601e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"    emacs jumps to error file\n");CHKERRQ(ierr);
602bf4d2887SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -debugger_ranks [n1,n2,..] Ranks to start in debugger\n");CHKERRQ(ierr);
603e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -debugger_pause [m] : delay (in seconds) to attach debugger\n");CHKERRQ(ierr);
604e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -stop_for_debugger : prints message on how to attach debugger manually\n");CHKERRQ(ierr);
605e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"                      waits the delay for you to attach\n");CHKERRQ(ierr);
6061cda70a7SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -display display: Location where X window graphics and debuggers are displayed\n");CHKERRQ(ierr);
607e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -no_signal_handler: do not trap error signals\n");CHKERRQ(ierr);
608e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n");CHKERRQ(ierr);
609e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -fp_trap: stop on floating point exceptions\n");CHKERRQ(ierr);
610e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"           note on IBM RS6000 this slows run greatly\n");CHKERRQ(ierr);
611e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n");CHKERRQ(ierr);
61279dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n");CHKERRQ(ierr);
61379dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n");CHKERRQ(ierr);
6144161f2a3SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_info: prints total memory usage\n");CHKERRQ(ierr);
61592f119d6SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n");CHKERRQ(ierr);
61679dccf82SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n");CHKERRQ(ierr);
61726a7e8d4SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -options_view: dump list of options inputted\n");CHKERRQ(ierr);
618e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left: dump list of unused options\n");CHKERRQ(ierr);
619e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_left no: don't dump list of unused options\n");CHKERRQ(ierr);
620e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -tmp tmpdir: alternative /tmp directory\n");CHKERRQ(ierr);
621e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -shared_tmp: tmp directory is shared by all processors\n");CHKERRQ(ierr);
622a8c7a070SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -not_shared_tmp: each processor has separate tmp directory\n");CHKERRQ(ierr);
6230841954dSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -memory_view: print memory usage at end of run\n");CHKERRQ(ierr);
624e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
625e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -get_total_flops: total flops over all processors\n");CHKERRQ(ierr);
626185ae32fSMatthew G. Knepley     ierr = (*PetscHelpPrintf)(comm," -log_view [:filename:[format]]: logging objects and events\n");CHKERRQ(ierr);
627e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -log_trace [filename]: prints trace of all PETSc calls\n");CHKERRQ(ierr);
62856071f75SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -log_exclude <list,of,classnames>: exclude given classes from logging\n");CHKERRQ(ierr);
629e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
630495fc317SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_mpe: Also create logfile viewable through Jumpshot\n");CHKERRQ(ierr);
631e5c89e4eSSatish Balay #endif
632e94e781bSJacob Faibussowitsch #endif
633e94e781bSJacob Faibussowitsch #if defined(PETSC_USE_INFO)
634fe9b927eSVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n");CHKERRQ(ierr);
635e5c89e4eSSatish Balay #endif
636e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -options_file <file>: reads options from file\n");CHKERRQ(ierr);
637c5b5d8d5SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -options_monitor: monitor options to standard output, including that set previously e.g. in option files\n");CHKERRQ(ierr);
638c5b5d8d5SVaclav Hapla     ierr = (*PetscHelpPrintf)(comm," -options_monitor_cancel: cancels all hardwired option monitors\n");CHKERRQ(ierr);
639e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm," -petsc_sleep n: sleeps n seconds before running program\n");CHKERRQ(ierr);
640e5c89e4eSSatish Balay   }
641e5c89e4eSSatish Balay 
64274ba8654SBarry Smith #if defined(PETSC_HAVE_POPEN)
64374ba8654SBarry Smith   {
64474ba8654SBarry Smith   char machine[128];
645589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-popen_machine",machine,sizeof(machine),&flg1);CHKERRQ(ierr);
64674ba8654SBarry Smith   if (flg1) {
64774ba8654SBarry Smith     ierr = PetscPOpenSetMachine(machine);CHKERRQ(ierr);
64874ba8654SBarry Smith   }
64974ba8654SBarry Smith   }
65074ba8654SBarry Smith #endif
65174ba8654SBarry Smith 
652c5929fdfSBarry Smith   ierr = PetscOptionsGetReal(NULL,NULL,"-petsc_sleep",&si,&flg1);CHKERRQ(ierr);
653e5c89e4eSSatish Balay   if (flg1) {
654e5c89e4eSSatish Balay     ierr = PetscSleep(si);CHKERRQ(ierr);
655e5c89e4eSSatish Balay   }
656e5c89e4eSSatish Balay   PetscFunctionReturn(0);
657e5c89e4eSSatish Balay }
658