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