xref: /petsc/src/sys/objects/pinit.c (revision bf4d2887a0c7d252f9e728fc844ebcd5378c5580)
1bc8a24ecSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file defines the initialization of PETSc, including PetscInitialize()
4e5c89e4eSSatish Balay */
5af0996ceSBarry Smith #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6022afb99SBarry Smith #include <petscvalgrind.h>
7665c2dedSJed Brown #include <petscviewer.h>
856883f60SBarry Smith #if defined(PETSC_USE_GCOV)
956883f60SBarry Smith EXTERN_C_BEGIN
1056883f60SBarry Smith void  __gcov_flush(void);
1156883f60SBarry Smith EXTERN_C_END
1256883f60SBarry Smith #endif
138101f56cSMatthew Knepley 
14a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
1595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
16a9f03627SSatish Balay #endif
17f2d66bcaSShri Abhyankar 
182d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
1995c0884eSLisandro Dalcin PETSC_INTERN PetscFPT PetscFPTData;
202d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
212d53ad75SBarry Smith #endif
222d53ad75SBarry Smith 
23a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2416ad0300SBarry Smith #include <petscviewersaws.h>
25a6790183SBarry Smith #endif
26eb02082bSJunchao Zhang 
27e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
28e5c89e4eSSatish Balay 
2995c0884eSLisandro Dalcin PETSC_INTERN FILE *petsc_history;
30e5c89e4eSSatish Balay 
3195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
3295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
3395c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
3495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3595c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3695c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);
370069ddf5SShri Abhyankar 
386de5d289SStefano Zampini /* user may set these BEFORE calling PetscInitialize() */
39e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
406de5d289SStefano Zampini #if defined(PETSC_HAVE_MPI_INIT_THREAD)
416de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = MPI_THREAD_FUNNELED;
426de5d289SStefano Zampini #else
436de5d289SStefano Zampini PetscMPIInt PETSC_MPI_THREAD_REQUIRED = 0;
446de5d289SStefano Zampini #endif
45e5c89e4eSSatish Balay 
46480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
47480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
48480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
495f7487a0SJunchao Zhang PetscMPIInt Petsc_ShmComm_keyval   = MPI_KEYVAL_INVALID;
50480cf27aSJed Brown 
51e5c89e4eSSatish Balay /*
52e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
53e5c89e4eSSatish Balay */
5402c9f0b5SLisandro Dalcin const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",NULL};
5502c9f0b5SLisandro Dalcin const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL};
56e5c89e4eSSatish Balay 
57ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
58ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
590f8e0872SSatish Balay 
60a2f94806SJed Brown PetscInt PetscHotRegionDepth;
61a2f94806SJed Brown 
62b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
63b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
64b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
65b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
66b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
67b22622e2STadeu Manoel #endif
68b22622e2STadeu Manoel 
69e5c89e4eSSatish Balay /*
70945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
7172a42c3cSBarry Smith 
7272a42c3cSBarry Smith    Collective
7372a42c3cSBarry Smith 
7472a42c3cSBarry Smith    Level: advanced
7572a42c3cSBarry Smith 
7695452b02SPatrick Sanan     Notes:
77a56f64adSBarry Smith     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
780f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
79a56f64adSBarry Smith      be called multiple times from Julia without the problem of trying to initialize MPI more than once.
800f11a792SBarry Smith 
81a56f64adSBarry Smith      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals
821ea5a559SBarry Smith 
8372a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
840f11a792SBarry Smith */
85945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
8672a42c3cSBarry Smith {
8772a42c3cSBarry Smith   PetscErrorCode ierr;
8872a42c3cSBarry Smith   int            myargc   = argc;
8972a42c3cSBarry Smith   char           **myargs = args;
9072a42c3cSBarry Smith 
9172a42c3cSBarry Smith   PetscFunctionBegin;
92c52ac268SRichard Tran Mills   ierr = PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr;
931ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
94df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
9572a42c3cSBarry Smith   PetscFunctionReturn(ierr);
9672a42c3cSBarry Smith }
9772a42c3cSBarry Smith 
98f0865b08SBarry Smith /*
99a56f64adSBarry Smith       Used by Julia interface to get communicator
100f0865b08SBarry Smith */
101945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
102f0865b08SBarry Smith {
103f0865b08SBarry Smith   PetscFunctionBegin;
104f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
105f0865b08SBarry Smith   PetscFunctionReturn(0);
106f0865b08SBarry Smith }
107f0865b08SBarry Smith 
108e5c89e4eSSatish Balay /*@C
109e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
110e5c89e4eSSatish Balay         the command line arguments.
111e5c89e4eSSatish Balay 
112e5c89e4eSSatish Balay    Collective
113e5c89e4eSSatish Balay 
114e5c89e4eSSatish Balay    Level: advanced
115e5c89e4eSSatish Balay 
116e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
117e5c89e4eSSatish Balay @*/
1187087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
119e5c89e4eSSatish Balay {
120e5c89e4eSSatish Balay   PetscErrorCode ierr;
121e5c89e4eSSatish Balay   int            argc   = 0;
12202c9f0b5SLisandro Dalcin   char           **args = NULL;
123e5c89e4eSSatish Balay 
124e5c89e4eSSatish Balay   PetscFunctionBegin;
1250298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
126e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
127e5c89e4eSSatish Balay }
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay /*@
130e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
131e5c89e4eSSatish Balay 
13293b6d2d1SJed Brown    Level: beginner
133e5c89e4eSSatish Balay 
134e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
135e5c89e4eSSatish Balay @*/
1367087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool *isInitialized)
137e5c89e4eSSatish Balay {
138e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
13993b6d2d1SJed Brown   return 0;
140e5c89e4eSSatish Balay }
141e5c89e4eSSatish Balay 
142e5c89e4eSSatish Balay /*@
143e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
144e5c89e4eSSatish Balay 
145e5c89e4eSSatish Balay    Level: developer
146e5c89e4eSSatish Balay 
147e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
148e5c89e4eSSatish Balay @*/
1497087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
150e5c89e4eSSatish Balay {
151e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
15293b6d2d1SJed Brown   return 0;
153e5c89e4eSSatish Balay }
154e5c89e4eSSatish Balay 
15557171095SVaclav Hapla PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char []);
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay /*
158e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
159e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
160e5c89e4eSSatish Balay */
161367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
162e5c89e4eSSatish Balay 
163367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
164e5c89e4eSSatish Balay {
165e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
166e5c89e4eSSatish Balay 
167e5c89e4eSSatish Balay   PetscFunctionBegin;
168e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
169e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
17041e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
171e5c89e4eSSatish Balay   }
172e5c89e4eSSatish Balay 
173e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
174e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
175e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
176e5c89e4eSSatish Balay   }
177812af9f3SBarry Smith   PetscFunctionReturnVoid();
178e5c89e4eSSatish Balay }
179e5c89e4eSSatish Balay 
180e5c89e4eSSatish Balay /*
181e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
182e5c89e4eSSatish Balay sum of the second entry.
183b693b147SBarry Smith 
18476f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
185367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
186b693b147SBarry Smith there would be no place to store the both needed results.
187e5c89e4eSSatish Balay */
18876ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
189e5c89e4eSSatish Balay {
190e5c89e4eSSatish Balay   PetscErrorCode ierr;
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay   PetscFunctionBegin;
193d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
194d6e4c47cSJed Brown   {
195d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
196367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
197d6e4c47cSJed Brown     *max = work.max;
198d6e4c47cSJed Brown     *sum = work.sum;
199d6e4c47cSJed Brown   }
200d6e4c47cSJed Brown #else
201d6e4c47cSJed Brown   {
202d6e4c47cSJed Brown     PetscMPIInt    size,rank;
203d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
204e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
205e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
206785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
207367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2086ac3741eSJed Brown     *max = work[rank].max;
2096ac3741eSJed Brown     *sum = work[rank].sum;
210e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
211d6e4c47cSJed Brown   }
212d6e4c47cSJed Brown #endif
213e5c89e4eSSatish Balay   PetscFunctionReturn(0);
214e5c89e4eSSatish Balay }
215e5c89e4eSSatish Balay 
216e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
217e5c89e4eSSatish Balay 
218570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
21906a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
220e5c89e4eSSatish Balay 
2218cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
222e5c89e4eSSatish Balay {
223e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
224e5c89e4eSSatish Balay 
225e5c89e4eSSatish Balay   PetscFunctionBegin;
2267c2de775SJed Brown   if (*datatype == MPIU_REAL) {
227e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
228a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2297c2de775SJed Brown   }
2307c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2317c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2327c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
233a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2347c2de775SJed Brown   }
2357c2de775SJed Brown #endif
2367c2de775SJed Brown   else {
2377c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
23841e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
239e2e03761SBarry Smith   }
240812af9f3SBarry Smith   PetscFunctionReturnVoid();
241e5c89e4eSSatish Balay }
242e5c89e4eSSatish Balay #endif
243e5c89e4eSSatish Balay 
244570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
245d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
246d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
247d9822059SBarry Smith 
2488cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
249d9822059SBarry Smith {
250d9822059SBarry Smith   PetscInt i,count = *cnt;
251d9822059SBarry Smith 
252d9822059SBarry Smith   PetscFunctionBegin;
2537c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2548c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
255a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2567c2de775SJed Brown   }
2577c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2587c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2597c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2607c2de775SJed Brown     for (i=0; i<count; i++) {
2617c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2627c2de775SJed Brown     }
2637c2de775SJed Brown   }
2647c2de775SJed Brown #endif
2657c2de775SJed Brown   else {
2667c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
26741e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
2688c764dc5SJose Roman   }
269d9822059SBarry Smith   PetscFunctionReturnVoid();
270d9822059SBarry Smith }
271d9822059SBarry Smith 
2728cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
273d9822059SBarry Smith {
274d9822059SBarry Smith   PetscInt    i,count = *cnt;
275d9822059SBarry Smith 
276d9822059SBarry Smith   PetscFunctionBegin;
2777c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2788c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
279a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2807c2de775SJed Brown   }
2817c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2827c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2837c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2847c2de775SJed Brown     for (i=0; i<count; i++) {
2857c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2867c2de775SJed Brown     }
2877c2de775SJed Brown   }
2887c2de775SJed Brown #endif
2897c2de775SJed Brown   else {
2908c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
29141e02c4dSJunchao Zhang     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
2928c764dc5SJose Roman   }
293d9822059SBarry Smith   PetscFunctionReturnVoid();
294d9822059SBarry Smith }
295d9822059SBarry Smith #endif
296d9822059SBarry Smith 
297480cf27aSJed Brown /*
298480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
299480cf27aSJed Brown 
300ff0e51ddSBarry Smith    This is called by MPI, not by users. This is called by MPI_Comm_free() when the communicator that has this  data as an attribute is freed.
301480cf27aSJed Brown 
30212801b39SBarry Smith    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
303480cf27aSJed Brown 
304480cf27aSJed Brown */
30533779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
306480cf27aSJed Brown {
307480cf27aSJed Brown   PetscErrorCode   ierr;
30805342407SJunchao Zhang   PetscCommCounter *counter=(PetscCommCounter*)count_val;
309480cf27aSJed Brown 
310480cf27aSJed Brown   PetscFunctionBegin;
31102c9f0b5SLisandro Dalcin   ierr = PetscInfo1(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
31205342407SJunchao Zhang   ierr = PetscFree(counter->iflags);CHKERRMPI(ierr);
31305342407SJunchao Zhang   ierr = PetscFree(counter);CHKERRMPI(ierr);
314480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
315480cf27aSJed Brown }
316480cf27aSJed Brown 
317480cf27aSJed Brown /*
31847435625SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
319da3039f7SJed Brown   calls MPI_Comm_free().
320da3039f7SJed Brown 
321da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
322480cf27aSJed Brown 
323ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
324480cf27aSJed Brown 
32512801b39SBarry Smith   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
326480cf27aSJed Brown 
327480cf27aSJed Brown */
32833779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
329480cf27aSJed Brown {
330480cf27aSJed Brown   PetscErrorCode                    ierr;
33133779a13SJunchao Zhang   union {MPI_Comm comm; void *ptr;} icomm;
332480cf27aSJed Brown 
333480cf27aSJed Brown   PetscFunctionBegin;
33412801b39SBarry Smith   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
335ec4fadc2SJed Brown   icomm.ptr = attr_val;
33676bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
33733779a13SJunchao Zhang     /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */
33833779a13SJunchao Zhang     PetscMPIInt flg;
33933779a13SJunchao Zhang     union {MPI_Comm comm; void *ptr;} ocomm;
34047435625SJed Brown     ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
34133779a13SJunchao Zhang     if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute");
34233779a13SJunchao Zhang     if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm's OuterComm attribute does not point to outer PETSc comm");
34333779a13SJunchao Zhang   }
34447435625SJed Brown   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
34533779a13SJunchao Zhang   ierr = PetscInfo2(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm);CHKERRMPI(ierr);
346da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
347b89831e5SBarry Smith }
348da3039f7SJed Brown 
349da3039f7SJed Brown /*
35033779a13SJunchao Zhang  * This is invoked on the inner comm when Petsc_InnerComm_Attr_Delete_Fn calls MPI_Comm_delete_attr().  It should not be reached any other way.
351da3039f7SJed Brown  */
35233779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
353da3039f7SJed Brown {
354da3039f7SJed Brown   PetscErrorCode ierr;
355da3039f7SJed Brown 
356da3039f7SJed Brown   PetscFunctionBegin;
35702c9f0b5SLisandro Dalcin   ierr = PetscInfo1(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
358480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
359480cf27aSJed Brown }
360480cf27aSJed Brown 
36133779a13SJunchao Zhang PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *);
36242218b76SBarry Smith 
363951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
3648cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3658cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3668cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
367e39fd77fSBarry Smith #endif
368e39fd77fSBarry Smith 
3690f9be574SPeter Hill PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE;
37012801b39SBarry Smith 
371eb27c7c8SSatish Balay PETSC_INTERN int  PetscGlobalArgc;
372eb27c7c8SSatish Balay PETSC_INTERN char **PetscGlobalArgs;
3736ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
37402c9f0b5SLisandro Dalcin char **PetscGlobalArgs = NULL;
375dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
376e5c89e4eSSatish Balay 
377dd63322aSSatish Balay PetscErrorCode PetscCitationsInitialize(void)
378051e4cf2SJed Brown {
379051e4cf2SJed Brown   PetscErrorCode ierr;
380051e4cf2SJed Brown 
381051e4cf2SJed Brown   PetscFunctionBegin;
382051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
383a1601671SBarry Smith   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n            and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n            Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n            Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n            and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n            and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.11},\n  Institution = {Argonne National Laboratory},\n  Year = {2019}\n}\n",NULL);CHKERRQ(ierr);
384051e4cf2SJed Brown   ierr = PetscCitationsRegister("@InProceedings{petsc-efficient,\n  Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n  Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n  Booktitle = {Modern Software Tools in Scientific Computing},\n  Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n  Pages = {163--202},\n  Publisher = {Birkh{\\\"{a}}user Press},\n  Year = {1997}\n}\n",NULL);CHKERRQ(ierr);
385051e4cf2SJed Brown   PetscFunctionReturn(0);
386051e4cf2SJed Brown }
387e5c89e4eSSatish Balay 
3882d747510SLisandro Dalcin static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */
3892d747510SLisandro Dalcin 
3902d747510SLisandro Dalcin PetscErrorCode  PetscSetProgramName(const char name[])
3912d747510SLisandro Dalcin {
3922d747510SLisandro Dalcin   PetscErrorCode ierr;
3932d747510SLisandro Dalcin 
3942d747510SLisandro Dalcin   PetscFunctionBegin;
395589a23caSBarry Smith   ierr  = PetscStrncpy(programname,name,sizeof(programname));CHKERRQ(ierr);
3962d747510SLisandro Dalcin   PetscFunctionReturn(0);
3972d747510SLisandro Dalcin }
3982d747510SLisandro Dalcin 
3992d747510SLisandro Dalcin /*@C
4002d747510SLisandro Dalcin     PetscGetProgramName - Gets the name of the running program.
4012d747510SLisandro Dalcin 
4022d747510SLisandro Dalcin     Not Collective
4032d747510SLisandro Dalcin 
4042d747510SLisandro Dalcin     Input Parameter:
4052d747510SLisandro Dalcin .   len - length of the string name
4062d747510SLisandro Dalcin 
4072d747510SLisandro Dalcin     Output Parameter:
4082d747510SLisandro Dalcin .   name - the name of the running program
4092d747510SLisandro Dalcin 
4102d747510SLisandro Dalcin    Level: advanced
4112d747510SLisandro Dalcin 
4122d747510SLisandro Dalcin     Notes:
4132d747510SLisandro Dalcin     The name of the program is copied into the user-provided character
4142d747510SLisandro Dalcin     array of length len.  On some machines the program name includes
4152d747510SLisandro Dalcin     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
4162d747510SLisandro Dalcin @*/
4172d747510SLisandro Dalcin PetscErrorCode  PetscGetProgramName(char name[],size_t len)
4182d747510SLisandro Dalcin {
4192d747510SLisandro Dalcin   PetscErrorCode ierr;
4202d747510SLisandro Dalcin 
4212d747510SLisandro Dalcin   PetscFunctionBegin;
4222d747510SLisandro Dalcin    ierr = PetscStrncpy(name,programname,len);CHKERRQ(ierr);
4232d747510SLisandro Dalcin   PetscFunctionReturn(0);
4242d747510SLisandro Dalcin }
4252d747510SLisandro Dalcin 
426e5c89e4eSSatish Balay /*@C
427e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
428e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
429e5c89e4eSSatish Balay 
430e5c89e4eSSatish Balay    Not Collective
431e5c89e4eSSatish Balay 
432e5c89e4eSSatish Balay    Output Parameters:
433e5c89e4eSSatish Balay +  argc - count of number of command line arguments
434e5c89e4eSSatish Balay -  args - the command line arguments
435e5c89e4eSSatish Balay 
436e5c89e4eSSatish Balay    Level: intermediate
437e5c89e4eSSatish Balay 
438e5c89e4eSSatish Balay    Notes:
439e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
440e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
441e5c89e4eSSatish Balay 
442f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
443f177e3b1SBarry Smith 
444793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
445e5c89e4eSSatish Balay 
446e5c89e4eSSatish Balay @*/
4477087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
448e5c89e4eSSatish Balay {
449e5c89e4eSSatish Balay   PetscFunctionBegin;
45017186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
451e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
452e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
453e5c89e4eSSatish Balay   PetscFunctionReturn(0);
454e5c89e4eSSatish Balay }
455e5c89e4eSSatish Balay 
456793721a6SBarry Smith /*@C
457793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
458793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
459793721a6SBarry Smith 
460793721a6SBarry Smith    Not Collective
461793721a6SBarry Smith 
462793721a6SBarry Smith    Output Parameters:
463793721a6SBarry Smith .  args - the command line arguments
464793721a6SBarry Smith 
465793721a6SBarry Smith    Level: intermediate
466793721a6SBarry Smith 
467793721a6SBarry Smith    Notes:
468793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
469793721a6SBarry Smith 
470793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
471793721a6SBarry Smith 
472793721a6SBarry Smith @*/
4737087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
474793721a6SBarry Smith {
475793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
476793721a6SBarry Smith   PetscErrorCode ierr;
477793721a6SBarry Smith 
478793721a6SBarry Smith   PetscFunctionBegin;
47917186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
4802d747510SLisandro Dalcin   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
481785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
482793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
483793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
484793721a6SBarry Smith   }
4852d747510SLisandro Dalcin   (*args)[argc-1] = NULL;
486793721a6SBarry Smith   PetscFunctionReturn(0);
487793721a6SBarry Smith }
488793721a6SBarry Smith 
489793721a6SBarry Smith /*@C
490793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
491793721a6SBarry Smith 
492793721a6SBarry Smith    Not Collective
493793721a6SBarry Smith 
494793721a6SBarry Smith    Output Parameters:
495793721a6SBarry Smith .  args - the command line arguments
496793721a6SBarry Smith 
497793721a6SBarry Smith    Level: intermediate
498793721a6SBarry Smith 
499793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
500793721a6SBarry Smith 
501793721a6SBarry Smith @*/
5027087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
503793721a6SBarry Smith {
504793721a6SBarry Smith   PetscInt       i = 0;
505793721a6SBarry Smith   PetscErrorCode ierr;
506793721a6SBarry Smith 
507793721a6SBarry Smith   PetscFunctionBegin;
508a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
509793721a6SBarry Smith   while (args[i]) {
510793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
511793721a6SBarry Smith     i++;
512793721a6SBarry Smith   }
513793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
514793721a6SBarry Smith   PetscFunctionReturn(0);
515793721a6SBarry Smith }
516793721a6SBarry Smith 
51711525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
51830befbd2SBarry Smith #include <petscconfiginfo.h>
51930befbd2SBarry Smith 
52095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
52111525c0dSBarry Smith {
52211525c0dSBarry Smith   if (!PetscGlobalRank) {
52330befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
52411525c0dSBarry Smith     int            port;
525ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
52611525c0dSBarry Smith     size_t         applinelen,introlen;
52711525c0dSBarry Smith     PetscErrorCode ierr;
528ffbd1cfbSBarry Smith     char           sawsurl[256];
52911525c0dSBarry Smith 
530c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
53111525c0dSBarry Smith     if (flg) {
53211525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
53311525c0dSBarry Smith 
534589a23caSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,sizeof(sawslog),NULL);CHKERRQ(ierr);
53511525c0dSBarry Smith       if (sawslog[0]) {
53611525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
53711525c0dSBarry Smith       } else {
53811525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
53911525c0dSBarry Smith       }
54011525c0dSBarry Smith     }
541589a23caSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,sizeof(cert),&flg);CHKERRQ(ierr);
54211525c0dSBarry Smith     if (flg) {
54311525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
54411525c0dSBarry Smith     }
545c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
546ffbd1cfbSBarry Smith     if (selectport) {
547ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
548ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
549ffbd1cfbSBarry Smith     } else {
550c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
55111525c0dSBarry Smith       if (flg) {
55211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
55311525c0dSBarry Smith       }
554ffbd1cfbSBarry Smith     }
555589a23caSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,sizeof(root),&flg);CHKERRQ(ierr);
55611525c0dSBarry Smith     if (flg) {
55711525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
55811525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5599c1e0ce8SBarry Smith     } else {
560c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5619c1e0ce8SBarry Smith       if (flg) {
562589a23caSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,sizeof(root));CHKERRQ(ierr);
5639c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5649c1e0ce8SBarry Smith       }
56511525c0dSBarry Smith     }
566c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
56711525c0dSBarry Smith     if (flg2) {
56811525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
56911525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
570589a23caSBarry Smith       ierr = PetscSNPrintf(jsdir,sizeof(jsdir),"%s/js",root);CHKERRQ(ierr);
57111525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
57211525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
57343da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
57411525c0dSBarry Smith     }
575589a23caSBarry Smith     ierr = PetscGetProgramName(programname,sizeof(programname));CHKERRQ(ierr);
57611525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
57711525c0dSBarry Smith     introlen   = 4096 + applinelen;
57830a8c9c0SSurtai Han     applinelen += 1024;
57911525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
58011525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
58111525c0dSBarry Smith 
58211525c0dSBarry Smith     if (rootlocal) {
58311525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
58411525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
58511525c0dSBarry Smith     }
58676a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
58711525c0dSBarry Smith     if (rootlocal && help) {
588928bb9adSStefano Zampini       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);CHKERRQ(ierr);
58911525c0dSBarry Smith     } else if (help) {
590928bb9adSStefano Zampini       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr);
59111525c0dSBarry Smith     } else {
592928bb9adSStefano Zampini       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr);
59311525c0dSBarry Smith     }
594b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
59530befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
59611525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
597a8d69d7bSBarry Smith                                     "<center><h2> <a href=\"https://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
598df62c222SBarry Smith                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
599928bb9adSStefano Zampini                                     "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr);
60043da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
60111525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
60211525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
603ffbd1cfbSBarry Smith     if (selectport) {
604aa573868SBarry Smith       PetscBool silent;
6057d812c46SBarry Smith 
6067d812c46SBarry Smith       ierr = SAWs_Initialize();
6077d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
6087d812c46SBarry Smith       while (ierr) {
6097d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
6107d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
6117d812c46SBarry Smith         ierr = SAWs_Initialize();
6127d812c46SBarry Smith       }
6137d812c46SBarry Smith 
614aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
615aa573868SBarry Smith       if (!silent) {
616ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
617ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
618ffbd1cfbSBarry Smith       }
6197d812c46SBarry Smith     } else {
6207d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
621aa573868SBarry Smith     }
6220af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
6230af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
6240af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
6250af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6260af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
62711525c0dSBarry Smith   }
62811525c0dSBarry Smith   PetscFunctionReturn(0);
62911525c0dSBarry Smith }
63011525c0dSBarry Smith #endif
63111525c0dSBarry Smith 
6324dfee713SSatish Balay /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
6334dfee713SSatish Balay PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
6344dfee713SSatish Balay {
6354dfee713SSatish Balay   PetscFunctionBegin;
6364dfee713SSatish Balay #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
6374dfee713SSatish Balay     /* see MPI.py for details on this bug */
6384dfee713SSatish Balay     (void) setenv("HWLOC_COMPONENTS","-x86",1);
6394dfee713SSatish Balay #endif
6404dfee713SSatish Balay   PetscFunctionReturn(0);
6414dfee713SSatish Balay }
6424dfee713SSatish Balay 
643a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
644a56f64adSBarry Smith #include <adios.h>
64522580e64SBarry Smith #include <adios_read.h>
6467b56e58cSSatish Balay int64_t Petsc_adios_group;
647a56f64adSBarry Smith #endif
64855d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
64955d657eeSBarry Smith #include <adios2_c.h>
65055d657eeSBarry Smith #endif
651cd1b99a6SBarry Smith #if defined(PETSC_HAVE_OPENMP)
652cd1b99a6SBarry Smith #include <omp.h>
653f90b075cSBarry Smith PetscInt PetscNumOMPThreads;
654cd1b99a6SBarry Smith #endif
655a56f64adSBarry Smith 
656bc8a24ecSBarry Smith #if defined(PETSC_HAVE_DLFCN_H)
657bc8a24ecSBarry Smith #include <dlfcn.h>
658bc8a24ecSBarry Smith #endif
659bc8a24ecSBarry Smith 
660e5c89e4eSSatish Balay /*@C
661e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
662e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
663e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
664e5c89e4eSSatish Balay    your program -- usually the very first line!
665e5c89e4eSSatish Balay 
666e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
667e5c89e4eSSatish Balay 
668e5c89e4eSSatish Balay    Input Parameters:
669e5c89e4eSSatish Balay +  argc - count of number of command line arguments
670e5c89e4eSSatish Balay .  args - the command line arguments
671c5b5d8d5SVaclav Hapla .  file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc.
672c5b5d8d5SVaclav Hapla           Use NULL to not check for code specific file.
673c5b5d8d5SVaclav Hapla           Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files.
6740298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
675e5c89e4eSSatish Balay 
67605827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
67705827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
67805827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
67905827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
68005827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
681e5c89e4eSSatish Balay 
682e5c89e4eSSatish Balay    Options Database Keys:
6837ca660e7SBarry Smith +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
6847ca660e7SBarry Smith .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
685e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
6868a690491SBarry Smith .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
6878a690491SBarry Smith .  -on_error_abort - calls abort() when error detected (no traceback)
6888a690491SBarry Smith .  -on_error_mpiabort - calls MPI_abort() when error detected
6898a690491SBarry Smith .  -error_output_stderr - prints error messages to stderr instead of the default stdout
6908a690491SBarry Smith .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
691*bf4d2887SBarry Smith .  -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger
692e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
693e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
694e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
69579dccf82SBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
69679dccf82SBarry Smith .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
69779dccf82SBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
698aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
69992f119d6SBarry Smith .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds, ignored in optimized build. May want to set in PETSC_OPTIONS environmental variable
70092f119d6SBarry Smith .  -malloc_view - show a list of all allocated memory during PetscFinalize()
70192f119d6SBarry Smith .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
702608c71bfSMatthew G. Knepley .  -malloc_requested_size - malloc logging will record the requested size rather than size after alignment
70392f119d6SBarry Smith .  -fp_trap - Stops on floating point exceptions
704e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
705e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
706e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
707e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
708e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
7090841954dSBarry Smith -  -memory_view - Print memory usage at end of run
710e5c89e4eSSatish Balay 
711c5b5d8d5SVaclav Hapla    Options Database Keys for Option Database:
712c5b5d8d5SVaclav Hapla +  -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc
713c5b5d8d5SVaclav Hapla .  -options_monitor - monitor all set options to standard output for the whole program run
714c5b5d8d5SVaclav Hapla -  -options_monitor_cancel - cancel options monitoring hard-wired using PetscOptionsMonitorSet()
715c5b5d8d5SVaclav Hapla 
716c5b5d8d5SVaclav Hapla    Options -options_monitor_{all,cancel} are
717c5b5d8d5SVaclav Hapla    position-independent and apply to all options set since the PETSc start.
718c5b5d8d5SVaclav Hapla    They can be used also in option files.
719c5b5d8d5SVaclav Hapla 
720c5b5d8d5SVaclav Hapla    See PetscOptionsMonitorSet() to do monitoring programmatically.
721c5b5d8d5SVaclav Hapla 
722e5c89e4eSSatish Balay    Options Database Keys for Profiling:
723a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
724fe9b927eSVaclav Hapla +  -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo().
725217044c2SLisandro Dalcin .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
726217044c2SLisandro Dalcin         however it slows things down and gives a distorted view of the overall runtime.
727495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
728e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
7299a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
73079dccf82SBarry Smith .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
7319a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
732495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
733f5d6ab90SLisandro Dalcin .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
734495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
735495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
736c2f74817SBarry Smith .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
73787c3beb6SLisandro Dalcin .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
738c2f74817SBarry Smith -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
739495fc317SBarry Smith 
740609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
741e5c89e4eSSatish Balay 
742ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
743ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
744ffbd1cfbSBarry Smith .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
745ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
746ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
747ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
748ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
749ffbd1cfbSBarry Smith 
750e5c89e4eSSatish Balay    Environmental Variables:
751e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
752e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
753e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
7544a971ea4SToby Isaac .   PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs
7554a971ea4SToby Isaac .   PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document
756e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
757e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
758e5c89e4eSSatish Balay 
759e5c89e4eSSatish Balay 
760e5c89e4eSSatish Balay    Level: beginner
761e5c89e4eSSatish Balay 
762e5c89e4eSSatish Balay    Notes:
763e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
764e5c89e4eSSatish Balay    it before PetscInitialize().
765e5c89e4eSSatish Balay 
766e5c89e4eSSatish Balay    Fortran Version:
767e5c89e4eSSatish Balay    In Fortran this routine has the format
768e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
769e5c89e4eSSatish Balay 
770e5c89e4eSSatish Balay +   ierr - error return code
771c5b5d8d5SVaclav Hapla -  file - [optional] PETSc database file, also checks ~/.petscrc, .petscrc and petscrc.
772c5b5d8d5SVaclav Hapla           Use PETSC_NULL_CHARACTER to not check for code specific file.
773c5b5d8d5SVaclav Hapla           Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files.
774e5c89e4eSSatish Balay 
775e5c89e4eSSatish Balay    Important Fortran Note:
7760eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7770298fd71SBarry Smith    null character string; you CANNOT just use NULL as
778a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
779e5c89e4eSSatish Balay 
78001cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
78101cb0274SBarry Smith    calling PetscInitialize().
782e5c89e4eSSatish Balay 
78301cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
784e5c89e4eSSatish Balay 
785e5c89e4eSSatish Balay @*/
7867087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
787e5c89e4eSSatish Balay {
788e5c89e4eSSatish Balay   PetscErrorCode ierr;
7894bb5149bSJed Brown   PetscMPIInt    flag, size;
79019c5658aSBarry Smith   PetscBool      flg = PETSC_TRUE;
791e5c89e4eSSatish Balay   char           hostname[256];
792e5c89e4eSSatish Balay 
793e5c89e4eSSatish Balay   PetscFunctionBegin;
794e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
7953d96e996SBarry Smith   /*
7963d96e996SBarry Smith       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
7973d96e996SBarry Smith       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
7983d96e996SBarry Smith         MPICH v3.1 (Released Feburary 2014)
7993d96e996SBarry Smith         IBM MPI v2.1 (December 2014)
800110fc3b0SBarry Smith         Intel MPI Library v5.0 (2014)
8013d96e996SBarry Smith         Cray MPT v7.0.0 (June 2014)
8023d96e996SBarry Smith       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
8033d96e996SBarry Smith       listed above and since that time are compatible.
8043d96e996SBarry Smith 
8053d96e996SBarry Smith       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
8063d96e996SBarry Smith       at compile time or runtime. Thus we will need to systematically track the allowed versions
8073d96e996SBarry Smith       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
8083d96e996SBarry Smith       to perform the checking.
8093d96e996SBarry Smith 
8103d96e996SBarry Smith       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
8113d96e996SBarry Smith 
8123d96e996SBarry Smith       Questions:
8133d96e996SBarry Smith 
8143d96e996SBarry Smith         Should the checks for ABI incompatibility be only on the major version number below?
8153d96e996SBarry Smith         Presumably the output to stderr will be removed before a release.
8163d96e996SBarry Smith   */
8173d96e996SBarry Smith 
81819c5658aSBarry Smith #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
81919c5658aSBarry Smith   {
82019c5658aSBarry Smith     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
82119c5658aSBarry Smith     PetscMPIInt mpilibraryversionlength;
82219c5658aSBarry Smith     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
8233d96e996SBarry Smith     /* check for MPICH versions before MPI ABI initiative */
82419c5658aSBarry Smith #if defined(MPICH_VERSION)
8253d96e996SBarry Smith #if MPICH_NUMVERSION < 30100000
82619c5658aSBarry Smith     {
82719c5658aSBarry Smith       char *ver,*lf;
82819c5658aSBarry Smith       flg = PETSC_FALSE;
82919c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
83019c5658aSBarry Smith       if (ver) {
83119c5658aSBarry Smith         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
83219c5658aSBarry Smith         if (lf) {
83319c5658aSBarry Smith           *lf = 0;
83419c5658aSBarry Smith           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
83519c5658aSBarry Smith         }
83619c5658aSBarry Smith       }
83719c5658aSBarry Smith       if (!flg) {
83819c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
8393d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
84019c5658aSBarry Smith       }
84119c5658aSBarry Smith     }
8423d96e996SBarry Smith #endif
8433d96e996SBarry Smith     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
84419c5658aSBarry Smith #elif defined(OMPI_MAJOR_VERSION)
84519c5658aSBarry Smith     {
84619c5658aSBarry Smith       char *ver,bs[32],*bsf;
84719c5658aSBarry Smith       flg = PETSC_FALSE;
84819c5658aSBarry Smith       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
84919c5658aSBarry Smith       if (ver) {
8502e924ca5SSatish Balay         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
85119c5658aSBarry Smith         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
85219c5658aSBarry Smith         if (bsf) flg = PETSC_TRUE;
85319c5658aSBarry Smith       }
85419c5658aSBarry Smith       if (!flg) {
85519c5658aSBarry Smith         fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
8563d96e996SBarry Smith         return PETSC_ERR_MPI_LIB_INCOMP;
85719c5658aSBarry Smith       }
85819c5658aSBarry Smith     }
85919c5658aSBarry Smith #endif
86019c5658aSBarry Smith   }
86119c5658aSBarry Smith #endif
86219c5658aSBarry Smith 
863bc8a24ecSBarry Smith #if defined(PETSC_HAVE_DLSYM)
864bc8a24ecSBarry Smith   {
865bc8a24ecSBarry Smith     PetscInt cnt = 0;
866bc8a24ecSBarry Smith     /* These symbols are currently in the OpenMPI and MPICH libraries; they may not always be, in that case the test will simply not detect the problem */
867bc8a24ecSBarry Smith     if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++;
868bc8a24ecSBarry Smith     if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++;
869bc8a24ecSBarry Smith     if (cnt > 1) {
870bc8a24ecSBarry Smith       fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n");
871bc8a24ecSBarry Smith       return PETSC_ERR_MPI_LIB_INCOMP;
872bc8a24ecSBarry Smith     }
873bc8a24ecSBarry Smith   }
874bc8a24ecSBarry Smith #endif
875bc8a24ecSBarry Smith 
876ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
877d89683f4Sbcordonn   PETSC_STDOUT = stdout;
878ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
879e5c89e4eSSatish Balay 
8808ad20175SVaclav Hapla   /*CHKERRQ can be used from now */
8818ad20175SVaclav Hapla   PetscErrorHandlingInitialized = PETSC_TRUE;
8828ad20175SVaclav Hapla 
8830c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
8840c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
8850c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
8860c30907bSSatish Balay #endif
8870c30907bSSatish Balay 
8884416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
889e5c89e4eSSatish Balay 
890e5c89e4eSSatish Balay   /*
891e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
892e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
893e5c89e4eSSatish Balay   */
894e5c89e4eSSatish Balay   if (argc && *argc) {
895e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
896e5c89e4eSSatish Balay   } else {
897e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
898e5c89e4eSSatish Balay   }
899e5c89e4eSSatish Balay 
900e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
901e5c89e4eSSatish Balay   if (!flag) {
902e32f2f54SBarry Smith     if (PETSC_COMM_WORLD != MPI_COMM_NULL) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You cannot set PETSC_COMM_WORLD if you have not initialized MPI first");
9034dfee713SSatish Balay     ierr = PetscPreMPIInit_Private();CHKERRQ(ierr);
9045e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
9055e765c61SJed Brown     {
9065e765c61SJed Brown       PetscMPIInt provided;
9076de5d289SStefano Zampini       ierr = MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided);CHKERRQ(ierr);
9085e765c61SJed Brown     }
9095e765c61SJed Brown #else
910e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
9115e765c61SJed Brown #endif
912e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
913e5c89e4eSSatish Balay   }
9144dfee713SSatish Balay 
915e5c89e4eSSatish Balay   if (argc && args) {
916e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
917e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
918e5c89e4eSSatish Balay   }
919e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
9205ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
9215ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
9225ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
923ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
924e5c89e4eSSatish Balay 
925a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
926d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
927e5c89e4eSSatish Balay 
9280f9be574SPeter Hill   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
92912801b39SBarry Smith     ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
93012801b39SBarry Smith     ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
9310f9be574SPeter Hill   }
93212801b39SBarry Smith 
933e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
934e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
935e5c89e4eSSatish Balay 
936e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
937e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
938e5c89e4eSSatish Balay 
9398ad47952SJed Brown   MPIU_BOOL = MPI_INT;
9408ad47952SJed Brown   MPIU_ENUM = MPI_INT;
9417cdaf61dSJed Brown   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
942e316c87fSJed Brown   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
943e316c87fSJed Brown   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
944e316c87fSJed Brown #if defined(PETSC_SIZEOF_LONG_LONG)
945e316c87fSJed Brown   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
946e316c87fSJed Brown #endif
947e316c87fSJed Brown   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
9488ad47952SJed Brown 
949e5c89e4eSSatish Balay   /*
950e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
951e5c89e4eSSatish Balay      shared libraries the constructors for global variables
952e5c89e4eSSatish Balay      are not called; at least on IRIX.
953e5c89e4eSSatish Balay   */
954886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
955e5c89e4eSSatish Balay   {
956252ecd31SSatish Balay #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
95750f81f78SJed Brown     PetscComplex ic(0.0,1.0);
958e5c89e4eSSatish Balay     PETSC_i = ic;
959252ecd31SSatish Balay #else
96050f81f78SJed Brown     PETSC_i = _Complex_I;
961b7940d39SSatish Balay #endif
962762437b8SSatish Balay   }
963762437b8SSatish Balay 
9642c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
965e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
966500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
967500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
968500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
9692c876bd9SBarry Smith #endif
970886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
971e5c89e4eSSatish Balay 
972e5c89e4eSSatish Balay   /*
973e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
974e5c89e4eSSatish Balay      half of the entries and maxes the second half.
975e5c89e4eSSatish Balay   */
976367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
977e5c89e4eSSatish Balay 
978ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
979c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
980c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
9817c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
9828c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
9838c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
9848c764dc5SJose Roman #endif
985d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
986d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
987570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
988570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
989570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
990570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
991570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
992c90a1750SBarry Smith #endif
993c90a1750SBarry Smith 
994570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
995cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
996cca4cb22SSatish Balay #endif
997cca4cb22SSatish Balay 
998e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
999e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
1000e5c89e4eSSatish Balay 
100140df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
1002e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
1003e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
100444041f26SJed Brown #endif
1005e5c89e4eSSatish Balay 
1006e5c89e4eSSatish Balay   /*
1007480cf27aSJed Brown      Attributes to be set on PETSc communicators
1008480cf27aSJed Brown   */
100933779a13SJunchao Zhang   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
101033779a13SJunchao Zhang   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
101133779a13SJunchao Zhang   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
101233779a13SJunchao Zhang   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
1013480cf27aSJed Brown 
1014480cf27aSJed Brown   /*
1015e8fb0fc0SBarry Smith      Build the options database
1016e5c89e4eSSatish Balay   */
1017c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
1018e5c89e4eSSatish Balay 
1019703f3eceSBarry Smith   /* call a second time so it can look in the options database */
1020703f3eceSBarry Smith   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
10216dc8fec2Sbcordonn 
1022e5c89e4eSSatish Balay   /*
102357171095SVaclav Hapla      Check system options and print help
1024e5c89e4eSSatish Balay   */
102557171095SVaclav Hapla   ierr = PetscOptionsCheckInitial_Private(help);CHKERRQ(ierr);
1026e5c89e4eSSatish Balay 
1027d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
1028d45a07a7SBarry Smith 
1029e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
103011525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
1031f4202a44SBarry Smith #endif
1032f4202a44SBarry Smith 
1033e5c89e4eSSatish Balay   /*
1034e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
1035e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1036e5c89e4eSSatish Balay   */
1037e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1038e5c89e4eSSatish Balay 
1039e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
104002c9f0b5SLisandro Dalcin   ierr = PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1041e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
104202c9f0b5SLisandro Dalcin   ierr = PetscInfo1(NULL,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1043cd1b99a6SBarry Smith #if defined(PETSC_HAVE_OPENMP)
1044101491d0SBarry Smith   {
1045101491d0SBarry Smith     PetscBool omp_view_flag;
1046cd1b99a6SBarry Smith     char      *threads = getenv("OMP_NUM_THREADS");
1047e5c89e4eSSatish Balay 
1048cd1b99a6SBarry Smith    if (threads) {
104902c9f0b5SLisandro Dalcin      ierr = PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1050f90b075cSBarry Smith      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1051cd1b99a6SBarry Smith    } else {
1052cd1b99a6SBarry Smith #define NMAX  10000
1053101491d0SBarry Smith      int          i;
1054cd1b99a6SBarry Smith       PetscScalar *x;
1055cd1b99a6SBarry Smith       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1056cd1b99a6SBarry Smith #pragma omp parallel for
1057cd1b99a6SBarry Smith       for (i=0; i<NMAX; i++) {
1058cd1b99a6SBarry Smith         x[i] = 0.0;
1059f90b075cSBarry Smith         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1060cd1b99a6SBarry Smith       }
1061cd1b99a6SBarry Smith       ierr = PetscFree(x);CHKERRQ(ierr);
106202c9f0b5SLisandro Dalcin       ierr = PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1063101491d0SBarry Smith     }
1064101491d0SBarry Smith     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1065f90b075cSBarry Smith     ierr = PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);CHKERRQ(ierr);
1066101491d0SBarry Smith     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1067101491d0SBarry Smith     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1068101491d0SBarry Smith     if (flg) {
106902c9f0b5SLisandro Dalcin       ierr = PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1070f90b075cSBarry Smith       omp_set_num_threads((int)PetscNumOMPThreads);
1071101491d0SBarry Smith     }
1072101491d0SBarry Smith     if (omp_view_flag) {
1073f90b075cSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr);
1074cd1b99a6SBarry Smith     }
1075cd1b99a6SBarry Smith   }
1076cd1b99a6SBarry Smith #endif
1077ef6c6fedSBoyana Norris 
1078951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1079e39fd77fSBarry Smith   /*
1080e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1081e39fd77fSBarry Smith 
1082e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
1083e39fd77fSBarry Smith   */
108430815ce0SLisandro Dalcin   if (!PetscBinaryBigEndian()) {
10850298fd71SBarry Smith     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
108630815ce0SLisandro Dalcin   }
1087951e3c8eSBarry Smith #endif
1088e39fd77fSBarry Smith 
108941c0b4b3SShri Abhyankar   /*
109041c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
109141c0b4b3SShri Abhyankar   */
1092ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1093e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
1094e1167bb9SShri Abhyankar #endif
1095e1167bb9SShri Abhyankar 
10962d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10972d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
10982d53ad75SBarry Smith #endif
10992d53ad75SBarry Smith 
11005e71baefSBarry Smith #if defined(PETSC_HAVE_HWLOC)
110187c3beb6SLisandro Dalcin   {
110287c3beb6SLisandro Dalcin     PetscViewer viewer;
110322e7e69cSBarry Smith     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
11045e71baefSBarry Smith     if (flg) {
11055e71baefSBarry Smith       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
110687c3beb6SLisandro Dalcin       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
110787c3beb6SLisandro Dalcin     }
11085e71baefSBarry Smith   }
11095e71baefSBarry Smith #endif
1110dff31646SBarry Smith 
111187c3beb6SLisandro Dalcin   flg = PETSC_TRUE;
111287c3beb6SLisandro Dalcin   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
111387c3beb6SLisandro Dalcin   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE);CHKERRQ(ierr);}
111487c3beb6SLisandro Dalcin 
1115a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
1116a56f64adSBarry Smith   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
11177b56e58cSSatish Balay   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1118a56f64adSBarry Smith   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
11199fc7e16cSBarry Smith   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1120a56f64adSBarry Smith #endif
112155d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
112255d657eeSBarry Smith #endif
1123a56f64adSBarry Smith 
1124301d30feSBarry Smith   /*
112557171095SVaclav Hapla       Set flag that we are completely initialized
1126301d30feSBarry Smith   */
1127301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
11282db0e300SLisandro Dalcin 
11292db0e300SLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
11302db0e300SLisandro Dalcin   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1131301d30feSBarry Smith   PetscFunctionReturn(0);
1132e5c89e4eSSatish Balay }
1133e5c89e4eSSatish Balay 
11344097062eSBarry Smith #if defined(PETSC_USE_LOG)
113595c0884eSLisandro Dalcin PETSC_INTERN PetscObject *PetscObjects;
1136ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsCounts;
1137ecfe9a72SLisandro Dalcin PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
113895c0884eSLisandro Dalcin PETSC_INTERN PetscBool   PetscObjectsLog;
11394097062eSBarry Smith #endif
1140e5c89e4eSSatish Balay 
1141008a6e76SBarry Smith /*
1142008a6e76SBarry Smith     Frees all the MPI types and operations that PETSc may have created
1143008a6e76SBarry Smith */
1144008a6e76SBarry Smith PetscErrorCode  PetscFreeMPIResources(void)
1145008a6e76SBarry Smith {
1146008a6e76SBarry Smith   PetscErrorCode ierr;
1147008a6e76SBarry Smith 
1148008a6e76SBarry Smith   PetscFunctionBegin;
1149008a6e76SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1150008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1151008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1152008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1153008a6e76SBarry Smith #endif
1154008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1155008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1156008a6e76SBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1157008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1158008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1159008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1160008a6e76SBarry Smith #endif
1161008a6e76SBarry Smith 
1162008a6e76SBarry Smith #if defined(PETSC_HAVE_COMPLEX)
1163008a6e76SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1164008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1165008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1166008a6e76SBarry Smith #endif
1167008a6e76SBarry Smith #endif
1168008a6e76SBarry Smith 
1169008a6e76SBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1170008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1171008a6e76SBarry Smith #endif
1172008a6e76SBarry Smith 
1173008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
117440df0d72SSatish Balay #if defined(PETSC_USE_64BIT_INDICES)
1175008a6e76SBarry Smith   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1176008a6e76SBarry Smith #endif
1177008a6e76SBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1178008a6e76SBarry Smith   PetscFunctionReturn(0);
1179008a6e76SBarry Smith }
1180008a6e76SBarry Smith 
1181e5c89e4eSSatish Balay /*@C
1182e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
1183e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
1184e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
1185e5c89e4eSSatish Balay 
1186e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
1187e5c89e4eSSatish Balay 
1188e5c89e4eSSatish Balay    Options Database Keys:
118926a7e8d4SBarry Smith +  -options_view - Calls PetscOptionsView()
1190e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
11917eb1d149SBarry Smith .  -objects_dump [all] - Prints list of objects allocated by the user that have not been freed, the option all cause all outstanding objects to be listed
1192e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
119392f119d6SBarry Smith .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1194e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
119592f119d6SBarry Smith -  -malloc_view <optional filename> - Prints list of all memory allocated and where
1196e5c89e4eSSatish Balay 
1197e5c89e4eSSatish Balay    Level: beginner
1198e5c89e4eSSatish Balay 
1199e5c89e4eSSatish Balay    Note:
1200e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
1201e5c89e4eSSatish Balay 
120288c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1203e5c89e4eSSatish Balay @*/
12047087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
1205e5c89e4eSSatish Balay {
1206e5c89e4eSSatish Balay   PetscErrorCode ierr;
12074bb5149bSJed Brown   PetscMPIInt    rank;
1208a8d2bbe5SBarry Smith   PetscInt       nopt;
12092bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1210dff31646SBarry Smith   PetscBool      flg;
121110463e74SBarry Smith #if defined(PETSC_USE_LOG)
121210463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
121310463e74SBarry Smith #endif
1214e5c89e4eSSatish Balay 
1215e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
12164b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
12173cbbc5ffSBarry Smith     return(PETSC_ERR_ARG_WRONGSTATE);
1218e5c89e4eSSatish Balay   }
12193cbbc5ffSBarry Smith   PetscFunctionBegin;
12200298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1221b022a5c1SBarry Smith 
12221f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1223a56f64adSBarry Smith #if defined(PETSC_HAVE_ADIOS)
122422580e64SBarry Smith   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1225a56f64adSBarry Smith   ierr = adios_finalize(rank);CHKERRQ(ierr);
1226a56f64adSBarry Smith #endif
122755d657eeSBarry Smith #if defined(PETSC_HAVE_ADIOS2)
122855d657eeSBarry Smith #endif
1229c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1230dff31646SBarry Smith   if (flg) {
12311f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
12321f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
12331f817a21SBarry Smith 
1234589a23caSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL);CHKERRQ(ierr);
12351f817a21SBarry Smith     if (filename[0]) {
12361f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
12371f817a21SBarry Smith     }
1238dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1239dff31646SBarry Smith     cits[0] = 0;
1240dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
12411f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
12421f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
12431f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
12441f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
12451f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1246dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1247dff31646SBarry Smith   }
1248dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1249dff31646SBarry Smith 
1250c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
125104102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
125204102261SBarry Smith   {
125304102261SBarry Smith     PetscInt nmax = 2;
125404102261SBarry Smith     char     **buffs;
125504102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1256c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
125704102261SBarry Smith     if (flg1) {
125804102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
125904102261SBarry Smith       if (nmax == 1) {
126004102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
126104102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
126204102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
126304102261SBarry Smith       }
126404102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
126504102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
126604102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
126704102261SBarry Smith     }
126804102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
126904102261SBarry Smith   }
1270763ec7b1SBarry Smith   {
1271763ec7b1SBarry Smith     PetscInt nmax = 2;
1272763ec7b1SBarry Smith     char     **buffs;
1273763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1274763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1275763ec7b1SBarry Smith     if (flg1) {
1276763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1277763ec7b1SBarry Smith       if (nmax == 1) {
1278763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1279763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1280763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1281763ec7b1SBarry Smith       }
1282763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1283763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1284763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1285763ec7b1SBarry Smith     }
1286763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1287763ec7b1SBarry Smith   }
128804102261SBarry Smith #endif
128904102261SBarry Smith 
12902d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
12912d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
12922d53ad75SBarry Smith #endif
12932d53ad75SBarry Smith 
1294e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1295dff31646SBarry Smith   flg = PETSC_FALSE;
1296c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1297d5649816SBarry Smith   if (flg) {
1298e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1299d5649816SBarry Smith   }
1300d5649816SBarry Smith #endif
1301d5649816SBarry Smith 
1302681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1303681455b2SBarry Smith   flg1 = PETSC_FALSE;
1304c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1305681455b2SBarry Smith   if (flg1) {
1306681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1307681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1308681455b2SBarry Smith   }
1309681455b2SBarry Smith #endif
1310681455b2SBarry Smith 
131167584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1312c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1313e5c89e4eSSatish Balay   if (!flg2) {
131490d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1315c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1316e5c89e4eSSatish Balay   }
1317e5c89e4eSSatish Balay   if (flg2) {
13180841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1319e5c89e4eSSatish Balay   }
132067584ceeSBarry Smith #endif
1321e5c89e4eSSatish Balay 
1322e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
132390d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1324c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1325e5c89e4eSSatish Balay   if (flg1) {
1326e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1327205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1328e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1329e5c89e4eSSatish Balay   }
1330e5c89e4eSSatish Balay #endif
1331e5c89e4eSSatish Balay 
1332e5c89e4eSSatish Balay 
1333e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1334e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1335e5c89e4eSSatish Balay   mname[0] = 0;
1336589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1337e5c89e4eSSatish Balay   if (flg1) {
1338e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1339e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1340e5c89e4eSSatish Balay   }
1341e5c89e4eSSatish Balay #endif
1342356e5837SBarry Smith #endif
1343a297a907SKarl Rupp 
1344dd710f27SBarry Smith   /*
1345dd710f27SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1346dd710f27SBarry Smith   */
1347dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1348dd710f27SBarry Smith 
1349356e5837SBarry Smith #if defined(PETSC_USE_LOG)
135087c3beb6SLisandro Dalcin   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1351f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
135287c3beb6SLisandro Dalcin   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
135387c3beb6SLisandro Dalcin 
1354356e5837SBarry Smith   mname[0] = 0;
1355589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1356e5c89e4eSSatish Balay   if (flg1) {
135791eabc43SBarry Smith     PetscViewer viewer;
135820a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
135991eabc43SBarry Smith     if (mname[0]) {
136091eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
136191eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
13626bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
136333f85c2fSBarry Smith     } else {
136433f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
13659a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
136633f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
13679a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
136833f85c2fSBarry Smith     }
1369e5c89e4eSSatish Balay   }
1370a297a907SKarl Rupp 
1371dd710f27SBarry Smith   /*
1372dd710f27SBarry Smith      Free any objects created by the last block of code.
1373dd710f27SBarry Smith   */
1374dd710f27SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1375dd710f27SBarry Smith 
1376dd710f27SBarry Smith   mname[0] = 0;
1377589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1378589a23caSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2);CHKERRQ(ierr);
13797ff663adSLisandro Dalcin   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1380e5c89e4eSSatish Balay #endif
138110463e74SBarry Smith 
138233f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
138310463e74SBarry Smith 
138490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1385c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1386e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
138790d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1388c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1389e5c89e4eSSatish Balay   if (flg1) {
1390e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1391e5c89e4eSSatish Balay   }
139290d69ab7SBarry Smith   flg1 = PETSC_FALSE;
139390d69ab7SBarry Smith   flg2 = PETSC_FALSE;
13948bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1395c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1396c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1397c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1398e4c476e2SSatish Balay 
1399e5c89e4eSSatish Balay   if (flg2) {
1400be56827dSJed Brown     PetscViewer viewer;
140102ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
140202ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1403c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1404be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1405e5c89e4eSSatish Balay   }
1406e5c89e4eSSatish Balay 
1407e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1408c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1409c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1410e5c89e4eSSatish Balay 
141133fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1412c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
14139245e749SBarry Smith   if (PetscUnlikelyDebug(!flg1)) flg3 = PETSC_TRUE;
1414e5c89e4eSSatish Balay   if (flg3) {
14153de2bfdfSBarry Smith     if (!flg2 && flg1) { /* have not yet printed the options */
1416be56827dSJed Brown       PetscViewer viewer;
141702ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
141802ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1419c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1420be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1421e5c89e4eSSatish Balay     }
14223de2bfdfSBarry Smith     ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
14233de2bfdfSBarry Smith     if (nopt) {
14243de2bfdfSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
14253de2bfdfSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
14263de2bfdfSBarry Smith       if (nopt == 1) {
1427e5c89e4eSSatish Balay         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1428e5c89e4eSSatish Balay       } else {
14297582186dSLisandro Dalcin         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1430e5c89e4eSSatish Balay       }
14313de2bfdfSBarry Smith     } else if (flg3 && flg1) {
14323de2bfdfSBarry Smith       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1433df12ba86SBarry Smith     }
1434c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1435e5c89e4eSSatish Balay   }
1436e5c89e4eSSatish Balay 
1437e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1438d45a07a7SBarry Smith   if (!PetscGlobalRank) {
143987f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
144016ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1441d45a07a7SBarry Smith   }
1442ec957eceSBarry Smith #endif
1443ec957eceSBarry Smith 
14444097062eSBarry Smith #if defined(PETSC_USE_LOG)
144510463e74SBarry Smith   /*
1446dbc8283eSBarry Smith        List all objects the user may have forgot to free
14472eff7a51SBarry Smith   */
144805df10baSBarry Smith   if (PetscObjectsLog) {
1449c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1450a64a8e02SBarry Smith     if (flg1) {
1451a64a8e02SBarry Smith       MPI_Comm local_comm;
14527eb1d149SBarry Smith       char     string[64];
1453a64a8e02SBarry Smith 
1454589a23caSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL);CHKERRQ(ierr);
1455a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1456a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
14577eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1458a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1459a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
14600a1571b3SBarry Smith     }
146105df10baSBarry Smith   }
14624097062eSBarry Smith #endif
14634097062eSBarry Smith 
14644097062eSBarry Smith #if defined(PETSC_USE_LOG)
1465dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1466dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1467a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
14684097062eSBarry Smith #endif
14692eff7a51SBarry Smith 
147033f85c2fSBarry Smith   /*
147133f85c2fSBarry Smith      Destroy any packages that registered a finalize
147233f85c2fSBarry Smith   */
147333f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
147433f85c2fSBarry Smith 
1475101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1476fa2bb9feSLisandro Dalcin   ierr = PetscLogFinalize();CHKERRQ(ierr);
1477101409b8SToby Isaac #endif
1478101409b8SToby Isaac 
147933f85c2fSBarry Smith   /*
148048dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
148148dd1dffSBarry Smith 
148237e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
148348dd1dffSBarry Smith   */
148437e93019SBarry Smith 
14854028d114SSatish Balay   if (petsc_history) {
1486f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
148702c9f0b5SLisandro Dalcin     petsc_history = NULL;
1488e5c89e4eSSatish Balay   }
14899de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1490e94e781bSJacob Faibussowitsch   ierr = PetscInfoDestroy();CHKERRQ(ierr);
1491e5c89e4eSSatish Balay 
149267584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
149392f119d6SBarry Smith   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1494e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
149592f119d6SBarry Smith     char sname[PETSC_MAX_PATH_LEN];
1496e5c89e4eSSatish Balay     FILE *fd;
1497ed9cf6e9SBarry Smith     int  err;
1498e5c89e4eSSatish Balay 
1499dc92acbaSJed Brown     flg2 = PETSC_FALSE;
150092f119d6SBarry Smith     flg3 = PETSC_FALSE;
1501cf9c20a2SJed Brown     if (PetscDefined(USE_DEBUG)) {ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);}
150292f119d6SBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);CHKERRQ(ierr);
150392f119d6SBarry Smith     fname[0] = 0;
1504589a23caSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1505e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1506e5c89e4eSSatish Balay 
1507589a23caSBarry Smith       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
1508e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1509e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1510ed9cf6e9SBarry Smith       err  = fclose(fd);
1511e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
151292f119d6SBarry Smith     } else if (flg1 || flg2 || flg3) {
1513e5c89e4eSSatish Balay       MPI_Comm local_comm;
1514e5c89e4eSSatish Balay 
1515e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1516e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1517e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1518e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1519e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1520e5c89e4eSSatish Balay     }
1521e5c89e4eSSatish Balay     fname[0] = 0;
1522589a23caSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1523e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1524e5c89e4eSSatish Balay 
1525589a23caSBarry Smith       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
152692f119d6SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
152792f119d6SBarry Smith       ierr = PetscMallocView(fd);CHKERRQ(ierr);
1528ed9cf6e9SBarry Smith       err  = fclose(fd);
1529e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
153092f119d6SBarry Smith     } else if (flg1) {
153192f119d6SBarry Smith       MPI_Comm local_comm;
153292f119d6SBarry Smith 
153392f119d6SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
153492f119d6SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
153592f119d6SBarry Smith       ierr = PetscMallocView(stdout);CHKERRQ(ierr);
153692f119d6SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
153792f119d6SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1538e5c89e4eSSatish Balay     }
1539e5c89e4eSSatish Balay   }
154067584ceeSBarry Smith #endif
154120e2c332SMatthew G. Knepley 
15425486ca60SMatthew G. Knepley   /*
15435486ca60SMatthew G. Knepley      Close any open dynamic libraries
15445486ca60SMatthew G. Knepley   */
15455486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
15465486ca60SMatthew G. Knepley 
1547e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
15484416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1549e5c89e4eSSatish Balay 
1550e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
155102c9f0b5SLisandro Dalcin   PetscGlobalArgs = NULL;
1552e5c89e4eSSatish Balay 
1553c2b86a48SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS)
1554c2b86a48SJunchao Zhang   if (PetscBeganKokkos) {
1555c2b86a48SJunchao Zhang     ierr = PetscKokkosFinalize_Private();CHKERRQ(ierr);
1556c2b86a48SJunchao Zhang     PetscBeganKokkos = PETSC_FALSE;
1557c2b86a48SJunchao Zhang   }
1558c2b86a48SJunchao Zhang #endif
1559c2b86a48SJunchao Zhang 
1560008a6e76SBarry Smith   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1561e5c89e4eSSatish Balay 
1562dbc8283eSBarry Smith   /*
1563efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1564efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1565efb80d3cSBarry Smith 
1566efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1567efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1568dbc8283eSBarry Smith  */
1569b770b1f6SSatish Balay   {
1570dbc8283eSBarry Smith     PetscCommCounter *counter;
1571dbc8283eSBarry Smith     PetscMPIInt      flg;
1572dbc8283eSBarry Smith     MPI_Comm         icomm;
1573265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
157447435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1575dbc8283eSBarry Smith     if (flg) {
1576265f3f35SJed Brown       icomm = ucomm.comm;
157747435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1578dbc8283eSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1579dbc8283eSBarry Smith 
158047435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
158147435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1582efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1583dbc8283eSBarry Smith     }
158447435625SJed Brown     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1585dbc8283eSBarry Smith     if (flg) {
1586265f3f35SJed Brown       icomm = ucomm.comm;
158747435625SJed Brown       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1588dbc8283eSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1589dbc8283eSBarry Smith 
159047435625SJed Brown       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
159147435625SJed Brown       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1592efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1593dbc8283eSBarry Smith     }
1594b770b1f6SSatish Balay   }
1595dbc8283eSBarry Smith 
159647435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
159747435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
159847435625SJed Brown   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
15995f7487a0SJunchao Zhang   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1600480cf27aSJed Brown 
16015ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
16025ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
16035ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1604ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1605ef19f930SBarry Smith 
1606e5c89e4eSSatish Balay   if (PetscBeganMPI) {
160799608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
160899b1327fSBarry Smith     PetscMPIInt flag;
160999b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1610e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
161199608316SBarry Smith #endif
1612e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1613e5c89e4eSSatish Balay   }
1614e5c89e4eSSatish Balay /*
1615e5c89e4eSSatish Balay 
1616e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1617e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1618e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1619e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1620e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
16210e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1622e5c89e4eSSatish Balay    memory was not freed.
1623e5c89e4eSSatish Balay 
1624e5c89e4eSSatish Balay */
16251d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1626a297a907SKarl Rupp 
16278ad20175SVaclav Hapla   PetscErrorHandlingInitialized = PETSC_FALSE;
1628e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1629e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
163056883f60SBarry Smith #if defined(PETSC_USE_GCOV)
163156883f60SBarry Smith   /*
163256883f60SBarry Smith      flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the
163356883f60SBarry Smith      gcov files are still being added to the directories as git tries to remove the directories.
163456883f60SBarry Smith    */
163556883f60SBarry Smith   __gcov_flush();
163656883f60SBarry Smith #endif
16373db9a53dSBarry Smith   PetscFunctionReturn(0);
1638e5c89e4eSSatish Balay }
1639e5c89e4eSSatish Balay 
164043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
16418cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
164243db4dbbSBarry Smith {
164343db4dbbSBarry Smith   if (*a == *b) return 1;
164443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
164543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
164643db4dbbSBarry Smith   return 0;
164743db4dbbSBarry Smith }
1648a70650f6SBarry Smith #endif
164943db4dbbSBarry Smith 
165043db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
16518cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
165243db4dbbSBarry Smith {
165343db4dbbSBarry Smith   if (*a == *b) return 1;
165443db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
165543db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
165643db4dbbSBarry Smith   return 0;
165743db4dbbSBarry Smith }
165843db4dbbSBarry Smith #endif
1659