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