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