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