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