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