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