xref: /petsc/src/sys/objects/pinit.c (revision 8ad20175d88643dafb91dc893b19fc7d09cd0ff4)
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   /* CHKERRQ can be used from now */
862   PetscErrorHandlingInitialized = PETSC_TRUE;
863 
864   /* on Windows - set printf to default to printing 2 digit exponents */
865 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
866   _set_output_format(_TWO_DIGIT_EXPONENT);
867 #endif
868 
869   ierr = PetscOptionsCreateDefault();CHKERRQ(ierr);
870 
871   /*
872      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
873      it that it sets args[0] on all processors to be args[0] on the first processor.
874   */
875   if (argc && *argc) {
876     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
877   } else {
878     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
879   }
880 
881   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
882   if (!flag) {
883     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");
884     ierr = PetscPreMPIInit_Private();CHKERRQ(ierr);
885 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
886     {
887       PetscMPIInt provided;
888       ierr = MPI_Init_thread(argc,args,PETSC_MPI_THREAD_REQUIRED,&provided);CHKERRQ(ierr);
889     }
890 #else
891     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
892 #endif
893     PetscBeganMPI = PETSC_TRUE;
894   }
895 
896   if (argc && args) {
897     PetscGlobalArgc = *argc;
898     PetscGlobalArgs = *args;
899   }
900   PetscFinalizeCalled = PETSC_FALSE;
901   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
902   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
903   ierr = PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
904   ierr = PetscSpinlockCreate(&PetscCommSpinLock);CHKERRQ(ierr);
905 
906   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
907   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
908 
909   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
910     ierr = MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);CHKERRQ(ierr);
911     ierr = MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);CHKERRQ(ierr);
912   }
913 
914   /* Done after init due to a bug in MPICH-GM? */
915   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
916 
917   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
918   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
919 
920   MPIU_BOOL = MPI_INT;
921   MPIU_ENUM = MPI_INT;
922   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
923   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
924   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
925 #if defined(PETSC_SIZEOF_LONG_LONG)
926   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
927 #endif
928   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}
929 
930   /*
931      Initialized the global complex variable; this is because with
932      shared libraries the constructors for global variables
933      are not called; at least on IRIX.
934   */
935 #if defined(PETSC_HAVE_COMPLEX)
936   {
937 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
938     PetscComplex ic(0.0,1.0);
939     PETSC_i = ic;
940 #else
941     PETSC_i = _Complex_I;
942 #endif
943   }
944 
945 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
946   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
947   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
948   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
949   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
950 #endif
951 #endif /* PETSC_HAVE_COMPLEX */
952 
953   /*
954      Create the PETSc MPI reduction operator that sums of the first
955      half of the entries and maxes the second half.
956   */
957   ierr = MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);CHKERRQ(ierr);
958 
959 #if defined(PETSC_USE_REAL___FLOAT128)
960   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
961   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
962 #if defined(PETSC_HAVE_COMPLEX)
963   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
964   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
965 #endif
966   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
967   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
968 #elif defined(PETSC_USE_REAL___FP16)
969   ierr = MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);CHKERRQ(ierr);
970   ierr = MPI_Type_commit(&MPIU___FP16);CHKERRQ(ierr);
971   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
972   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
973 #endif
974 
975 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
976   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
977 #endif
978 
979   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
980   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
981 
982 #if defined(PETSC_USE_64BIT_INDICES)
983   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
984   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
985 #endif
986 
987   /*
988      Attributes to be set on PETSc communicators
989   */
990   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
991   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
992   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
993   ierr = MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);CHKERRQ(ierr);
994 
995   /*
996      Build the options database
997   */
998   ierr = PetscOptionsInsert(NULL,argc,args,file);CHKERRQ(ierr);
999 
1000   /* call a second time so it can look in the options database */
1001   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
1002 
1003   /*
1004      Check system options and print help
1005   */
1006   ierr = PetscOptionsCheckInitial_Private(help);CHKERRQ(ierr);
1007 
1008   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
1009 
1010 #if defined(PETSC_HAVE_SAWS)
1011   ierr = PetscInitializeSAWs(help);CHKERRQ(ierr);
1012 #endif
1013 
1014   /*
1015      Load the dynamic libraries (on machines that support them), this registers all
1016      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
1017   */
1018   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
1019 
1020   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
1021   ierr = PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
1022   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
1023   ierr = PetscInfo1(NULL,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
1024 #if defined(PETSC_HAVE_OPENMP)
1025   {
1026     PetscBool omp_view_flag;
1027     char      *threads = getenv("OMP_NUM_THREADS");
1028 
1029    if (threads) {
1030      ierr = PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);CHKERRQ(ierr);
1031      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
1032    } else {
1033 #define NMAX  10000
1034      int          i;
1035       PetscScalar *x;
1036       ierr = PetscMalloc1(NMAX,&x);CHKERRQ(ierr);
1037 #pragma omp parallel for
1038       for (i=0; i<NMAX; i++) {
1039         x[i] = 0.0;
1040         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
1041       }
1042       ierr = PetscFree(x);CHKERRQ(ierr);
1043       ierr = PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1044     }
1045     ierr = PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");CHKERRQ(ierr);
1046     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);
1047     ierr = PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);CHKERRQ(ierr);
1048     ierr = PetscOptionsEnd();CHKERRQ(ierr);
1049     if (flg) {
1050       ierr = PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);CHKERRQ(ierr);
1051       omp_set_num_threads((int)PetscNumOMPThreads);
1052     }
1053     if (omp_view_flag) {
1054       ierr = PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);CHKERRQ(ierr);
1055     }
1056   }
1057 #endif
1058   /* Check the options database for options related to the options database itself */
1059   ierr = PetscOptionsSetFromOptions(NULL);CHKERRQ(ierr);
1060 
1061 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
1062   /*
1063       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
1064 
1065       Currently not used because it is not supported by MPICH.
1066   */
1067   if (!PetscBinaryBigEndian()) {
1068     ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
1069   }
1070 #endif
1071 
1072   /*
1073       Setup building of stack frames for all function calls
1074   */
1075 #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
1076   ierr = PetscStackCreate();CHKERRQ(ierr);
1077 #endif
1078 
1079 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1080   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
1081 #endif
1082 
1083 #if defined(PETSC_HAVE_HWLOC)
1084   {
1085     PetscViewer viewer;
1086     ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);CHKERRQ(ierr);
1087     if (flg) {
1088       ierr = PetscProcessPlacementView(viewer);CHKERRQ(ierr);
1089       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1090     }
1091   }
1092 #endif
1093 
1094   flg = PETSC_TRUE;
1095   ierr = PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);CHKERRQ(ierr);
1096   if (!flg) {ierr = PetscOptionsPushGetViewerOff(PETSC_TRUE); CHKERRQ(ierr);}
1097 
1098 #if defined(PETSC_HAVE_ADIOS)
1099   ierr = adios_init_noxml(PETSC_COMM_WORLD);CHKERRQ(ierr);
1100   ierr = adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);CHKERRQ(ierr);
1101   ierr = adios_select_method(Petsc_adios_group,"MPI","","");CHKERRQ(ierr);
1102   ierr = adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");CHKERRQ(ierr);
1103 #endif
1104 #if defined(PETSC_HAVE_ADIOS2)
1105 #endif
1106 
1107   /*
1108       Set flag that we are completely initialized
1109   */
1110   PetscInitializeCalled = PETSC_TRUE;
1111 
1112   ierr = PetscOptionsHasName(NULL,NULL,"-python",&flg);CHKERRQ(ierr);
1113   if (flg) {ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);}
1114   PetscFunctionReturn(0);
1115 }
1116 
1117 #if defined(PETSC_USE_LOG)
1118 PETSC_INTERN PetscObject *PetscObjects;
1119 PETSC_INTERN PetscInt    PetscObjectsCounts;
1120 PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
1121 PETSC_INTERN PetscBool   PetscObjectsLog;
1122 #endif
1123 
1124 /*
1125     Frees all the MPI types and operations that PETSc may have created
1126 */
1127 PetscErrorCode  PetscFreeMPIResources(void)
1128 {
1129   PetscErrorCode ierr;
1130 
1131   PetscFunctionBegin;
1132 #if defined(PETSC_USE_REAL___FLOAT128)
1133   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1134 #if defined(PETSC_HAVE_COMPLEX)
1135   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1136 #endif
1137   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1138   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1139 #elif defined(PETSC_USE_REAL___FP16)
1140   ierr = MPI_Type_free(&MPIU___FP16);CHKERRQ(ierr);
1141   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1142   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1143 #endif
1144 
1145 #if defined(PETSC_HAVE_COMPLEX)
1146 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1147   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1148   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1149 #endif
1150 #endif
1151 
1152 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
1153   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1154 #endif
1155 
1156   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1157 #if defined(PETSC_USE_64BIT_INDICES)
1158   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1159 #endif
1160   ierr = MPI_Op_free(&MPIU_MAXSUM_OP);CHKERRQ(ierr);
1161   PetscFunctionReturn(0);
1162 }
1163 
1164 /*@C
1165    PetscFinalize - Checks for options to be called at the conclusion
1166    of the program. MPI_Finalize() is called only if the user had not
1167    called MPI_Init() before calling PetscInitialize().
1168 
1169    Collective on PETSC_COMM_WORLD
1170 
1171    Options Database Keys:
1172 +  -options_view - Calls PetscOptionsView()
1173 .  -options_left - Prints unused options that remain in the database
1174 .  -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
1175 .  -mpidump - Calls PetscMPIDump()
1176 .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
1177 .  -malloc_info - Prints total memory usage
1178 -  -malloc_view <optional filename> - Prints list of all memory allocated and where
1179 
1180    Level: beginner
1181 
1182    Note:
1183    See PetscInitialize() for more general runtime options.
1184 
1185 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
1186 @*/
1187 PetscErrorCode  PetscFinalize(void)
1188 {
1189   PetscErrorCode ierr;
1190   PetscMPIInt    rank;
1191   PetscInt       nopt;
1192   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
1193   PetscBool      flg;
1194 #if defined(PETSC_USE_LOG)
1195   char           mname[PETSC_MAX_PATH_LEN];
1196 #endif
1197 
1198   if (!PetscInitializeCalled) {
1199     printf("PetscInitialize() must be called before PetscFinalize()\n");
1200     return(PETSC_ERR_ARG_WRONGSTATE);
1201   }
1202   PetscFunctionBegin;
1203   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
1204 
1205   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1206 #if defined(PETSC_HAVE_ADIOS)
1207   ierr = adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);CHKERRQ(ierr);
1208   ierr = adios_finalize(rank);CHKERRQ(ierr);
1209 #endif
1210 #if defined(PETSC_HAVE_ADIOS2)
1211 #endif
1212   ierr = PetscOptionsHasName(NULL,NULL,"-citations",&flg);CHKERRQ(ierr);
1213   if (flg) {
1214     char  *cits, filename[PETSC_MAX_PATH_LEN];
1215     FILE  *fd = PETSC_STDOUT;
1216 
1217     ierr = PetscOptionsGetString(NULL,NULL,"-citations",filename,sizeof(filename),NULL);CHKERRQ(ierr);
1218     if (filename[0]) {
1219       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
1220     }
1221     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
1222     cits[0] = 0;
1223     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
1224     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
1225     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1226     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
1227     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
1228     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
1229     ierr = PetscFree(cits);CHKERRQ(ierr);
1230   }
1231   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
1232 
1233 #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
1234   /* TextBelt is run for testing purposes only, please do not use this feature often */
1235   {
1236     PetscInt nmax = 2;
1237     char     **buffs;
1238     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1239     ierr = PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);CHKERRQ(ierr);
1240     if (flg1) {
1241       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
1242       if (nmax == 1) {
1243         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1244         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1245         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1246       }
1247       ierr = PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1248       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1249       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1250     }
1251     ierr = PetscFree(buffs);CHKERRQ(ierr);
1252   }
1253   {
1254     PetscInt nmax = 2;
1255     char     **buffs;
1256     ierr = PetscMalloc1(2,&buffs);CHKERRQ(ierr);
1257     ierr = PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);CHKERRQ(ierr);
1258     if (flg1) {
1259       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
1260       if (nmax == 1) {
1261         ierr = PetscMalloc1(128,&buffs[1]);CHKERRQ(ierr);
1262         ierr = PetscGetProgramName(buffs[1],32);CHKERRQ(ierr);
1263         ierr = PetscStrcat(buffs[1]," has completed");CHKERRQ(ierr);
1264       }
1265       ierr = PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);CHKERRQ(ierr);
1266       ierr = PetscFree(buffs[0]);CHKERRQ(ierr);
1267       ierr = PetscFree(buffs[1]);CHKERRQ(ierr);
1268     }
1269     ierr = PetscFree(buffs);CHKERRQ(ierr);
1270   }
1271 #endif
1272   /*
1273     It should be safe to cancel the options monitors, since we don't expect to be setting options
1274     here (at least that are worth monitoring).  Monitors ought to be released so that they release
1275     whatever memory was allocated there before -malloc_dump reports unfreed memory.
1276   */
1277   ierr = PetscOptionsMonitorCancel();CHKERRQ(ierr);
1278 
1279 #if defined(PETSC_SERIALIZE_FUNCTIONS)
1280   ierr = PetscFPTDestroy();CHKERRQ(ierr);
1281 #endif
1282 
1283 
1284 #if defined(PETSC_HAVE_SAWS)
1285   flg = PETSC_FALSE;
1286   ierr = PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);CHKERRQ(ierr);
1287   if (flg) {
1288     ierr = PetscOptionsSAWsDestroy();CHKERRQ(ierr);
1289   }
1290 #endif
1291 
1292 #if defined(PETSC_HAVE_X)
1293   flg1 = PETSC_FALSE;
1294   ierr = PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);CHKERRQ(ierr);
1295   if (flg1) {
1296     /*  this is a crude hack, but better than nothing */
1297     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);CHKERRQ(ierr);
1298   }
1299 #endif
1300 
1301 #if !defined(PETSC_HAVE_THREADSAFETY)
1302   ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
1303   if (!flg2) {
1304     flg2 = PETSC_FALSE;
1305     ierr = PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);CHKERRQ(ierr);
1306   }
1307   if (flg2) {
1308     ierr = PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
1309   }
1310 #endif
1311 
1312 #if defined(PETSC_USE_LOG)
1313   flg1 = PETSC_FALSE;
1314   ierr = PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
1315   if (flg1) {
1316     PetscLogDouble flops = 0;
1317     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
1318     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
1319   }
1320 #endif
1321 
1322 
1323 #if defined(PETSC_USE_LOG)
1324 #if defined(PETSC_HAVE_MPE)
1325   mname[0] = 0;
1326   ierr = PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1327   if (flg1) {
1328     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1329     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1330   }
1331 #endif
1332 #endif
1333 
1334   /*
1335      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1336   */
1337   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1338 
1339 #if defined(PETSC_USE_LOG)
1340   ierr = PetscOptionsPushGetViewerOff(PETSC_FALSE);CHKERRQ(ierr);
1341   ierr = PetscLogViewFromOptions();CHKERRQ(ierr);
1342   ierr = PetscOptionsPopGetViewerOff();CHKERRQ(ierr);
1343 
1344   mname[0] = 0;
1345   ierr = PetscOptionsGetString(NULL,NULL,"-log_summary",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1346   if (flg1) {
1347     PetscViewer viewer;
1348     ierr = (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");CHKERRQ(ierr);
1349     if (mname[0]) {
1350       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1351       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1352       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1353     } else {
1354       viewer = PETSC_VIEWER_STDOUT_WORLD;
1355       ierr   = PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);CHKERRQ(ierr);
1356       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1357       ierr   = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1358     }
1359   }
1360 
1361   /*
1362      Free any objects created by the last block of code.
1363   */
1364   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1365 
1366   mname[0] = 0;
1367   ierr = PetscOptionsGetString(NULL,NULL,"-log_all",mname,sizeof(mname),&flg1);CHKERRQ(ierr);
1368   ierr = PetscOptionsGetString(NULL,NULL,"-log",mname,sizeof(mname),&flg2);CHKERRQ(ierr);
1369   if (flg1 || flg2) {ierr = PetscLogDump(mname);CHKERRQ(ierr);}
1370 #endif
1371 
1372   ierr = PetscStackDestroy();CHKERRQ(ierr);
1373 
1374   flg1 = PETSC_FALSE;
1375   ierr = PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1376   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1377   flg1 = PETSC_FALSE;
1378   ierr = PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1379   if (flg1) {
1380     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1381   }
1382   flg1 = PETSC_FALSE;
1383   flg2 = PETSC_FALSE;
1384   /* preemptive call to avoid listing this option in options table as unused */
1385   ierr = PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1386   ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1387   ierr = PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);CHKERRQ(ierr);
1388 
1389   if (flg2) {
1390     PetscViewer viewer;
1391     ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1392     ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1393     ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1394     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1395   }
1396 
1397   /* to prevent PETSc -options_left from warning */
1398   ierr = PetscOptionsHasName(NULL,NULL,"-nox",&flg1);CHKERRQ(ierr);
1399   ierr = PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1400 
1401   flg3 = PETSC_FALSE; /* default value is required */
1402   ierr = PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1403   if (PetscDefined(USE_DEBUG) && !flg1) flg3 = PETSC_TRUE;
1404   if (flg3) {
1405     if (!flg2 && flg1) { /* have not yet printed the options */
1406       PetscViewer viewer;
1407       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1408       ierr = PetscViewerSetType(viewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1409       ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
1410       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1411     }
1412     ierr = PetscOptionsAllUsed(NULL,&nopt);CHKERRQ(ierr);
1413     if (nopt) {
1414       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1415       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1416       if (nopt == 1) {
1417         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1418       } else {
1419         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1420       }
1421     } else if (flg3 && flg1) {
1422       ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1423     }
1424     ierr = PetscOptionsLeft(NULL);CHKERRQ(ierr);
1425   }
1426 
1427 #if defined(PETSC_HAVE_SAWS)
1428   if (!PetscGlobalRank) {
1429     ierr = PetscStackSAWsViewOff();CHKERRQ(ierr);
1430     PetscStackCallSAWs(SAWs_Finalize,());
1431   }
1432 #endif
1433 
1434 #if defined(PETSC_USE_LOG)
1435   /*
1436        List all objects the user may have forgot to free
1437   */
1438   if (PetscObjectsLog) {
1439     ierr = PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1440     if (flg1) {
1441       MPI_Comm local_comm;
1442       char     string[64];
1443 
1444       ierr = PetscOptionsGetString(NULL,NULL,"-objects_dump",string,sizeof(string),NULL);CHKERRQ(ierr);
1445       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1446       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1447       ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1448       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1449       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1450     }
1451   }
1452 #endif
1453 
1454 #if defined(PETSC_USE_LOG)
1455   PetscObjectsCounts    = 0;
1456   PetscObjectsMaxCounts = 0;
1457   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1458 #endif
1459 
1460   /*
1461      Destroy any packages that registered a finalize
1462   */
1463   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1464 
1465 #if defined(PETSC_USE_LOG)
1466   ierr = PetscLogFinalize();CHKERRQ(ierr);
1467 #endif
1468 
1469   /*
1470      Print PetscFunctionLists that have not been properly freed
1471 
1472   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1473   */
1474 
1475   if (petsc_history) {
1476     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1477     petsc_history = NULL;
1478   }
1479   ierr = PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);CHKERRQ(ierr);
1480   ierr = PetscInfoDestroy();CHKERRQ(ierr);
1481 
1482 #if !defined(PETSC_HAVE_THREADSAFETY)
1483   if (!(PETSC_RUNNING_ON_VALGRIND)) {
1484     char fname[PETSC_MAX_PATH_LEN];
1485     char sname[PETSC_MAX_PATH_LEN];
1486     FILE *fd;
1487     int  err;
1488 
1489     flg2 = PETSC_FALSE;
1490     flg3 = PETSC_FALSE;
1491     if (PetscDefined(USE_DEBUG)) {ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);}
1492     ierr = PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);CHKERRQ(ierr);
1493     fname[0] = 0;
1494     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1495     if (flg1 && fname[0]) {
1496 
1497       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
1498       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1499       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1500       err  = fclose(fd);
1501       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1502     } else if (flg1 || flg2 || flg3) {
1503       MPI_Comm local_comm;
1504 
1505       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1506       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1507       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1508       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1509       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1510     }
1511     fname[0] = 0;
1512     ierr = PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,sizeof(fname),&flg1);CHKERRQ(ierr);
1513     if (flg1 && fname[0]) {
1514 
1515       PetscSNPrintf(sname,sizeof(sname),"%s_%d",fname,rank);
1516       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1517       ierr = PetscMallocView(fd);CHKERRQ(ierr);
1518       err  = fclose(fd);
1519       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1520     } else if (flg1) {
1521       MPI_Comm local_comm;
1522 
1523       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1524       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1525       ierr = PetscMallocView(stdout);CHKERRQ(ierr);
1526       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1527       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1528     }
1529   }
1530 #endif
1531 
1532   /*
1533      Close any open dynamic libraries
1534   */
1535   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1536 
1537   /* Can be destroyed only after all the options are used */
1538   ierr = PetscOptionsDestroyDefault();CHKERRQ(ierr);
1539 
1540   PetscGlobalArgc = 0;
1541   PetscGlobalArgs = NULL;
1542 
1543   ierr = PetscFreeMPIResources();CHKERRQ(ierr);
1544 
1545   /*
1546      Destroy any known inner MPI_Comm's and attributes pointing to them
1547      Note this will not destroy any new communicators the user has created.
1548 
1549      If all PETSc objects were not destroyed those left over objects will have hanging references to
1550      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1551  */
1552   {
1553     PetscCommCounter *counter;
1554     PetscMPIInt      flg;
1555     MPI_Comm         icomm;
1556     union {MPI_Comm comm; void *ptr;} ucomm;
1557     ierr = MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1558     if (flg) {
1559       icomm = ucomm.comm;
1560       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1561       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1562 
1563       ierr = MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1564       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1565       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1566     }
1567     ierr = MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1568     if (flg) {
1569       icomm = ucomm.comm;
1570       ierr = MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1571       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1572 
1573       ierr = MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1574       ierr = MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1575       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1576     }
1577   }
1578 
1579   ierr = MPI_Comm_free_keyval(&Petsc_Counter_keyval);CHKERRQ(ierr);
1580   ierr = MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1581   ierr = MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1582   ierr = MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);CHKERRQ(ierr);
1583 
1584   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);CHKERRQ(ierr);
1585   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);CHKERRQ(ierr);
1586   ierr = PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);CHKERRQ(ierr);
1587   ierr = PetscSpinlockDestroy(&PetscCommSpinLock);CHKERRQ(ierr);
1588 
1589   if (PetscBeganMPI) {
1590 #if defined(PETSC_HAVE_MPI_FINALIZED)
1591     PetscMPIInt flag;
1592     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1593     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1594 #endif
1595     ierr = MPI_Finalize();CHKERRQ(ierr);
1596   }
1597 /*
1598 
1599      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1600    the communicator has some outstanding requests on it. Specifically if the
1601    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1602    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1603    is never freed as it should be. Thus one may obtain messages of the form
1604    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1605    memory was not freed.
1606 
1607 */
1608   ierr = PetscMallocClear();CHKERRQ(ierr);
1609 
1610   PetscErrorHandlingInitialized = PETSC_FALSE;
1611   PetscInitializeCalled = PETSC_FALSE;
1612   PetscFinalizeCalled   = PETSC_TRUE;
1613   PetscFunctionReturn(0);
1614 }
1615 
1616 #if defined(PETSC_MISSING_LAPACK_lsame_)
1617 PETSC_EXTERN int lsame_(char *a,char *b)
1618 {
1619   if (*a == *b) return 1;
1620   if (*a + 32 == *b) return 1;
1621   if (*a - 32 == *b) return 1;
1622   return 0;
1623 }
1624 #endif
1625 
1626 #if defined(PETSC_MISSING_LAPACK_lsame)
1627 PETSC_EXTERN int lsame(char *a,char *b)
1628 {
1629   if (*a == *b) return 1;
1630   if (*a + 32 == *b) return 1;
1631   if (*a - 32 == *b) return 1;
1632   return 0;
1633 }
1634 #endif
1635