xref: /petsc/src/sys/objects/pinit.c (revision 609bdbee21ea3be08735c64dbe00a9ab27759925)
17d0a6c19SBarry Smith 
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>
88101f56cSMatthew Knepley 
9a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
10896238b9SBarry Smith extern PetscErrorCode PetscLogInitialize(void);
11a9f03627SSatish Balay #endif
12f2d66bcaSShri Abhyankar 
132d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
142d53ad75SBarry Smith PetscFPT PetscFPTData = 0;
152d53ad75SBarry Smith #endif
162d53ad75SBarry Smith 
1782f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
1882f73ecaSAlejandro Lamas Daviña cublasHandle_t cublasv2handle = NULL;
1982f73ecaSAlejandro Lamas Daviña #endif
2082f73ecaSAlejandro Lamas Daviña 
21a6790183SBarry Smith #if defined(PETSC_HAVE_SAWS)
2216ad0300SBarry Smith #include <petscviewersaws.h>
23a6790183SBarry Smith #endif
24e5c89e4eSSatish Balay /* -----------------------------------------------------------------------------------------*/
25e5c89e4eSSatish Balay 
26e5c89e4eSSatish Balay extern FILE *petsc_history;
27e5c89e4eSSatish Balay 
2809573ac7SBarry Smith extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
2909573ac7SBarry Smith extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
3037e93019SBarry Smith extern PetscErrorCode PetscFunctionListPrintAll(void);
3109573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
3209573ac7SBarry Smith extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
3309573ac7SBarry Smith extern PetscErrorCode PetscCloseHistoryFile(FILE**);
340069ddf5SShri Abhyankar 
35e5c89e4eSSatish Balay /* user may set this BEFORE calling PetscInitialize() */
36e8373e55SMatthew Knepley MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
37e5c89e4eSSatish Balay 
38480cf27aSJed Brown PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
39480cf27aSJed Brown PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
40480cf27aSJed Brown PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
41480cf27aSJed Brown 
42e5c89e4eSSatish Balay /*
43e5c89e4eSSatish Balay      Declare and set all the string names of the PETSc enums
44e5c89e4eSSatish Balay */
456a6fc655SJed Brown const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
466a6fc655SJed Brown const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};
476a6fc655SJed Brown const char *const PetscDataTypes[] = {"INT","DOUBLE","COMPLEX","LONG","SHORT","FLOAT",
482d53ad75SBarry Smith                                       "CHAR","LOGICAL","ENUM","BOOL","LONGDOUBLE","OBJECT","FUNCTION","PetscDataType","PETSC_",0};
49e5c89e4eSSatish Balay 
50ace3abfcSBarry Smith PetscBool PetscPreLoadingUsed = PETSC_FALSE;
51ace3abfcSBarry Smith PetscBool PetscPreLoadingOn   = PETSC_FALSE;
520f8e0872SSatish Balay 
53a2f94806SJed Brown PetscInt PetscHotRegionDepth;
54a2f94806SJed Brown 
55b22622e2STadeu Manoel #if defined(PETSC_HAVE_THREADSAFETY)
56b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockOpen;
57b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStdout;
58b22622e2STadeu Manoel PetscSpinlock PetscViewerASCIISpinLockStderr;
59b22622e2STadeu Manoel PetscSpinlock PetscCommSpinLock;
60b22622e2STadeu Manoel #endif
61b22622e2STadeu Manoel 
62e5c89e4eSSatish Balay /*
63e5c89e4eSSatish Balay        Checks the options database for initializations related to the
64e5c89e4eSSatish Balay     PETSc components
65e5c89e4eSSatish Balay */
667087cfbeSBarry Smith PetscErrorCode  PetscOptionsCheckInitial_Components(void)
67e5c89e4eSSatish Balay {
68ace3abfcSBarry Smith   PetscBool      flg1;
69e5c89e4eSSatish Balay   PetscErrorCode ierr;
70e5c89e4eSSatish Balay 
71e5c89e4eSSatish Balay   PetscFunctionBegin;
72c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg1);CHKERRQ(ierr);
73e5c89e4eSSatish Balay   if (flg1) {
74e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
75e8e7597cSSatish Balay     MPI_Comm comm = PETSC_COMM_WORLD;
76e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
779a9a5d4cSBarry Smith     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
786cf91177SBarry Smith     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
79e5c89e4eSSatish Balay     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
80e5c89e4eSSatish Balay #endif
81e5c89e4eSSatish Balay   }
82e5c89e4eSSatish Balay   PetscFunctionReturn(0);
83e5c89e4eSSatish Balay }
84e5c89e4eSSatish Balay 
850f11a792SBarry Smith /*
86945d1669SBarry Smith       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
8772a42c3cSBarry Smith 
8872a42c3cSBarry Smith    Collective
8972a42c3cSBarry Smith 
9072a42c3cSBarry Smith    Level: advanced
9172a42c3cSBarry Smith 
92945d1669SBarry Smith     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
930f11a792SBarry Smith      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
94945d1669SBarry Smith      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
950f11a792SBarry Smith 
961ea5a559SBarry Smith      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
971ea5a559SBarry Smith 
9872a42c3cSBarry Smith .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
990f11a792SBarry Smith */
100945d1669SBarry Smith PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
10172a42c3cSBarry Smith {
10272a42c3cSBarry Smith   PetscErrorCode ierr;
10372a42c3cSBarry Smith   int            myargc   = argc;
10472a42c3cSBarry Smith   char           **myargs = args;
10572a42c3cSBarry Smith 
10672a42c3cSBarry Smith   PetscFunctionBegin;
1073bf036e2SBarry Smith   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
1081ea5a559SBarry Smith   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
109df413903SBarry Smith   PetscBeganMPI = PETSC_FALSE;
11072a42c3cSBarry Smith   PetscFunctionReturn(ierr);
11172a42c3cSBarry Smith }
11272a42c3cSBarry Smith 
113f0865b08SBarry Smith /*
114945d1669SBarry Smith       Used by MATLAB and Julia interface to get communicator
115f0865b08SBarry Smith */
116945d1669SBarry Smith PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
117f0865b08SBarry Smith {
118f0865b08SBarry Smith   PetscFunctionBegin;
119f0865b08SBarry Smith   *comm = PETSC_COMM_SELF;
120f0865b08SBarry Smith   PetscFunctionReturn(0);
121f0865b08SBarry Smith }
122f0865b08SBarry Smith 
123e5c89e4eSSatish Balay /*@C
124e5c89e4eSSatish Balay       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
125e5c89e4eSSatish Balay         the command line arguments.
126e5c89e4eSSatish Balay 
127e5c89e4eSSatish Balay    Collective
128e5c89e4eSSatish Balay 
129e5c89e4eSSatish Balay    Level: advanced
130e5c89e4eSSatish Balay 
131e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeFortran()
132e5c89e4eSSatish Balay @*/
1337087cfbeSBarry Smith PetscErrorCode  PetscInitializeNoArguments(void)
134e5c89e4eSSatish Balay {
135e5c89e4eSSatish Balay   PetscErrorCode ierr;
136e5c89e4eSSatish Balay   int            argc   = 0;
137e5c89e4eSSatish Balay   char           **args = 0;
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay   PetscFunctionBegin;
1400298fd71SBarry Smith   ierr = PetscInitialize(&argc,&args,NULL,NULL);
141e5c89e4eSSatish Balay   PetscFunctionReturn(ierr);
142e5c89e4eSSatish Balay }
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay /*@
145e5c89e4eSSatish Balay       PetscInitialized - Determine whether PETSc is initialized.
146e5c89e4eSSatish Balay 
14793b6d2d1SJed Brown    Level: beginner
148e5c89e4eSSatish Balay 
149e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
150e5c89e4eSSatish Balay @*/
1517087cfbeSBarry Smith PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
152e5c89e4eSSatish Balay {
153e5c89e4eSSatish Balay   *isInitialized = PetscInitializeCalled;
15493b6d2d1SJed Brown   return 0;
155e5c89e4eSSatish Balay }
156e5c89e4eSSatish Balay 
157e5c89e4eSSatish Balay /*@
158e5c89e4eSSatish Balay       PetscFinalized - Determine whether PetscFinalize() has been called yet
159e5c89e4eSSatish Balay 
160e5c89e4eSSatish Balay    Level: developer
161e5c89e4eSSatish Balay 
162e5c89e4eSSatish Balay .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
163e5c89e4eSSatish Balay @*/
1647087cfbeSBarry Smith PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
165e5c89e4eSSatish Balay {
166e5c89e4eSSatish Balay   *isFinalized = PetscFinalizeCalled;
16793b6d2d1SJed Brown   return 0;
168e5c89e4eSSatish Balay }
169e5c89e4eSSatish Balay 
17009573ac7SBarry Smith extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
171e5c89e4eSSatish Balay 
172e5c89e4eSSatish Balay /*
173e5c89e4eSSatish Balay        This function is the MPI reduction operation used to compute the sum of the
174e5c89e4eSSatish Balay    first half of the datatype and the max of the second half.
175e5c89e4eSSatish Balay */
176367daffbSBarry Smith MPI_Op MPIU_MAXSUM_OP = 0;
177e5c89e4eSSatish Balay 
178367daffbSBarry Smith PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
179e5c89e4eSSatish Balay {
180e5c89e4eSSatish Balay   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
181e5c89e4eSSatish Balay 
182e5c89e4eSSatish Balay   PetscFunctionBegin;
183e5c89e4eSSatish Balay   if (*datatype != MPIU_2INT) {
184e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
185e5c89e4eSSatish Balay     MPI_Abort(MPI_COMM_WORLD,1);
186e5c89e4eSSatish Balay   }
187e5c89e4eSSatish Balay 
188e5c89e4eSSatish Balay   for (i=0; i<count; i++) {
189e5c89e4eSSatish Balay     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
190e5c89e4eSSatish Balay     xout[2*i+1] += xin[2*i+1];
191e5c89e4eSSatish Balay   }
192812af9f3SBarry Smith   PetscFunctionReturnVoid();
193e5c89e4eSSatish Balay }
194e5c89e4eSSatish Balay 
195e5c89e4eSSatish Balay /*
196e5c89e4eSSatish Balay     Returns the max of the first entry owned by this processor and the
197e5c89e4eSSatish Balay sum of the second entry.
198b693b147SBarry Smith 
19976f543a4SJed Brown     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
200367daffbSBarry Smith is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
201b693b147SBarry Smith there would be no place to store the both needed results.
202e5c89e4eSSatish Balay */
20376ec1555SBarry Smith PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
204e5c89e4eSSatish Balay {
205e5c89e4eSSatish Balay   PetscErrorCode ierr;
206e5c89e4eSSatish Balay 
207e5c89e4eSSatish Balay   PetscFunctionBegin;
208d6e4c47cSJed Brown #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
209d6e4c47cSJed Brown   {
210d6e4c47cSJed Brown     struct {PetscInt max,sum;} work;
211367daffbSBarry Smith     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
212d6e4c47cSJed Brown     *max = work.max;
213d6e4c47cSJed Brown     *sum = work.sum;
214d6e4c47cSJed Brown   }
215d6e4c47cSJed Brown #else
216d6e4c47cSJed Brown   {
217d6e4c47cSJed Brown     PetscMPIInt    size,rank;
218d6e4c47cSJed Brown     struct {PetscInt max,sum;} *work;
219e5c89e4eSSatish Balay     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
220e5c89e4eSSatish Balay     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
221785e854fSJed Brown     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
222367daffbSBarry Smith     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
2236ac3741eSJed Brown     *max = work[rank].max;
2246ac3741eSJed Brown     *sum = work[rank].sum;
225e5c89e4eSSatish Balay     ierr = PetscFree(work);CHKERRQ(ierr);
226d6e4c47cSJed Brown   }
227d6e4c47cSJed Brown #endif
228e5c89e4eSSatish Balay   PetscFunctionReturn(0);
229e5c89e4eSSatish Balay }
230e5c89e4eSSatish Balay 
231e5c89e4eSSatish Balay /* ----------------------------------------------------------------------------*/
232e5c89e4eSSatish Balay 
233570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
23406a205a8SBarry Smith MPI_Op MPIU_SUM = 0;
235e5c89e4eSSatish Balay 
2368cc058d9SJed Brown PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
237e5c89e4eSSatish Balay {
238e5c89e4eSSatish Balay   PetscInt i,count = *cnt;
239e5c89e4eSSatish Balay 
240e5c89e4eSSatish Balay   PetscFunctionBegin;
2417c2de775SJed Brown   if (*datatype == MPIU_REAL) {
242e2e03761SBarry Smith     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
243a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2447c2de775SJed Brown   }
2457c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2467c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2477c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
248a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] += xin[i];
2497c2de775SJed Brown   }
2507c2de775SJed Brown #endif
2517c2de775SJed Brown   else {
2527c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
253e2e03761SBarry Smith     MPI_Abort(MPI_COMM_WORLD,1);
254e2e03761SBarry Smith   }
255812af9f3SBarry Smith   PetscFunctionReturnVoid();
256e5c89e4eSSatish Balay }
257e5c89e4eSSatish Balay #endif
258e5c89e4eSSatish Balay 
259570b7f6dSBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
260d9822059SBarry Smith MPI_Op MPIU_MAX = 0;
261d9822059SBarry Smith MPI_Op MPIU_MIN = 0;
262d9822059SBarry Smith 
2638cc058d9SJed Brown PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
264d9822059SBarry Smith {
265d9822059SBarry Smith   PetscInt i,count = *cnt;
266d9822059SBarry Smith 
267d9822059SBarry Smith   PetscFunctionBegin;
2687c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2698c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
270a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
2717c2de775SJed Brown   }
2727c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2737c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2747c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2757c2de775SJed Brown     for (i=0; i<count; i++) {
2767c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
2777c2de775SJed Brown     }
2787c2de775SJed Brown   }
2797c2de775SJed Brown #endif
2807c2de775SJed Brown   else {
2817c2de775SJed Brown     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
2828c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
2838c764dc5SJose Roman   }
284d9822059SBarry Smith   PetscFunctionReturnVoid();
285d9822059SBarry Smith }
286d9822059SBarry Smith 
2878cc058d9SJed Brown PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
288d9822059SBarry Smith {
289d9822059SBarry Smith   PetscInt    i,count = *cnt;
290d9822059SBarry Smith 
291d9822059SBarry Smith   PetscFunctionBegin;
2927c2de775SJed Brown   if (*datatype == MPIU_REAL) {
2938c764dc5SJose Roman     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
294a297a907SKarl Rupp     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
2957c2de775SJed Brown   }
2967c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2977c2de775SJed Brown   else if (*datatype == MPIU_COMPLEX) {
2987c2de775SJed Brown     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
2997c2de775SJed Brown     for (i=0; i<count; i++) {
3007c2de775SJed Brown       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
3017c2de775SJed Brown     }
3027c2de775SJed Brown   }
3037c2de775SJed Brown #endif
3047c2de775SJed Brown   else {
3058c764dc5SJose Roman     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
3068c764dc5SJose Roman     MPI_Abort(MPI_COMM_WORLD,1);
3078c764dc5SJose Roman   }
308d9822059SBarry Smith   PetscFunctionReturnVoid();
309d9822059SBarry Smith }
310d9822059SBarry Smith #endif
311d9822059SBarry Smith 
312480cf27aSJed Brown /*
313480cf27aSJed Brown    Private routine to delete internal tag/name counter storage when a communicator is freed.
314480cf27aSJed Brown 
315ff0e51ddSBarry 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.
316480cf27aSJed Brown 
317480cf27aSJed Brown    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
318480cf27aSJed Brown 
319480cf27aSJed Brown */
3208cc058d9SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
321480cf27aSJed Brown {
322480cf27aSJed Brown   PetscErrorCode ierr;
323480cf27aSJed Brown 
324480cf27aSJed Brown   PetscFunctionBegin;
325480cf27aSJed Brown   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
326480cf27aSJed Brown   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
327480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
328480cf27aSJed Brown }
329480cf27aSJed Brown 
330480cf27aSJed Brown /*
331da3039f7SJed Brown   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
332da3039f7SJed Brown   calls MPI_Comm_free().
333da3039f7SJed Brown 
334da3039f7SJed Brown   This is the only entry point for breaking the links between inner and outer comms.
335480cf27aSJed Brown 
336ff0e51ddSBarry Smith   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
337480cf27aSJed Brown 
338480cf27aSJed Brown   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
339480cf27aSJed Brown 
340480cf27aSJed Brown */
341da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
342480cf27aSJed Brown {
343480cf27aSJed Brown   PetscErrorCode ierr;
344b89831e5SBarry Smith   PetscMPIInt    flg;
345265f3f35SJed Brown   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
346480cf27aSJed Brown 
347480cf27aSJed Brown   PetscFunctionBegin;
348da3039f7SJed Brown   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
349ec4fadc2SJed Brown   icomm.ptr = attr_val;
350da3039f7SJed Brown 
351265f3f35SJed Brown   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
352b3ef52cdSBarry Smith   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
353da3039f7SJed Brown   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
354da3039f7SJed Brown   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
355da3039f7SJed Brown   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
356da3039f7SJed Brown   PetscFunctionReturn(MPI_SUCCESS);
357b89831e5SBarry Smith }
358da3039f7SJed Brown 
359da3039f7SJed Brown /*
360da3039f7SJed Brown  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
361da3039f7SJed Brown  */
362da3039f7SJed Brown PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
363da3039f7SJed Brown {
364da3039f7SJed Brown   PetscErrorCode ierr;
365da3039f7SJed Brown 
366da3039f7SJed Brown   PetscFunctionBegin;
367da3039f7SJed Brown   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
368480cf27aSJed Brown   PetscFunctionReturn(MPI_SUCCESS);
369480cf27aSJed Brown }
370480cf27aSJed Brown 
371951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
372e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3738cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
3748cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
3758cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
376e39fd77fSBarry Smith #endif
377951e3c8eSBarry Smith #endif
378e39fd77fSBarry Smith 
3796ae9a8a6SBarry Smith int  PetscGlobalArgc   = 0;
3806ae9a8a6SBarry Smith char **PetscGlobalArgs = 0;
381dff31646SBarry Smith PetscSegBuffer PetscCitationsList;
382e5c89e4eSSatish Balay 
383051e4cf2SJed Brown PetscErrorCode PetscCitationsInitialize()
384051e4cf2SJed Brown {
385051e4cf2SJed Brown   PetscErrorCode ierr;
386051e4cf2SJed Brown 
387051e4cf2SJed Brown   PetscFunctionBegin;
388051e4cf2SJed Brown   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
389ae618e69SSatish Balay   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown and Peter Brune\n            and Kris Buschelman and Lisandro Dalcin and Victor Eijkhout and William D. Gropp\n            and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Karl Rupp and Barry F. Smith\n            and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.7},\n  Institution = {Argonne National Laboratory},\n  Year = {2016}\n}\n",NULL);CHKERRQ(ierr);
390051e4cf2SJed 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);
391051e4cf2SJed Brown   PetscFunctionReturn(0);
392051e4cf2SJed Brown }
393e5c89e4eSSatish Balay 
394e5c89e4eSSatish Balay /*@C
395e5c89e4eSSatish Balay    PetscGetArgs - Allows you to access the raw command line arguments anywhere
396e5c89e4eSSatish Balay      after PetscInitialize() is called but before PetscFinalize().
397e5c89e4eSSatish Balay 
398e5c89e4eSSatish Balay    Not Collective
399e5c89e4eSSatish Balay 
400e5c89e4eSSatish Balay    Output Parameters:
401e5c89e4eSSatish Balay +  argc - count of number of command line arguments
402e5c89e4eSSatish Balay -  args - the command line arguments
403e5c89e4eSSatish Balay 
404e5c89e4eSSatish Balay    Level: intermediate
405e5c89e4eSSatish Balay 
406e5c89e4eSSatish Balay    Notes:
407e5c89e4eSSatish Balay       This is usually used to pass the command line arguments into other libraries
408e5c89e4eSSatish Balay    that are called internally deep in PETSc or the application.
409e5c89e4eSSatish Balay 
410f177e3b1SBarry Smith       The first argument contains the program name as is normal for C arguments.
411f177e3b1SBarry Smith 
412e5c89e4eSSatish Balay    Concepts: command line arguments
413e5c89e4eSSatish Balay 
414793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
415e5c89e4eSSatish Balay 
416e5c89e4eSSatish Balay @*/
4177087cfbeSBarry Smith PetscErrorCode  PetscGetArgs(int *argc,char ***args)
418e5c89e4eSSatish Balay {
419e5c89e4eSSatish Balay   PetscFunctionBegin;
42017186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
421e5c89e4eSSatish Balay   *argc = PetscGlobalArgc;
422e5c89e4eSSatish Balay   *args = PetscGlobalArgs;
423e5c89e4eSSatish Balay   PetscFunctionReturn(0);
424e5c89e4eSSatish Balay }
425e5c89e4eSSatish Balay 
426793721a6SBarry Smith /*@C
427793721a6SBarry Smith    PetscGetArguments - Allows you to access the  command line arguments anywhere
428793721a6SBarry Smith      after PetscInitialize() is called but before PetscFinalize().
429793721a6SBarry Smith 
430793721a6SBarry Smith    Not Collective
431793721a6SBarry Smith 
432793721a6SBarry Smith    Output Parameters:
433793721a6SBarry Smith .  args - the command line arguments
434793721a6SBarry Smith 
435793721a6SBarry Smith    Level: intermediate
436793721a6SBarry Smith 
437793721a6SBarry Smith    Notes:
438793721a6SBarry Smith       This does NOT start with the program name and IS null terminated (final arg is void)
439793721a6SBarry Smith 
440793721a6SBarry Smith    Concepts: command line arguments
441793721a6SBarry Smith 
442793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
443793721a6SBarry Smith 
444793721a6SBarry Smith @*/
4457087cfbeSBarry Smith PetscErrorCode  PetscGetArguments(char ***args)
446793721a6SBarry Smith {
447793721a6SBarry Smith   PetscInt       i,argc = PetscGlobalArgc;
448793721a6SBarry Smith   PetscErrorCode ierr;
449793721a6SBarry Smith 
450793721a6SBarry Smith   PetscFunctionBegin;
45117186662SBarry Smith   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
452717030eeSLisandro Dalcin   if (!argc) {*args = 0; PetscFunctionReturn(0);}
453785e854fSJed Brown   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
454793721a6SBarry Smith   for (i=0; i<argc-1; i++) {
455793721a6SBarry Smith     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
456793721a6SBarry Smith   }
457793721a6SBarry Smith   (*args)[argc-1] = 0;
458793721a6SBarry Smith   PetscFunctionReturn(0);
459793721a6SBarry Smith }
460793721a6SBarry Smith 
461793721a6SBarry Smith /*@C
462793721a6SBarry Smith    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
463793721a6SBarry Smith 
464793721a6SBarry Smith    Not Collective
465793721a6SBarry Smith 
466793721a6SBarry Smith    Output Parameters:
467793721a6SBarry Smith .  args - the command line arguments
468793721a6SBarry Smith 
469793721a6SBarry Smith    Level: intermediate
470793721a6SBarry Smith 
471793721a6SBarry Smith    Concepts: command line arguments
472793721a6SBarry Smith 
473793721a6SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
474793721a6SBarry Smith 
475793721a6SBarry Smith @*/
4767087cfbeSBarry Smith PetscErrorCode  PetscFreeArguments(char **args)
477793721a6SBarry Smith {
478793721a6SBarry Smith   PetscInt       i = 0;
479793721a6SBarry Smith   PetscErrorCode ierr;
480793721a6SBarry Smith 
481793721a6SBarry Smith   PetscFunctionBegin;
482a297a907SKarl Rupp   if (!args) PetscFunctionReturn(0);
483793721a6SBarry Smith   while (args[i]) {
484793721a6SBarry Smith     ierr = PetscFree(args[i]);CHKERRQ(ierr);
485793721a6SBarry Smith     i++;
486793721a6SBarry Smith   }
487793721a6SBarry Smith   ierr = PetscFree(args);CHKERRQ(ierr);
488793721a6SBarry Smith   PetscFunctionReturn(0);
489793721a6SBarry Smith }
490793721a6SBarry Smith 
49111525c0dSBarry Smith #if defined(PETSC_HAVE_SAWS)
49230befbd2SBarry Smith #include <petscconfiginfo.h>
49330befbd2SBarry Smith 
49411525c0dSBarry Smith PetscErrorCode  PetscInitializeSAWs(const char help[])
49511525c0dSBarry Smith {
49611525c0dSBarry Smith   if (!PetscGlobalRank) {
49730befbd2SBarry Smith     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
49811525c0dSBarry Smith     int            port;
499ffbd1cfbSBarry Smith     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
50011525c0dSBarry Smith     size_t         applinelen,introlen;
50111525c0dSBarry Smith     PetscErrorCode ierr;
502ffbd1cfbSBarry Smith     char           sawsurl[256];
50311525c0dSBarry Smith 
504c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
50511525c0dSBarry Smith     if (flg) {
50611525c0dSBarry Smith       char  sawslog[PETSC_MAX_PATH_LEN];
50711525c0dSBarry Smith 
508c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
50911525c0dSBarry Smith       if (sawslog[0]) {
51011525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
51111525c0dSBarry Smith       } else {
51211525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
51311525c0dSBarry Smith       }
51411525c0dSBarry Smith     }
515c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
51611525c0dSBarry Smith     if (flg) {
51711525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
51811525c0dSBarry Smith     }
519c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
520ffbd1cfbSBarry Smith     if (selectport) {
521ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
522ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
523ffbd1cfbSBarry Smith     } else {
524c5929fdfSBarry Smith       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
52511525c0dSBarry Smith       if (flg) {
52611525c0dSBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
52711525c0dSBarry Smith       }
528ffbd1cfbSBarry Smith     }
529c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
53011525c0dSBarry Smith     if (flg) {
53111525c0dSBarry Smith       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
53211525c0dSBarry Smith       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
5339c1e0ce8SBarry Smith     } else {
534c5929fdfSBarry Smith       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
5359c1e0ce8SBarry Smith       if (flg) {
5363c01dfcfSBarry Smith         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
5379c1e0ce8SBarry Smith         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
5389c1e0ce8SBarry Smith       }
53911525c0dSBarry Smith     }
540c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
54111525c0dSBarry Smith     if (flg2) {
54211525c0dSBarry Smith       char jsdir[PETSC_MAX_PATH_LEN];
54311525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
54411525c0dSBarry Smith       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
54511525c0dSBarry Smith       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
54611525c0dSBarry Smith       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
54743da4ab2SBarry Smith       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
54811525c0dSBarry Smith     }
54911525c0dSBarry Smith     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
55011525c0dSBarry Smith     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
55111525c0dSBarry Smith     introlen   = 4096 + applinelen;
55230a8c9c0SSurtai Han     applinelen += 1024;
55311525c0dSBarry Smith     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
55411525c0dSBarry Smith     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
55511525c0dSBarry Smith 
55611525c0dSBarry Smith     if (rootlocal) {
55711525c0dSBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
55811525c0dSBarry Smith       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
55911525c0dSBarry Smith     }
56076a34f28SBarry Smith     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
56111525c0dSBarry Smith     if (rootlocal && help) {
56230befbd2SBarry Smith       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);
56311525c0dSBarry Smith     } else if (help) {
56430a8c9c0SSurtai Han       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
56511525c0dSBarry Smith     } else {
56630befbd2SBarry Smith       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
56711525c0dSBarry Smith     }
568b0bb5815SBarry Smith     ierr = PetscFree(options);CHKERRQ(ierr);
56930befbd2SBarry Smith     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
57011525c0dSBarry Smith     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
57111525c0dSBarry Smith                                     "<center><h2> <a href=\"http://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
572df62c222SBarry 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"
573df62c222SBarry Smith                                     "%s",version,petscconfigureoptions,appline);
57443da4ab2SBarry Smith     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
57511525c0dSBarry Smith     ierr = PetscFree(intro);CHKERRQ(ierr);
57611525c0dSBarry Smith     ierr = PetscFree(appline);CHKERRQ(ierr);
577ffbd1cfbSBarry Smith     if (selectport) {
578aa573868SBarry Smith       PetscBool silent;
5797d812c46SBarry Smith 
5807d812c46SBarry Smith       ierr = SAWs_Initialize();
5817d812c46SBarry Smith       /* another process may have grabbed the port so keep trying */
5827d812c46SBarry Smith       while (ierr) {
5837d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
5847d812c46SBarry Smith         PetscStackCallSAWs(SAWs_Set_Port,(port));
5857d812c46SBarry Smith         ierr = SAWs_Initialize();
5867d812c46SBarry Smith       }
5877d812c46SBarry Smith 
588aa573868SBarry Smith       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
589aa573868SBarry Smith       if (!silent) {
590ffbd1cfbSBarry Smith         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
591ffbd1cfbSBarry Smith         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
592ffbd1cfbSBarry Smith       }
5937d812c46SBarry Smith     } else {
5947d812c46SBarry Smith       PetscStackCallSAWs(SAWs_Initialize,());
595aa573868SBarry Smith     }
5960af79b04SBarry Smith     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
5970af79b04SBarry Smith                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
5980af79b04SBarry Smith                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
5990af79b04SBarry Smith                                   "  Institution = {Argonne National Laboratory},\n"
6000af79b04SBarry Smith                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
60111525c0dSBarry Smith   }
60211525c0dSBarry Smith   PetscFunctionReturn(0);
60311525c0dSBarry Smith }
60411525c0dSBarry Smith #endif
60511525c0dSBarry Smith 
606e5c89e4eSSatish Balay /*@C
607e5c89e4eSSatish Balay    PetscInitialize - Initializes the PETSc database and MPI.
608e5c89e4eSSatish Balay    PetscInitialize() calls MPI_Init() if that has yet to be called,
609e5c89e4eSSatish Balay    so this routine should always be called near the beginning of
610e5c89e4eSSatish Balay    your program -- usually the very first line!
611e5c89e4eSSatish Balay 
612e5c89e4eSSatish Balay    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
613e5c89e4eSSatish Balay 
614e5c89e4eSSatish Balay    Input Parameters:
615e5c89e4eSSatish Balay +  argc - count of number of command line arguments
616e5c89e4eSSatish Balay .  args - the command line arguments
6170298fd71SBarry Smith .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
618fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
6190298fd71SBarry Smith -  help - [optional] Help message to print, use NULL for no message
620e5c89e4eSSatish Balay 
62105827820SBarry Smith    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
62205827820SBarry Smith    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
62305827820SBarry Smith    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
62405827820SBarry Smith    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
62505827820SBarry Smith    if different subcommunicators of the job are doing different things with PETSc.
626e5c89e4eSSatish Balay 
627e5c89e4eSSatish Balay    Options Database Keys:
628e5c89e4eSSatish Balay +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
629e5c89e4eSSatish Balay .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
630e5c89e4eSSatish Balay .  -on_error_emacs <machinename> causes emacsclient to jump to error file
631b52f573bSBarry Smith .  -on_error_abort calls abort() when error detected (no traceback)
632e8fb0fc0SBarry Smith .  -on_error_mpiabort calls MPI_abort() when error detected
633e8fb0fc0SBarry Smith .  -error_output_stderr prints error messages to stderr instead of the default stdout
634e8fb0fc0SBarry Smith .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
635e5c89e4eSSatish Balay .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
636e5c89e4eSSatish Balay .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
637e5c89e4eSSatish Balay .  -stop_for_debugger - Print message on how to attach debugger manually to
638e5c89e4eSSatish Balay                         process and wait (-debugger_pause) seconds for attachment
6392fb0ec9aSBarry Smith .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
640e5c89e4eSSatish Balay .  -malloc no - Indicates not to use error-checking malloc
6412fb0ec9aSBarry Smith .  -malloc_debug - check for memory corruption at EVERY malloc or free
642aee23540SBarry Smith .  -malloc_dump - prints a list of all unfreed memory at the end of the run
643dc92acbaSJed Brown .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
644e5c89e4eSSatish Balay .  -fp_trap - Stops on floating point exceptions (Note that on the
645e5c89e4eSSatish Balay               IBM RS6000 this slows code by at least a factor of 10.)
646e5c89e4eSSatish Balay .  -no_signal_handler - Indicates not to trap error signals
647e5c89e4eSSatish Balay .  -shared_tmp - indicates /tmp directory is shared by all processors
648e5c89e4eSSatish Balay .  -not_shared_tmp - each processor has own /tmp
649e5c89e4eSSatish Balay .  -tmp - alternative name of /tmp directory
650e5c89e4eSSatish Balay .  -get_total_flops - returns total flops done by all processors
6510841954dSBarry Smith -  -memory_view - Print memory usage at end of run
652e5c89e4eSSatish Balay 
653e5c89e4eSSatish Balay    Options Database Keys for Profiling:
654a7f22e61SSatish Balay    See Users-Manual: ch_profiling for details.
655495fc317SBarry Smith +  -info <optional filename> - Prints verbose information to the screen
656495fc317SBarry Smith .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
657495fc317SBarry Smith .  -log_sync - Log the synchronization in scatters, inner products and norms
658495fc317SBarry Smith .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
659e5c89e4eSSatish Balay         hangs without running in the debugger).  See PetscLogTraceBegin().
6609a9a5d4cSBarry Smith .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
6619a9a5d4cSBarry Smith .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
662495fc317SBarry Smith         summary is written to the file.  See PetscLogView().
6639a9a5d4cSBarry Smith .  -log_exclude: <vec,mat,pc.ksp,snes> - excludes subset of object classes from logging
664495fc317SBarry Smith .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
665495fc317SBarry Smith .  -log [filename] - Logs basic profiline information  See PetscLogDump().
666495fc317SBarry Smith -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
667495fc317SBarry Smith 
668*609bdbeeSBarry Smith     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
669e5c89e4eSSatish Balay 
670ffbd1cfbSBarry Smith    Options Database Keys for SAWs:
671ffbd1cfbSBarry Smith +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
672ffbd1cfbSBarry 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
673ffbd1cfbSBarry Smith                             this is useful when you are running many jobs that utilize SAWs at the same time
674ffbd1cfbSBarry Smith .  -saws_log <filename> - save a log of all SAWs communication
675ffbd1cfbSBarry Smith .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
676ffbd1cfbSBarry Smith -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
677ffbd1cfbSBarry Smith 
678e5c89e4eSSatish Balay    Environmental Variables:
679e5c89e4eSSatish Balay +   PETSC_TMP - alternative tmp directory
680e5c89e4eSSatish Balay .   PETSC_SHARED_TMP - tmp is shared by all processes
681e5c89e4eSSatish Balay .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
682e5c89e4eSSatish Balay .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
683e5c89e4eSSatish Balay -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
684e5c89e4eSSatish Balay 
685e5c89e4eSSatish Balay 
686e5c89e4eSSatish Balay    Level: beginner
687e5c89e4eSSatish Balay 
688e5c89e4eSSatish Balay    Notes:
689e5c89e4eSSatish Balay    If for some reason you must call MPI_Init() separately, call
690e5c89e4eSSatish Balay    it before PetscInitialize().
691e5c89e4eSSatish Balay 
692e5c89e4eSSatish Balay    Fortran Version:
693e5c89e4eSSatish Balay    In Fortran this routine has the format
694e5c89e4eSSatish Balay $       call PetscInitialize(file,ierr)
695e5c89e4eSSatish Balay 
696e5c89e4eSSatish Balay +   ierr - error return code
6970eb4c9c0SBarry Smith -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
698fc2bca9aSBarry Smith           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
699e5c89e4eSSatish Balay 
700e5c89e4eSSatish Balay    Important Fortran Note:
7010eb4c9c0SBarry Smith    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
7020298fd71SBarry Smith    null character string; you CANNOT just use NULL as
703a7f22e61SSatish Balay    in the C version. See Users-Manual: ch_fortran for details.
704e5c89e4eSSatish Balay 
70501cb0274SBarry Smith    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
70601cb0274SBarry Smith    calling PetscInitialize().
707e5c89e4eSSatish Balay 
708e5c89e4eSSatish Balay    Concepts: initializing PETSc
709e5c89e4eSSatish Balay 
71001cb0274SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
711e5c89e4eSSatish Balay 
712e5c89e4eSSatish Balay @*/
7137087cfbeSBarry Smith PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
714e5c89e4eSSatish Balay {
715e5c89e4eSSatish Balay   PetscErrorCode ierr;
7164bb5149bSJed Brown   PetscMPIInt    flag, size;
717ace3abfcSBarry Smith   PetscBool      flg;
718e5c89e4eSSatish Balay   char           hostname[256];
71982f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
72082f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
72182f73ecaSAlejandro Lamas Daviña #endif
722e5c89e4eSSatish Balay 
723e5c89e4eSSatish Balay   PetscFunctionBegin;
724e5c89e4eSSatish Balay   if (PetscInitializeCalled) PetscFunctionReturn(0);
725e5c89e4eSSatish Balay 
726ae9b4142SLisandro Dalcin   /* these must be initialized in a routine, not as a constant declaration*/
727d89683f4Sbcordonn   PETSC_STDOUT = stdout;
728ae9b4142SLisandro Dalcin   PETSC_STDERR = stderr;
729e5c89e4eSSatish Balay 
7300c30907bSSatish Balay   /* on Windows - set printf to default to printing 2 digit exponents */
7310c30907bSSatish Balay #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
7320c30907bSSatish Balay   _set_output_format(_TWO_DIGIT_EXPONENT);
7330c30907bSSatish Balay #endif
7340c30907bSSatish Balay 
7354416b707SBarry Smith   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
736e5c89e4eSSatish Balay 
737e5c89e4eSSatish Balay   /*
738e5c89e4eSSatish Balay      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
739e5c89e4eSSatish Balay      it that it sets args[0] on all processors to be args[0] on the first processor.
740e5c89e4eSSatish Balay   */
741e5c89e4eSSatish Balay   if (argc && *argc) {
742e5c89e4eSSatish Balay     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
743e5c89e4eSSatish Balay   } else {
744e5c89e4eSSatish Balay     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
745e5c89e4eSSatish Balay   }
746e5c89e4eSSatish Balay 
747e5c89e4eSSatish Balay   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
748e5c89e4eSSatish Balay   if (!flag) {
749e32f2f54SBarry 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");
7505e765c61SJed Brown #if defined(PETSC_HAVE_MPI_INIT_THREAD)
7515e765c61SJed Brown     {
7525e765c61SJed Brown       PetscMPIInt provided;
7535e765c61SJed Brown       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
7545e765c61SJed Brown     }
7555e765c61SJed Brown #else
756e5c89e4eSSatish Balay     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
7575e765c61SJed Brown #endif
758e5c89e4eSSatish Balay     PetscBeganMPI = PETSC_TRUE;
759e5c89e4eSSatish Balay   }
760e5c89e4eSSatish Balay   if (argc && args) {
761e5c89e4eSSatish Balay     PetscGlobalArgc = *argc;
762e5c89e4eSSatish Balay     PetscGlobalArgs = *args;
763e5c89e4eSSatish Balay   }
764e5c89e4eSSatish Balay   PetscFinalizeCalled = PETSC_FALSE;
7655ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
7665ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
7675ad9ad5bSBarry Smith   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
768ef19f930SBarry Smith   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
769e5c89e4eSSatish Balay 
770a297a907SKarl Rupp   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
771d54338ecSKarl Rupp   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
772e5c89e4eSSatish Balay 
773e5c89e4eSSatish Balay   /* Done after init due to a bug in MPICH-GM? */
774e5c89e4eSSatish Balay   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
775e5c89e4eSSatish Balay 
776e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
777e5c89e4eSSatish Balay   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
778e5c89e4eSSatish Balay 
7798ad47952SJed Brown   MPIU_BOOL = MPI_INT;
7808ad47952SJed Brown   MPIU_ENUM = MPI_INT;
7818ad47952SJed Brown 
782e5c89e4eSSatish Balay   /*
783e5c89e4eSSatish Balay      Initialized the global complex variable; this is because with
784e5c89e4eSSatish Balay      shared libraries the constructors for global variables
785e5c89e4eSSatish Balay      are not called; at least on IRIX.
786e5c89e4eSSatish Balay   */
787886cfec0SSatish Balay #if defined(PETSC_HAVE_COMPLEX)
788e5c89e4eSSatish Balay   {
789a24ee22aSSatish Balay #if defined(PETSC_CLANGUAGE_CXX)
79050f81f78SJed Brown     PetscComplex ic(0.0,1.0);
791e5c89e4eSSatish Balay     PETSC_i = ic;
792a24ee22aSSatish Balay #elif defined(PETSC_CLANGUAGE_C)
79350f81f78SJed Brown     PETSC_i = _Complex_I;
794b7940d39SSatish Balay #endif
795762437b8SSatish Balay   }
796762437b8SSatish Balay 
7972c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
798e69cd0e6SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
799500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
800500d8756SSatish Balay   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
801500d8756SSatish Balay   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
8022c876bd9SBarry Smith #endif
803886cfec0SSatish Balay #endif /* PETSC_HAVE_COMPLEX */
804e5c89e4eSSatish Balay 
805e5c89e4eSSatish Balay   /*
806e5c89e4eSSatish Balay      Create the PETSc MPI reduction operator that sums of the first
807e5c89e4eSSatish Balay      half of the entries and maxes the second half.
808e5c89e4eSSatish Balay   */
809367daffbSBarry Smith   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
810e5c89e4eSSatish Balay 
811ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
812c90a1750SBarry Smith   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
813c90a1750SBarry Smith   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
8147c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
8158c764dc5SJose Roman   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
8168c764dc5SJose Roman   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
8178c764dc5SJose Roman #endif
818d9822059SBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
819d9822059SBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
820570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
821570b7f6dSBarry Smith   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
822570b7f6dSBarry Smith   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
823570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
824570b7f6dSBarry Smith   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
825c90a1750SBarry Smith #endif
826c90a1750SBarry Smith 
827570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
828cca4cb22SSatish Balay   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
829cca4cb22SSatish Balay #endif
830cca4cb22SSatish Balay 
831e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
832e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
833e5c89e4eSSatish Balay 
83444041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
835e5c89e4eSSatish Balay   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
836e5c89e4eSSatish Balay   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
83744041f26SJed Brown #endif
838e5c89e4eSSatish Balay 
839ec957eceSBarry Smith 
840e5c89e4eSSatish Balay   /*
841480cf27aSJed Brown      Attributes to be set on PETSc communicators
842480cf27aSJed Brown   */
843480cf27aSJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
844da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
845da3039f7SJed Brown   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
846480cf27aSJed Brown 
847480cf27aSJed Brown   /*
848e8fb0fc0SBarry Smith      Build the options database
849e5c89e4eSSatish Balay   */
850c5929fdfSBarry Smith   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
851e5c89e4eSSatish Balay 
8526dc8fec2Sbcordonn 
853e5c89e4eSSatish Balay   /*
854e5c89e4eSSatish Balay      Print main application help message
855e5c89e4eSSatish Balay   */
856c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-help",&flg);CHKERRQ(ierr);
857e5c89e4eSSatish Balay   if (help && flg) {
858e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
859e5c89e4eSSatish Balay   }
860e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
861e5c89e4eSSatish Balay 
862d45a07a7SBarry Smith   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
863d45a07a7SBarry Smith 
864e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
86511525c0dSBarry Smith   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
866f4202a44SBarry Smith #endif
867f4202a44SBarry Smith 
868896238b9SBarry Smith   /* Creates the logging data structures; this is enabled even if logging is not turned on */
869a9f03627SSatish Balay #if defined(PETSC_USE_LOG)
870896238b9SBarry Smith   ierr = PetscLogInitialize();CHKERRQ(ierr);
871a9f03627SSatish Balay #endif
872e5c89e4eSSatish Balay 
873e5c89e4eSSatish Balay   /*
874e5c89e4eSSatish Balay      Load the dynamic libraries (on machines that support them), this registers all
875e5c89e4eSSatish Balay      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
876e5c89e4eSSatish Balay   */
877e5c89e4eSSatish Balay   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
878e5c89e4eSSatish Balay 
879e5c89e4eSSatish Balay   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
880ae15b995SBarry Smith   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
881e5c89e4eSSatish Balay   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
882ae15b995SBarry Smith   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
883e5c89e4eSSatish Balay 
884e5c89e4eSSatish Balay   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
885ef6c6fedSBoyana Norris   /* Check the options database for options related to the options database itself */
886c5929fdfSBarry Smith   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
887ef6c6fedSBoyana Norris 
888951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
889e39fd77fSBarry Smith   /*
890e39fd77fSBarry Smith       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
891e39fd77fSBarry Smith 
892e39fd77fSBarry Smith       Currently not used because it is not supported by MPICH.
893e39fd77fSBarry Smith   */
894e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
8950298fd71SBarry Smith   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
896e39fd77fSBarry Smith #endif
897951e3c8eSBarry Smith #endif
898e39fd77fSBarry Smith 
89935d88935SVictor Minden #if defined(PETSC_HAVE_CUDA)
90020e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
901c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
90220e2c332SMatthew G. Knepley   if (flg) {
9034bb5149bSJed Brown     PetscMPIInt p;
904663ba86aSMatthew G Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
90582f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
90682f73ecaSAlejandro Lamas Daviña         cberr = cublasCreate(&cublasv2handle);CHKERRCUBLAS(cberr);
90782f73ecaSAlejandro Lamas Daviña       }
908663ba86aSMatthew G Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
909663ba86aSMatthew G Knepley     }
9104bb5149bSJed Brown   }
9113e39abd9SVictor Minden #endif
91292e62aa6SBarry Smith 
913c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
9149ac80d5eSLisandro Dalcin   if (flg) {
9159ac80d5eSLisandro Dalcin     PetscInitializeCalled = PETSC_TRUE;
9160298fd71SBarry Smith     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
9179ac80d5eSLisandro Dalcin   }
9189ac80d5eSLisandro Dalcin 
91941c0b4b3SShri Abhyankar   /*
92041c0b4b3SShri Abhyankar       Setup building of stack frames for all function calls
92141c0b4b3SShri Abhyankar   */
922ef19f930SBarry Smith #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
923e1167bb9SShri Abhyankar   ierr = PetscStackCreate();CHKERRQ(ierr);
924e1167bb9SShri Abhyankar #endif
925e1167bb9SShri Abhyankar 
9262d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
9272d53ad75SBarry Smith   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
9282d53ad75SBarry Smith #endif
9292d53ad75SBarry Smith 
930dff31646SBarry Smith 
931301d30feSBarry Smith   /*
932301d30feSBarry Smith       Once we are completedly initialized then we can set this variables
933301d30feSBarry Smith   */
934301d30feSBarry Smith   PetscInitializeCalled = PETSC_TRUE;
935301d30feSBarry Smith   PetscFunctionReturn(0);
936e5c89e4eSSatish Balay }
937e5c89e4eSSatish Balay 
9384097062eSBarry Smith #if defined(PETSC_USE_LOG)
9392eff7a51SBarry Smith extern PetscObject *PetscObjects;
9402eff7a51SBarry Smith extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
94105df10baSBarry Smith extern PetscBool   PetscObjectsLog;
9424097062eSBarry Smith #endif
943e5c89e4eSSatish Balay 
944e5c89e4eSSatish Balay /*@C
945e5c89e4eSSatish Balay    PetscFinalize - Checks for options to be called at the conclusion
946e5c89e4eSSatish Balay    of the program. MPI_Finalize() is called only if the user had not
947e5c89e4eSSatish Balay    called MPI_Init() before calling PetscInitialize().
948e5c89e4eSSatish Balay 
949e5c89e4eSSatish Balay    Collective on PETSC_COMM_WORLD
950e5c89e4eSSatish Balay 
951e5c89e4eSSatish Balay    Options Database Keys:
95288c29154SBarry Smith +  -options_table - Calls PetscOptionsView()
953e5c89e4eSSatish Balay .  -options_left - Prints unused options that remain in the database
9547eb1d149SBarry 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
955e5c89e4eSSatish Balay .  -mpidump - Calls PetscMPIDump()
956e5c89e4eSSatish Balay .  -malloc_dump - Calls PetscMallocDump()
957e5c89e4eSSatish Balay .  -malloc_info - Prints total memory usage
958e5c89e4eSSatish Balay -  -malloc_log - Prints summary of memory usage
959e5c89e4eSSatish Balay 
960e5c89e4eSSatish Balay    Level: beginner
961e5c89e4eSSatish Balay 
962e5c89e4eSSatish Balay    Note:
963e5c89e4eSSatish Balay    See PetscInitialize() for more general runtime options.
964e5c89e4eSSatish Balay 
96588c29154SBarry Smith .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
966e5c89e4eSSatish Balay @*/
9677087cfbeSBarry Smith PetscErrorCode  PetscFinalize(void)
968e5c89e4eSSatish Balay {
969e5c89e4eSSatish Balay   PetscErrorCode ierr;
9704bb5149bSJed Brown   PetscMPIInt    rank;
971a8d2bbe5SBarry Smith   PetscInt       nopt;
9722bf49c77SBarry Smith   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
973dff31646SBarry Smith   PetscBool      flg;
97410463e74SBarry Smith #if defined(PETSC_USE_LOG)
97510463e74SBarry Smith   char           mname[PETSC_MAX_PATH_LEN];
97610463e74SBarry Smith #endif
97782f73ecaSAlejandro Lamas Daviña #if defined(PETSC_HAVE_CUDA)
97882f73ecaSAlejandro Lamas Daviña   cublasStatus_t cberr;
97982f73ecaSAlejandro Lamas Daviña #endif
980e5c89e4eSSatish Balay 
981e5c89e4eSSatish Balay   PetscFunctionBegin;
982e5c89e4eSSatish Balay   if (!PetscInitializeCalled) {
9834b09e917SBarry Smith     printf("PetscInitialize() must be called before PetscFinalize()\n");
9844b09e917SBarry Smith     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
985e5c89e4eSSatish Balay   }
9860298fd71SBarry Smith   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
987b022a5c1SBarry Smith 
9881f817a21SBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
9891f817a21SBarry Smith 
990c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
991dff31646SBarry Smith   if (flg) {
9921f817a21SBarry Smith     char  *cits, filename[PETSC_MAX_PATH_LEN];
9931f817a21SBarry Smith     FILE  *fd = PETSC_STDOUT;
9941f817a21SBarry Smith 
995c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
9961f817a21SBarry Smith     if (filename[0]) {
9971f817a21SBarry Smith       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
9981f817a21SBarry Smith     }
999dff31646SBarry Smith     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1000dff31646SBarry Smith     cits[0] = 0;
1001dff31646SBarry Smith     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
10021f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
10031f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10041f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
10051f817a21SBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
10061f817a21SBarry Smith     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1007dff31646SBarry Smith     ierr = PetscFree(cits);CHKERRQ(ierr);
1008dff31646SBarry Smith   }
1009dff31646SBarry Smith   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1010dff31646SBarry Smith 
1011c2a97968SBarry Smith #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
101204102261SBarry Smith   /* TextBelt is run for testing purposes only, please do not use this feature often */
101304102261SBarry Smith   {
101404102261SBarry Smith     PetscInt nmax = 2;
101504102261SBarry Smith     char     **buffs;
101604102261SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1017c5929fdfSBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
101804102261SBarry Smith     if (flg1) {
101904102261SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
102004102261SBarry Smith       if (nmax == 1) {
102104102261SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
102204102261SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
102304102261SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
102404102261SBarry Smith       }
102504102261SBarry Smith       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
102604102261SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
102704102261SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
102804102261SBarry Smith     }
102904102261SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
103004102261SBarry Smith   }
1031763ec7b1SBarry Smith   {
1032763ec7b1SBarry Smith     PetscInt nmax = 2;
1033763ec7b1SBarry Smith     char     **buffs;
1034763ec7b1SBarry Smith     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1035763ec7b1SBarry Smith     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1036763ec7b1SBarry Smith     if (flg1) {
1037763ec7b1SBarry Smith       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1038763ec7b1SBarry Smith       if (nmax == 1) {
1039763ec7b1SBarry Smith         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1040763ec7b1SBarry Smith         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1041763ec7b1SBarry Smith         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1042763ec7b1SBarry Smith       }
1043763ec7b1SBarry Smith       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1044763ec7b1SBarry Smith       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1045763ec7b1SBarry Smith       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1046763ec7b1SBarry Smith     }
1047763ec7b1SBarry Smith     ierr = PetscFree(buffs);CHKERRQ(ierr);
1048763ec7b1SBarry Smith   }
104904102261SBarry Smith #endif
105067234432SDmitry Karpeev   /*
105167234432SDmitry Karpeev     It should be safe to cancel the options monitors, since we don't expect to be setting options
105267234432SDmitry Karpeev     here (at least that are worth monitoring).  Monitors ought to be released so that they release
105367234432SDmitry Karpeev     whatever memory was allocated there before -malloc_dump reports unfreed memory.
105467234432SDmitry Karpeev   */
105567234432SDmitry Karpeev   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
105604102261SBarry Smith 
10572d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
10582d53ad75SBarry Smith   ierr = PetscFPTDestroy();CHKERRQ(ierr);
10592d53ad75SBarry Smith #endif
10602d53ad75SBarry Smith 
10612d53ad75SBarry Smith 
1062e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1063dff31646SBarry Smith   flg = PETSC_FALSE;
1064c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1065d5649816SBarry Smith   if (flg) {
1066e04113cfSBarry Smith     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1067d5649816SBarry Smith   }
1068d5649816SBarry Smith #endif
1069d5649816SBarry Smith 
1070681455b2SBarry Smith #if defined(PETSC_HAVE_X)
1071681455b2SBarry Smith   flg1 = PETSC_FALSE;
1072c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1073681455b2SBarry Smith   if (flg1) {
1074681455b2SBarry Smith     /*  this is a crude hack, but better than nothing */
1075681455b2SBarry Smith     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1076681455b2SBarry Smith   }
1077681455b2SBarry Smith #endif
1078681455b2SBarry Smith 
107967584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
1080c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1081e5c89e4eSSatish Balay   if (!flg2) {
108290d69ab7SBarry Smith     flg2 = PETSC_FALSE;
1083c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1084e5c89e4eSSatish Balay   }
1085e5c89e4eSSatish Balay   if (flg2) {
10860841954dSBarry Smith     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1087e5c89e4eSSatish Balay   }
108867584ceeSBarry Smith #endif
1089e5c89e4eSSatish Balay 
1090e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
109190d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1092c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1093e5c89e4eSSatish Balay   if (flg1) {
1094e5c89e4eSSatish Balay     PetscLogDouble flops = 0;
1095205a32c2SJed Brown     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1096e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1097e5c89e4eSSatish Balay   }
1098e5c89e4eSSatish Balay #endif
1099e5c89e4eSSatish Balay 
1100e5c89e4eSSatish Balay 
1101e5c89e4eSSatish Balay #if defined(PETSC_USE_LOG)
1102e5c89e4eSSatish Balay #if defined(PETSC_HAVE_MPE)
1103e5c89e4eSSatish Balay   mname[0] = 0;
1104a297a907SKarl Rupp 
1105c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1106e5c89e4eSSatish Balay   if (flg1) {
1107e5c89e4eSSatish Balay     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1108e5c89e4eSSatish Balay     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1109e5c89e4eSSatish Balay   }
1110e5c89e4eSSatish Balay #endif
1111e5c89e4eSSatish Balay   mname[0] = 0;
1112a297a907SKarl Rupp 
1113f14045dbSBarry Smith   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1114c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1115e5c89e4eSSatish Balay   if (flg1) {
111691eabc43SBarry Smith     PetscViewer viewer;
111720a8bfc3SBarry Smith     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
111891eabc43SBarry Smith     if (mname[0]) {
111991eabc43SBarry Smith       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
112091eabc43SBarry Smith       ierr = PetscLogView(viewer);CHKERRQ(ierr);
11216bf464f9SBarry Smith       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
112233f85c2fSBarry Smith     } else {
112333f85c2fSBarry Smith       viewer = PETSC_VIEWER_STDOUT_WORLD;
11249a9a5d4cSBarry Smith       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
112533f85c2fSBarry Smith       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
11269a9a5d4cSBarry Smith       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
112733f85c2fSBarry Smith     }
1128e5c89e4eSSatish Balay   }
1129e5c89e4eSSatish Balay   mname[0] = 0;
1130a297a907SKarl Rupp 
1131c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1132c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1133e5c89e4eSSatish Balay   if (flg1 || flg2) {
1134e5c89e4eSSatish Balay     if (mname[0]) PetscLogDump(mname);
1135e5c89e4eSSatish Balay     else          PetscLogDump(0);
1136e5c89e4eSSatish Balay   }
1137e5c89e4eSSatish Balay #endif
113810463e74SBarry Smith 
1139b58ca069SBarry Smith   /*
1140b58ca069SBarry Smith      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1141b58ca069SBarry Smith   */
1142b58ca069SBarry Smith   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1143b58ca069SBarry Smith 
114433f85c2fSBarry Smith   ierr = PetscStackDestroy();CHKERRQ(ierr);
114510463e74SBarry Smith 
114690d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1147c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1148e5c89e4eSSatish Balay   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
114990d69ab7SBarry Smith   flg1 = PETSC_FALSE;
1150c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1151e5c89e4eSSatish Balay   if (flg1) {
1152e5c89e4eSSatish Balay     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1153e5c89e4eSSatish Balay   }
115490d69ab7SBarry Smith   flg1 = PETSC_FALSE;
115590d69ab7SBarry Smith   flg2 = PETSC_FALSE;
11568bb29257SSatish Balay   /* preemptive call to avoid listing this option in options table as unused */
1157c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1158c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1159c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1160e4c476e2SSatish Balay 
1161e5c89e4eSSatish Balay   if (flg2) {
1162be56827dSJed Brown     PetscViewer viewer;
116302ba9f54SBarry Smith     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
116402ba9f54SBarry Smith     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1165c5929fdfSBarry Smith     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1166be56827dSJed Brown     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1167e5c89e4eSSatish Balay   }
1168e5c89e4eSSatish Balay 
1169e5c89e4eSSatish Balay   /* to prevent PETSc -options_left from warning */
1170c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1171c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1172e5c89e4eSSatish Balay 
117333fc4174SSatish Balay   flg3 = PETSC_FALSE; /* default value is required */
1174c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1175c5929fdfSBarry Smith   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1176e5c89e4eSSatish Balay   if (flg3) {
1177e5c89e4eSSatish Balay     if (!flg2) { /* have not yet printed the options */
1178be56827dSJed Brown       PetscViewer viewer;
117902ba9f54SBarry Smith       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
118002ba9f54SBarry Smith       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1181c5929fdfSBarry Smith       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1182be56827dSJed Brown       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1183e5c89e4eSSatish Balay     }
1184e5c89e4eSSatish Balay     if (!nopt) {
1185e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1186e5c89e4eSSatish Balay     } else if (nopt == 1) {
1187e5c89e4eSSatish Balay       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1188e5c89e4eSSatish Balay     } else {
11897582186dSLisandro Dalcin       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1190e5c89e4eSSatish Balay     }
1191df12ba86SBarry Smith   }
1192e5c89e4eSSatish Balay #if defined(PETSC_USE_DEBUG)
1193da8b8a77SBarry Smith   if (nopt && !flg3 && !flg1) {
1194e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1195e5c89e4eSSatish Balay     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1196c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1197e5c89e4eSSatish Balay   } else if (nopt && flg3) {
1198e5c89e4eSSatish Balay #else
1199e5c89e4eSSatish Balay   if (nopt && flg3) {
1200e5c89e4eSSatish Balay #endif
1201c5929fdfSBarry Smith     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1202e5c89e4eSSatish Balay   }
1203e5c89e4eSSatish Balay 
1204e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1205d45a07a7SBarry Smith   if (!PetscGlobalRank) {
120687f587eeSBarry Smith     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
120716ad0300SBarry Smith     PetscStackCallSAWs(SAWs_Finalize,());
1208d45a07a7SBarry Smith   }
1209ec957eceSBarry Smith #endif
1210ec957eceSBarry Smith 
12114097062eSBarry Smith #if defined(PETSC_USE_LOG)
121210463e74SBarry Smith   /*
1213dbc8283eSBarry Smith        List all objects the user may have forgot to free
12142eff7a51SBarry Smith   */
121505df10baSBarry Smith   if (PetscObjectsLog) {
1216c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1217a64a8e02SBarry Smith     if (flg1) {
1218a64a8e02SBarry Smith       MPI_Comm local_comm;
12197eb1d149SBarry Smith       char     string[64];
1220a64a8e02SBarry Smith 
1221c5929fdfSBarry Smith       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1222a64a8e02SBarry Smith       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1223a64a8e02SBarry Smith       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
12247eb1d149SBarry Smith       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1225a64a8e02SBarry Smith       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1226a64a8e02SBarry Smith       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
12270a1571b3SBarry Smith     }
122805df10baSBarry Smith   }
12294097062eSBarry Smith #endif
12304097062eSBarry Smith 
12314097062eSBarry Smith #if defined(PETSC_USE_LOG)
1232dbc8283eSBarry Smith   PetscObjectsCounts    = 0;
1233dbc8283eSBarry Smith   PetscObjectsMaxCounts = 0;
1234a297a907SKarl Rupp   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
12354097062eSBarry Smith #endif
12362eff7a51SBarry Smith 
123733f85c2fSBarry Smith   /*
123833f85c2fSBarry Smith      Destroy any packages that registered a finalize
123933f85c2fSBarry Smith   */
124033f85c2fSBarry Smith   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
124133f85c2fSBarry Smith 
1242101409b8SToby Isaac #if defined(PETSC_USE_LOG)
1243101409b8SToby Isaac   ierr = PetscLogDestroy();CHKERRQ(ierr);
1244101409b8SToby Isaac #endif
1245101409b8SToby Isaac 
124633f85c2fSBarry Smith   /*
124748dd1dffSBarry Smith      Print PetscFunctionLists that have not been properly freed
124848dd1dffSBarry Smith 
124937e93019SBarry Smith   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
125048dd1dffSBarry Smith   */
125137e93019SBarry Smith 
12524028d114SSatish Balay   if (petsc_history) {
1253f3dea69dSBarry Smith     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1254e5c89e4eSSatish Balay     petsc_history = 0;
1255e5c89e4eSSatish Balay   }
12569de0f6ecSBarry Smith   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1257e5c89e4eSSatish Balay 
12580298fd71SBarry Smith   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1259e5c89e4eSSatish Balay 
126067584ceeSBarry Smith #if !defined(PETSC_HAVE_THREADSAFETY)
12618bb29257SSatish Balay   {
1262e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
1263e5c89e4eSSatish Balay     FILE *fd;
1264ed9cf6e9SBarry Smith     int  err;
1265e5c89e4eSSatish Balay 
1266e5c89e4eSSatish Balay     fname[0] = 0;
1267a297a907SKarl Rupp 
1268c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1269dc92acbaSJed Brown     flg2 = PETSC_FALSE;
1270c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
12718bf1f09cSShri Abhyankar #if defined(PETSC_USE_DEBUG)
1272dc92acbaSJed Brown     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1273dc92acbaSJed Brown #else
1274dc92acbaSJed Brown     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1275dc92acbaSJed Brown #endif
1276e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1277e5c89e4eSSatish Balay       char sname[PETSC_MAX_PATH_LEN];
1278e5c89e4eSSatish Balay 
1279e5c89e4eSSatish Balay       sprintf(sname,"%s_%d",fname,rank);
1280e32f2f54SBarry Smith       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1281e5c89e4eSSatish Balay       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1282ed9cf6e9SBarry Smith       err  = fclose(fd);
1283e32f2f54SBarry Smith       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1284dc92acbaSJed Brown     } else if (flg1 || flg2) {
1285e5c89e4eSSatish Balay       MPI_Comm local_comm;
1286e5c89e4eSSatish Balay 
1287e5c89e4eSSatish Balay       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1288e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1289e5c89e4eSSatish Balay       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1290e5c89e4eSSatish Balay       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1291e5c89e4eSSatish Balay       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1292e5c89e4eSSatish Balay     }
1293e5c89e4eSSatish Balay   }
1294a64a8e02SBarry Smith 
12958bb29257SSatish Balay   {
1296e5c89e4eSSatish Balay     char fname[PETSC_MAX_PATH_LEN];
12970298fd71SBarry Smith     FILE *fd = NULL;
1298e5c89e4eSSatish Balay 
1299e5c89e4eSSatish Balay     fname[0] = 0;
1300a297a907SKarl Rupp 
1301c5929fdfSBarry Smith     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1302c5929fdfSBarry Smith     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1303e5c89e4eSSatish Balay     if (flg1 && fname[0]) {
1304ed9cf6e9SBarry Smith       int err;
1305e5c89e4eSSatish Balay 
1306574034a9SJed Brown       if (!rank) {
1307574034a9SJed Brown         fd = fopen(fname,"w");
1308574034a9SJed Brown         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1309574034a9SJed Brown       }
1310e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1311574034a9SJed Brown       if (fd) {
1312ed9cf6e9SBarry Smith         err = fclose(fd);
1313e32f2f54SBarry Smith         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1314574034a9SJed Brown       }
1315574034a9SJed Brown     } else if (flg1 || flg2) {
1316e5c89e4eSSatish Balay       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1317e5c89e4eSSatish Balay     }
1318e5c89e4eSSatish Balay   }
131967584ceeSBarry Smith #endif
132020e2c332SMatthew G. Knepley 
13215486ca60SMatthew G. Knepley   /*
13225486ca60SMatthew G. Knepley      Close any open dynamic libraries
13235486ca60SMatthew G. Knepley   */
13245486ca60SMatthew G. Knepley   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
13255486ca60SMatthew G. Knepley 
132620e2c332SMatthew G. Knepley #if defined(PETSC_HAVE_CUDA)
132720e2c332SMatthew G. Knepley   flg  = PETSC_TRUE;
1328c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
132920e2c332SMatthew G. Knepley   if (flg) {
133020e2c332SMatthew G. Knepley     PetscInt p;
133120e2c332SMatthew G. Knepley     for (p = 0; p < PetscGlobalSize; ++p) {
133282f73ecaSAlejandro Lamas Daviña       if (p == PetscGlobalRank) {
133382f73ecaSAlejandro Lamas Daviña         if (cublasv2handle) {
133482f73ecaSAlejandro Lamas Daviña           cberr = cublasDestroy(cublasv2handle);CHKERRCUBLAS(cberr);
133582f73ecaSAlejandro Lamas Daviña         }
133682f73ecaSAlejandro Lamas Daviña       }
133720e2c332SMatthew G. Knepley       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
133820e2c332SMatthew G. Knepley     }
133920e2c332SMatthew G. Knepley   }
134020e2c332SMatthew G. Knepley #endif
134120e2c332SMatthew G. Knepley 
1342e5c89e4eSSatish Balay   /* Can be destroyed only after all the options are used */
13434416b707SBarry Smith   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1344e5c89e4eSSatish Balay 
1345e5c89e4eSSatish Balay   PetscGlobalArgc = 0;
1346e5c89e4eSSatish Balay   PetscGlobalArgs = 0;
1347e5c89e4eSSatish Balay 
1348ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
1349c90a1750SBarry Smith   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
13507c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13518c764dc5SJose Roman   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
13528c764dc5SJose Roman #endif
1353d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1354d9822059SBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1355570b7f6dSBarry Smith #elif defined(PETSC_USE_REAL___FP16)
1356570b7f6dSBarry Smith   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1357570b7f6dSBarry Smith   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1358570b7f6dSBarry Smith   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1359c90a1750SBarry Smith #endif
1360c90a1750SBarry Smith 
13617c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
13622c876bd9SBarry Smith #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1363500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1364500d8756SSatish Balay   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
13652c876bd9SBarry Smith #endif
1366e5c89e4eSSatish Balay #endif
1367cca4cb22SSatish Balay 
1368570b7f6dSBarry Smith #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1369cca4cb22SSatish Balay   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1370cca4cb22SSatish Balay #endif
1371cca4cb22SSatish Balay 
1372e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
137344041f26SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1374e5c89e4eSSatish Balay   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
137544041f26SJed Brown #endif
1376367daffbSBarry Smith   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1377e5c89e4eSSatish Balay 
1378dbc8283eSBarry Smith   /*
1379efb80d3cSBarry Smith      Destroy any known inner MPI_Comm's and attributes pointing to them
1380efb80d3cSBarry Smith      Note this will not destroy any new communicators the user has created.
1381efb80d3cSBarry Smith 
1382efb80d3cSBarry Smith      If all PETSc objects were not destroyed those left over objects will have hanging references to
1383efb80d3cSBarry Smith      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1384dbc8283eSBarry Smith  */
1385b770b1f6SSatish Balay   {
1386dbc8283eSBarry Smith     PetscCommCounter *counter;
1387dbc8283eSBarry Smith     PetscMPIInt      flg;
1388dbc8283eSBarry Smith     MPI_Comm         icomm;
1389265f3f35SJed Brown     union {MPI_Comm comm; void *ptr;} ucomm;
1390265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1391dbc8283eSBarry Smith     if (flg) {
1392265f3f35SJed Brown       icomm = ucomm.comm;
1393dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1394dbc8283eSBarry 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");
1395dbc8283eSBarry Smith 
1396dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1397efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1398efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1399dbc8283eSBarry Smith     }
1400265f3f35SJed Brown     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1401dbc8283eSBarry Smith     if (flg) {
1402265f3f35SJed Brown       icomm = ucomm.comm;
1403dbc8283eSBarry Smith       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1404dbc8283eSBarry 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");
1405dbc8283eSBarry Smith 
1406dbc8283eSBarry Smith       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1407efb80d3cSBarry Smith       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1408efb80d3cSBarry Smith       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1409dbc8283eSBarry Smith     }
1410b770b1f6SSatish Balay   }
1411dbc8283eSBarry Smith 
1412480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1413480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1414480cf27aSJed Brown   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1415480cf27aSJed Brown 
14165ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
14175ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
14185ad9ad5bSBarry Smith   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1419ef19f930SBarry Smith   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1420ef19f930SBarry Smith 
1421e5c89e4eSSatish Balay   if (PetscBeganMPI) {
142299608316SBarry Smith #if defined(PETSC_HAVE_MPI_FINALIZED)
142399b1327fSBarry Smith     PetscMPIInt flag;
142499b1327fSBarry Smith     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1425e32f2f54SBarry Smith     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
142699608316SBarry Smith #endif
1427e5c89e4eSSatish Balay     ierr = MPI_Finalize();CHKERRQ(ierr);
1428e5c89e4eSSatish Balay   }
1429e5c89e4eSSatish Balay /*
1430e5c89e4eSSatish Balay 
1431e5c89e4eSSatish Balay      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1432e5c89e4eSSatish Balay    the communicator has some outstanding requests on it. Specifically if the
1433e5c89e4eSSatish Balay    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1434e5c89e4eSSatish Balay    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1435e5c89e4eSSatish Balay    is never freed as it should be. Thus one may obtain messages of the form
14360e5e90baSSatish Balay    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1437e5c89e4eSSatish Balay    memory was not freed.
1438e5c89e4eSSatish Balay 
1439e5c89e4eSSatish Balay */
14401d1a0024SBarry Smith   ierr = PetscMallocClear();CHKERRQ(ierr);
1441a297a907SKarl Rupp 
1442e5c89e4eSSatish Balay   PetscInitializeCalled = PETSC_FALSE;
1443e5c89e4eSSatish Balay   PetscFinalizeCalled   = PETSC_TRUE;
14443db9a53dSBarry Smith   PetscFunctionReturn(0);
1445e5c89e4eSSatish Balay }
1446e5c89e4eSSatish Balay 
144743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame_)
14488cc058d9SJed Brown PETSC_EXTERN int lsame_(char *a,char *b)
144943db4dbbSBarry Smith {
145043db4dbbSBarry Smith   if (*a == *b) return 1;
145143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
145243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
145343db4dbbSBarry Smith   return 0;
145443db4dbbSBarry Smith }
1455a70650f6SBarry Smith #endif
145643db4dbbSBarry Smith 
145743db4dbbSBarry Smith #if defined(PETSC_MISSING_LAPACK_lsame)
14588cc058d9SJed Brown PETSC_EXTERN int lsame(char *a,char *b)
145943db4dbbSBarry Smith {
146043db4dbbSBarry Smith   if (*a == *b) return 1;
146143db4dbbSBarry Smith   if (*a + 32 == *b) return 1;
146243db4dbbSBarry Smith   if (*a - 32 == *b) return 1;
146343db4dbbSBarry Smith   return 0;
146443db4dbbSBarry Smith }
146543db4dbbSBarry Smith #endif
1466