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