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