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