xref: /petsc/src/sys/objects/pinit.c (revision 563ffbab739d96c559dd28f4ad9be3f5bd74c24d)
1 
2 /*
3    This file defines the initialization of PETSc, including PetscInitialize()
4 */
5 #define PETSC_DESIRE_COMPLEX
6 #include <petsc-private/petscimpl.h>        /*I  "petscsys.h"   I*/
7 #include <petscviewer.h>
8 
9 #if defined(PETSC_HAVE_CUDA)
10 #include <cublas.h>
11 #endif
12 
13 #include <petscthreadcomm.h>
14 
15 #if defined(PETSC_USE_LOG)
16 extern PetscErrorCode PetscLogBegin_Private(void);
17 #endif
18 extern PetscBool PetscHMPIWorker;
19 
20 
21 #if defined(PETSC_SERIALIZE_FUNCTIONS)
22 PetscFPT PetscFPTData = 0;
23 #endif
24 
25 /* -----------------------------------------------------------------------------------------*/
26 
27 extern FILE *petsc_history;
28 
29 extern PetscErrorCode PetscInitialize_DynamicLibraries(void);
30 extern PetscErrorCode PetscFinalize_DynamicLibraries(void);
31 extern PetscErrorCode PetscFunctionListPrintAll(void);
32 extern PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
33 extern PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
34 extern 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 
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 /*
57        Checks the options database for initializations related to the
58     PETSc components
59 */
60 #undef __FUNCT__
61 #define __FUNCT__ "PetscOptionsCheckInitial_Components"
62 PetscErrorCode  PetscOptionsCheckInitial_Components(void)
63 {
64   PetscBool      flg1;
65   PetscErrorCode ierr;
66 
67   PetscFunctionBegin;
68   ierr = PetscOptionsHasName(NULL,"-help",&flg1);CHKERRQ(ierr);
69   if (flg1) {
70 #if defined(PETSC_USE_LOG)
71     MPI_Comm comm = PETSC_COMM_WORLD;
72     ierr = (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");CHKERRQ(ierr);
73     ierr = (*PetscHelpPrintf)(comm," -log_summary_exclude: <vec,mat,pc.ksp,snes>\n");CHKERRQ(ierr);
74     ierr = (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,ts>\n");CHKERRQ(ierr);
75     ierr = (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");CHKERRQ(ierr);
76 #endif
77   }
78   PetscFunctionReturn(0);
79 }
80 
81 #undef __FUNCT__
82 #define __FUNCT__ "PetscInitializeNoPointers"
83 /*
84       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args
85 
86    Collective
87 
88    Level: advanced
89 
90     Notes: this is called only by the PETSc MATLAB and Julia interface. Even though it might start MPI it sets the flag to
91      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
92      be called multiple times from MATLAB and Julia without the problem of trying to initialize MPI more than once.
93 
94      Turns off PETSc signal handling because that can interact with MATLAB's signal handling causing random crashes.
95 
96 .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
97 */
98 PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
99 {
100   PetscErrorCode ierr;
101   int            myargc   = argc;
102   char           **myargs = args;
103 
104   PetscFunctionBegin;
105   ierr = PetscInitialize(&myargc,&myargs,filename,help);CHKERRQ(ierr);
106   ierr = PetscPopSignalHandler();CHKERRQ(ierr);
107   PetscBeganMPI = PETSC_FALSE;
108   PetscFunctionReturn(ierr);
109 }
110 
111 #undef __FUNCT__
112 #define __FUNCT__ "PetscGetPETSC_COMM_SELF"
113 /*
114       Used by MATLAB and Julia interface to get communicator
115 */
116 PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
117 {
118   PetscFunctionBegin;
119   *comm = PETSC_COMM_SELF;
120   PetscFunctionReturn(0);
121 }
122 
123 #undef __FUNCT__
124 #define __FUNCT__ "PetscInitializeNoArguments"
125 /*@C
126       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
127         the command line arguments.
128 
129    Collective
130 
131    Level: advanced
132 
133 .seealso: PetscInitialize(), PetscInitializeFortran()
134 @*/
135 PetscErrorCode  PetscInitializeNoArguments(void)
136 {
137   PetscErrorCode ierr;
138   int            argc   = 0;
139   char           **args = 0;
140 
141   PetscFunctionBegin;
142   ierr = PetscInitialize(&argc,&args,NULL,NULL);
143   PetscFunctionReturn(ierr);
144 }
145 
146 #undef __FUNCT__
147 #define __FUNCT__ "PetscInitialized"
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 #undef __FUNCT__
162 #define __FUNCT__ "PetscFinalized"
163 /*@
164       PetscFinalized - Determine whether PetscFinalize() has been called yet
165 
166    Level: developer
167 
168 .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
169 @*/
170 PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
171 {
172   *isFinalized = PetscFinalizeCalled;
173   return 0;
174 }
175 
176 extern PetscErrorCode PetscOptionsCheckInitial_Private(void);
177 
178 /*
179        This function is the MPI reduction operation used to compute the sum of the
180    first half of the datatype and the max of the second half.
181 */
182 MPI_Op PetscMaxSum_Op = 0;
183 
184 #undef __FUNCT__
185 #define __FUNCT__ "PetscMaxSum_Local"
186 PETSC_EXTERN void MPIAPI PetscMaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
187 {
188   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;
189 
190   PetscFunctionBegin;
191   if (*datatype != MPIU_2INT) {
192     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
193     MPI_Abort(MPI_COMM_WORLD,1);
194   }
195 
196   for (i=0; i<count; i++) {
197     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
198     xout[2*i+1] += xin[2*i+1];
199   }
200   PetscFunctionReturnVoid();
201 }
202 
203 /*
204     Returns the max of the first entry owned by this processor and the
205 sum of the second entry.
206 
207     The reason nprocs[2*i] contains lengths nprocs[2*i+1] contains flag of 1 if length is nonzero
208 is so that the PetscMaxSum_Op() can set TWO values, if we passed in only nprocs[i] with lengths
209 there would be no place to store the both needed results.
210 */
211 #undef __FUNCT__
212 #define __FUNCT__ "PetscMaxSum"
213 PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt nprocs[],PetscInt *max,PetscInt *sum)
214 {
215   PetscMPIInt    size,rank;
216   struct {PetscInt max,sum;} *work;
217   PetscErrorCode ierr;
218 
219   PetscFunctionBegin;
220   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
221   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
222   ierr = PetscMalloc(size*sizeof(*work),&work);CHKERRQ(ierr);
223   ierr = MPI_Allreduce((void*)nprocs,work,size,MPIU_2INT,PetscMaxSum_Op,comm);CHKERRQ(ierr);
224   *max = work[rank].max;
225   *sum = work[rank].sum;
226   ierr = PetscFree(work);CHKERRQ(ierr);
227   PetscFunctionReturn(0);
228 }
229 
230 /* ----------------------------------------------------------------------------*/
231 MPI_Op  PetscADMax_Op = 0;
232 
233 #undef __FUNCT__
234 #define __FUNCT__ "PetscADMax_Local"
235 PETSC_EXTERN void MPIAPI PetscADMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
236 {
237   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
238   PetscInt    i,count = *cnt;
239 
240   PetscFunctionBegin;
241   if (*datatype != MPIU_2SCALAR) {
242     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
243     MPI_Abort(MPI_COMM_WORLD,1);
244   }
245 
246   for (i=0; i<count; i++) {
247     if (PetscRealPart(xout[2*i]) < PetscRealPart(xin[2*i])) {
248       xout[2*i]   = xin[2*i];
249       xout[2*i+1] = xin[2*i+1];
250     }
251   }
252   PetscFunctionReturnVoid();
253 }
254 
255 MPI_Op PetscADMin_Op = 0;
256 
257 #undef __FUNCT__
258 #define __FUNCT__ "PetscADMin_Local"
259 PETSC_EXTERN void MPIAPI PetscADMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
260 {
261   PetscScalar *xin = (PetscScalar*)in,*xout = (PetscScalar*)out;
262   PetscInt    i,count = *cnt;
263 
264   PetscFunctionBegin;
265   if (*datatype != MPIU_2SCALAR) {
266     (*PetscErrorPrintf)("Can only handle MPIU_2SCALAR data (i.e. double or complex) types");
267     MPI_Abort(MPI_COMM_WORLD,1);
268   }
269 
270   for (i=0; i<count; i++) {
271     if (PetscRealPart(xout[2*i]) > PetscRealPart(xin[2*i])) {
272       xout[2*i]   = xin[2*i];
273       xout[2*i+1] = xin[2*i+1];
274     }
275   }
276   PetscFunctionReturnVoid();
277 }
278 /* ---------------------------------------------------------------------------------------*/
279 
280 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
281 MPI_Op MPIU_SUM = 0;
282 
283 #undef __FUNCT__
284 #define __FUNCT__ "PetscSum_Local"
285 PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
286 {
287   PetscInt i,count = *cnt;
288 
289   PetscFunctionBegin;
290   if (*datatype == MPIU_REAL) {
291     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
292     for (i=0; i<count; i++) xout[i] += xin[i];
293   }
294 #if defined(PETSC_HAVE_COMPLEX)
295   else if (*datatype == MPIU_COMPLEX) {
296     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
297     for (i=0; i<count; i++) xout[i] += xin[i];
298   }
299 #endif
300   else {
301     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
302     MPI_Abort(MPI_COMM_WORLD,1);
303   }
304   PetscFunctionReturnVoid();
305 }
306 #endif
307 
308 #if defined(PETSC_USE_REAL___FLOAT128)
309 MPI_Op MPIU_MAX = 0;
310 MPI_Op MPIU_MIN = 0;
311 
312 #undef __FUNCT__
313 #define __FUNCT__ "PetscMax_Local"
314 PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
315 {
316   PetscInt i,count = *cnt;
317 
318   PetscFunctionBegin;
319   if (*datatype == MPIU_REAL) {
320     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
321     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
322   }
323 #if defined(PETSC_HAVE_COMPLEX)
324   else if (*datatype == MPIU_COMPLEX) {
325     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
326     for (i=0; i<count; i++) {
327       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
328     }
329   }
330 #endif
331   else {
332     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
333     MPI_Abort(MPI_COMM_WORLD,1);
334   }
335   PetscFunctionReturnVoid();
336 }
337 
338 #undef __FUNCT__
339 #define __FUNCT__ "PetscMin_Local"
340 PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
341 {
342   PetscInt    i,count = *cnt;
343 
344   PetscFunctionBegin;
345   if (*datatype == MPIU_REAL) {
346     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
347     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
348   }
349 #if defined(PETSC_HAVE_COMPLEX)
350   else if (*datatype == MPIU_COMPLEX) {
351     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
352     for (i=0; i<count; i++) {
353       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
354     }
355   }
356 #endif
357   else {
358     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
359     MPI_Abort(MPI_COMM_WORLD,1);
360   }
361   PetscFunctionReturnVoid();
362 }
363 #endif
364 
365 #undef __FUNCT__
366 #define __FUNCT__ "Petsc_DelCounter"
367 /*
368    Private routine to delete internal tag/name counter storage when a communicator is freed.
369 
370    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.
371 
372    Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
373 
374 */
375 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
376 {
377   PetscErrorCode ierr;
378 
379   PetscFunctionBegin;
380   ierr = PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
381   ierr = PetscFree(count_val);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
382   PetscFunctionReturn(MPI_SUCCESS);
383 }
384 
385 #undef __FUNCT__
386 #define __FUNCT__ "Petsc_DelComm_Outer"
387 /*
388   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Attr_delete) or when the user
389   calls MPI_Comm_free().
390 
391   This is the only entry point for breaking the links between inner and outer comms.
392 
393   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.
394 
395   Note: this is declared extern "C" because it is passed to MPI_Keyval_create()
396 
397 */
398 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
399 {
400   PetscErrorCode ierr;
401   PetscMPIInt    flg;
402   union {MPI_Comm comm; void *ptr;} icomm,ocomm;
403 
404   PetscFunctionBegin;
405   if (keyval != Petsc_InnerComm_keyval) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
406   icomm.ptr = attr_val;
407 
408   ierr = MPI_Attr_get(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRQ(ierr);
409   if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
410   if (ocomm.comm != comm) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
411   ierr = MPI_Attr_delete(icomm.comm,Petsc_OuterComm_keyval);CHKERRQ(ierr); /* Calls Petsc_DelComm_Inner */
412   ierr = PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
413   PetscFunctionReturn(MPI_SUCCESS);
414 }
415 
416 #undef __FUNCT__
417 #define __FUNCT__ "Petsc_DelComm_Inner"
418 /*
419  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Attr_delete.  It should not be reached any other way.
420  */
421 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
422 {
423   PetscErrorCode ierr;
424 
425   PetscFunctionBegin;
426   ierr = PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);if (ierr) PetscFunctionReturn((PetscMPIInt)ierr);
427   PetscFunctionReturn(MPI_SUCCESS);
428 }
429 
430 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
431 #if !defined(PETSC_WORDS_BIGENDIAN)
432 PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
433 PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
434 PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
435 #endif
436 #endif
437 
438 int  PetscGlobalArgc   = 0;
439 char **PetscGlobalArgs = 0;
440 PetscSegBuffer PetscCitationsList;
441 
442 #undef __FUNCT__
443 #define __FUNCT__ "PetscCitationsInitialize"
444 PetscErrorCode PetscCitationsInitialize()
445 {
446   PetscErrorCode ierr;
447 
448   PetscFunctionBegin;
449   ierr = PetscSegBufferCreate(1,10000,&PetscCitationsList);CHKERRQ(ierr);
450   ierr = PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Jed Brown and and Kris Buschelman and Victor Eijkhout\n            and William D.  Gropp and Dinesh Kaushik and Matthew G. Knepley\n            and Lois Curfman McInnes and Barry F. Smith and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.4},\n  Institution = {Argonne National Laboratory},\n  Year = {2013}\n}\n",NULL);CHKERRQ(ierr);
451   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);
452   PetscFunctionReturn(0);
453 }
454 
455 #undef __FUNCT__
456 #define __FUNCT__ "PetscGetArgs"
457 /*@C
458    PetscGetArgs - Allows you to access the raw command line arguments anywhere
459      after PetscInitialize() is called but before PetscFinalize().
460 
461    Not Collective
462 
463    Output Parameters:
464 +  argc - count of number of command line arguments
465 -  args - the command line arguments
466 
467    Level: intermediate
468 
469    Notes:
470       This is usually used to pass the command line arguments into other libraries
471    that are called internally deep in PETSc or the application.
472 
473       The first argument contains the program name as is normal for C arguments.
474 
475    Concepts: command line arguments
476 
477 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()
478 
479 @*/
480 PetscErrorCode  PetscGetArgs(int *argc,char ***args)
481 {
482   PetscFunctionBegin;
483   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
484   *argc = PetscGlobalArgc;
485   *args = PetscGlobalArgs;
486   PetscFunctionReturn(0);
487 }
488 
489 #undef __FUNCT__
490 #define __FUNCT__ "PetscGetArguments"
491 /*@C
492    PetscGetArguments - Allows you to access the  command line arguments anywhere
493      after PetscInitialize() is called but before PetscFinalize().
494 
495    Not Collective
496 
497    Output Parameters:
498 .  args - the command line arguments
499 
500    Level: intermediate
501 
502    Notes:
503       This does NOT start with the program name and IS null terminated (final arg is void)
504 
505    Concepts: command line arguments
506 
507 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()
508 
509 @*/
510 PetscErrorCode  PetscGetArguments(char ***args)
511 {
512   PetscInt       i,argc = PetscGlobalArgc;
513   PetscErrorCode ierr;
514 
515   PetscFunctionBegin;
516   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
517   if (!argc) {*args = 0; PetscFunctionReturn(0);}
518   ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr);
519   for (i=0; i<argc-1; i++) {
520     ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr);
521   }
522   (*args)[argc-1] = 0;
523   PetscFunctionReturn(0);
524 }
525 
526 #undef __FUNCT__
527 #define __FUNCT__ "PetscFreeArguments"
528 /*@C
529    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()
530 
531    Not Collective
532 
533    Output Parameters:
534 .  args - the command line arguments
535 
536    Level: intermediate
537 
538    Concepts: command line arguments
539 
540 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()
541 
542 @*/
543 PetscErrorCode  PetscFreeArguments(char **args)
544 {
545   PetscInt       i = 0;
546   PetscErrorCode ierr;
547 
548   PetscFunctionBegin;
549   if (!args) PetscFunctionReturn(0);
550   while (args[i]) {
551     ierr = PetscFree(args[i]);CHKERRQ(ierr);
552     i++;
553   }
554   ierr = PetscFree(args);CHKERRQ(ierr);
555   PetscFunctionReturn(0);
556 }
557 
558 #undef __FUNCT__
559 #define __FUNCT__ "PetscInitialize"
560 /*@C
561    PetscInitialize - Initializes the PETSc database and MPI.
562    PetscInitialize() calls MPI_Init() if that has yet to be called,
563    so this routine should always be called near the beginning of
564    your program -- usually the very first line!
565 
566    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set
567 
568    Input Parameters:
569 +  argc - count of number of command line arguments
570 .  args - the command line arguments
571 .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
572           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
573 -  help - [optional] Help message to print, use NULL for no message
574 
575    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
576    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
577    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
578    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
579    if different subcommunicators of the job are doing different things with PETSc.
580 
581    Options Database Keys:
582 +  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
583 .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
584 .  -on_error_emacs <machinename> causes emacsclient to jump to error file
585 .  -on_error_abort calls abort() when error detected (no traceback)
586 .  -on_error_mpiabort calls MPI_abort() when error detected
587 .  -error_output_stderr prints error messages to stderr instead of the default stdout
588 .  -error_output_none does not print the error messages (but handles errors in the same way as if this was not called)
589 .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
590 .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
591 .  -stop_for_debugger - Print message on how to attach debugger manually to
592                         process and wait (-debugger_pause) seconds for attachment
593 .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries)
594 .  -malloc no - Indicates not to use error-checking malloc
595 .  -malloc_debug - check for memory corruption at EVERY malloc or free
596 .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds
597 .  -fp_trap - Stops on floating point exceptions (Note that on the
598               IBM RS6000 this slows code by at least a factor of 10.)
599 .  -no_signal_handler - Indicates not to trap error signals
600 .  -shared_tmp - indicates /tmp directory is shared by all processors
601 .  -not_shared_tmp - each processor has own /tmp
602 .  -tmp - alternative name of /tmp directory
603 .  -get_total_flops - returns total flops done by all processors
604 .  -memory_info - Print memory usage at end of run
605 -  -server <port> - start PETSc webserver (default port is 8080)
606 
607    Options Database Keys for Profiling:
608    See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details.
609 +  -info <optional filename> - Prints verbose information to the screen
610 .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
611 .  -log_sync - Log the synchronization in scatters, inner products and norms
612 .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
613         hangs without running in the debugger).  See PetscLogTraceBegin().
614 .  -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the
615         summary is written to the file.  See PetscLogView().
616 .  -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython().
617 .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
618 .  -log [filename] - Logs basic profiline information  See PetscLogDump().
619 -  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
620 
621     Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time
622 
623    Environmental Variables:
624 +   PETSC_TMP - alternative tmp directory
625 .   PETSC_SHARED_TMP - tmp is shared by all processes
626 .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
627 .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
628 -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to
629 
630 
631    Level: beginner
632 
633    Notes:
634    If for some reason you must call MPI_Init() separately, call
635    it before PetscInitialize().
636 
637    Fortran Version:
638    In Fortran this routine has the format
639 $       call PetscInitialize(file,ierr)
640 
641 +   ierr - error return code
642 -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for
643           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
644 
645    Important Fortran Note:
646    In Fortran, you MUST use NULL_CHARACTER to indicate a
647    null character string; you CANNOT just use NULL as
648    in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details.
649 
650    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
651    calling PetscInitialize().
652 
653    Concepts: initializing PETSc
654 
655 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
656 
657 @*/
658 PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
659 {
660   PetscErrorCode ierr;
661   PetscMPIInt    flag, size;
662   PetscInt       nodesize;
663   PetscBool      flg;
664   char           hostname[256];
665 
666   PetscFunctionBegin;
667   if (PetscInitializeCalled) PetscFunctionReturn(0);
668 
669   /* these must be initialized in a routine, not as a constant declaration*/
670   PETSC_STDOUT = stdout;
671   PETSC_STDERR = stderr;
672 
673   ierr = PetscOptionsCreate();CHKERRQ(ierr);
674 
675   /*
676      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
677      it that it sets args[0] on all processors to be args[0] on the first processor.
678   */
679   if (argc && *argc) {
680     ierr = PetscSetProgramName(**args);CHKERRQ(ierr);
681   } else {
682     ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr);
683   }
684 
685   ierr = MPI_Initialized(&flag);CHKERRQ(ierr);
686   if (!flag) {
687     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");
688 #if defined(PETSC_HAVE_MPI_INIT_THREAD)
689     {
690       PetscMPIInt provided;
691       ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr);
692     }
693 #else
694     ierr = MPI_Init(argc,args);CHKERRQ(ierr);
695 #endif
696     PetscBeganMPI = PETSC_TRUE;
697   }
698   if (argc && args) {
699     PetscGlobalArgc = *argc;
700     PetscGlobalArgs = *args;
701   }
702   PetscFinalizeCalled = PETSC_FALSE;
703 
704   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
705   ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr);
706 
707   /* Done after init due to a bug in MPICH-GM? */
708   ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr);
709 
710   ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr);
711   ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr);
712 
713   MPIU_BOOL = MPI_INT;
714   MPIU_ENUM = MPI_INT;
715 
716   /*
717      Initialized the global complex variable; this is because with
718      shared libraries the constructors for global variables
719      are not called; at least on IRIX.
720   */
721 #if defined(PETSC_HAVE_COMPLEX)
722   {
723 #if defined(PETSC_CLANGUAGE_CXX)
724     PetscComplex ic(0.0,1.0);
725     PETSC_i = ic;
726 #elif defined(PETSC_CLANGUAGE_C)
727     PETSC_i = _Complex_I;
728 #endif
729   }
730 
731 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
732   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
733   ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
734   ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr);
735   ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr);
736 #endif
737 #endif /* PETSC_HAVE_COMPLEX */
738 
739   /*
740      Create the PETSc MPI reduction operator that sums of the first
741      half of the entries and maxes the second half.
742   */
743   ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr);
744 
745 #if defined(PETSC_USE_REAL___FLOAT128)
746   ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr);
747   ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr);
748 #if defined(PETSC_HAVE_COMPLEX)
749   ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr);
750   ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr);
751 #endif
752   ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr);
753   ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr);
754 #endif
755 
756 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
757   ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr);
758 #endif
759 
760   ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr);
761   ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr);
762   ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr);
763   ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr);
764 
765 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
766   ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr);
767   ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr);
768 #endif
769 
770   /*
771      Attributes to be set on PETSc communicators
772   */
773   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr);
774   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Outer,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr);
775   ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm_Inner,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr);
776 
777   /*
778      Build the options database
779   */
780   ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr);
781 
782 
783   /*
784      Print main application help message
785   */
786   ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr);
787   if (help && flg) {
788     ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr);
789   }
790   ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr);
791 
792 
793   /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */
794 #if defined(PETSC_USE_LOG)
795   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
796 #endif
797 
798   /*
799      Load the dynamic libraries (on machines that support them), this registers all
800      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
801   */
802   ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr);
803 
804   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
805   ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr);
806   ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr);
807   ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr);
808 
809   ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr);
810   /* Check the options database for options related to the options database itself */
811   ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr);
812 
813 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
814   /*
815       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI
816 
817       Currently not used because it is not supported by MPICH.
818   */
819 #if !defined(PETSC_WORDS_BIGENDIAN)
820   ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr);
821 #endif
822 #endif
823 
824   ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr);
825   if (flg) {
826 #if defined(PETSC_HAVE_MPI_COMM_SPAWN)
827     ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */
828 #else
829     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead");
830 #endif
831   } else {
832     ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr);
833     if (flg) {
834       ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr);
835       if (PetscHMPIWorker) { /* if worker then never enter user code */
836         PetscInitializeCalled = PETSC_TRUE;
837         PetscEnd();
838       }
839     }
840   }
841 
842 #if defined(PETSC_HAVE_CUDA)
843   flg  = PETSC_TRUE;
844   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
845   if (flg) {
846     PetscMPIInt p;
847     for (p = 0; p < PetscGlobalSize; ++p) {
848       if (p == PetscGlobalRank) cublasInit();
849       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
850     }
851   }
852 #endif
853 
854   ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr);
855   if (flg) {
856     PetscInitializeCalled = PETSC_TRUE;
857     ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr);
858   }
859 
860   ierr = PetscThreadCommInitializePackage();CHKERRQ(ierr);
861 
862   /*
863       Setup building of stack frames for all function calls
864   */
865   PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates pthread_key */
866 #if defined(PETSC_USE_DEBUG)
867   ierr = PetscStackCreate();CHKERRQ(ierr);
868 #endif
869 
870 #if defined(PETSC_SERIALIZE_FUNCTIONS)
871   ierr = PetscFPTCreate(10000);CHKERRQ(ierr);
872 #endif
873 
874   ierr = PetscCitationsInitialize();CHKERRQ(ierr);
875 
876   /*
877       Once we are completedly initialized then we can set this variables
878   */
879   PetscInitializeCalled = PETSC_TRUE;
880   PetscFunctionReturn(0);
881 }
882 
883 extern PetscObject *PetscObjects;
884 extern PetscInt    PetscObjectsCounts, PetscObjectsMaxCounts;
885 
886 #undef __FUNCT__
887 #define __FUNCT__ "PetscFinalize"
888 /*@C
889    PetscFinalize - Checks for options to be called at the conclusion
890    of the program. MPI_Finalize() is called only if the user had not
891    called MPI_Init() before calling PetscInitialize().
892 
893    Collective on PETSC_COMM_WORLD
894 
895    Options Database Keys:
896 +  -options_table - Calls PetscOptionsView()
897 .  -options_left - Prints unused options that remain in the database
898 .  -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
899 .  -mpidump - Calls PetscMPIDump()
900 .  -malloc_dump - Calls PetscMallocDump()
901 .  -malloc_info - Prints total memory usage
902 -  -malloc_log - Prints summary of memory usage
903 
904    Level: beginner
905 
906    Note:
907    See PetscInitialize() for more general runtime options.
908 
909 .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
910 @*/
911 PetscErrorCode  PetscFinalize(void)
912 {
913   PetscErrorCode ierr;
914   PetscMPIInt    rank;
915   PetscInt       nopt;
916   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
917   PetscBool      flg;
918 #if defined(PETSC_USE_LOG)
919   char           mname[PETSC_MAX_PATH_LEN];
920 #endif
921 
922   PetscFunctionBegin;
923   if (!PetscInitializeCalled) {
924     printf("PetscInitialize() must be called before PetscFinalize()\n");
925     PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE);
926   }
927   ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr);
928 
929   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
930 
931   ierr = PetscOptionsHasName(NULL,"-citations",&flg);CHKERRQ(ierr);
932   if (flg) {
933     char  *cits, filename[PETSC_MAX_PATH_LEN];
934     FILE  *fd = PETSC_STDOUT;
935 
936     ierr = PetscOptionsGetString(NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);CHKERRQ(ierr);
937     if (filename[0]) {
938       ierr = PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);CHKERRQ(ierr);
939     }
940     ierr = PetscSegBufferGet(PetscCitationsList,1,&cits);CHKERRQ(ierr);
941     cits[0] = 0;
942     ierr = PetscSegBufferExtractAlloc(PetscCitationsList,&cits);CHKERRQ(ierr);
943     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");CHKERRQ(ierr);
944     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
945     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);CHKERRQ(ierr);
946     ierr = PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");CHKERRQ(ierr);
947     ierr = PetscFClose(PETSC_COMM_WORLD,fd);CHKERRQ(ierr);
948     ierr = PetscFree(cits);CHKERRQ(ierr);
949   }
950   ierr = PetscSegBufferDestroy(&PetscCitationsList);CHKERRQ(ierr);
951 
952 #if defined(PETSC_SERIALIZE_FUNCTIONS)
953   ierr = PetscFPTDestroy();CHKERRQ(ierr);
954 #endif
955 
956 
957 #if defined(PETSC_HAVE_AMS)
958   flg = PETSC_FALSE;
959   ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr);
960   if (flg) {
961     ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr);
962   }
963 #endif
964 
965 #if defined(PETSC_USE_SERVER)
966   flg1 = PETSC_FALSE;
967   ierr = PetscOptionsGetBool(NULL,"-server",&flg1,NULL);CHKERRQ(ierr);
968   if (flg1) {
969     /*  this is a crude hack, but better than nothing */
970     ierr = PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 petscwebserver","r",NULL);CHKERRQ(ierr);
971   }
972 #endif
973 
974   ierr = PetscHMPIFinalize();CHKERRQ(ierr);
975 
976   ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr);
977   if (!flg2) {
978     flg2 = PETSC_FALSE;
979     ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr);
980   }
981   if (flg2) {
982     ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr);
983   }
984 
985 #if defined(PETSC_USE_LOG)
986   flg1 = PETSC_FALSE;
987   ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr);
988   if (flg1) {
989     PetscLogDouble flops = 0;
990     ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr);
991     ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr);
992   }
993 #endif
994 
995 
996 #if defined(PETSC_USE_LOG)
997 #if defined(PETSC_HAVE_MPE)
998   mname[0] = 0;
999 
1000   ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1001   if (flg1) {
1002     if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);}
1003     else          {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);}
1004   }
1005 #endif
1006   mname[0] = 0;
1007 
1008   ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1009   if (flg1) {
1010     PetscViewer viewer;
1011     if (mname[0]) {
1012       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1013       ierr = PetscLogView(viewer);CHKERRQ(ierr);
1014       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1015     } else {
1016       viewer = PETSC_VIEWER_STDOUT_WORLD;
1017       ierr   = PetscLogView(viewer);CHKERRQ(ierr);
1018     }
1019   }
1020 
1021   mname[0] = 0;
1022 
1023   ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1024   if (flg1) {
1025     PetscViewer viewer;
1026     if (mname[0]) {
1027       ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr);
1028       ierr = PetscLogViewPython(viewer);CHKERRQ(ierr);
1029       ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1030     } else {
1031       viewer = PETSC_VIEWER_STDOUT_WORLD;
1032       ierr   = PetscLogViewPython(viewer);CHKERRQ(ierr);
1033     }
1034   }
1035 
1036   ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1037   if (flg1) {
1038     if (mname[0])  {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);}
1039     else           {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);}
1040   }
1041 
1042   mname[0] = 0;
1043 
1044   ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr);
1045   ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr);
1046   if (flg1 || flg2) {
1047     if (mname[0]) PetscLogDump(mname);
1048     else          PetscLogDump(0);
1049   }
1050 #endif
1051 
1052   /*
1053      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
1054   */
1055   ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr);
1056 
1057   ierr = PetscStackDestroy();CHKERRQ(ierr);
1058   PetscThreadLocalDestroy((PetscThreadKey)petscstack); /* Deletes pthread_key */
1059 
1060   flg1 = PETSC_FALSE;
1061   ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr);
1062   if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);}
1063   flg1 = PETSC_FALSE;
1064   ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr);
1065   if (flg1) {
1066     ierr = PetscMPIDump(stdout);CHKERRQ(ierr);
1067   }
1068   flg1 = PETSC_FALSE;
1069   flg2 = PETSC_FALSE;
1070   /* preemptive call to avoid listing this option in options table as unused */
1071   ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr);
1072   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1073   ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr);
1074 
1075   if (flg2) {
1076     PetscViewer viewer;
1077     ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1078     ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1079     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1080   }
1081 
1082   /* to prevent PETSc -options_left from warning */
1083   ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr);
1084   ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr);
1085 
1086   if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */
1087     flg3 = PETSC_FALSE; /* default value is required */
1088     ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr);
1089     ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr);
1090     if (flg3) {
1091       if (!flg2) { /* have not yet printed the options */
1092         PetscViewer viewer;
1093         ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr);
1094         ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
1095         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1096       }
1097       if (!nopt) {
1098         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr);
1099       } else if (nopt == 1) {
1100         ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr);
1101       } else {
1102         ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr);
1103       }
1104     }
1105 #if defined(PETSC_USE_DEBUG)
1106     if (nopt && !flg3 && !flg1) {
1107       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr);
1108       ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr);
1109       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1110     } else if (nopt && flg3) {
1111 #else
1112     if (nopt && flg3) {
1113 #endif
1114       ierr = PetscOptionsLeft();CHKERRQ(ierr);
1115     }
1116   }
1117 
1118   {
1119     PetscThreadComm tcomm_world;
1120     ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr);
1121     /* Free global thread communicator */
1122     ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr);
1123   }
1124 
1125   /*
1126        List all objects the user may have forgot to free
1127   */
1128   ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr);
1129   if (flg1) {
1130     MPI_Comm local_comm;
1131     char     string[64];
1132 
1133     ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr);
1134     ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1135     ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1136     ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr);
1137     ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1138     ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1139   }
1140   PetscObjectsCounts    = 0;
1141   PetscObjectsMaxCounts = 0;
1142 
1143   ierr = PetscFree(PetscObjects);CHKERRQ(ierr);
1144 
1145 #if defined(PETSC_USE_LOG)
1146   ierr = PetscLogDestroy();CHKERRQ(ierr);
1147 #endif
1148 
1149   /*
1150      Destroy any packages that registered a finalize
1151   */
1152   ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr);
1153 
1154   /*
1155      Destroy all the function registration lists created
1156   */
1157   ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr);
1158 
1159   /*
1160      Print PetscFunctionLists that have not been properly freed
1161 
1162   ierr = PetscFunctionListPrintAll();CHKERRQ(ierr);
1163   */
1164 
1165   if (petsc_history) {
1166     ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr);
1167     petsc_history = 0;
1168   }
1169 
1170   ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr);
1171 
1172   {
1173     char fname[PETSC_MAX_PATH_LEN];
1174     FILE *fd;
1175     int  err;
1176 
1177     fname[0] = 0;
1178 
1179     ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr);
1180     flg2 = PETSC_FALSE;
1181     ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr);
1182 #if defined(PETSC_USE_DEBUG)
1183     if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE;
1184 #else
1185     flg2 = PETSC_FALSE;         /* Skip reporting for optimized builds regardless of -malloc_test */
1186 #endif
1187     if (flg1 && fname[0]) {
1188       char sname[PETSC_MAX_PATH_LEN];
1189 
1190       sprintf(sname,"%s_%d",fname,rank);
1191       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
1192       ierr = PetscMallocDump(fd);CHKERRQ(ierr);
1193       err  = fclose(fd);
1194       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1195     } else if (flg1 || flg2) {
1196       MPI_Comm local_comm;
1197 
1198       ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr);
1199       ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr);
1200       ierr = PetscMallocDump(stdout);CHKERRQ(ierr);
1201       ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr);
1202       ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr);
1203     }
1204   }
1205 
1206   {
1207     char fname[PETSC_MAX_PATH_LEN];
1208     FILE *fd = NULL;
1209 
1210     fname[0] = 0;
1211 
1212     ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr);
1213     ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr);
1214     if (flg1 && fname[0]) {
1215       int err;
1216 
1217       if (!rank) {
1218         fd = fopen(fname,"w");
1219         if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname);
1220       }
1221       ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr);
1222       if (fd) {
1223         err = fclose(fd);
1224         if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
1225       }
1226     } else if (flg1 || flg2) {
1227       ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr);
1228     }
1229   }
1230 
1231 #if defined(PETSC_HAVE_CUDA)
1232   flg  = PETSC_TRUE;
1233   ierr = PetscOptionsGetBool(NULL,"-cublas",&flg,NULL);CHKERRQ(ierr);
1234   if (flg) {
1235     PetscInt p;
1236     for (p = 0; p < PetscGlobalSize; ++p) {
1237       if (p == PetscGlobalRank) cublasShutdown();
1238       ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
1239     }
1240   }
1241 #endif
1242 
1243   /* Can be destroyed only after all the options are used */
1244   ierr = PetscOptionsDestroy();CHKERRQ(ierr);
1245 
1246   PetscGlobalArgc = 0;
1247   PetscGlobalArgs = 0;
1248 
1249 #if defined(PETSC_USE_REAL___FLOAT128)
1250   ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr);
1251 #if defined(PETSC_HAVE_COMPLEX)
1252   ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr);
1253 #endif
1254   ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr);
1255   ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr);
1256 #endif
1257 
1258 #if defined(PETSC_HAVE_COMPLEX)
1259 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
1260   ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr);
1261   ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr);
1262 #endif
1263 #endif
1264 
1265 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128)
1266   ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr);
1267 #endif
1268 
1269   ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr);
1270 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
1271   ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr);
1272 #endif
1273   ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr);
1274   ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr);
1275   ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr);
1276 
1277   /*
1278      Destroy any known inner MPI_Comm's and attributes pointing to them
1279      Note this will not destroy any new communicators the user has created.
1280 
1281      If all PETSc objects were not destroyed those left over objects will have hanging references to
1282      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
1283  */
1284   {
1285     PetscCommCounter *counter;
1286     PetscMPIInt      flg;
1287     MPI_Comm         icomm;
1288     union {MPI_Comm comm; void *ptr;} ucomm;
1289     ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1290     if (flg) {
1291       icomm = ucomm.comm;
1292       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1293       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1294 
1295       ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1296       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1297       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1298     }
1299     ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);CHKERRQ(ierr);
1300     if (flg) {
1301       icomm = ucomm.comm;
1302       ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr);
1303       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");
1304 
1305       ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr);
1306       ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr);
1307       ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr);
1308     }
1309   }
1310 
1311   ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr);
1312   ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr);
1313   ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr);
1314 
1315   if (PetscBeganMPI) {
1316 #if defined(PETSC_HAVE_MPI_FINALIZED)
1317     PetscMPIInt flag;
1318     ierr = MPI_Finalized(&flag);CHKERRQ(ierr);
1319     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
1320 #endif
1321     ierr = MPI_Finalize();CHKERRQ(ierr);
1322   }
1323 /*
1324 
1325      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
1326    the communicator has some outstanding requests on it. Specifically if the
1327    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
1328    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
1329    is never freed as it should be. Thus one may obtain messages of the form
1330    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
1331    memory was not freed.
1332 
1333 */
1334   ierr = PetscMallocClear();CHKERRQ(ierr);
1335 
1336   PetscInitializeCalled = PETSC_FALSE;
1337   PetscFinalizeCalled   = PETSC_TRUE;
1338   PetscFunctionReturn(ierr);
1339 }
1340 
1341 #if defined(PETSC_MISSING_LAPACK_lsame_)
1342 PETSC_EXTERN int lsame_(char *a,char *b)
1343 {
1344   if (*a == *b) return 1;
1345   if (*a + 32 == *b) return 1;
1346   if (*a - 32 == *b) return 1;
1347   return 0;
1348 }
1349 #endif
1350 
1351 #if defined(PETSC_MISSING_LAPACK_lsame)
1352 PETSC_EXTERN int lsame(char *a,char *b)
1353 {
1354   if (*a == *b) return 1;
1355   if (*a + 32 == *b) return 1;
1356   if (*a - 32 == *b) return 1;
1357   return 0;
1358 }
1359 #endif
1360