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