xref: /petsc/src/sys/objects/pinit.c (revision 101491d09958655a6d5d7bc5ec1bb8da95f3cf14)
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 
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);CHKERRQ(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 = 0;
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     MPI_Abort(MPI_COMM_WORLD,1);
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     MPI_Abort(MPI_COMM_WORLD,1);
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     MPI_Abort(MPI_COMM_WORLD,1);
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     MPI_Abort(MPI_COMM_WORLD,1);
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(0,"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(0,"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(0,"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,PETSC_MPI_ERROR_CODE;
378 
379 PETSC_INTERN int  PetscGlobalArgc;
380 PETSC_INTERN char **PetscGlobalArgs;
381 int  PetscGlobalArgc   = 0;
382 char **PetscGlobalArgs = 0;
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    Concepts: command line arguments
453 
454 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
455 
456 @*/
457 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
458 {
459   PetscFunctionBegin;
460   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
461   *argc = PetscGlobalArgc;
462   *args = PetscGlobalArgs;
463   PetscFunctionReturn(0);
464 }
465 
466 /*@C
467    PetscGetArguments - Allows you to access the  command line arguments anywhere
468      after PetscInitialize() is called but before PetscFinalize().
469 
470    Not Collective
471 
472    Output Parameters:
473 .  args - the command line arguments
474 
475    Level: intermediate
476 
477    Notes:
478       This does NOT start with the program name and IS null terminated (final arg is void)
479 
480    Concepts: command line arguments
481 
482 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
483 
484 @*/
485 PetscErrorCode  PetscGetArguments(char ***args)
486 {
487   PetscInt       i,argc = PetscGlobalArgc;
488   PetscErrorCode ierr;
489 
490   PetscFunctionBegin;
491   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
492   if (!argc) {*args = NULL; PetscFunctionReturn(0);}
493   ierr = PetscMalloc1(argc,args);CHKERRQ(ierr);
494   for (i=0; i<argc-1; i++) {
495     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
496   }
497   (*args)[argc-1] = NULL;
498   PetscFunctionReturn(0);
499 }
500 
501 /*@C
502    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
503 
504    Not Collective
505 
506    Output Parameters:
507 .  args - the command line arguments
508 
509    Level: intermediate
510 
511    Concepts: command line arguments
512 
513 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
514 
515 @*/
516 PetscErrorCode  PetscFreeArguments(char **args)
517 {
518   PetscInt       i = 0;
519   PetscErrorCode ierr;
520 
521   PetscFunctionBegin;
522   if (!args) PetscFunctionReturn(0);
523   while (args[i]) {
524     ierr = PetscFree(args[i]);CHKERRQ(ierr);
525     i++;
526   }
527   ierr = PetscFree(args);CHKERRQ(ierr);
528   PetscFunctionReturn(0);
529 }
530 
531 #if defined(PETSC_HAVE_SAWS)
532 #include <petscconfiginfo.h>
533 
534 PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
535 {
536   if (!PetscGlobalRank) {
537     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
538     int            port;
539     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
540     size_t         applinelen,introlen;
541     PetscErrorCode ierr;
542     char           sawsurl[256];
543 
544     ierr = PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);CHKERRQ(ierr);
545     if (flg) {
546       char  sawslog[PETSC_MAX_PATH_LEN];
547 
548       ierr = PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
549       if (sawslog[0]) {
550         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
551       } else {
552         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
553       }
554     }
555     ierr = PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
556     if (flg) {
557       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
558     }
559     ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);CHKERRQ(ierr);
560     if (selectport) {
561         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
562         PetscStackCallSAWs(SAWs_Set_Port,(port));
563     } else {
564       ierr = PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);CHKERRQ(ierr);
565       if (flg) {
566         PetscStackCallSAWs(SAWs_Set_Port,(port));
567       }
568     }
569     ierr = PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
570     if (flg) {
571       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
572       ierr = PetscStrcmp(root,".",&rootlocal);CHKERRQ(ierr);
573     } else {
574       ierr = PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);CHKERRQ(ierr);
575       if (flg) {
576         ierr = PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
577         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));CHKERRQ(ierr);
578       }
579     }
580     ierr = PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);CHKERRQ(ierr);
581     if (flg2) {
582       char jsdir[PETSC_MAX_PATH_LEN];
583       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
584       ierr = PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);CHKERRQ(ierr);
585       ierr = PetscTestDirectory(jsdir,'r',&flg);CHKERRQ(ierr);
586       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
587       PetscStackCallSAWs(SAWs_Push_Local_Header,());CHKERRQ(ierr);
588     }
589     ierr = PetscGetProgramName(programname,64);CHKERRQ(ierr);
590     ierr = PetscStrlen(help,&applinelen);CHKERRQ(ierr);
591     introlen   = 4096 + applinelen;
592     applinelen += 1024;
593     ierr = PetscMalloc(applinelen,&appline);CHKERRQ(ierr);
594     ierr = PetscMalloc(introlen,&intro);CHKERRQ(ierr);
595 
596     if (rootlocal) {
597       ierr = PetscSNPrintf(appline,applinelen,"%s.c.html",programname);CHKERRQ(ierr);
598       ierr = PetscTestFile(appline,'r',&rootlocal);CHKERRQ(ierr);
599     }
600     ierr = PetscOptionsGetAll(NULL,&options);CHKERRQ(ierr);
601     if (rootlocal && help) {
602       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);
603     } else if (help) {
604       ierr = PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);CHKERRQ(ierr);
605     } else {
606       ierr = PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);CHKERRQ(ierr);
607     }
608     ierr = PetscFree(options);CHKERRQ(ierr);
609     ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
610     ierr = PetscSNPrintf(intro,introlen,"<body>\n"
611                                     "<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"
612                                     "<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"
613                                     "%s",version,petscconfigureoptions,appline);CHKERRQ(ierr);
614     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
615     ierr = PetscFree(intro);CHKERRQ(ierr);
616     ierr = PetscFree(appline);CHKERRQ(ierr);
617     if (selectport) {
618       PetscBool silent;
619 
620       ierr = SAWs_Initialize();
621       /* another process may have grabbed the port so keep trying */
622       while (ierr) {
623         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
624         PetscStackCallSAWs(SAWs_Set_Port,(port));
625         ierr = SAWs_Initialize();
626       }
627 
628       ierr = PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);CHKERRQ(ierr);
629       if (!silent) {
630         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
631         ierr = PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);CHKERRQ(ierr);
632       }
633     } else {
634       PetscStackCallSAWs(SAWs_Initialize,());
635     }
636     ierr = PetscCitationsRegister("@TechReport{ saws,\n"
637                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
638                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
639                                   "  Institution = {Argonne National Laboratory},\n"
640                                   "  Year   = 2013\n}\n",NULL);CHKERRQ(ierr);
641   }
642   PetscFunctionReturn(0);
643 }
644 #endif
645 
646 #if defined(PETSC_HAVE_ADIOS)
647 #include <adios.h>
648 #include <adios_read.h>
649 int64_t Petsc_adios_group;
650 #endif
651 #if defined(PETSC_HAVE_ADIOS2)
652 #include <adios2_c.h>
653 #endif
654 #if defined(PETSC_HAVE_OPENMP)
655 #include <omp.h>
656 #endif
657 
658 /*@C
659    PetscInitialize - Initializes the PETSc database and MPI.
660    PetscInitialize() calls MPI_Init() if that has yet to be called,
661    so this routine should always be called near the beginning of
662    your program -- usually the very first line!
663 
664    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
665 
666    Input Parameters:
667 +  argc - count of number of command line arguments
668 .  args - the command line arguments
669 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
670           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
671 -  help - [optional] Help message to print, use NULL for no message
672 
673    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
674    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
675    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
676    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
677    if different subcommunicators of the job are doing different things with PETSc.
678 
679    Options Database Keys:
680 +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
681 .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
682 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
683 .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
684 .  -on_error_abort - calls abort() when error detected (no traceback)
685 .  -on_error_mpiabort - calls MPI_abort() when error detected
686 .  -error_output_stderr - prints error messages to stderr instead of the default stdout
687 .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
688 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
689 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
690 .  -stop_for_debugger - Print message on how to attach debugger manually to
691                         process and wait (-debugger_pause) seconds for attachment
692 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
693 .  -malloc no - Indicates not to use error-checking malloc
694 .  -malloc_debug - check for memory corruption at EVERY malloc or free
695 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
696 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
697 .  -fp_trap - Stops on floating point exceptions (Note that on the
698               IBM RS6000 this slows code by at least a factor of 10.)
699 .  -no_signal_handler - Indicates not to trap error signals
700 .  -shared_tmp - indicates /tmp directory is shared by all processors
701 .  -not_shared_tmp - each processor has own /tmp
702 .  -tmp - alternative name of /tmp directory
703 .  -get_total_flops - returns total flops done by all processors
704 -  -memory_view - Print memory usage at end of run
705 
706    Options Database Keys for Profiling:
707    See Users-Manual: ch_profiling for details.
708 +  -info <optional filename> - Prints verbose information to the screen
709 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
710 .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
711         however it slows things down and gives a distorted view of the overall runtime.
712 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
713         hangs without running in the debugger).  See PetscLogTraceBegin().
714 .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
715 .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
716         summary is written to the file.  See PetscLogView().
717 .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
718 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
719 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
720 .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
721 .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
722 -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
723 
724     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
725 
726    Options Database Keys for SAWs:
727 +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
728 .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
729                             this is useful when you are running many jobs that utilize SAWs at the same time
730 .  -saws_log <filename> - save a log of all SAWs communication
731 .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
732 -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
733 
734    Environmental Variables:
735 +   PETSC_TMP - alternative tmp directory
736 .   PETSC_SHARED_TMP - tmp is shared by all processes
737 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
738 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
739 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
740 
741 
742    Level: beginner
743 
744    Notes:
745    If for some reason you must call MPI_Init() separately, call
746    it before PetscInitialize().
747 
748    Fortran Version:
749    In Fortran this routine has the format
750 $       call PetscInitialize(file,ierr)
751 
752 +   ierr - error return code
753 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
754           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
755 
756    Important Fortran Note:
757    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
758    null character string; you CANNOT just use NULL as
759    in the C version. See Users-Manual: ch_fortran for details.
760 
761    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
762    calling PetscInitialize().
763 
764    Concepts: initializing PETSc
765 
766 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
767 
768 @*/
769 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
770 {
771   PetscErrorCode ierr;
772   PetscMPIInt    flag, size;
773   PetscBool      flg = PETSC_TRUE;
774   char           hostname[256];
775 
776   PetscFunctionBegin;
777   if (PetscInitializeCalled) PetscFunctionReturn(0);
778   /*
779       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
780       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
781         MPICH v3.1 (Released Feburary 2014)
782         IBM MPI v2.1 (December 2014)
783         Intel® MPI Library v5.0 (2014)
784         Cray MPT v7.0.0 (June 2014)
785       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
786       listed above and since that time are compatible.
787 
788       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
789       at compile time or runtime. Thus we will need to systematically track the allowed versions
790       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
791       to perform the checking.
792 
793       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
794 
795       Questions:
796 
797         Should the checks for ABI incompatibility be only on the major version number below?
798         Presumably the output to stderr will be removed before a release.
799   */
800 
801 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
802   {
803     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
804     PetscMPIInt mpilibraryversionlength;
805     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
806     /* check for MPICH versions before MPI ABI initiative */
807 #if defined(MPICH_VERSION)
808 #if MPICH_NUMVERSION < 30100000
809     {
810       char *ver,*lf;
811       flg = PETSC_FALSE;
812       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
813       if (ver) {
814         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
815         if (lf) {
816           *lf = 0;
817           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
818         }
819       }
820       if (!flg) {
821         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
822         return PETSC_ERR_MPI_LIB_INCOMP;
823       }
824     }
825 #endif
826     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
827 #elif defined(OMPI_MAJOR_VERSION)
828     {
829       char *ver,bs[32],*bsf;
830       flg = PETSC_FALSE;
831       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
832       if (ver) {
833         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
834         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
835         if (bsf) flg = PETSC_TRUE;
836       }
837       if (!flg) {
838         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);
839         return PETSC_ERR_MPI_LIB_INCOMP;
840       }
841     }
842 #endif
843   }
844 #endif
845 
846 
847   /* these must be initialized in a routine, not as a constant declaration*/
848   PETSC_STDOUT = stdout;
849   PETSC_STDERR = stderr;
850 
851   /* on Windows - set printf to default to printing 2 digit exponents */
852 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
853   _set_output_format(_TWO_DIGIT_EXPONENT);
854 #endif
855 
856   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
857 
858   /*
859      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
860      it that it sets args[0] on all processors to be args[0] on the first processor.
861   */
862   if (argc && *argc) {
863     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
864   } else {
865     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
866   }
867 
868   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
869   if (!flag) {
870     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");
871 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
872     {
873       PetscMPIInt provided;
874       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
875     }
876 #else
877     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
878 #endif
879     PetscBeganMPI = PETSC_TRUE;
880   }
881   if (argc && args) {
882     PetscGlobalArgc = *argc;
883     PetscGlobalArgs = *args;
884   }
885   PetscFinalizeCalled = PETSC_FALSE;
886   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
887   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
888   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
889   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
890 
891   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
892   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
893 
894   ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
895   ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
896 
897   /* Done after init due to a bug in MPICH-GM? */
898   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
899 
900   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
901   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
902 
903   MPIU_BOOL = MPI_INT;
904   MPIU_ENUM = MPI_INT;
905   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
906   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
907   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
908 #if defined(PETSC_SIZEOF_LONG_LONG)
909   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
910 #endif
911   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
912 
913   /*
914      Initialized the global complex variable; this is because with
915      shared libraries the constructors for global variables
916      are not called; at least on IRIX.
917   */
918 #if defined(PETSC_HAVE_COMPLEX)
919   {
920 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
921     PetscComplex ic(0.0,1.0);
922     PETSC_i = ic;
923 #else
924     PETSC_i = _Complex_I;
925 #endif
926   }
927 
928 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
929   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
930   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
931   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
932   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
933 #endif
934 #endif /* PETSC_HAVE_COMPLEX */
935 
936   /*
937      Create the PETSc MPI reduction operator that sums of the first
938      half of the entries and maxes the second half.
939   */
940   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
941 
942 #if defined(PETSC_USE_REAL___FLOAT128)
943   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
944   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
945 #if defined(PETSC_HAVE_COMPLEX)
946   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
947   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
948 #endif
949   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
950   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
951 #elif defined(PETSC_USE_REAL___FP16)
952   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
953   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
954   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
955   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
956 #endif
957 
958 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
959   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
960 #endif
961 
962   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
963   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
964 
965 #if defined(PETSC_USE_64BIT_INDICES)
966   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
967   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
968 #endif
969 
970 
971   /*
972      Attributes to be set on PETSc communicators
973   */
974   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
975   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
976   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
977   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_DelComm_Shm,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
978 
979   /*
980      Build the options database
981   */
982   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
983 
984   /* call a second time so it can look in the options database */
985   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
986 
987   /*
988      Print main application help message
989   */
990   ierr = PetscOptionsHasHelp(NULL,&flg);CHKERRQ(ierr);
991   if (help && flg) {
992     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
993   }
994   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
995 
996   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
997 
998 #if defined(PETSC_HAVE_SAWS)
999   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
1000 #endif
1001 
1002   /* Creates the logging data structures; this is enabled even if logging is not turned on */
1003 #if defined(PETSC_USE_LOG)
1004   ierr = PetscLogInitialize();CHKERRQ(ierr);
1005 #endif
1006 
1007   /*
1008      Load the dynamic libraries (on machines that support them), this registers all
1009      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1010   */
1011   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1012 
1013   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1014   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1015   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1016   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1017 #if defined(PETSC_HAVE_OPENMP)
1018   {
1019     PetscInt  ompthreads;
1020     PetscBool omp_view_flag;
1021     char      *threads = getenv("OMP_NUM_THREADS");
1022 
1023    if (threads) {
1024      ierr = PetscInfo1(0,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1025      (void) sscanf(threads, "%" PetscInt_FMT,&ompthreads);
1026    } else {
1027 #define NMAX  10000
1028      int          i;
1029       PetscScalar *x;
1030       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1031 #pragma omp parallel for
1032       for (i=0; i<NMAX; i++) {
1033         x[i] = 0.0;
1034         ompthreads  = (PetscInt) omp_get_num_threads();
1035       }
1036       ierr = PetscFree(x);CHKERRQ(ierr);
1037       ierr = PetscInfo1(0,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",ompthreads);CHKERRQ(ierr);
1038     }
1039     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1040     ierr = PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",ompthreads,&ompthreads,&flg);CHKERRQ(ierr);
1041     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1042     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1043     if (flg) {
1044       ierr = PetscInfo1(0,"Number of OpenMP theads %D (given by -omp_num_threads)\n",ompthreads);CHKERRQ(ierr);
1045       omp_set_num_threads((int)ompthreads);
1046     }
1047     if (omp_view_flag) {
1048       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",ompthreads);CHKERRQ(ierr);
1049     }
1050   }
1051 #endif
1052   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
1053   /* Check the options database for options related to the options database itself */
1054   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1055 
1056 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1057   /*
1058       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1059 
1060       Currently not used because it is not supported by MPICH.
1061   */
1062   if (!PetscBinaryBigEndian()) {
1063     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1064   }
1065 #endif
1066 
1067   /*
1068       Setup building of stack frames for all function calls
1069   */
1070 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1071   ierr = PetscStackCreate();CHKERRQ(ierr);
1072 #endif
1073 
1074 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1075   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1076 #endif
1077 
1078 #if defined(PETSC_HAVE_HWLOC)
1079   {
1080     PetscViewer viewer;
1081     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1082     if (flg) {
1083       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1084       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1085     }
1086   }
1087 #endif
1088 
1089   flg = PETSC_TRUE;
1090   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1091   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1092 
1093 #if defined(PETSC_HAVE_ADIOS)
1094   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1095   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1096   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1097   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1098 #endif
1099 #if defined(PETSC_HAVE_ADIOS2)
1100 #endif
1101 
1102   /*
1103       Once we are completedly initialized then we can set this variables
1104   */
1105   PetscInitializeCalled = PETSC_TRUE;
1106 
1107   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1108   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1109   PetscFunctionReturn(0);
1110 }
1111 
1112 #if defined(PETSC_USE_LOG)
1113 PETSC_INTERN PetscObject *PetscObjects;
1114 PETSC_INTERN PetscInt    PetscObjectsCounts;
1115 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1116 PETSC_INTERN PetscBool   PetscObjectsLog;
1117 #endif
1118 
1119 /*
1120     Frees all the MPI types and operations that PETSc may have created
1121 */
1122 PetscErrorCode  PetscFreeMPIResources(void)
1123 {
1124   PetscErrorCode ierr;
1125 
1126   PetscFunctionBegin;
1127 #if defined(PETSC_USE_REAL___FLOAT128)
1128   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1129 #if defined(PETSC_HAVE_COMPLEX)
1130   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1131 #endif
1132   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1133   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1134 #elif defined(PETSC_USE_REAL___FP16)
1135   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1136   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1137   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1138 #endif
1139 
1140 #if defined(PETSC_HAVE_COMPLEX)
1141 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1142   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1143   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1144 #endif
1145 #endif
1146 
1147 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1148   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1149 #endif
1150 
1151   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1152 #if defined(PETSC_USE_64BIT_INDICES)
1153   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1154 #endif
1155   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1156   PetscFunctionReturn(0);
1157 }
1158 
1159 /*@C
1160    PetscFinalize - Checks for options to be called at the conclusion
1161    of the program. MPI_Finalize() is called only if the user had not
1162    called MPI_Init() before calling PetscInitialize().
1163 
1164    Collective on PETSC_COMM_WORLD
1165 
1166    Options Database Keys:
1167 +  -options_view - Calls PetscOptionsView()
1168 .  -options_left - Prints unused options that remain in the database
1169 .  -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
1170 .  -mpidump - Calls PetscMPIDump()
1171 .  -malloc_dump - Calls PetscMallocDump()
1172 .  -malloc_info - Prints total memory usage
1173 -  -malloc_log - Prints summary of memory usage
1174 
1175    Level: beginner
1176 
1177    Note:
1178    See PetscInitialize() for more general runtime options.
1179 
1180 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1181 @*/
1182 PetscErrorCode  PetscFinalize(void)
1183 {
1184   PetscErrorCode ierr;
1185   PetscMPIInt    rank;
1186   PetscInt       nopt;
1187   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1188   PetscBool      flg;
1189 #if defined(PETSC_USE_LOG)
1190   char           mname[PETSC_MAX_PATH_LEN];
1191 #endif
1192 
1193   if (!PetscInitializeCalled) {
1194     printf("PetscInitialize() must be called before PetscFinalize()\n");
1195     return(PETSC_ERR_ARG_WRONGSTATE);
1196   }
1197   PetscFunctionBegin;
1198   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1199 
1200   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1201 #if defined(PETSC_HAVE_ADIOS)
1202   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1203   ierr = adios_finalize(rank);CHKERRQ(ierr);
1204 #endif
1205 #if defined(PETSC_HAVE_ADIOS2)
1206 #endif
1207   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1208   if (flg) {
1209     char  *cits, filename[PETSC_MAX_PATH_LEN];
1210     FILE  *fd = PETSC_STDOUT;
1211 
1212     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
1213     if (filename[0]) {
1214       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1215     }
1216     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1217     cits[0] = 0;
1218     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1219     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1220     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1221     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1222     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1223     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1224     ierr = PetscFree(cits);CHKERRQ(ierr);
1225   }
1226   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1227 
1228 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1229   /* TextBelt is run for testing purposes only, please do not use this feature often */
1230   {
1231     PetscInt nmax = 2;
1232     char     **buffs;
1233     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1234     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1235     if (flg1) {
1236       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1237       if (nmax == 1) {
1238         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1239         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1240         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1241       }
1242       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1243       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1244       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1245     }
1246     ierr = PetscFree(buffs);CHKERRQ(ierr);
1247   }
1248   {
1249     PetscInt nmax = 2;
1250     char     **buffs;
1251     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1252     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1253     if (flg1) {
1254       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1255       if (nmax == 1) {
1256         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1257         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1258         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1259       }
1260       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1261       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1262       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1263     }
1264     ierr = PetscFree(buffs);CHKERRQ(ierr);
1265   }
1266 #endif
1267   /*
1268     It should be safe to cancel the options monitors, since we don't expect to be setting options
1269     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1270     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1271   */
1272   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1273 
1274 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1275   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1276 #endif
1277 
1278 
1279 #if defined(PETSC_HAVE_SAWS)
1280   flg = PETSC_FALSE;
1281   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1282   if (flg) {
1283     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1284   }
1285 #endif
1286 
1287 #if defined(PETSC_HAVE_X)
1288   flg1 = PETSC_FALSE;
1289   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1290   if (flg1) {
1291     /*  this is a crude hack, but better than nothing */
1292     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1293   }
1294 #endif
1295 
1296 #if !defined(PETSC_HAVE_THREADSAFETY)
1297   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1298   if (!flg2) {
1299     flg2 = PETSC_FALSE;
1300     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1301   }
1302   if (flg2) {
1303     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1304   }
1305 #endif
1306 
1307 #if defined(PETSC_USE_LOG)
1308   flg1 = PETSC_FALSE;
1309   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1310   if (flg1) {
1311     PetscLogDouble flops = 0;
1312     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1313     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1314   }
1315 #endif
1316 
1317 
1318 #if defined(PETSC_USE_LOG)
1319 #if defined(PETSC_HAVE_MPE)
1320   mname[0] = 0;
1321   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1322   if (flg1) {
1323     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1324     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1325   }
1326 #endif
1327 #endif
1328 
1329   /*
1330      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1331   */
1332   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1333 
1334 #if defined(PETSC_USE_LOG)
1335   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1336   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1337   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1338 
1339   mname[0] = 0;
1340   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1341   if (flg1) {
1342     PetscViewer viewer;
1343     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1344     if (mname[0]) {
1345       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1346       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1347       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1348     } else {
1349       viewer = PETSC_VIEWER_STDOUT_WORLD;
1350       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1351       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1352       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1353     }
1354   }
1355 
1356   /*
1357      Free any objects created by the last block of code.
1358   */
1359   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1360 
1361   mname[0] = 0;
1362   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1363   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1364   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1365 #endif
1366 
1367   ierr = PetscStackDestroy();CHKERRQ(ierr);
1368 
1369   flg1 = PETSC_FALSE;
1370   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1371   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1372   flg1 = PETSC_FALSE;
1373   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1374   if (flg1) {
1375     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1376   }
1377   flg1 = PETSC_FALSE;
1378   flg2 = PETSC_FALSE;
1379   /* preemptive call to avoid listing this option in options table as unused */
1380   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1381   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1382   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1383 
1384   if (flg2) {
1385     PetscViewer viewer;
1386     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1387     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1388     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1389     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1390   }
1391 
1392   /* to prevent PETSc -options_left from warning */
1393   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1394   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1395 
1396   flg3 = PETSC_FALSE; /* default value is required */
1397   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1398   ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1399   if (flg3) {
1400     if (!flg2) { /* have not yet printed the options */
1401       PetscViewer viewer;
1402       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1403       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1404       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1405       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1406     }
1407     if (!nopt) {
1408       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1409     } else if (nopt == 1) {
1410       ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1411     } else {
1412       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1413     }
1414   }
1415 #if defined(PETSC_USE_DEBUG)
1416   if (nopt && !flg3 && !flg1) {
1417     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1418     ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1419     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1420   } else if (nopt && flg3) {
1421 #else
1422   if (nopt && flg3) {
1423 #endif
1424     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1425   }
1426 
1427 #if defined(PETSC_HAVE_SAWS)
1428   if (!PetscGlobalRank) {
1429     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1430     PetscStackCallSAWs(SAWs_Finalize,());
1431   }
1432 #endif
1433 
1434 #if defined(PETSC_USE_LOG)
1435   /*
1436        List all objects the user may have forgot to free
1437   */
1438   if (PetscObjectsLog) {
1439     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1440     if (flg1) {
1441       MPI_Comm local_comm;
1442       char     string[64];
1443 
1444       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1445       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1446       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1447       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1448       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1449       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1450     }
1451   }
1452 #endif
1453 
1454 #if defined(PETSC_USE_LOG)
1455   PetscObjectsCounts    = 0;
1456   PetscObjectsMaxCounts = 0;
1457   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1458 #endif
1459 
1460   /*
1461      Destroy any packages that registered a finalize
1462   */
1463   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1464 
1465 #if defined(PETSC_USE_LOG)
1466   ierr = PetscLogFinalize();CHKERRQ(ierr);
1467 #endif
1468 
1469   /*
1470      Print PetscFunctionLists that have not been properly freed
1471 
1472   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1473   */
1474 
1475   if (petsc_history) {
1476     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1477     petsc_history = 0;
1478   }
1479   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1480 
1481   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1482 
1483 #if !defined(PETSC_HAVE_THREADSAFETY)
1484   {
1485     char fname[PETSC_MAX_PATH_LEN];
1486     FILE *fd;
1487     int  err;
1488 
1489     fname[0] = 0;
1490 
1491     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1492     flg2 = PETSC_FALSE;
1493     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1494 #if defined(PETSC_USE_DEBUG)
1495     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1496 #else
1497     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1498 #endif
1499     if (flg1 && fname[0]) {
1500       char sname[PETSC_MAX_PATH_LEN];
1501 
1502       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
1503       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1504       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1505       err  = fclose(fd);
1506       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1507     } else if (flg1 || flg2) {
1508       MPI_Comm local_comm;
1509 
1510       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1511       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1512       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1513       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1514       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1515     }
1516   }
1517 
1518   {
1519     char fname[PETSC_MAX_PATH_LEN];
1520     FILE *fd = NULL;
1521 
1522     fname[0] = 0;
1523 
1524     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1525     ierr = PetscOptionsHasName(NULL,NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1526     if (flg1 && fname[0]) {
1527       int err;
1528 
1529       if (!rank) {
1530         fd = fopen(fname,"w");
1531         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1532       }
1533       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1534       if (fd) {
1535         err = fclose(fd);
1536         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1537       }
1538     } else if (flg1 || flg2) {
1539       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1540     }
1541   }
1542 #endif
1543 
1544   /*
1545      Close any open dynamic libraries
1546   */
1547   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1548 
1549   /* Can be destroyed only after all the options are used */
1550   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1551 
1552   PetscGlobalArgc = 0;
1553   PetscGlobalArgs = 0;
1554 
1555   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1556 
1557   /*
1558      Destroy any known inner MPI_Comm's and attributes pointing to them
1559      Note this will not destroy any new communicators the user has created.
1560 
1561      If all PETSc objects were not destroyed those left over objects will have hanging references to
1562      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1563  */
1564   {
1565     PetscCommCounter *counter;
1566     PetscMPIInt      flg;
1567     MPI_Comm         icomm;
1568     union {MPI_Comm comm; void *ptr;} ucomm;
1569     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1570     if (flg) {
1571       icomm = ucomm.comm;
1572       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1573       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1574 
1575       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1576       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1577       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1578     }
1579     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1580     if (flg) {
1581       icomm = ucomm.comm;
1582       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1583       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1584 
1585       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1586       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1587       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1588     }
1589   }
1590 
1591   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1592   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1593   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1594   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1595 
1596   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1597   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1598   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1599   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1600 
1601   if (PetscBeganMPI) {
1602 #if defined(PETSC_HAVE_MPI_FINALIZED)
1603     PetscMPIInt flag;
1604     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1605     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1606 #endif
1607     ierr = MPI_Finalize();CHKERRQ(ierr);
1608   }
1609 /*
1610 
1611      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1612    the communicator has some outstanding requests on it. Specifically if the
1613    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1614    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1615    is never freed as it should be. Thus one may obtain messages of the form
1616    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1617    memory was not freed.
1618 
1619 */
1620   ierr = PetscMallocClear();CHKERRQ(ierr);
1621 
1622   PetscInitializeCalled = PETSC_FALSE;
1623   PetscFinalizeCalled   = PETSC_TRUE;
1624   PetscFunctionReturn(0);
1625 }
1626 
1627 #if defined(PETSC_MISSING_LAPACK_lsame_)
1628 PETSC_EXTERN int lsame_(char *a,char *b)
1629 {
1630   if (*a == *b) return 1;
1631   if (*a + 32 == *b) return 1;
1632   if (*a - 32 == *b) return 1;
1633   return 0;
1634 }
1635 #endif
1636 
1637 #if defined(PETSC_MISSING_LAPACK_lsame)
1638 PETSC_EXTERN int lsame(char *a,char *b)
1639 {
1640   if (*a == *b) return 1;
1641   if (*a + 32 == *b) return 1;
1642   if (*a - 32 == *b) return 1;
1643   return 0;
1644 }
1645 #endif
1646