xref: /petsc/src/sys/objects/pinit.c (revision 5717109557508c8fc7c2a09b4eaa86bd29417f1e)
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 ~username/.petscrc and .petscrc use NULL to not check for
667           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
668 -  help - [optional] Help message to print, use NULL for no message
669 
670    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
671    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
672    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
673    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
674    if different subcommunicators of the job are doing different things with PETSc.
675 
676    Options Database Keys:
677 +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
678 .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
679 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
680 .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
681 .  -on_error_abort - calls abort() when error detected (no traceback)
682 .  -on_error_mpiabort - calls MPI_abort() when error detected
683 .  -error_output_stderr - prints error messages to stderr instead of the default stdout
684 .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
685 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
686 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
687 .  -stop_for_debugger - Print message on how to attach debugger manually to
688                         process and wait (-debugger_pause) seconds for attachment
689 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
690 .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
691 .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
692 .  -malloc_dump - prints a list of all unfreed memory at the end of the run
693 .  -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
694 .  -malloc_view - show a list of all allocated memory during PetscFinalize()
695 .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
696 .  -fp_trap - Stops on floating point exceptions
697 .  -no_signal_handler - Indicates not to trap error signals
698 .  -shared_tmp - indicates /tmp directory is shared by all processors
699 .  -not_shared_tmp - each processor has own /tmp
700 .  -tmp - alternative name of /tmp directory
701 .  -get_total_flops - returns total flops done by all processors
702 -  -memory_view - Print memory usage at end of run
703 
704    Options Database Keys for Profiling:
705    See Users-Manual: ch_profiling for details.
706 +  -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo().
707 .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
708         however it slows things down and gives a distorted view of the overall runtime.
709 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
710         hangs without running in the debugger).  See PetscLogTraceBegin().
711 .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
712 .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
713 .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
714         summary is written to the file.  See PetscLogView().
715 .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
716 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
717 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
718 .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
719 .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
720 -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code
721 
722     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time
723 
724    Options Database Keys for SAWs:
725 +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
726 .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
727                             this is useful when you are running many jobs that utilize SAWs at the same time
728 .  -saws_log <filename> - save a log of all SAWs communication
729 .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
730 -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files
731 
732    Environmental Variables:
733 +   PETSC_TMP - alternative tmp directory
734 .   PETSC_SHARED_TMP - tmp is shared by all processes
735 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
736 .   PETSC_OPTIONS - a string containing additional options for petsc in the form of command line "-key value" pairs
737 .   PETSC_OPTIONS_YAML - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document
738 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
739 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
740 
741 
742    Level: beginner
743 
744    Notes:
745    If for some reason you must call MPI_Init() separately, call
746    it before PetscInitialize().
747 
748    Fortran Version:
749    In Fortran this routine has the format
750 $       call PetscInitialize(file,ierr)
751 
752 +   ierr - error return code
753 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
754           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
755 
756    Important Fortran Note:
757    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
758    null character string; you CANNOT just use NULL as
759    in the C version. See Users-Manual: ch_fortran for details.
760 
761    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
762    calling PetscInitialize().
763 
764 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
765 
766 @*/
767 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
768 {
769   PetscErrorCode ierr;
770   PetscMPIInt    flag, size;
771   PetscBool      flg = PETSC_TRUE;
772   char           hostname[256];
773 
774   PetscFunctionBegin;
775   if (PetscInitializeCalled) PetscFunctionReturn(0);
776   /*
777       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
778       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
779         MPICH v3.1 (Released Feburary 2014)
780         IBM MPI v2.1 (December 2014)
781         Intel® MPI Library v5.0 (2014)
782         Cray MPT v7.0.0 (June 2014)
783       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
784       listed above and since that time are compatible.
785 
786       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
787       at compile time or runtime. Thus we will need to systematically track the allowed versions
788       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
789       to perform the checking.
790 
791       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).
792 
793       Questions:
794 
795         Should the checks for ABI incompatibility be only on the major version number below?
796         Presumably the output to stderr will be removed before a release.
797   */
798 
799 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
800   {
801     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
802     PetscMPIInt mpilibraryversionlength;
803     ierr = MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
804     /* check for MPICH versions before MPI ABI initiative */
805 #if defined(MPICH_VERSION)
806 #if MPICH_NUMVERSION < 30100000
807     {
808       char *ver,*lf;
809       flg = PETSC_FALSE;
810       ierr = PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
811       if (ver) {
812         ierr = PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
813         if (lf) {
814           *lf = 0;
815           ierr = PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
816         }
817       }
818       if (!flg) {
819         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
820         return PETSC_ERR_MPI_LIB_INCOMP;
821       }
822     }
823 #endif
824     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
825 #elif defined(OMPI_MAJOR_VERSION)
826     {
827       char *ver,bs[32],*bsf;
828       flg = PETSC_FALSE;
829       ierr = PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
830       if (ver) {
831         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
832         ierr = PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
833         if (bsf) flg = PETSC_TRUE;
834       }
835       if (!flg) {
836         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);
837         return PETSC_ERR_MPI_LIB_INCOMP;
838       }
839     }
840 #endif
841   }
842 #endif
843 
844 #if defined(PETSC_HAVE_DLSYM)
845   {
846     PetscInt cnt = 0;
847     /* 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 */
848     if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++;
849     if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++;
850     if (cnt > 1) {
851       fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n");
852       return PETSC_ERR_MPI_LIB_INCOMP;
853     }
854   }
855 #endif
856 
857   /* these must be initialized in a routine, not as a constant declaration*/
858   PETSC_STDOUT = stdout;
859   PETSC_STDERR = stderr;
860 
861   /* on Windows - set printf to default to printing 2 digit exponents */
862 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
863   _set_output_format(_TWO_DIGIT_EXPONENT);
864 #endif
865 
866   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
867 
868   /*
869      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
870      it that it sets args[0] on all processors to be args[0] on the first processor.
871   */
872   if (argc && *argc) {
873     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
874   } else {
875     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
876   }
877 
878   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
879   if (!flag) {
880     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");
881     ierr = PetscPreMPIInit_Private();CHKERRQ(ierr);
882 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
883     {
884       PetscMPIInt provided;
885       ierr = MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided);CHKERRQ(ierr);
886     }
887 #else
888     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
889 #endif
890     PetscBeganMPI = PETSC_TRUE;
891   }
892 
893   if (argc && args) {
894     PetscGlobalArgc = *argc;
895     PetscGlobalArgs = *args;
896   }
897   PetscFinalizeCalled = PETSC_FALSE;
898   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
899   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
900   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
901   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
902 
903   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
904   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
905 
906   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
907     ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
908     ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
909   }
910 
911   /* Done after init due to a bug in MPICH-GM? */
912   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
913 
914   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
915   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
916 
917   MPIU_BOOL = MPI_INT;
918   MPIU_ENUM = MPI_INT;
919   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
920   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
921   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
922 #if defined(PETSC_SIZEOF_LONG_LONG)
923   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
924 #endif
925   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
926 
927   /*
928      Initialized the global complex variable; this is because with
929      shared libraries the constructors for global variables
930      are not called; at least on IRIX.
931   */
932 #if defined(PETSC_HAVE_COMPLEX)
933   {
934 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
935     PetscComplex ic(0.0,1.0);
936     PETSC_i = ic;
937 #else
938     PETSC_i = _Complex_I;
939 #endif
940   }
941 
942 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
943   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
944   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
945   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
946   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
947 #endif
948 #endif /* PETSC_HAVE_COMPLEX */
949 
950   /*
951      Create the PETSc MPI reduction operator that sums of the first
952      half of the entries and maxes the second half.
953   */
954   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
955 
956 #if defined(PETSC_USE_REAL___FLOAT128)
957   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
958   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
959 #if defined(PETSC_HAVE_COMPLEX)
960   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
961   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
962 #endif
963   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
964   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
965 #elif defined(PETSC_USE_REAL___FP16)
966   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
967   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
968   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
969   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
970 #endif
971 
972 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
973   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
974 #endif
975 
976   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
977   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
978 
979 #if defined(PETSC_USE_64BIT_INDICES)
980   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
981   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
982 #endif
983 
984   /*
985      Attributes to be set on PETSc communicators
986   */
987   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
988   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
989   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
990   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
991 
992   /*
993      Build the options database
994   */
995   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
996 
997   /* call a second time so it can look in the options database */
998   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
999 
1000   /*
1001      Check system options and print help
1002   */
1003   ierr = PetscOptionsCheckInitial_Private(help);CHKERRQ(ierr);
1004 
1005   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
1006 
1007 #if defined(PETSC_HAVE_SAWS)
1008   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
1009 #endif
1010 
1011   /*
1012      Load the dynamic libraries (on machines that support them), this registers all
1013      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1014   */
1015   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1016 
1017   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1018   ierr = PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1019   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1020   ierr = PetscInfo1(NULL,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1021 #if defined(PETSC_HAVE_OPENMP)
1022   {
1023     PetscBool omp_view_flag;
1024     char      *threads = getenv("OMP_NUM_THREADS");
1025 
1026    if (threads) {
1027      ierr = PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1028      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1029    } else {
1030 #define NMAX  10000
1031      int          i;
1032       PetscScalar *x;
1033       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1034 #pragma omp parallel for
1035       for (i=0; i<NMAX; i++) {
1036         x[i] = 0.0;
1037         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1038       }
1039       ierr = PetscFree(x);CHKERRQ(ierr);
1040       ierr = PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1041     }
1042     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1043     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);
1044     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1045     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1046     if (flg) {
1047       ierr = PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1048       omp_set_num_threads((int)PetscNumOMPThreads);
1049     }
1050     if (omp_view_flag) {
1051       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr);
1052     }
1053   }
1054 #endif
1055   /* Check the options database for options related to the options database itself */
1056   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1057 
1058 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1059   /*
1060       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1061 
1062       Currently not used because it is not supported by MPICH.
1063   */
1064   if (!PetscBinaryBigEndian()) {
1065     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1066   }
1067 #endif
1068 
1069   /*
1070       Setup building of stack frames for all function calls
1071   */
1072 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1073   ierr = PetscStackCreate();CHKERRQ(ierr);
1074 #endif
1075 
1076 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1077   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1078 #endif
1079 
1080 #if defined(PETSC_HAVE_HWLOC)
1081   {
1082     PetscViewer viewer;
1083     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1084     if (flg) {
1085       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1086       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1087     }
1088   }
1089 #endif
1090 
1091   flg = PETSC_TRUE;
1092   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1093   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1094 
1095 #if defined(PETSC_HAVE_ADIOS)
1096   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1097   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1098   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1099   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1100 #endif
1101 #if defined(PETSC_HAVE_ADIOS2)
1102 #endif
1103 
1104   /*
1105       Set flag that we are completely initialized
1106   */
1107   PetscInitializeCalled = PETSC_TRUE;
1108 
1109   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1110   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1111   PetscFunctionReturn(0);
1112 }
1113 
1114 #if defined(PETSC_USE_LOG)
1115 PETSC_INTERN PetscObject *PetscObjects;
1116 PETSC_INTERN PetscInt    PetscObjectsCounts;
1117 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1118 PETSC_INTERN PetscBool   PetscObjectsLog;
1119 #endif
1120 
1121 /*
1122     Frees all the MPI types and operations that PETSc may have created
1123 */
1124 PetscErrorCode  PetscFreeMPIResources(void)
1125 {
1126   PetscErrorCode ierr;
1127 
1128   PetscFunctionBegin;
1129 #if defined(PETSC_USE_REAL___FLOAT128)
1130   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1131 #if defined(PETSC_HAVE_COMPLEX)
1132   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1133 #endif
1134   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1135   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1136 #elif defined(PETSC_USE_REAL___FP16)
1137   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1138   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1139   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1140 #endif
1141 
1142 #if defined(PETSC_HAVE_COMPLEX)
1143 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1144   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1145   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1146 #endif
1147 #endif
1148 
1149 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1150   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1151 #endif
1152 
1153   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1154 #if defined(PETSC_USE_64BIT_INDICES)
1155   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1156 #endif
1157   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1158   PetscFunctionReturn(0);
1159 }
1160 
1161 /*@C
1162    PetscFinalize - Checks for options to be called at the conclusion
1163    of the program. MPI_Finalize() is called only if the user had not
1164    called MPI_Init() before calling PetscInitialize().
1165 
1166    Collective on PETSC_COMM_WORLD
1167 
1168    Options Database Keys:
1169 +  -options_view - Calls PetscOptionsView()
1170 .  -options_left - Prints unused options that remain in the database
1171 .  -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
1172 .  -mpidump - Calls PetscMPIDump()
1173 .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1174 .  -malloc_info - Prints total memory usage
1175 -  -malloc_view <optional filename> - Prints list of all memory allocated and where
1176 
1177    Level: beginner
1178 
1179    Note:
1180    See PetscInitialize() for more general runtime options.
1181 
1182 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1183 @*/
1184 PetscErrorCode  PetscFinalize(void)
1185 {
1186   PetscErrorCode ierr;
1187   PetscMPIInt    rank;
1188   PetscInt       nopt;
1189   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1190   PetscBool      flg;
1191 #if defined(PETSC_USE_LOG)
1192   char           mname[PETSC_MAX_PATH_LEN];
1193 #endif
1194 
1195   if (!PetscInitializeCalled) {
1196     printf("PetscInitialize() must be called before PetscFinalize()\n");
1197     return(PETSC_ERR_ARG_WRONGSTATE);
1198   }
1199   PetscFunctionBegin;
1200   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1201 
1202   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1203 #if defined(PETSC_HAVE_ADIOS)
1204   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1205   ierr = adios_finalize(rank);CHKERRQ(ierr);
1206 #endif
1207 #if defined(PETSC_HAVE_ADIOS2)
1208 #endif
1209   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1210   if (flg) {
1211     char  *cits, filename[PETSC_MAX_PATH_LEN];
1212     FILE  *fd = PETSC_STDOUT;
1213 
1214     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL);CHKERRQ(ierr);
1215     if (filename[0]) {
1216       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1217     }
1218     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1219     cits[0] = 0;
1220     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1221     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1222     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1223     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1224     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1225     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1226     ierr = PetscFree(cits);CHKERRQ(ierr);
1227   }
1228   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1229 
1230 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1231   /* TextBelt is run for testing purposes only, please do not use this feature often */
1232   {
1233     PetscInt nmax = 2;
1234     char     **buffs;
1235     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1236     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1237     if (flg1) {
1238       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1239       if (nmax == 1) {
1240         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1241         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1242         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1243       }
1244       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1245       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1246       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1247     }
1248     ierr = PetscFree(buffs);CHKERRQ(ierr);
1249   }
1250   {
1251     PetscInt nmax = 2;
1252     char     **buffs;
1253     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1254     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1255     if (flg1) {
1256       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1257       if (nmax == 1) {
1258         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1259         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1260         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1261       }
1262       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1263       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1264       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1265     }
1266     ierr = PetscFree(buffs);CHKERRQ(ierr);
1267   }
1268 #endif
1269   /*
1270     It should be safe to cancel the options monitors, since we don't expect to be setting options
1271     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1272     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1273   */
1274   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1275 
1276 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1277   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1278 #endif
1279 
1280 
1281 #if defined(PETSC_HAVE_SAWS)
1282   flg = PETSC_FALSE;
1283   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1284   if (flg) {
1285     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1286   }
1287 #endif
1288 
1289 #if defined(PETSC_HAVE_X)
1290   flg1 = PETSC_FALSE;
1291   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1292   if (flg1) {
1293     /*  this is a crude hack, but better than nothing */
1294     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1295   }
1296 #endif
1297 
1298 #if !defined(PETSC_HAVE_THREADSAFETY)
1299   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1300   if (!flg2) {
1301     flg2 = PETSC_FALSE;
1302     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1303   }
1304   if (flg2) {
1305     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1306   }
1307 #endif
1308 
1309 #if defined(PETSC_USE_LOG)
1310   flg1 = PETSC_FALSE;
1311   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1312   if (flg1) {
1313     PetscLogDouble flops = 0;
1314     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1315     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1316   }
1317 #endif
1318 
1319 
1320 #if defined(PETSC_USE_LOG)
1321 #if defined(PETSC_HAVE_MPE)
1322   mname[0] = 0;
1323   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1324   if (flg1) {
1325     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1326     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1327   }
1328 #endif
1329 #endif
1330 
1331   /*
1332      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1333   */
1334   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1335 
1336 #if defined(PETSC_USE_LOG)
1337   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1338   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1339   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1340 
1341   mname[0] = 0;
1342   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1343   if (flg1) {
1344     PetscViewer viewer;
1345     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1346     if (mname[0]) {
1347       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1348       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1349       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1350     } else {
1351       viewer = PETSC_VIEWER_STDOUT_WORLD;
1352       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1353       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1354       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1355     }
1356   }
1357 
1358   /*
1359      Free any objects created by the last block of code.
1360   */
1361   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1362 
1363   mname[0] = 0;
1364   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1365   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2);CHKERRQ(ierr);
1366   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1367 #endif
1368 
1369   ierr = PetscStackDestroy();CHKERRQ(ierr);
1370 
1371   flg1 = PETSC_FALSE;
1372   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1373   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1374   flg1 = PETSC_FALSE;
1375   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1376   if (flg1) {
1377     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1378   }
1379   flg1 = PETSC_FALSE;
1380   flg2 = PETSC_FALSE;
1381   /* preemptive call to avoid listing this option in options table as unused */
1382   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1383   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1384   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1385 
1386   if (flg2) {
1387     PetscViewer viewer;
1388     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1389     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1390     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1391     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1392   }
1393 
1394   /* to prevent PETSc -options_left from warning */
1395   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1396   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1397 
1398   flg3 = PETSC_FALSE; /* default value is required */
1399   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1400   if (PetscDefined(USE_DEBUG) && !flg1) flg3 = PETSC_TRUE;
1401   if (flg3) {
1402     if (!flg2 && flg1) { /* have not yet printed the options */
1403       PetscViewer viewer;
1404       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1405       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1406       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1407       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1408     }
1409     ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1410     if (nopt) {
1411       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1412       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1413       if (nopt == 1) {
1414         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1415       } else {
1416         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1417       }
1418     } else if (flg3 && flg1) {
1419       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1420     }
1421     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1422   }
1423 
1424 #if defined(PETSC_HAVE_SAWS)
1425   if (!PetscGlobalRank) {
1426     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1427     PetscStackCallSAWs(SAWs_Finalize,());
1428   }
1429 #endif
1430 
1431 #if defined(PETSC_USE_LOG)
1432   /*
1433        List all objects the user may have forgot to free
1434   */
1435   if (PetscObjectsLog) {
1436     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1437     if (flg1) {
1438       MPI_Comm local_comm;
1439       char     string[64];
1440 
1441       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL);CHKERRQ(ierr);
1442       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1443       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1444       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1445       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1446       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1447     }
1448   }
1449 #endif
1450 
1451 #if defined(PETSC_USE_LOG)
1452   PetscObjectsCounts    = 0;
1453   PetscObjectsMaxCounts = 0;
1454   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1455 #endif
1456 
1457   /*
1458      Destroy any packages that registered a finalize
1459   */
1460   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1461 
1462 #if defined(PETSC_USE_LOG)
1463   ierr = PetscLogFinalize();CHKERRQ(ierr);
1464 #endif
1465 
1466   /*
1467      Print PetscFunctionLists that have not been properly freed
1468 
1469   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1470   */
1471 
1472   if (petsc_history) {
1473     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1474     petsc_history = NULL;
1475   }
1476   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1477   ierr = PetscInfoDestroy();CHKERRQ(ierr);
1478 
1479 #if !defined(PETSC_HAVE_THREADSAFETY)
1480   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1481     char fname[PETSC_MAX_PATH_LEN];
1482     char sname[PETSC_MAX_PATH_LEN];
1483     FILE *fd;
1484     int  err;
1485 
1486     flg2 = PETSC_FALSE;
1487     flg3 = PETSC_FALSE;
1488     if (PetscDefined(USE_DEBUG)) {ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);}
1489     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);CHKERRQ(ierr);
1490     fname[0] = 0;
1491     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1492     if (flg1 && fname[0]) {
1493 
1494       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
1495       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1496       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1497       err  = fclose(fd);
1498       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1499     } else if (flg1 || flg2 || flg3) {
1500       MPI_Comm local_comm;
1501 
1502       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1503       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1504       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1505       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1506       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1507     }
1508     fname[0] = 0;
1509     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1510     if (flg1 && fname[0]) {
1511 
1512       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
1513       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1514       ierr = PetscMallocView(fd);CHKERRQ(ierr);
1515       err  = fclose(fd);
1516       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1517     } else if (flg1) {
1518       MPI_Comm local_comm;
1519 
1520       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1521       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1522       ierr = PetscMallocView(stdout);CHKERRQ(ierr);
1523       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1524       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1525     }
1526   }
1527 #endif
1528 
1529   /*
1530      Close any open dynamic libraries
1531   */
1532   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1533 
1534   /* Can be destroyed only after all the options are used */
1535   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1536 
1537   PetscGlobalArgc = 0;
1538   PetscGlobalArgs = NULL;
1539 
1540   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1541 
1542   /*
1543      Destroy any known inner MPI_Comm's and attributes pointing to them
1544      Note this will not destroy any new communicators the user has created.
1545 
1546      If all PETSc objects were not destroyed those left over objects will have hanging references to
1547      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1548  */
1549   {
1550     PetscCommCounter *counter;
1551     PetscMPIInt      flg;
1552     MPI_Comm         icomm;
1553     union {MPI_Comm comm; void *ptr;} ucomm;
1554     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1555     if (flg) {
1556       icomm = ucomm.comm;
1557       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1558       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1559 
1560       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1561       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1562       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1563     }
1564     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1565     if (flg) {
1566       icomm = ucomm.comm;
1567       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1568       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1569 
1570       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1571       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1572       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1573     }
1574   }
1575 
1576   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1577   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1578   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1579   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1580 
1581   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1582   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1583   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1584   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1585 
1586   if (PetscBeganMPI) {
1587 #if defined(PETSC_HAVE_MPI_FINALIZED)
1588     PetscMPIInt flag;
1589     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1590     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1591 #endif
1592     ierr = MPI_Finalize();CHKERRQ(ierr);
1593   }
1594 /*
1595 
1596      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1597    the communicator has some outstanding requests on it. Specifically if the
1598    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1599    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1600    is never freed as it should be. Thus one may obtain messages of the form
1601    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1602    memory was not freed.
1603 
1604 */
1605   ierr = PetscMallocClear();CHKERRQ(ierr);
1606 
1607   PetscInitializeCalled = PETSC_FALSE;
1608   PetscFinalizeCalled   = PETSC_TRUE;
1609   PetscFunctionReturn(0);
1610 }
1611 
1612 #if defined(PETSC_MISSING_LAPACK_lsame_)
1613 PETSC_EXTERN int lsame_(char *a,char *b)
1614 {
1615   if (*a == *b) return 1;
1616   if (*a + 32 == *b) return 1;
1617   if (*a - 32 == *b) return 1;
1618   return 0;
1619 }
1620 #endif
1621 
1622 #if defined(PETSC_MISSING_LAPACK_lsame)
1623 PETSC_EXTERN int lsame(char *a,char *b)
1624 {
1625   if (*a == *b) return 1;
1626   if (*a + 32 == *b) return 1;
1627   if (*a - 32 == *b) return 1;
1628   return 0;
1629 }
1630 #endif
1631