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