xref: /petsc/src/sys/objects/pinit.c (revision 4b9acda671f9684507dbcc5126d13e3d26456e7a)
1 #define PETSC_DESIRE_FEATURE_TEST_MACROS
2 /*
3    This file defines the initialization of PETSc, including PetscInitialize()
4 */
5 #include <petsc/private/petscimpl.h>        /*I  "petscsys.h"   I*/
6 #include <petscvalgrind.h>
7 #include <petscviewer.h>
8 
9 #if defined(PETSC_USE_LOG)
10 PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
11 #endif
12 
13 #if defined(PETSC_SERIALIZE_FUNCTIONS)
14 PETSC_INTERN PetscFPT PetscFPTData;
15 PetscFPT PetscFPTData = 0;
16 #endif
17 
18 #if defined(PETSC_HAVE_SAWS)
19 #include <petscviewersaws.h>
20 #endif
21 
22 /* -----------------------------------------------------------------------------------------*/
23 
24 PETSC_INTERN FILE *petsc_history;
25 
26 PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
27 PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
28 PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
29 PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
30 PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
31 PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);
32 
33 /* user may set this BEFORE calling PetscInitialize() */
34 MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;
35 
36 PetscMPIInt Petsc_Counter_keyval   = MPI_KEYVAL_INVALID;
37 PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID;
38 PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID;
39 PetscMPIInt Petsc_ShmComm_keyval   = MPI_KEYVAL_INVALID;
40 
41 /*
42      Declare and set all the string names of the PETSc enums
43 */
44 const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",NULL};
45 const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL};
46 
47 PetscBool PetscPreLoadingUsed = PETSC_FALSE;
48 PetscBool PetscPreLoadingOn   = PETSC_FALSE;
49 
50 PetscInt PetscHotRegionDepth;
51 
52 #if defined(PETSC_HAVE_THREADSAFETY)
53 PetscSpinlock PetscViewerASCIISpinLockOpen;
54 PetscSpinlock PetscViewerASCIISpinLockStdout;
55 PetscSpinlock PetscViewerASCIISpinLockStderr;
56 PetscSpinlock PetscCommSpinLock;
57 #endif
58 
59 /*
60        Checks the options database for initializations related to the
61     PETSc components
62 */
63 PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Components(void)
64 {
65   PetscBool      flg;
66   PetscErrorCode ierr;
67 
68   PetscFunctionBegin;
69   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
70   if (flg) {
71 #if defined(PETSC_USE_LOG)
72     MPI_Comm comm = PETSC_COMM_WORLD;
73     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
74     ierr = (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
75     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");CHKERRQ(ierr);
76     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
77 #endif
78   }
79   PetscFunctionReturn(0);
80 }
81 
82 /*
83       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
84 
85    Collective
86 
87    Level: advanced
88 
89     Notes:
90     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
91      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92      be called multiple times from Julia without the problem of trying to initialize MPI more than once.
93 
94      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals
95 
96 .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
97 */
98 PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
99 {
100   PetscErrorCode ierr;
101   int            myargc   = argc;
102   char           **myargs = args;
103 
104   PetscFunctionBegin;
105   ierr = PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr;
106   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107   PetscBeganMPI = PETSC_FALSE;
108   PetscFunctionReturn(ierr);
109 }
110 
111 /*
112       Used by Julia interface to get communicator
113 */
114 PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
115 {
116   PetscFunctionBegin;
117   *comm = PETSC_COMM_SELF;
118   PetscFunctionReturn(0);
119 }
120 
121 /*@C
122       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
123         the command line arguments.
124 
125    Collective
126 
127    Level: advanced
128 
129 .seealso: PetscInitialize(), PetscInitializeFortran()
130 @*/
131 PetscErrorCode  PetscInitializeNoArguments(void)
132 {
133   PetscErrorCode ierr;
134   int            argc   = 0;
135   char           **args = NULL;
136 
137   PetscFunctionBegin;
138   ierr = PetscInitialize(&argc,&args,NULL,NULL);
139   PetscFunctionReturn(ierr);
140 }
141 
142 /*@
143       PetscInitialized - Determine whether PETSc is initialized.
144 
145    Level: beginner
146 
147 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
148 @*/
149 PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
150 {
151   *isInitialized = PetscInitializeCalled;
152   return 0;
153 }
154 
155 /*@
156       PetscFinalized - Determine whether PetscFinalize() has been called yet
157 
158    Level: developer
159 
160 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
161 @*/
162 PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
163 {
164   *isFinalized = PetscFinalizeCalled;
165   return 0;
166 }
167 
168 PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);
169 
170 /*
171        This function is the MPI reduction operation used to compute the sum of the
172    first half of the datatype and the max of the second half.
173 */
174 MPI_Op MPIU_MAXSUM_OP = 0;
175 
176 PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
177 {
178   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
179 
180   PetscFunctionBegin;
181   if (*datatype != MPIU_2INT) {
182     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
183     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
184   }
185 
186   for (i=0; i<count; i++) {
187     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
188     xout[2*i+1] += xin[2*i+1];
189   }
190   PetscFunctionReturnVoid();
191 }
192 
193 /*
194     Returns the max of the first entry owned by this processor and the
195 sum of the second entry.
196 
197     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
198 is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
199 there would be no place to store the both needed results.
200 */
201 PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
202 {
203   PetscErrorCode ierr;
204 
205   PetscFunctionBegin;
206 #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
207   {
208     struct {PetscInt max,sum;} work;
209     ierr = MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
210     *max = work.max;
211     *sum = work.sum;
212   }
213 #else
214   {
215     PetscMPIInt    size,rank;
216     struct {PetscInt max,sum;} *work;
217     ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
218     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
219     ierr = PetscMalloc1(size,&work);CHKERRQ(ierr);
220     ierr = MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);CHKERRQ(ierr);
221     *max = work[rank].max;
222     *sum = work[rank].sum;
223     ierr = PetscFree(work);CHKERRQ(ierr);
224   }
225 #endif
226   PetscFunctionReturn(0);
227 }
228 
229 /* ----------------------------------------------------------------------------*/
230 
231 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
232 MPI_Op MPIU_SUM = 0;
233 
234 PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
235 {
236   PetscInt i,count = *cnt;
237 
238   PetscFunctionBegin;
239   if (*datatype == MPIU_REAL) {
240     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
241     for (i=0; i<count; i++) xout[i] += xin[i];
242   }
243 #if defined(PETSC_HAVE_COMPLEX)
244   else if (*datatype == MPIU_COMPLEX) {
245     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
246     for (i=0; i<count; i++) xout[i] += xin[i];
247   }
248 #endif
249   else {
250     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
251     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
252   }
253   PetscFunctionReturnVoid();
254 }
255 #endif
256 
257 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
258 MPI_Op MPIU_MAX = 0;
259 MPI_Op MPIU_MIN = 0;
260 
261 PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
262 {
263   PetscInt i,count = *cnt;
264 
265   PetscFunctionBegin;
266   if (*datatype == MPIU_REAL) {
267     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
268     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
269   }
270 #if defined(PETSC_HAVE_COMPLEX)
271   else if (*datatype == MPIU_COMPLEX) {
272     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
273     for (i=0; i<count; i++) {
274       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
275     }
276   }
277 #endif
278   else {
279     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
280     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
281   }
282   PetscFunctionReturnVoid();
283 }
284 
285 PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286 {
287   PetscInt    i,count = *cnt;
288 
289   PetscFunctionBegin;
290   if (*datatype == MPIU_REAL) {
291     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
293   }
294 #if defined(PETSC_HAVE_COMPLEX)
295   else if (*datatype == MPIU_COMPLEX) {
296     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
297     for (i=0; i<count; i++) {
298       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
299     }
300   }
301 #endif
302   else {
303     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
304     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
305   }
306   PetscFunctionReturnVoid();
307 }
308 #endif
309 
310 /*
311    Private routine to delete internal tag/name counter storage when a communicator is freed.
312 
313    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.
314 
315    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
316 
317 */
318 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
319 {
320   PetscErrorCode ierr;
321 
322   PetscFunctionBegin;
323   ierr = PetscInfo1(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
324   ierr = PetscFree(count_val);CHKERRMPI(ierr);
325   PetscFunctionReturn(MPI_SUCCESS);
326 }
327 
328 /*
329   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
330   calls MPI_Comm_free().
331 
332   This is the only entry point for breaking the links between inner and outer comms.
333 
334   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
335 
336   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()
337 
338 */
339 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
340 {
341   PetscErrorCode                    ierr;
342   PetscMPIInt                       flg;
343   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
344 
345   PetscFunctionBegin;
346   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
347   icomm.ptr = attr_val;
348 
349   ierr = MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
350   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
351   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
352   ierr = MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
353   ierr = PetscInfo1(NULL,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);CHKERRMPI(ierr);
354   PetscFunctionReturn(MPI_SUCCESS);
355 }
356 
357 /*
358  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Comm_delete_attr.  It should not be reached any other way.
359  */
360 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
361 {
362   PetscErrorCode ierr;
363 
364   PetscFunctionBegin;
365   ierr = PetscInfo1(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
366   PetscFunctionReturn(MPI_SUCCESS);
367 }
368 
369 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Shm(MPI_Comm,PetscMPIInt,void *,void *);
370 
371 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
372 PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
373 PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
374 PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
375 #endif
376 
377 PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE;
378 
379 PETSC_INTERN int  PetscGlobalArgc;
380 PETSC_INTERN char **PetscGlobalArgs;
381 int  PetscGlobalArgc   = 0;
382 char **PetscGlobalArgs = NULL;
383 PetscSegBuffer PetscCitationsList;
384 
385 PetscErrorCode PetscCitationsInitialize(void)
386 {
387   PetscErrorCode ierr;
388 
389   PetscFunctionBegin;
390   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
391   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n            and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n            Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n            Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n            and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n            and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.11},\n  Institution = {Argonne National Laboratory},\n  Year = {2019}\n}\n",NULL);CHKERRQ(ierr);
392   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);
393   PetscFunctionReturn(0);
394 }
395 
396 static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */
397 
398 PetscErrorCode  PetscSetProgramName(const char name[])
399 {
400   PetscErrorCode ierr;
401 
402   PetscFunctionBegin;
403   ierr  = PetscStrncpy(programname,name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
404   PetscFunctionReturn(0);
405 }
406 
407 /*@C
408     PetscGetProgramName - Gets the name of the running program.
409 
410     Not Collective
411 
412     Input Parameter:
413 .   len - length of the string name
414 
415     Output Parameter:
416 .   name - the name of the running program
417 
418    Level: advanced
419 
420     Notes:
421     The name of the program is copied into the user-provided character
422     array of length len.  On some machines the program name includes
423     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
424 @*/
425 PetscErrorCode  PetscGetProgramName(char name[],size_t len)
426 {
427   PetscErrorCode ierr;
428 
429   PetscFunctionBegin;
430    ierr = PetscStrncpy(name,programname,len);CHKERRQ(ierr);
431   PetscFunctionReturn(0);
432 }
433 
434 /*@C
435    PetscGetArgs - Allows you to access the raw command line arguments anywhere
436      after PetscInitialize() is called but before PetscFinalize().
437 
438    Not Collective
439 
440    Output Parameters:
441 +  argc - count of number of command line arguments
442 -  args - the command line arguments
443 
444    Level: intermediate
445 
446    Notes:
447       This is usually used to pass the command line arguments into other libraries
448    that are called internally deep in PETSc or the application.
449 
450       The first argument contains the program name as is normal for C arguments.
451 
452 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
453 
454 @*/
455 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
456 {
457   PetscFunctionBegin;
458   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
459   *argc = PetscGlobalArgc;
460   *args = PetscGlobalArgs;
461   PetscFunctionReturn(0);
462 }
463 
464 /*@C
465    PetscGetArguments - Allows you to access the  command line arguments anywhere
466      after PetscInitialize() is called but before PetscFinalize().
467 
468    Not Collective
469 
470    Output Parameters:
471 .  args - the command line arguments
472 
473    Level: intermediate
474 
475    Notes:
476       This does NOT start with the program name and IS null terminated (final arg is void)
477 
478 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
479 
480 @*/
481 PetscErrorCode  PetscGetArguments(char ***args)
482 {
483   PetscInt       i,argc = PetscGlobalArgc;
484   PetscErrorCode ierr;
485 
486   PetscFunctionBegin;
487   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
488   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
489   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
490   for (i=0; i<argc-1; i++) {
491     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
492   }
493   (*args)[argc-1] = NULL;
494   PetscFunctionReturn(0);
495 }
496 
497 /*@C
498    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
499 
500    Not Collective
501 
502    Output Parameters:
503 .  args - the command line arguments
504 
505    Level: intermediate
506 
507 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
508 
509 @*/
510 PetscErrorCode  PetscFreeArguments(char **args)
511 {
512   PetscInt       i = 0;
513   PetscErrorCode ierr;
514 
515   PetscFunctionBegin;
516   if (!args) PetscFunctionReturn(0);
517   while (args[i]) {
518     ierr = PetscFree(args[i]);CHKERRQ(ierr);
519     i++;
520   }
521   ierr = PetscFree(args);CHKERRQ(ierr);
522   PetscFunctionReturn(0);
523 }
524 
525 #if defined(PETSC_HAVE_SAWS)
526 #include <petscconfiginfo.h>
527 
528 PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
529 {
530   if (!PetscGlobalRank) {
531     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
532     int            port;
533     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
534     size_t         applinelen,introlen;
535     PetscErrorCode ierr;
536     char           sawsurl[256];
537 
538     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
539     if (flg) {
540       char  sawslog[PETSC_MAX_PATH_LEN];
541 
542       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
543       if (sawslog[0]) {
544         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
545       } else {
546         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
547       }
548     }
549     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
550     if (flg) {
551       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
552     }
553     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
554     if (selectport) {
555         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
556         PetscStackCallSAWs(SAWs_Set_Port,(port));
557     } else {
558       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
559       if (flg) {
560         PetscStackCallSAWs(SAWs_Set_Port,(port));
561       }
562     }
563     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
564     if (flg) {
565       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
566       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
567     } else {
568       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
569       if (flg) {
570         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
571         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
572       }
573     }
574     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
575     if (flg2) {
576       char jsdir[PETSC_MAX_PATH_LEN];
577       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
578       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
579       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
580       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
581       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
582     }
583     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
584     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
585     introlen   = 4096 + applinelen;
586     applinelen += 1024;
587     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
588     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
589 
590     if (rootlocal) {
591       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
592       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
593     }
594     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
595     if (rootlocal && help) {
596       ierr = PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);CHKERRQ(ierr);
597     } else if (help) {
598       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr);
599     } else {
600       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr);
601     }
602     ierr = PetscFree(options);CHKERRQ(ierr);
603     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
604     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
605                                     "<center><h2> <a href=\"https://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
606                                     "<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"
607                                     "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr);
608     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
609     ierr = PetscFree(intro);CHKERRQ(ierr);
610     ierr = PetscFree(appline);CHKERRQ(ierr);
611     if (selectport) {
612       PetscBool silent;
613 
614       ierr = SAWs_Initialize();
615       /* another process may have grabbed the port so keep trying */
616       while (ierr) {
617         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
618         PetscStackCallSAWs(SAWs_Set_Port,(port));
619         ierr = SAWs_Initialize();
620       }
621 
622       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
623       if (!silent) {
624         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
625         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
626       }
627     } else {
628       PetscStackCallSAWs(SAWs_Initialize,());
629     }
630     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
631                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
632                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
633                                   "  Institution = {Argonne National Laboratory},\n"
634                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
635   }
636   PetscFunctionReturn(0);
637 }
638 #endif
639 
640 /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
641 PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
642 {
643   PetscFunctionBegin;
644 #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
645     /* see MPI.py for details on this bug */
646     (void) setenv("HWLOC_COMPONENTS","-x86",1);
647 #endif
648   PetscFunctionReturn(0);
649 }
650 
651 #if defined(PETSC_HAVE_ADIOS)
652 #include <adios.h>
653 #include <adios_read.h>
654 int64_t Petsc_adios_group;
655 #endif
656 #if defined(PETSC_HAVE_ADIOS2)
657 #include <adios2_c.h>
658 #endif
659 #if defined(PETSC_HAVE_OPENMP)
660 #include <omp.h>
661 PetscInt PetscNumOMPThreads;
662 #endif
663 
664 #if defined(PETSC_HAVE_DLFCN_H)
665 #include <dlfcn.h>
666 #endif
667 
668 /*@C
669    PetscInitialize - Initializes the PETSc database and MPI.
670    PetscInitialize() calls MPI_Init() if that has yet to be called,
671    so this routine should always be called near the beginning of
672    your program -- usually the very first line!
673 
674    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
675 
676    Input Parameters:
677 +  argc - count of number of command line arguments
678 .  args - the command line arguments
679 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
680           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
681 -  help - [optional] Help message to print, use NULL for no message
682 
683    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
684    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
685    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
686    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
687    if different subcommunicators of the job are doing different things with PETSc.
688 
689    Options Database Keys:
690 +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
691 .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
692 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
693 .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
694 .  -on_error_abort - calls abort() when error detected (no traceback)
695 .  -on_error_mpiabort - calls MPI_abort() when error detected
696 .  -error_output_stderr - prints error messages to stderr instead of the default stdout
697 .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
698 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
699 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
700 .  -stop_for_debugger - Print message on how to attach debugger manually to
701                         process and wait (-debugger_pause) seconds for attachment
702 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
703 .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
704 .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
705 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
706 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds, ignored in optimized build. May want to set in PETSC_OPTIONS environmental variable
707 .  -malloc_view - show a list of all allocated memory during PetscFinalize()
708 .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
709 .  -fp_trap - Stops on floating point exceptions
710 .  -no_signal_handler - Indicates not to trap error signals
711 .  -shared_tmp - indicates /tmp directory is shared by all processors
712 .  -not_shared_tmp - each processor has own /tmp
713 .  -tmp - alternative name of /tmp directory
714 .  -get_total_flops - returns total flops done by all processors
715 -  -memory_view - Print memory usage at end of run
716 
717    Options Database Keys for Profiling:
718    See Users-Manual: ch_profiling for details.
719 +  -info <optional filename> - Prints verbose information to the screen
720 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
721 .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
722         however it slows things down and gives a distorted view of the overall runtime.
723 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
724         hangs without running in the debugger).  See PetscLogTraceBegin().
725 .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
726 .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
727 .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
728         summary is written to the file.  See PetscLogView().
729 .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
730 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
731 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
732 .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
733 .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
734 -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
735 
736     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
737 
738    Options Database Keys for SAWs:
739 +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
740 .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
741                             this is useful when you are running many jobs that utilize SAWs at the same time
742 .  -saws_log <filename> - save a log of all SAWs communication
743 .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
744 -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
745 
746    Environmental Variables:
747 +   PETSC_TMP - alternative tmp directory
748 .   PETSC_SHARED_TMP - tmp is shared by all processes
749 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
750 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
751 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
752 
753 
754    Level: beginner
755 
756    Notes:
757    If for some reason you must call MPI_Init() separately, call
758    it before PetscInitialize().
759 
760    Fortran Version:
761    In Fortran this routine has the format
762 $       call PetscInitialize(file,ierr)
763 
764 +   ierr - error return code
765 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
766           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
767 
768    Important Fortran Note:
769    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
770    null character string; you CANNOT just use NULL as
771    in the C version. See Users-Manual: ch_fortran for details.
772 
773    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
774    calling PetscInitialize().
775 
776 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
777 
778 @*/
779 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
780 {
781   PetscErrorCode ierr;
782   PetscMPIInt    flag, size;
783   PetscBool      flg = PETSC_TRUE;
784   char           hostname[256];
785 
786   PetscFunctionBegin;
787   if (PetscInitializeCalled) PetscFunctionReturn(0);
788   /*
789       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
790       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
791         MPICH v3.1 (Released Feburary 2014)
792         IBM MPI v2.1 (December 2014)
793         Intel® MPI Library v5.0 (2014)
794         Cray MPT v7.0.0 (June 2014)
795       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
796       listed above and since that time are compatible.
797 
798       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
799       at compile time or runtime. Thus we will need to systematically track the allowed versions
800       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
801       to perform the checking.
802 
803       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
804 
805       Questions:
806 
807         Should the checks for ABI incompatibility be only on the major version number below?
808         Presumably the output to stderr will be removed before a release.
809   */
810 
811 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
812   {
813     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
814     PetscMPIInt mpilibraryversionlength;
815     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
816     /* check for MPICH versions before MPI ABI initiative */
817 #if defined(MPICH_VERSION)
818 #if MPICH_NUMVERSION < 30100000
819     {
820       char *ver,*lf;
821       flg = PETSC_FALSE;
822       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
823       if (ver) {
824         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
825         if (lf) {
826           *lf = 0;
827           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
828         }
829       }
830       if (!flg) {
831         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
832         return PETSC_ERR_MPI_LIB_INCOMP;
833       }
834     }
835 #endif
836     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
837 #elif defined(OMPI_MAJOR_VERSION)
838     {
839       char *ver,bs[32],*bsf;
840       flg = PETSC_FALSE;
841       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
842       if (ver) {
843         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
844         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
845         if (bsf) flg = PETSC_TRUE;
846       }
847       if (!flg) {
848         fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
849         return PETSC_ERR_MPI_LIB_INCOMP;
850       }
851     }
852 #endif
853   }
854 #endif
855 
856 #if defined(PETSC_HAVE_DLSYM)
857   {
858     PetscInt cnt = 0;
859     /* These symbols are currently in the OpenMPI and MPICH libraries; they may not always be, in that case the test will simply not detect the problem */
860     if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++;
861     if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++;
862     if (cnt > 1) {
863       fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n");
864       return PETSC_ERR_MPI_LIB_INCOMP;
865     }
866   }
867 #endif
868 
869   /* these must be initialized in a routine, not as a constant declaration*/
870   PETSC_STDOUT = stdout;
871   PETSC_STDERR = stderr;
872 
873   /* on Windows - set printf to default to printing 2 digit exponents */
874 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
875   _set_output_format(_TWO_DIGIT_EXPONENT);
876 #endif
877 
878   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
879 
880   /*
881      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
882      it that it sets args[0] on all processors to be args[0] on the first processor.
883   */
884   if (argc && *argc) {
885     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
886   } else {
887     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
888   }
889 
890   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
891   if (!flag) {
892     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");
893     ierr = PetscPreMPIInit_Private();CHKERRQ(ierr);
894 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
895     {
896       PetscMPIInt provided;
897       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
898     }
899 #else
900     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
901 #endif
902     PetscBeganMPI = PETSC_TRUE;
903   }
904 
905   if (argc && args) {
906     PetscGlobalArgc = *argc;
907     PetscGlobalArgs = *args;
908   }
909   PetscFinalizeCalled = PETSC_FALSE;
910   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
911   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
912   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
913   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
914 
915   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
916   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
917 
918   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
919     ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
920     ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
921   }
922 
923   /* Done after init due to a bug in MPICH-GM? */
924   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
925 
926   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
927   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
928 
929   MPIU_BOOL = MPI_INT;
930   MPIU_ENUM = MPI_INT;
931   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
932   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
933   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
934 #if defined(PETSC_SIZEOF_LONG_LONG)
935   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
936 #endif
937   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
938 
939   /*
940      Initialized the global complex variable; this is because with
941      shared libraries the constructors for global variables
942      are not called; at least on IRIX.
943   */
944 #if defined(PETSC_HAVE_COMPLEX)
945   {
946 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
947     PetscComplex ic(0.0,1.0);
948     PETSC_i = ic;
949 #else
950     PETSC_i = _Complex_I;
951 #endif
952   }
953 
954 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
955   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
956   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
957   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
958   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
959 #endif
960 #endif /* PETSC_HAVE_COMPLEX */
961 
962   /*
963      Create the PETSc MPI reduction operator that sums of the first
964      half of the entries and maxes the second half.
965   */
966   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
967 
968 #if defined(PETSC_USE_REAL___FLOAT128)
969   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
970   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
971 #if defined(PETSC_HAVE_COMPLEX)
972   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
973   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
974 #endif
975   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
976   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
977 #elif defined(PETSC_USE_REAL___FP16)
978   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
979   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
980   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
981   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
982 #endif
983 
984 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
985   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
986 #endif
987 
988   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
989   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
990 
991 #if defined(PETSC_USE_64BIT_INDICES)
992   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
993   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
994 #endif
995 
996 
997   /*
998      Attributes to be set on PETSc communicators
999   */
1000   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
1001   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
1002   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
1003   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Shm,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
1004 
1005   /*
1006      Build the options database
1007   */
1008   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
1009 
1010   /* call a second time so it can look in the options database */
1011   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
1012 
1013   /*
1014      Print main application help message
1015   */
1016   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
1017   if (help && flg) {
1018     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
1019   }
1020   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
1021 
1022   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
1023 
1024 #if defined(PETSC_HAVE_SAWS)
1025   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
1026 #endif
1027 
1028   /*
1029      Load the dynamic libraries (on machines that support them), this registers all
1030      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1031   */
1032   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1033 
1034   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1035   ierr = PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1036   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1037   ierr = PetscInfo1(NULL,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1038 #if defined(PETSC_HAVE_OPENMP)
1039   {
1040     PetscBool omp_view_flag;
1041     char      *threads = getenv("OMP_NUM_THREADS");
1042 
1043    if (threads) {
1044      ierr = PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1045      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1046    } else {
1047 #define NMAX  10000
1048      int          i;
1049       PetscScalar *x;
1050       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1051 #pragma omp parallel for
1052       for (i=0; i<NMAX; i++) {
1053         x[i] = 0.0;
1054         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1055       }
1056       ierr = PetscFree(x);CHKERRQ(ierr);
1057       ierr = PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1058     }
1059     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1060     ierr = PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);CHKERRQ(ierr);
1061     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1062     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1063     if (flg) {
1064       ierr = PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1065       omp_set_num_threads((int)PetscNumOMPThreads);
1066     }
1067     if (omp_view_flag) {
1068       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr);
1069     }
1070   }
1071 #endif
1072   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
1073   /* Check the options database for options related to the options database itself */
1074   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1075 
1076 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1077   /*
1078       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1079 
1080       Currently not used because it is not supported by MPICH.
1081   */
1082   if (!PetscBinaryBigEndian()) {
1083     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1084   }
1085 #endif
1086 
1087   /*
1088       Setup building of stack frames for all function calls
1089   */
1090 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1091   ierr = PetscStackCreate();CHKERRQ(ierr);
1092 #endif
1093 
1094 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1095   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1096 #endif
1097 
1098 #if defined(PETSC_HAVE_HWLOC)
1099   {
1100     PetscViewer viewer;
1101     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1102     if (flg) {
1103       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1104       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1105     }
1106   }
1107 #endif
1108 
1109   flg = PETSC_TRUE;
1110   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1111   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1112 
1113 #if defined(PETSC_HAVE_ADIOS)
1114   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1115   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1116   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1117   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1118 #endif
1119 #if defined(PETSC_HAVE_ADIOS2)
1120 #endif
1121 
1122   /*
1123       Once we are completedly initialized then we can set this variables
1124   */
1125   PetscInitializeCalled = PETSC_TRUE;
1126 
1127   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1128   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1129   PetscFunctionReturn(0);
1130 }
1131 
1132 #if defined(PETSC_USE_LOG)
1133 PETSC_INTERN PetscObject *PetscObjects;
1134 PETSC_INTERN PetscInt    PetscObjectsCounts;
1135 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1136 PETSC_INTERN PetscBool   PetscObjectsLog;
1137 #endif
1138 
1139 /*
1140     Frees all the MPI types and operations that PETSc may have created
1141 */
1142 PetscErrorCode  PetscFreeMPIResources(void)
1143 {
1144   PetscErrorCode ierr;
1145 
1146   PetscFunctionBegin;
1147 #if defined(PETSC_USE_REAL___FLOAT128)
1148   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1149 #if defined(PETSC_HAVE_COMPLEX)
1150   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1151 #endif
1152   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1153   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1154 #elif defined(PETSC_USE_REAL___FP16)
1155   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1156   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1157   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1158 #endif
1159 
1160 #if defined(PETSC_HAVE_COMPLEX)
1161 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1162   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1163   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1164 #endif
1165 #endif
1166 
1167 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1168   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1169 #endif
1170 
1171   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1172 #if defined(PETSC_USE_64BIT_INDICES)
1173   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1174 #endif
1175   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1176   PetscFunctionReturn(0);
1177 }
1178 
1179 /*@C
1180    PetscFinalize - Checks for options to be called at the conclusion
1181    of the program. MPI_Finalize() is called only if the user had not
1182    called MPI_Init() before calling PetscInitialize().
1183 
1184    Collective on PETSC_COMM_WORLD
1185 
1186    Options Database Keys:
1187 +  -options_view - Calls PetscOptionsView()
1188 .  -options_left - Prints unused options that remain in the database
1189 .  -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
1190 .  -mpidump - Calls PetscMPIDump()
1191 .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1192 .  -malloc_info - Prints total memory usage
1193 -  -malloc_view <optional filename> - Prints list of all memory allocated and where
1194 
1195    Level: beginner
1196 
1197    Note:
1198    See PetscInitialize() for more general runtime options.
1199 
1200 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1201 @*/
1202 PetscErrorCode  PetscFinalize(void)
1203 {
1204   PetscErrorCode ierr;
1205   PetscMPIInt    rank;
1206   PetscInt       nopt;
1207   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1208   PetscBool      flg;
1209 #if defined(PETSC_USE_LOG)
1210   char           mname[PETSC_MAX_PATH_LEN];
1211 #endif
1212 
1213   if (!PetscInitializeCalled) {
1214     printf("PetscInitialize() must be called before PetscFinalize()\n");
1215     return(PETSC_ERR_ARG_WRONGSTATE);
1216   }
1217   PetscFunctionBegin;
1218   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1219 
1220   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1221 #if defined(PETSC_HAVE_ADIOS)
1222   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1223   ierr = adios_finalize(rank);CHKERRQ(ierr);
1224 #endif
1225 #if defined(PETSC_HAVE_ADIOS2)
1226 #endif
1227   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1228   if (flg) {
1229     char  *cits, filename[PETSC_MAX_PATH_LEN];
1230     FILE  *fd = PETSC_STDOUT;
1231 
1232     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
1233     if (filename[0]) {
1234       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1235     }
1236     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1237     cits[0] = 0;
1238     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1239     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1240     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1241     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1242     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1243     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1244     ierr = PetscFree(cits);CHKERRQ(ierr);
1245   }
1246   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1247 
1248 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1249   /* TextBelt is run for testing purposes only, please do not use this feature often */
1250   {
1251     PetscInt nmax = 2;
1252     char     **buffs;
1253     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1254     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1255     if (flg1) {
1256       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1257       if (nmax == 1) {
1258         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1259         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1260         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1261       }
1262       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1263       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1264       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1265     }
1266     ierr = PetscFree(buffs);CHKERRQ(ierr);
1267   }
1268   {
1269     PetscInt nmax = 2;
1270     char     **buffs;
1271     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1272     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1273     if (flg1) {
1274       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1275       if (nmax == 1) {
1276         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1277         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1278         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1279       }
1280       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1281       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1282       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1283     }
1284     ierr = PetscFree(buffs);CHKERRQ(ierr);
1285   }
1286 #endif
1287   /*
1288     It should be safe to cancel the options monitors, since we don't expect to be setting options
1289     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1290     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1291   */
1292   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1293 
1294 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1295   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1296 #endif
1297 
1298 
1299 #if defined(PETSC_HAVE_SAWS)
1300   flg = PETSC_FALSE;
1301   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1302   if (flg) {
1303     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1304   }
1305 #endif
1306 
1307 #if defined(PETSC_HAVE_X)
1308   flg1 = PETSC_FALSE;
1309   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1310   if (flg1) {
1311     /*  this is a crude hack, but better than nothing */
1312     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1313   }
1314 #endif
1315 
1316 #if !defined(PETSC_HAVE_THREADSAFETY)
1317   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1318   if (!flg2) {
1319     flg2 = PETSC_FALSE;
1320     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1321   }
1322   if (flg2) {
1323     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1324   }
1325 #endif
1326 
1327 #if defined(PETSC_USE_LOG)
1328   flg1 = PETSC_FALSE;
1329   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1330   if (flg1) {
1331     PetscLogDouble flops = 0;
1332     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1333     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1334   }
1335 #endif
1336 
1337 
1338 #if defined(PETSC_USE_LOG)
1339 #if defined(PETSC_HAVE_MPE)
1340   mname[0] = 0;
1341   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1342   if (flg1) {
1343     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1344     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1345   }
1346 #endif
1347 #endif
1348 
1349   /*
1350      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1351   */
1352   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1353 
1354 #if defined(PETSC_USE_LOG)
1355   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1356   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1357   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1358 
1359   mname[0] = 0;
1360   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1361   if (flg1) {
1362     PetscViewer viewer;
1363     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1364     if (mname[0]) {
1365       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1366       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1367       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1368     } else {
1369       viewer = PETSC_VIEWER_STDOUT_WORLD;
1370       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1371       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1372       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1373     }
1374   }
1375 
1376   /*
1377      Free any objects created by the last block of code.
1378   */
1379   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1380 
1381   mname[0] = 0;
1382   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1383   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1384   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1385 #endif
1386 
1387   ierr = PetscStackDestroy();CHKERRQ(ierr);
1388 
1389   flg1 = PETSC_FALSE;
1390   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1391   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1392   flg1 = PETSC_FALSE;
1393   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1394   if (flg1) {
1395     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1396   }
1397   flg1 = PETSC_FALSE;
1398   flg2 = PETSC_FALSE;
1399   /* preemptive call to avoid listing this option in options table as unused */
1400   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1401   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1402   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1403 
1404   if (flg2) {
1405     PetscViewer viewer;
1406     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1407     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1408     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1409     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1410   }
1411 
1412   /* to prevent PETSc -options_left from warning */
1413   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1414   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1415 
1416   flg3 = PETSC_FALSE; /* default value is required */
1417   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1418 #if defined(PETSC_USE_DEBUG)
1419   if (!flg1) flg3 = PETSC_TRUE;
1420 #endif
1421   if (flg3) {
1422     if (!flg2 && flg1) { /* have not yet printed the options */
1423       PetscViewer viewer;
1424       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1425       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1426       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1427       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1428     }
1429     ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1430     if (nopt) {
1431       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1432       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1433       if (nopt == 1) {
1434         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1435       } else {
1436         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1437       }
1438     } else if (flg3 && flg1) {
1439       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1440     }
1441     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1442   }
1443 
1444 #if defined(PETSC_HAVE_SAWS)
1445   if (!PetscGlobalRank) {
1446     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1447     PetscStackCallSAWs(SAWs_Finalize,());
1448   }
1449 #endif
1450 
1451 #if defined(PETSC_USE_LOG)
1452   /*
1453        List all objects the user may have forgot to free
1454   */
1455   if (PetscObjectsLog) {
1456     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1457     if (flg1) {
1458       MPI_Comm local_comm;
1459       char     string[64];
1460 
1461       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1462       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1463       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1464       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1465       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1466       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1467     }
1468   }
1469 #endif
1470 
1471 #if defined(PETSC_USE_LOG)
1472   PetscObjectsCounts    = 0;
1473   PetscObjectsMaxCounts = 0;
1474   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1475 #endif
1476 
1477   /*
1478      Destroy any packages that registered a finalize
1479   */
1480   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1481 
1482 #if defined(PETSC_USE_LOG)
1483   ierr = PetscLogFinalize();CHKERRQ(ierr);
1484 #endif
1485 
1486   /*
1487      Print PetscFunctionLists that have not been properly freed
1488 
1489   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1490   */
1491 
1492   if (petsc_history) {
1493     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1494     petsc_history = NULL;
1495   }
1496   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1497 
1498   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1499 
1500 #if !defined(PETSC_HAVE_THREADSAFETY)
1501   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1502     char fname[PETSC_MAX_PATH_LEN];
1503     char sname[PETSC_MAX_PATH_LEN];
1504     FILE *fd;
1505     int  err;
1506 
1507     flg2 = PETSC_FALSE;
1508     flg3 = PETSC_FALSE;
1509 #if defined(PETSC_USE_DEBUG)
1510     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1511 #endif
1512     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);CHKERRQ(ierr);
1513     fname[0] = 0;
1514     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1515     if (flg1 && fname[0]) {
1516 
1517       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1518       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1519       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1520       err  = fclose(fd);
1521       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1522     } else if (flg1 || flg2 || flg3) {
1523       MPI_Comm local_comm;
1524 
1525       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1526       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1527       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1528       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1529       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1530     }
1531     fname[0] = 0;
1532     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,250,&flg1);CHKERRQ(ierr);
1533     if (flg1 && fname[0]) {
1534 
1535       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1536       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1537       ierr = PetscMallocView(fd);CHKERRQ(ierr);
1538       err  = fclose(fd);
1539       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1540     } else if (flg1) {
1541       MPI_Comm local_comm;
1542 
1543       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1544       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1545       ierr = PetscMallocView(stdout);CHKERRQ(ierr);
1546       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1547       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1548     }
1549   }
1550 #endif
1551 
1552   /*
1553      Close any open dynamic libraries
1554   */
1555   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1556 
1557   /* Can be destroyed only after all the options are used */
1558   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1559 
1560   PetscGlobalArgc = 0;
1561   PetscGlobalArgs = NULL;
1562 
1563   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1564 
1565   /*
1566      Destroy any known inner MPI_Comm's and attributes pointing to them
1567      Note this will not destroy any new communicators the user has created.
1568 
1569      If all PETSc objects were not destroyed those left over objects will have hanging references to
1570      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1571  */
1572   {
1573     PetscCommCounter *counter;
1574     PetscMPIInt      flg;
1575     MPI_Comm         icomm;
1576     union {MPI_Comm comm; void *ptr;} ucomm;
1577     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1578     if (flg) {
1579       icomm = ucomm.comm;
1580       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1581       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1582 
1583       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1584       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1585       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1586     }
1587     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1588     if (flg) {
1589       icomm = ucomm.comm;
1590       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1591       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1592 
1593       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1594       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1595       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1596     }
1597   }
1598 
1599   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1600   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1601   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1602   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1603 
1604   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1605   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1606   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1607   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1608 
1609   if (PetscBeganMPI) {
1610 #if defined(PETSC_HAVE_MPI_FINALIZED)
1611     PetscMPIInt flag;
1612     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1613     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1614 #endif
1615     ierr = MPI_Finalize();CHKERRQ(ierr);
1616   }
1617 /*
1618 
1619      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1620    the communicator has some outstanding requests on it. Specifically if the
1621    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1622    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1623    is never freed as it should be. Thus one may obtain messages of the form
1624    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1625    memory was not freed.
1626 
1627 */
1628   ierr = PetscMallocClear();CHKERRQ(ierr);
1629 
1630   PetscInitializeCalled = PETSC_FALSE;
1631   PetscFinalizeCalled   = PETSC_TRUE;
1632   PetscFunctionReturn(0);
1633 }
1634 
1635 #if defined(PETSC_MISSING_LAPACK_lsame_)
1636 PETSC_EXTERN int lsame_(char *a,char *b)
1637 {
1638   if (*a == *b) return 1;
1639   if (*a + 32 == *b) return 1;
1640   if (*a - 32 == *b) return 1;
1641   return 0;
1642 }
1643 #endif
1644 
1645 #if defined(PETSC_MISSING_LAPACK_lsame)
1646 PETSC_EXTERN int lsame(char *a,char *b)
1647 {
1648   if (*a == *b) return 1;
1649   if (*a + 32 == *b) return 1;
1650   if (*a - 32 == *b) return 1;
1651   return 0;
1652 }
1653 #endif
1654