Actual source code: pinit.c
petsc-3.13.6 2020-09-29
Report Typos and Errors

      1: #define PETSC_DESIRE_FEATURE_TEST_MACROS
      2: /*
      3:    This file defines the initialization of PETSc, including PetscInitialize()
      4: */
      5:  #include <petsc/private/petscimpl.h>
      6:  #include <petscvalgrind.h>
      7:  #include <petscviewer.h>
      8: #if defined(PETSC_USE_GCOV)
      9: EXTERN_C_BEGIN
     10: void  __gcov_flush(void);
     11: EXTERN_C_END
     12: #endif

     14: #if defined(PETSC_USE_LOG)
     15: PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
     16: #endif

     18: #if defined(PETSC_SERIALIZE_FUNCTIONS)
     19: PETSC_INTERN PetscFPT PetscFPTData;
     20: PetscFPT PetscFPTData = 0;
     21: #endif

     23: #if defined(PETSC_HAVE_SAWS)
     24:  #include <petscviewersaws.h>
     25: #endif

     27: /* -----------------------------------------------------------------------------------------*/

     29: PETSC_INTERN FILE *petsc_history;

     31: PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void);
     32: PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void);
     33: PETSC_INTERN PetscErrorCode PetscFunctionListPrintAll(void);
     34: PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm,int);
     35: PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm,int);
     36: PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE**);

     38: /* user may set this BEFORE calling PetscInitialize() */
     39: MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL;

     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: PetscMPIInt Petsc_ShmComm_keyval   = MPI_KEYVAL_INVALID;

     46: /*
     47:      Declare and set all the string names of the PETSc enums
     48: */
     49: const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",NULL};
     50: const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",NULL};

     52: PetscBool PetscPreLoadingUsed = PETSC_FALSE;
     53: PetscBool PetscPreLoadingOn   = PETSC_FALSE;

     55: PetscInt PetscHotRegionDepth;

     57: #if defined(PETSC_HAVE_THREADSAFETY)
     58: PetscSpinlock PetscViewerASCIISpinLockOpen;
     59: PetscSpinlock PetscViewerASCIISpinLockStdout;
     60: PetscSpinlock PetscViewerASCIISpinLockStderr;
     61: PetscSpinlock PetscCommSpinLock;
     62: #endif

     64: /*
     65:       PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args

     67:    Collective

     69:    Level: advanced

     71:     Notes:
     72:     this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to
     73:      indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to
     74:      be called multiple times from Julia without the problem of trying to initialize MPI more than once.

     76:      Developer Note: Turns off PETSc signal handling to allow Julia to manage signals

     78: .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
     79: */
     80: PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
     81: {
     83:   int            myargc   = argc;
     84:   char           **myargs = args;

     87:   PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr;
     88:   PetscPopSignalHandler();
     89:   PetscBeganMPI = PETSC_FALSE;
     90:   PetscFunctionReturn(ierr);
     91: }

     93: /*
     94:       Used by Julia interface to get communicator
     95: */
     96: PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
     97: {
     99:   *comm = PETSC_COMM_SELF;
    100:   return(0);
    101: }

    103: /*@C
    104:       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
    105:         the command line arguments.

    107:    Collective

    109:    Level: advanced

    111: .seealso: PetscInitialize(), PetscInitializeFortran()
    112: @*/
    113: PetscErrorCode  PetscInitializeNoArguments(void)
    114: {
    116:   int            argc   = 0;
    117:   char           **args = NULL;

    120:   PetscInitialize(&argc,&args,NULL,NULL);
    121:   PetscFunctionReturn(ierr);
    122: }

    124: /*@
    125:       PetscInitialized - Determine whether PETSc is initialized.

    127:    Level: beginner

    129: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
    130: @*/
    131: PetscErrorCode PetscInitialized(PetscBool *isInitialized)
    132: {
    133:   *isInitialized = PetscInitializeCalled;
    134:   return 0;
    135: }

    137: /*@
    138:       PetscFinalized - Determine whether PetscFinalize() has been called yet

    140:    Level: developer

    142: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
    143: @*/
    144: PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
    145: {
    146:   *isFinalized = PetscFinalizeCalled;
    147:   return 0;
    148: }

    150: PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);

    152: /*
    153:        This function is the MPI reduction operation used to compute the sum of the
    154:    first half of the datatype and the max of the second half.
    155: */
    156: MPI_Op MPIU_MAXSUM_OP = 0;

    158: PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
    159: {
    160:   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;

    163:   if (*datatype != MPIU_2INT) {
    164:     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
    165:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
    166:   }

    168:   for (i=0; i<count; i++) {
    169:     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
    170:     xout[2*i+1] += xin[2*i+1];
    171:   }
    172:   PetscFunctionReturnVoid();
    173: }

    175: /*
    176:     Returns the max of the first entry owned by this processor and the
    177: sum of the second entry.

    179:     The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero
    180: is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths
    181: there would be no place to store the both needed results.
    182: */
    183: PetscErrorCode  PetscMaxSum(MPI_Comm comm,const PetscInt sizes[],PetscInt *max,PetscInt *sum)
    184: {

    188: #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
    189:   {
    190:     struct {PetscInt max,sum;} work;
    191:     MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);
    192:     *max = work.max;
    193:     *sum = work.sum;
    194:   }
    195: #else
    196:   {
    197:     PetscMPIInt    size,rank;
    198:     struct {PetscInt max,sum;} *work;
    199:     MPI_Comm_size(comm,&size);
    200:     MPI_Comm_rank(comm,&rank);
    201:     PetscMalloc1(size,&work);
    202:     MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);
    203:     *max = work[rank].max;
    204:     *sum = work[rank].sum;
    205:     PetscFree(work);
    206:   }
    207: #endif
    208:   return(0);
    209: }

    211: /* ----------------------------------------------------------------------------*/

    213: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
    214: MPI_Op MPIU_SUM = 0;

    216: PETSC_EXTERN void PetscSum_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
    217: {
    218:   PetscInt i,count = *cnt;

    221:   if (*datatype == MPIU_REAL) {
    222:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
    223:     for (i=0; i<count; i++) xout[i] += xin[i];
    224:   }
    225: #if defined(PETSC_HAVE_COMPLEX)
    226:   else if (*datatype == MPIU_COMPLEX) {
    227:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
    228:     for (i=0; i<count; i++) xout[i] += xin[i];
    229:   }
    230: #endif
    231:   else {
    232:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
    233:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
    234:   }
    235:   PetscFunctionReturnVoid();
    236: }
    237: #endif

    239: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
    240: MPI_Op MPIU_MAX = 0;
    241: MPI_Op MPIU_MIN = 0;

    243: PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
    244: {
    245:   PetscInt i,count = *cnt;

    248:   if (*datatype == MPIU_REAL) {
    249:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
    250:     for (i=0; i<count; i++) xout[i] = PetscMax(xout[i],xin[i]);
    251:   }
    252: #if defined(PETSC_HAVE_COMPLEX)
    253:   else if (*datatype == MPIU_COMPLEX) {
    254:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
    255:     for (i=0; i<count; i++) {
    256:       xout[i] = PetscRealPartComplex(xout[i])<PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
    257:     }
    258:   }
    259: #endif
    260:   else {
    261:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
    262:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
    263:   }
    264:   PetscFunctionReturnVoid();
    265: }

    267: PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
    268: {
    269:   PetscInt    i,count = *cnt;

    272:   if (*datatype == MPIU_REAL) {
    273:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
    274:     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
    275:   }
    276: #if defined(PETSC_HAVE_COMPLEX)
    277:   else if (*datatype == MPIU_COMPLEX) {
    278:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
    279:     for (i=0; i<count; i++) {
    280:       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
    281:     }
    282:   }
    283: #endif
    284:   else {
    285:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
    286:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
    287:   }
    288:   PetscFunctionReturnVoid();
    289: }
    290: #endif

    292: /*
    293:    Private routine to delete internal tag/name counter storage when a communicator is freed.

    295:    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.

    297:    Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()

    299: */
    300: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
    301: {
    302:   PetscErrorCode   ierr;
    303:   PetscCommCounter *counter=(PetscCommCounter*)count_val;

    306:   PetscInfo1(NULL,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
    307:   PetscFree(counter->iflags);CHKERRMPI(ierr);
    308:   PetscFree(counter);CHKERRMPI(ierr);
    309:   PetscFunctionReturn(MPI_SUCCESS);
    310: }

    312: /*
    313:   This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user
    314:   calls MPI_Comm_free().

    316:   This is the only entry point for breaking the links between inner and outer comms.

    318:   This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator.

    320:   Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval()

    322: */
    323: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
    324: {
    325:   PetscErrorCode                    ierr;
    326:   union {MPI_Comm comm; void *ptr;} icomm;

    329:   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
    330:   icomm.ptr = attr_val;
    331: #if defined(PETSC_USE_DEBUG)
    332:   {
    333:     /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */
    334:     PetscMPIInt flg;
    335:     union {MPI_Comm comm; void *ptr;} ocomm;
    336:     MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
    337:     if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm does not have OuterComm attribute");
    338:     if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner comm's OuterComm attribute does not point to outer PETSc comm");
    339:   }
    340: #endif
    341:   MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
    342:   PetscInfo2(NULL,"User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n",(long)comm,(long)icomm.comm);CHKERRMPI(ierr);
    343:   PetscFunctionReturn(MPI_SUCCESS);
    344: }

    346: /*
    347:  * This is invoked on the inner comm when Petsc_InnerComm_Attr_Delete_Fn calls MPI_Comm_delete_attr().  It should not be reached any other way.
    348:  */
    349: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
    350: {

    354:   PetscInfo1(NULL,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
    355:   PetscFunctionReturn(MPI_SUCCESS);
    356: }

    358: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm,PetscMPIInt,void *,void *);

    360: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
    361: PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
    362: PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
    363: PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
    364: #endif

    366: PetscMPIInt PETSC_MPI_ERROR_CLASS=MPI_ERR_LASTCODE,PETSC_MPI_ERROR_CODE;

    368: PETSC_INTERN int  PetscGlobalArgc;
    369: PETSC_INTERN char **PetscGlobalArgs;
    370: int  PetscGlobalArgc   = 0;
    371: char **PetscGlobalArgs = NULL;
    372: PetscSegBuffer PetscCitationsList;

    374: PetscErrorCode PetscCitationsInitialize(void)
    375: {

    379:   PetscSegBufferCreate(1,10000,&PetscCitationsList);
    380:   PetscCitationsRegister("@TechReport{petsc-user-ref,\n  Author = {Satish Balay and Shrirang Abhyankar and Mark F. Adams and Jed Brown \n            and Peter Brune and Kris Buschelman and Lisandro Dalcin and\n            Victor Eijkhout and William D. Gropp and Dmitry Karpeyev and\n            Dinesh Kaushik and Matthew G. Knepley and Dave A. May and Lois Curfman McInnes\n            and Richard Tran Mills and Todd Munson and Karl Rupp and Patrick Sanan\n            and Barry F. Smith and Stefano Zampini and Hong Zhang and Hong Zhang},\n  Title = {{PETS}c Users Manual},\n  Number = {ANL-95/11 - Revision 3.11},\n  Institution = {Argonne National Laboratory},\n  Year = {2019}\n}\n",NULL);
    381:   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);
    382:   return(0);
    383: }

    385: static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */

    387: PetscErrorCode  PetscSetProgramName(const char name[])
    388: {

    392:   PetscStrncpy(programname,name,PETSC_MAX_PATH_LEN);
    393:   return(0);
    394: }

    396: /*@C
    397:     PetscGetProgramName - Gets the name of the running program.

    399:     Not Collective

    401:     Input Parameter:
    402: .   len - length of the string name

    404:     Output Parameter:
    405: .   name - the name of the running program

    407:    Level: advanced

    409:     Notes:
    410:     The name of the program is copied into the user-provided character
    411:     array of length len.  On some machines the program name includes
    412:     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
    413: @*/
    414: PetscErrorCode  PetscGetProgramName(char name[],size_t len)
    415: {

    419:    PetscStrncpy(name,programname,len);
    420:   return(0);
    421: }

    423: /*@C
    424:    PetscGetArgs - Allows you to access the raw command line arguments anywhere
    425:      after PetscInitialize() is called but before PetscFinalize().

    427:    Not Collective

    429:    Output Parameters:
    430: +  argc - count of number of command line arguments
    431: -  args - the command line arguments

    433:    Level: intermediate

    435:    Notes:
    436:       This is usually used to pass the command line arguments into other libraries
    437:    that are called internally deep in PETSc or the Section 1.5 Writing Application Codes with PETSc.

    439:       The first argument contains the program name as is normal for C arguments.

    441: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments()

    443: @*/
    444: PetscErrorCode  PetscGetArgs(int *argc,char ***args)
    445: {
    447:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
    448:   *argc = PetscGlobalArgc;
    449:   *args = PetscGlobalArgs;
    450:   return(0);
    451: }

    453: /*@C
    454:    PetscGetArguments - Allows you to access the  command line arguments anywhere
    455:      after PetscInitialize() is called but before PetscFinalize().

    457:    Not Collective

    459:    Output Parameters:
    460: .  args - the command line arguments

    462:    Level: intermediate

    464:    Notes:
    465:       This does NOT start with the program name and IS null terminated (final arg is void)

    467: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments()

    469: @*/
    470: PetscErrorCode  PetscGetArguments(char ***args)
    471: {
    472:   PetscInt       i,argc = PetscGlobalArgc;

    476:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
    477:   if (!argc) {*args = NULL; return(0);}
    478:   PetscMalloc1(argc,args);
    479:   for (i=0; i<argc-1; i++) {
    480:     PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);
    481:   }
    482:   (*args)[argc-1] = NULL;
    483:   return(0);
    484: }

    486: /*@C
    487:    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()

    489:    Not Collective

    491:    Output Parameters:
    492: .  args - the command line arguments

    494:    Level: intermediate

    496: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments()

    498: @*/
    499: PetscErrorCode  PetscFreeArguments(char **args)
    500: {
    501:   PetscInt       i = 0;

    505:   if (!args) return(0);
    506:   while (args[i]) {
    507:     PetscFree(args[i]);
    508:     i++;
    509:   }
    510:   PetscFree(args);
    511:   return(0);
    512: }

    514: #if defined(PETSC_HAVE_SAWS)
    515: #include <petscconfiginfo.h>

    517: PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
    518: {
    519:   if (!PetscGlobalRank) {
    520:     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
    521:     int            port;
    522:     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
    523:     size_t         applinelen,introlen;
    525:     char           sawsurl[256];

    527:     PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);
    528:     if (flg) {
    529:       char  sawslog[PETSC_MAX_PATH_LEN];

    531:       PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);
    532:       if (sawslog[0]) {
    533:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
    534:       } else {
    535:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
    536:       }
    537:     }
    538:     PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);
    539:     if (flg) {
    540:       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
    541:     }
    542:     PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);
    543:     if (selectport) {
    544:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
    545:         PetscStackCallSAWs(SAWs_Set_Port,(port));
    546:     } else {
    547:       PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);
    548:       if (flg) {
    549:         PetscStackCallSAWs(SAWs_Set_Port,(port));
    550:       }
    551:     }
    552:     PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);
    553:     if (flg) {
    554:       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
    555:       PetscStrcmp(root,".",&rootlocal);
    556:     } else {
    557:       PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);
    558:       if (flg) {
    559:         PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);
    560:         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
    561:       }
    562:     }
    563:     PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);
    564:     if (flg2) {
    565:       char jsdir[PETSC_MAX_PATH_LEN];
    566:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
    567:       PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);
    568:       PetscTestDirectory(jsdir,'r',&flg);
    569:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
    570:       PetscStackCallSAWs(SAWs_Push_Local_Header,());
    571:     }
    572:     PetscGetProgramName(programname,64);
    573:     PetscStrlen(help,&applinelen);
    574:     introlen   = 4096 + applinelen;
    575:     applinelen += 1024;
    576:     PetscMalloc(applinelen,&appline);
    577:     PetscMalloc(introlen,&intro);

    579:     if (rootlocal) {
    580:       PetscSNPrintf(appline,applinelen,"%s.c.html",programname);
    581:       PetscTestFile(appline,'r',&rootlocal);
    582:     }
    583:     PetscOptionsGetAll(NULL,&options);
    584:     if (rootlocal && help) {
    585:       PetscSNPrintf(appline,applinelen,"<center> Running <a href=\"%s.c.html\">%s</a> %s</center><br><center><pre>%s</pre></center><br>\n",programname,programname,options,help);
    586:     } else if (help) {
    587:       PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
    588:     } else {
    589:       PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
    590:     }
    591:     PetscFree(options);
    592:     PetscGetVersion(version,sizeof(version));
    593:     PetscSNPrintf(intro,introlen,"<body>\n"
    594:                                     "<center><h2> <a href=\"https://www.mcs.anl.gov/petsc\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n"
    595:                                     "<center>This is the default PETSc Section 1.5 Writing Application Codes with PETSc dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
    596:                                     "%s",version,petscconfigureoptions,appline);
    597:     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
    598:     PetscFree(intro);
    599:     PetscFree(appline);
    600:     if (selectport) {
    601:       PetscBool silent;

    603:       SAWs_Initialize();
    604:       /* another process may have grabbed the port so keep trying */
    605:       while (ierr) {
    606:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
    607:         PetscStackCallSAWs(SAWs_Set_Port,(port));
    608:         SAWs_Initialize();
    609:       }

    611:       PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);
    612:       if (!silent) {
    613:         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
    614:         PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);
    615:       }
    616:     } else {
    617:       PetscStackCallSAWs(SAWs_Initialize,());
    618:     }
    619:     PetscCitationsRegister("@TechReport{ saws,\n"
    620:                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
    621:                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
    622:                                   "  Institution = {Argonne National Laboratory},\n"
    623:                                   "  Year   = 2013\n}\n",NULL);
    624:   }
    625:   return(0);
    626: }
    627: #endif

    629: /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
    630: PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
    631: {
    633: #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
    634:     /* see MPI.py for details on this bug */
    635:     (void) setenv("HWLOC_COMPONENTS","-x86",1);
    636: #endif
    637:   return(0);
    638: }

    640: #if defined(PETSC_HAVE_ADIOS)
    641: #include <adios.h>
    642: #include <adios_read.h>
    643: int64_t Petsc_adios_group;
    644: #endif
    645: #if defined(PETSC_HAVE_ADIOS2)
    646: #include <adios2_c.h>
    647: #endif
    648: #if defined(PETSC_HAVE_OPENMP)
    649: #include <omp.h>
    650: PetscInt PetscNumOMPThreads;
    651: #endif

    653: #if defined(PETSC_HAVE_DLFCN_H)
    654: #include <dlfcn.h>
    655: #endif

    657: /*@C
    658:    PetscInitialize - Initializes the PETSc database and MPI.
    659:    PetscInitialize() calls MPI_Init() if that has yet to be called,
    660:    so this routine should always be called near the beginning of
    661:    your program -- usually the very first line!

    663:    Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set

    665:    Input Parameters:
    666: +  argc - count of number of command line arguments
    667: .  args - the command line arguments
    668: .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
    669:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
    670: -  help - [optional] Help message to print, use NULL for no message

    672:    If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that
    673:    communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a
    674:    four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not,
    675:    then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even
    676:    if different subcommunicators of the job are doing different things with PETSc.

    678:    Options Database Keys:
    679: +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
    680: .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
    681: .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
    682: .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
    683: .  -on_error_abort - calls abort() when error detected (no traceback)
    684: .  -on_error_mpiabort - calls MPI_abort() when error detected
    685: .  -error_output_stderr - prints error messages to stderr instead of the default stdout
    686: .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
    687: .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
    688: .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
    689: .  -stop_for_debugger - Print message on how to attach debugger manually to
    690:                         process and wait (-debugger_pause) seconds for attachment
    691: .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
    692: .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
    693: .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
    694: .  -malloc_dump - prints a list of all unfreed memory at the end of the run
    695: .  -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds, ignored in optimized build. May want to set in PETSC_OPTIONS environmental variable
    696: .  -malloc_view - show a list of all allocated memory during PetscFinalize()
    697: .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
    698: .  -fp_trap - Stops on floating point exceptions
    699: .  -no_signal_handler - Indicates not to trap error signals
    700: .  -shared_tmp - indicates /tmp directory is shared by all processors
    701: .  -not_shared_tmp - each processor has own /tmp
    702: .  -tmp - alternative name of /tmp directory
    703: .  -get_total_flops - returns total flops done by all processors
    704: -  -memory_view - Print memory usage at end of run

    706:    Options Database Keys for Profiling:
    707:    See Users-Manual: Chapter 13 Profiling for details.
    708: +  -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See PetscInfo().
    709: .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
    710:         however it slows things down and gives a distorted view of the overall runtime.
    711: .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
    712:         hangs without running in the debugger).  See PetscLogTraceBegin().
    713: .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
    714: .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
    715: .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
    716:         summary is written to the file.  See PetscLogView().
    717: .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
    718: .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
    719: .  -log [filename] - Logs basic profiline information  See PetscLogDump().
    720: .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
    721: .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
    722: -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code

    724:     Only one of -log_trace, -log_view, -log_view, -log_all, -log, or -log_mpe may be used at a time

    726:    Options Database Keys for SAWs:
    727: +  -saws_port <portnumber> - port number to publish SAWs data, default is 8080
    728: .  -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen
    729:                             this is useful when you are running many jobs that utilize SAWs at the same time
    730: .  -saws_log <filename> - save a log of all SAWs communication
    731: .  -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP
    732: -  -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files

    734:    Environmental Variables:
    735: +   PETSC_TMP - alternative tmp directory
    736: .   PETSC_SHARED_TMP - tmp is shared by all processes
    737: .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
    738: .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
    739: -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to

    742:    Level: beginner

    744:    Notes:
    745:    If for some reason you must call MPI_Init() separately, call
    746:    it before PetscInitialize().

    748:    Fortran Version:
    749:    In Fortran this routine has the format
    750: $       call PetscInitialize(file,ierr)

    752: +   ierr - error return code
    753: -  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use PETSC_NULL_CHARACTER to not check for
    754:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files

    756:    Important Fortran Note:
    757:    In Fortran, you MUST use PETSC_NULL_CHARACTER to indicate a
    758:    null character string; you CANNOT just use NULL as
    759:    in the C version. See Users-Manual: Chapter 11 PETSc for Fortran Users for details.

    761:    If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after
    762:    calling PetscInitialize().

    764: .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()

    766: @*/
    767: PetscErrorCode  PetscInitialize(int *argc,char ***args,const char file[],const char help[])
    768: {
    770:   PetscMPIInt    flag, size;
    771:   PetscBool      flg = PETSC_TRUE;
    772:   char           hostname[256];

    775:   if (PetscInitializeCalled) return(0);
    776:   /*
    777:       The checking over compatible runtime libraries is complicated by the MPI ABI initiative
    778:       https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with
    779:         MPICH v3.1 (Released Feburary 2014)
    780:         IBM MPI v2.1 (December 2014)
    781:         Intel MPI Library v5.0 (2014)
    782:         Cray MPT v7.0.0 (June 2014)
    783:       As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions
    784:       listed above and since that time are compatible.

    786:       Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number
    787:       at compile time or runtime. Thus we will need to systematically track the allowed versions
    788:       and how they are represented in the mpi.h and MPI_Get_library_version() output in order
    789:       to perform the checking.

    791:       Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI).

    793:       Questions:

    795:         Should the checks for ABI incompatibility be only on the major version number below?
    796:         Presumably the output to stderr will be removed before a release.
    797:   */

    799: #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION)
    800:   {
    801:     char        mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING];
    802:     PetscMPIInt mpilibraryversionlength;
    803:     MPI_Get_library_version(mpilibraryversion,&mpilibraryversionlength);if (ierr) return ierr;
    804:     /* check for MPICH versions before MPI ABI initiative */
    805: #if defined(MPICH_VERSION)
    806: #if MPICH_NUMVERSION < 30100000
    807:     {
    808:       char *ver,*lf;
    809:       flg = PETSC_FALSE;
    810:       PetscStrstr(mpilibraryversion,"MPICH Version:",&ver);if (ierr) return ierr;
    811:       if (ver) {
    812:         PetscStrchr(ver,'\n',&lf);if (ierr) return ierr;
    813:         if (lf) {
    814:           *lf = 0;
    815:           PetscStrendswith(ver,MPICH_VERSION,&flg);if (ierr) return ierr;
    816:         }
    817:       }
    818:       if (!flg) {
    819:         fprintf(stderr,"PETSc Error --- MPICH library version \n%s does not match what PETSc was compiled with %s, aborting\n",mpilibraryversion,MPICH_VERSION);
    820:         return PETSC_ERR_MPI_LIB_INCOMP;
    821:       }
    822:     }
    823: #endif
    824:     /* check for OpenMPI version, it is not part of the MPI ABI initiative (is it part of another initiative that needs to be handled?) */
    825: #elif defined(OMPI_MAJOR_VERSION)
    826:     {
    827:       char *ver,bs[32],*bsf;
    828:       flg = PETSC_FALSE;
    829:       PetscStrstr(mpilibraryversion,"Open MPI",&ver);if (ierr) return ierr;
    830:       if (ver) {
    831:         PetscSNPrintf(bs,32,"v%d.%d",OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
    832:         PetscStrstr(ver,bs,&bsf);if (ierr) return ierr;
    833:         if (bsf) flg = PETSC_TRUE;
    834:       }
    835:       if (!flg) {
    836:         fprintf(stderr,"PETSc Error --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d, aborting\n",mpilibraryversion,OMPI_MAJOR_VERSION,OMPI_MINOR_VERSION);
    837:         return PETSC_ERR_MPI_LIB_INCOMP;
    838:       }
    839:     }
    840: #endif
    841:   }
    842: #endif

    844: #if defined(PETSC_HAVE_DLSYM)
    845:   {
    846:     PetscInt cnt = 0;
    847:     /* These symbols are currently in the OpenMPI and MPICH libraries; they may not always be, in that case the test will simply not detect the problem */
    848:     if (dlsym(RTLD_DEFAULT,"ompi_mpi_init")) cnt++;
    849:     if (dlsym(RTLD_DEFAULT,"MPL_exit")) cnt++;
    850:     if (cnt > 1) {
    851:       fprintf(stderr,"PETSc Error --- Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly\n");
    852:       return PETSC_ERR_MPI_LIB_INCOMP;
    853:     }
    854:   }
    855: #endif

    857:   /* these must be initialized in a routine, not as a constant declaration*/
    858:   PETSC_STDOUT = stdout;
    859:   PETSC_STDERR = stderr;

    861:   /* on Windows - set printf to default to printing 2 digit exponents */
    862: #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT)
    863:   _set_output_format(_TWO_DIGIT_EXPONENT);
    864: #endif

    866:   PetscOptionsCreateDefault();

    868:   /*
    869:      We initialize the program name here (before MPI_Init()) because MPICH has a bug in
    870:      it that it sets args[0] on all processors to be args[0] on the first processor.
    871:   */
    872:   if (argc && *argc) {
    873:     PetscSetProgramName(**args);
    874:   } else {
    875:     PetscSetProgramName("Unknown Name");
    876:   }

    878:   MPI_Initialized(&flag);
    879:   if (!flag) {
    880:     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");
    881:     PetscPreMPIInit_Private();
    882: #if defined(PETSC_HAVE_MPI_INIT_THREAD)
    883:     {
    884:       PetscMPIInt provided;
    885:       MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);
    886:     }
    887: #else
    888:     MPI_Init(argc,args);
    889: #endif
    890:     PetscBeganMPI = PETSC_TRUE;
    891:   }

    893:   if (argc && args) {
    894:     PetscGlobalArgc = *argc;
    895:     PetscGlobalArgs = *args;
    896:   }
    897:   PetscFinalizeCalled = PETSC_FALSE;
    898:   PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen);
    899:   PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout);
    900:   PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr);
    901:   PetscSpinlockCreate(&PetscCommSpinLock);

    903:   if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD;
    904:   MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);

    906:   if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) {
    907:     MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS);
    908:     MPI_Add_error_code(PETSC_MPI_ERROR_CLASS,&PETSC_MPI_ERROR_CODE);
    909:   }

    911:   /* Done after init due to a bug in MPICH-GM? */
    912:   PetscErrorPrintfInitialize();

    914:   MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);
    915:   MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);

    917:   MPIU_BOOL = MPI_INT;
    918:   MPIU_ENUM = MPI_INT;
    919:   MPIU_FORTRANADDR = (sizeof(void*) == sizeof(int)) ? MPI_INT : MPIU_INT64;
    920:   if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED;
    921:   else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG;
    922: #if defined(PETSC_SIZEOF_LONG_LONG)
    923:   else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG;
    924: #endif
    925:   else {(*PetscErrorPrintf)("PetscInitialize: Could not find MPI type for size_t\n"); return PETSC_ERR_SUP_SYS;}

    927:   /*
    928:      Initialized the global complex variable; this is because with
    929:      shared libraries the constructors for global variables
    930:      are not called; at least on IRIX.
    931:   */
    932: #if defined(PETSC_HAVE_COMPLEX)
    933:   {
    934: #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128)
    935:     PetscComplex ic(0.0,1.0);
    936:     PETSC_i = ic;
    937: #else
    938:     PETSC_i = _Complex_I;
    939: #endif
    940:   }

    942: #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
    943:   MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);
    944:   MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);
    945:   MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);
    946:   MPI_Type_commit(&MPIU_C_COMPLEX);
    947: #endif
    948: #endif /* PETSC_HAVE_COMPLEX */

    950:   /*
    951:      Create the PETSc MPI reduction operator that sums of the first
    952:      half of the entries and maxes the second half.
    953:   */
    954:   MPI_Op_create(MPIU_MaxSum_Local,1,&MPIU_MAXSUM_OP);

    956: #if defined(PETSC_USE_REAL___FLOAT128)
    957:   MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);
    958:   MPI_Type_commit(&MPIU___FLOAT128);
    959: #if defined(PETSC_HAVE_COMPLEX)
    960:   MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);
    961:   MPI_Type_commit(&MPIU___COMPLEX128);
    962: #endif
    963:   MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);
    964:   MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);
    965: #elif defined(PETSC_USE_REAL___FP16)
    966:   MPI_Type_contiguous(2,MPI_CHAR,&MPIU___FP16);
    967:   MPI_Type_commit(&MPIU___FP16);
    968:   MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);
    969:   MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);
    970: #endif

    972: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
    973:   MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);
    974: #endif

    976:   MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);
    977:   MPI_Type_commit(&MPIU_2SCALAR);

    979: #if defined(PETSC_USE_64BIT_INDICES)
    980:   MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);
    981:   MPI_Type_commit(&MPIU_2INT);
    982: #endif

    985:   /*
    986:      Attributes to be set on PETSc communicators
    987:   */
    988:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_Counter_Attr_Delete_Fn,&Petsc_Counter_keyval,(void*)0);
    989:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_InnerComm_Attr_Delete_Fn,&Petsc_InnerComm_keyval,(void*)0);
    990:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_OuterComm_Attr_Delete_Fn,&Petsc_OuterComm_keyval,(void*)0);
    991:   MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN,Petsc_ShmComm_Attr_Delete_Fn,&Petsc_ShmComm_keyval,(void*)0);

    993:   /*
    994:      Build the options database
    995:   */
    996:   PetscOptionsInsert(NULL,argc,args,file);

    998:   /* call a second time so it can look in the options database */
    999:   PetscErrorPrintfInitialize();

    1001:   /*
    1002:      Print main Section 1.5 Writing Application Codes with PETSc help message
    1003:   */
    1004:   PetscOptionsHasHelp(NULL,&flg);
    1005:   if (help && flg) {
    1006:     PetscPrintf(PETSC_COMM_WORLD,help);
    1007:     PetscPrintf(PETSC_COMM_WORLD,"----------------------------------------\n");
    1008:   }
    1009:   PetscOptionsCheckInitial_Private();

    1011:   PetscCitationsInitialize();

    1013: #if defined(PETSC_HAVE_SAWS)
    1014:   PetscInitializeSAWs(help);
    1015: #endif

    1017:   /*
    1018:      Load the dynamic libraries (on machines that support them), this registers all
    1019:      the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes)
    1020:   */
    1021:   PetscInitialize_DynamicLibraries();

    1023:   MPI_Comm_size(PETSC_COMM_WORLD,&size);
    1024:   PetscInfo1(NULL,"PETSc successfully started: number of processors = %d\n",size);
    1025:   PetscGetHostName(hostname,256);
    1026:   PetscInfo1(NULL,"Running on machine: %s\n",hostname);
    1027: #if defined(PETSC_HAVE_OPENMP)
    1028:   {
    1029:     PetscBool omp_view_flag;
    1030:     char      *threads = getenv("OMP_NUM_THREADS");

    1032:    if (threads) {
    1033:      PetscInfo1(NULL,"Number of OpenMP threads %s (given by OMP_NUM_THREADS)\n",threads);
    1034:      (void) sscanf(threads, "%" PetscInt_FMT,&PetscNumOMPThreads);
    1035:    } else {
    1036: #define NMAX  10000
    1037:      int          i;
    1038:       PetscScalar *x;
    1039:       PetscMalloc1(NMAX,&x);
    1040: #pragma omp parallel for
    1041:       for (i=0; i<NMAX; i++) {
    1042:         x[i] = 0.0;
    1043:         PetscNumOMPThreads  = (PetscInt) omp_get_num_threads();
    1044:       }
    1045:       PetscFree(x);
    1046:       PetscInfo1(NULL,"Number of OpenMP threads %D (number not set with OMP_NUM_THREADS, chosen by system)\n",PetscNumOMPThreads);
    1047:     }
    1048:     PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"OpenMP options","Sys");
    1049:     PetscOptionsInt("-omp_num_threads","Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS","None",PetscNumOMPThreads,&PetscNumOMPThreads,&flg);
    1050:     PetscOptionsName("-omp_view","Display OpenMP number of threads",NULL,&omp_view_flag);
    1051:     PetscOptionsEnd();
    1052:     if (flg) {
    1053:       PetscInfo1(NULL,"Number of OpenMP theads %D (given by -omp_num_threads)\n",PetscNumOMPThreads);
    1054:       omp_set_num_threads((int)PetscNumOMPThreads);
    1055:     }
    1056:     if (omp_view_flag) {
    1057:       PetscPrintf(PETSC_COMM_WORLD,"OpenMP: number of threads %D\n",PetscNumOMPThreads);
    1058:     }
    1059:   }
    1060: #endif
    1061:   /* Check the options database for options related to the options database itself */
    1062:   PetscOptionsSetFromOptions(NULL);

    1064: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
    1065:   /*
    1066:       Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI

    1068:       Currently not used because it is not supported by MPICH.
    1069:   */
    1070:   if (!PetscBinaryBigEndian()) {
    1071:     MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);
    1072:   }
    1073: #endif

    1075:   /*
    1076:       Setup building of stack frames for all function calls
    1077:   */
    1078: #if defined(PETSC_USE_DEBUG) && !defined(PETSC_HAVE_THREADSAFETY)
    1079:   PetscStackCreate();
    1080: #endif

    1082: #if defined(PETSC_SERIALIZE_FUNCTIONS)
    1083:   PetscFPTCreate(10000);
    1084: #endif

    1086: #if defined(PETSC_HAVE_HWLOC)
    1087:   {
    1088:     PetscViewer viewer;
    1089:     PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-process_view",&viewer,NULL,&flg);
    1090:     if (flg) {
    1091:       PetscProcessPlacementView(viewer);
    1092:       PetscViewerDestroy(&viewer);
    1093:     }
    1094:   }
    1095: #endif

    1097:   flg = PETSC_TRUE;
    1098:   PetscOptionsGetBool(NULL,NULL,"-viewfromoptions",&flg,NULL);
    1099:   if (!flg) {PetscOptionsPushGetViewerOff(PETSC_TRUE); }

    1101: #if defined(PETSC_HAVE_ADIOS)
    1102:   adios_init_noxml(PETSC_COMM_WORLD);
    1103:   adios_declare_group(&Petsc_adios_group,"PETSc","",adios_stat_default);
    1104:   adios_select_method(Petsc_adios_group,"MPI","","");
    1105:   adios_read_init_method(ADIOS_READ_METHOD_BP,PETSC_COMM_WORLD,"");
    1106: #endif
    1107: #if defined(PETSC_HAVE_ADIOS2)
    1108: #endif

    1110:   /*
    1111:       Once we are completedly initialized then we can set this variables
    1112:   */
    1113:   PetscInitializeCalled = PETSC_TRUE;

    1115:   PetscOptionsHasName(NULL,NULL,"-python",&flg);
    1116:   if (flg) {PetscPythonInitialize(NULL,NULL);}
    1117:   return(0);
    1118: }

    1120: #if defined(PETSC_USE_LOG)
    1121: PETSC_INTERN PetscObject *PetscObjects;
    1122: PETSC_INTERN PetscInt    PetscObjectsCounts;
    1123: PETSC_INTERN PetscInt    PetscObjectsMaxCounts;
    1124: PETSC_INTERN PetscBool   PetscObjectsLog;
    1125: #endif

    1127: /*
    1128:     Frees all the MPI types and operations that PETSc may have created
    1129: */
    1130: PetscErrorCode  PetscFreeMPIResources(void)
    1131: {

    1135: #if defined(PETSC_USE_REAL___FLOAT128)
    1136:   MPI_Type_free(&MPIU___FLOAT128);
    1137: #if defined(PETSC_HAVE_COMPLEX)
    1138:   MPI_Type_free(&MPIU___COMPLEX128);
    1139: #endif
    1140:   MPI_Op_free(&MPIU_MAX);
    1141:   MPI_Op_free(&MPIU_MIN);
    1142: #elif defined(PETSC_USE_REAL___FP16)
    1143:   MPI_Type_free(&MPIU___FP16);
    1144:   MPI_Op_free(&MPIU_MAX);
    1145:   MPI_Op_free(&MPIU_MIN);
    1146: #endif

    1148: #if defined(PETSC_HAVE_COMPLEX)
    1149: #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
    1150:   MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);
    1151:   MPI_Type_free(&MPIU_C_COMPLEX);
    1152: #endif
    1153: #endif

    1155: #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
    1156:   MPI_Op_free(&MPIU_SUM);
    1157: #endif

    1159:   MPI_Type_free(&MPIU_2SCALAR);
    1160: #if defined(PETSC_USE_64BIT_INDICES)
    1161:   MPI_Type_free(&MPIU_2INT);
    1162: #endif
    1163:   MPI_Op_free(&MPIU_MAXSUM_OP);
    1164:   return(0);
    1165: }

    1167: /*@C
    1168:    PetscFinalize - Checks for options to be called at the conclusion
    1169:    of the program. MPI_Finalize() is called only if the user had not
    1170:    called MPI_Init() before calling PetscInitialize().

    1172:    Collective on PETSC_COMM_WORLD

    1174:    Options Database Keys:
    1175: +  -options_view - Calls PetscOptionsView()
    1176: .  -options_left - Prints unused options that remain in the database
    1177: .  -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
    1178: .  -mpidump - Calls PetscMPIDump()
    1179: .  -malloc_dump <optional filename> - Calls PetscMallocDump(), displays all memory allocated that has not been freed
    1180: .  -malloc_info - Prints total memory usage
    1181: -  -malloc_view <optional filename> - Prints list of all memory allocated and where

    1183:    Level: beginner

    1185:    Note:
    1186:    See PetscInitialize() for more general runtime options.

    1188: .seealso: PetscInitialize(), PetscOptionsView(), PetscMallocDump(), PetscMPIDump(), PetscEnd()
    1189: @*/
    1190: PetscErrorCode  PetscFinalize(void)
    1191: {
    1193:   PetscMPIInt    rank;
    1194:   PetscInt       nopt;
    1195:   PetscBool      flg1 = PETSC_FALSE,flg2 = PETSC_FALSE,flg3 = PETSC_FALSE;
    1196:   PetscBool      flg;
    1197: #if defined(PETSC_USE_LOG)
    1198:   char           mname[PETSC_MAX_PATH_LEN];
    1199: #endif

    1201:   if (!PetscInitializeCalled) {
    1202:     printf("PetscInitialize() must be called before PetscFinalize()\n");
    1203:     return(PETSC_ERR_ARG_WRONGSTATE);
    1204:   }
    1206:   PetscInfo(NULL,"PetscFinalize() called\n");

    1208:   MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
    1209: #if defined(PETSC_HAVE_ADIOS)
    1210:   adios_read_finalize_method(ADIOS_READ_METHOD_BP_AGGREGATE);
    1211:   adios_finalize(rank);
    1212: #endif
    1213: #if defined(PETSC_HAVE_ADIOS2)
    1214: #endif
    1215:   PetscOptionsHasName(NULL,NULL,"-citations",&flg);
    1216:   if (flg) {
    1217:     char  *cits, filename[PETSC_MAX_PATH_LEN];
    1218:     FILE  *fd = PETSC_STDOUT;

    1220:     PetscOptionsGetString(NULL,NULL,"-citations",filename,PETSC_MAX_PATH_LEN,NULL);
    1221:     if (filename[0]) {
    1222:       PetscFOpen(PETSC_COMM_WORLD,filename,"w",&fd);
    1223:     }
    1224:     PetscSegBufferGet(PetscCitationsList,1,&cits);
    1225:     cits[0] = 0;
    1226:     PetscSegBufferExtractAlloc(PetscCitationsList,&cits);
    1227:     PetscFPrintf(PETSC_COMM_WORLD,fd,"If you publish results based on this computation please cite the following:\n");
    1228:     PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");
    1229:     PetscFPrintf(PETSC_COMM_WORLD,fd,"%s",cits);
    1230:     PetscFPrintf(PETSC_COMM_WORLD,fd,"===========================================================================\n");
    1231:     PetscFClose(PETSC_COMM_WORLD,fd);
    1232:     PetscFree(cits);
    1233:   }
    1234:   PetscSegBufferDestroy(&PetscCitationsList);

    1236: #if defined(PETSC_HAVE_SSL) && defined(PETSC_USE_SOCKET_VIEWER)
    1237:   /* TextBelt is run for testing purposes only, please do not use this feature often */
    1238:   {
    1239:     PetscInt nmax = 2;
    1240:     char     **buffs;
    1241:     PetscMalloc1(2,&buffs);
    1242:     PetscOptionsGetStringArray(NULL,NULL,"-textbelt",buffs,&nmax,&flg1);
    1243:     if (flg1) {
    1244:       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-textbelt requires either the phone number or number,\"message\"");
    1245:       if (nmax == 1) {
    1246:         PetscMalloc1(128,&buffs[1]);
    1247:         PetscGetProgramName(buffs[1],32);
    1248:         PetscStrcat(buffs[1]," has completed");
    1249:       }
    1250:       PetscTextBelt(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);
    1251:       PetscFree(buffs[0]);
    1252:       PetscFree(buffs[1]);
    1253:     }
    1254:     PetscFree(buffs);
    1255:   }
    1256:   {
    1257:     PetscInt nmax = 2;
    1258:     char     **buffs;
    1259:     PetscMalloc1(2,&buffs);
    1260:     PetscOptionsGetStringArray(NULL,NULL,"-tellmycell",buffs,&nmax,&flg1);
    1261:     if (flg1) {
    1262:       if (!nmax) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_USER,"-tellmycell requires either the phone number or number,\"message\"");
    1263:       if (nmax == 1) {
    1264:         PetscMalloc1(128,&buffs[1]);
    1265:         PetscGetProgramName(buffs[1],32);
    1266:         PetscStrcat(buffs[1]," has completed");
    1267:       }
    1268:       PetscTellMyCell(PETSC_COMM_WORLD,buffs[0],buffs[1],NULL);
    1269:       PetscFree(buffs[0]);
    1270:       PetscFree(buffs[1]);
    1271:     }
    1272:     PetscFree(buffs);
    1273:   }
    1274: #endif
    1275:   /*
    1276:     It should be safe to cancel the options monitors, since we don't expect to be setting options
    1277:     here (at least that are worth monitoring).  Monitors ought to be released so that they release
    1278:     whatever memory was allocated there before -malloc_dump reports unfreed memory.
    1279:   */
    1280:   PetscOptionsMonitorCancel();

    1282: #if defined(PETSC_SERIALIZE_FUNCTIONS)
    1283:   PetscFPTDestroy();
    1284: #endif

    1287: #if defined(PETSC_HAVE_SAWS)
    1288:   flg = PETSC_FALSE;
    1289:   PetscOptionsGetBool(NULL,NULL,"-saw_options",&flg,NULL);
    1290:   if (flg) {
    1291:     PetscOptionsSAWsDestroy();
    1292:   }
    1293: #endif

    1295: #if defined(PETSC_HAVE_X)
    1296:   flg1 = PETSC_FALSE;
    1297:   PetscOptionsGetBool(NULL,NULL,"-x_virtual",&flg1,NULL);
    1298:   if (flg1) {
    1299:     /*  this is a crude hack, but better than nothing */
    1300:     PetscPOpen(PETSC_COMM_WORLD,NULL,"pkill -9 Xvfb","r",NULL);
    1301:   }
    1302: #endif

    1304: #if !defined(PETSC_HAVE_THREADSAFETY)
    1305:   PetscOptionsGetBool(NULL,NULL,"-malloc_info",&flg2,NULL);
    1306:   if (!flg2) {
    1307:     flg2 = PETSC_FALSE;
    1308:     PetscOptionsGetBool(NULL,NULL,"-memory_view",&flg2,NULL);
    1309:   }
    1310:   if (flg2) {
    1311:     PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");
    1312:   }
    1313: #endif

    1315: #if defined(PETSC_USE_LOG)
    1316:   flg1 = PETSC_FALSE;
    1317:   PetscOptionsGetBool(NULL,NULL,"-get_total_flops",&flg1,NULL);
    1318:   if (flg1) {
    1319:     PetscLogDouble flops = 0;
    1320:     MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);
    1321:     PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);
    1322:   }
    1323: #endif

    1326: #if defined(PETSC_USE_LOG)
    1327: #if defined(PETSC_HAVE_MPE)
    1328:   mname[0] = 0;
    1329:   PetscOptionsGetString(NULL,NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);
    1330:   if (flg1) {
    1331:     if (mname[0]) {PetscLogMPEDump(mname);}
    1332:     else          {PetscLogMPEDump(0);}
    1333:   }
    1334: #endif
    1335: #endif

    1337:   /*
    1338:      Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_().
    1339:   */
    1340:   PetscObjectRegisterDestroyAll();

    1342: #if defined(PETSC_USE_LOG)
    1343:   PetscOptionsPushGetViewerOff(PETSC_FALSE);
    1344:   PetscLogViewFromOptions();
    1345:   PetscOptionsPopGetViewerOff();

    1347:   mname[0] = 0;
    1348:   PetscOptionsGetString(NULL,NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);
    1349:   if (flg1) {
    1350:     PetscViewer viewer;
    1351:     (*PetscHelpPrintf)(PETSC_COMM_WORLD,"\n\n WARNING:   -log_summary is being deprecated; switch to -log_view\n\n\n");
    1352:     if (mname[0]) {
    1353:       PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);
    1354:       PetscLogView(viewer);
    1355:       PetscViewerDestroy(&viewer);
    1356:     } else {
    1357:       viewer = PETSC_VIEWER_STDOUT_WORLD;
    1358:       PetscViewerPushFormat(viewer,PETSC_VIEWER_DEFAULT);
    1359:       PetscLogView(viewer);
    1360:       PetscViewerPopFormat(viewer);
    1361:     }
    1362:   }

    1364:   /*
    1365:      Free any objects created by the last block of code.
    1366:   */
    1367:   PetscObjectRegisterDestroyAll();

    1369:   mname[0] = 0;
    1370:   PetscOptionsGetString(NULL,NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);
    1371:   PetscOptionsGetString(NULL,NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);
    1372:   if (flg1 || flg2) {PetscLogDump(mname);}
    1373: #endif

    1375:   PetscStackDestroy();

    1377:   flg1 = PETSC_FALSE;
    1378:   PetscOptionsGetBool(NULL,NULL,"-no_signal_handler",&flg1,NULL);
    1379:   if (!flg1) { PetscPopSignalHandler();}
    1380:   flg1 = PETSC_FALSE;
    1381:   PetscOptionsGetBool(NULL,NULL,"-mpidump",&flg1,NULL);
    1382:   if (flg1) {
    1383:     PetscMPIDump(stdout);
    1384:   }
    1385:   flg1 = PETSC_FALSE;
    1386:   flg2 = PETSC_FALSE;
    1387:   /* preemptive call to avoid listing this option in options table as unused */
    1388:   PetscOptionsHasName(NULL,NULL,"-malloc_dump",&flg1);
    1389:   PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);
    1390:   PetscOptionsGetBool(NULL,NULL,"-options_view",&flg2,NULL);

    1392:   if (flg2) {
    1393:     PetscViewer viewer;
    1394:     PetscViewerCreate(PETSC_COMM_WORLD,&viewer);
    1395:     PetscViewerSetType(viewer,PETSCVIEWERASCII);
    1396:     PetscOptionsView(NULL,viewer);
    1397:     PetscViewerDestroy(&viewer);
    1398:   }

    1400:   /* to prevent PETSc -options_left from warning */
    1401:   PetscOptionsHasName(NULL,NULL,"-nox",&flg1);
    1402:   PetscOptionsHasName(NULL,NULL,"-nox_warning",&flg1);

    1404:   flg3 = PETSC_FALSE; /* default value is required */
    1405:   PetscOptionsGetBool(NULL,NULL,"-options_left",&flg3,&flg1);
    1406: #if defined(PETSC_USE_DEBUG)
    1407:   if (!flg1) flg3 = PETSC_TRUE;
    1408: #endif
    1409:   if (flg3) {
    1410:     if (!flg2 && flg1) { /* have not yet printed the options */
    1411:       PetscViewer viewer;
    1412:       PetscViewerCreate(PETSC_COMM_WORLD,&viewer);
    1413:       PetscViewerSetType(viewer,PETSCVIEWERASCII);
    1414:       PetscOptionsView(NULL,viewer);
    1415:       PetscViewerDestroy(&viewer);
    1416:     }
    1417:     PetscOptionsAllUsed(NULL,&nopt);
    1418:     if (nopt) {
    1419:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");
    1420:       PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");
    1421:       if (nopt == 1) {
    1422:         PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");
    1423:       } else {
    1424:         PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);
    1425:       }
    1426:     } else if (flg3 && flg1) {
    1427:       PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");
    1428:     }
    1429:     PetscOptionsLeft(NULL);
    1430:   }

    1432: #if defined(PETSC_HAVE_SAWS)
    1433:   if (!PetscGlobalRank) {
    1434:     PetscStackSAWsViewOff();
    1435:     PetscStackCallSAWs(SAWs_Finalize,());
    1436:   }
    1437: #endif

    1439: #if defined(PETSC_USE_LOG)
    1440:   /*
    1441:        List all objects the user may have forgot to free
    1442:   */
    1443:   if (PetscObjectsLog) {
    1444:     PetscOptionsHasName(NULL,NULL,"-objects_dump",&flg1);
    1445:     if (flg1) {
    1446:       MPI_Comm local_comm;
    1447:       char     string[64];

    1449:       PetscOptionsGetString(NULL,NULL,"-objects_dump",string,64,NULL);
    1450:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
    1451:       PetscSequentialPhaseBegin_Private(local_comm,1);
    1452:       PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);
    1453:       PetscSequentialPhaseEnd_Private(local_comm,1);
    1454:       MPI_Comm_free(&local_comm);
    1455:     }
    1456:   }
    1457: #endif

    1459: #if defined(PETSC_USE_LOG)
    1460:   PetscObjectsCounts    = 0;
    1461:   PetscObjectsMaxCounts = 0;
    1462:   PetscFree(PetscObjects);
    1463: #endif

    1465:   /*
    1466:      Destroy any packages that registered a finalize
    1467:   */
    1468:   PetscRegisterFinalizeAll();

    1470: #if defined(PETSC_USE_LOG)
    1471:   PetscLogFinalize();
    1472: #endif

    1474:   /*
    1475:      Print PetscFunctionLists that have not been properly freed

    1477:   PetscFunctionListPrintAll();
    1478:   */

    1480:   if (petsc_history) {
    1481:     PetscCloseHistoryFile(&petsc_history);
    1482:     petsc_history = NULL;
    1483:   }
    1484:   PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton);
    1485:   PetscInfoDestroy();

    1487: #if !defined(PETSC_HAVE_THREADSAFETY)
    1488:   if (!(PETSC_RUNNING_ON_VALGRIND)) {
    1489:     char fname[PETSC_MAX_PATH_LEN];
    1490:     char sname[PETSC_MAX_PATH_LEN];
    1491:     FILE *fd;
    1492:     int  err;

    1494:     flg2 = PETSC_FALSE;
    1495:     flg3 = PETSC_FALSE;
    1496: #if defined(PETSC_USE_DEBUG)
    1497:     PetscOptionsGetBool(NULL,NULL,"-malloc_test",&flg2,NULL);
    1498: #endif
    1499:     PetscOptionsGetBool(NULL,NULL,"-malloc_debug",&flg3,NULL);
    1500:     fname[0] = 0;
    1501:     PetscOptionsGetString(NULL,NULL,"-malloc_dump",fname,250,&flg1);
    1502:     if (flg1 && fname[0]) {

    1504:       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
    1505:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
    1506:       PetscMallocDump(fd);
    1507:       err  = fclose(fd);
    1508:       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
    1509:     } else if (flg1 || flg2 || flg3) {
    1510:       MPI_Comm local_comm;

    1512:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
    1513:       PetscSequentialPhaseBegin_Private(local_comm,1);
    1514:       PetscMallocDump(stdout);
    1515:       PetscSequentialPhaseEnd_Private(local_comm,1);
    1516:       MPI_Comm_free(&local_comm);
    1517:     }
    1518:     fname[0] = 0;
    1519:     PetscOptionsGetString(NULL,NULL,"-malloc_view",fname,250,&flg1);
    1520:     if (flg1 && fname[0]) {

    1522:       PetscSNPrintf(sname,PETSC_MAX_PATH_LEN,"%s_%d",fname,rank);
    1523:       fd   = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname);
    1524:       PetscMallocView(fd);
    1525:       err  = fclose(fd);
    1526:       if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file");
    1527:     } else if (flg1) {
    1528:       MPI_Comm local_comm;

    1530:       MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);
    1531:       PetscSequentialPhaseBegin_Private(local_comm,1);
    1532:       PetscMallocView(stdout);
    1533:       PetscSequentialPhaseEnd_Private(local_comm,1);
    1534:       MPI_Comm_free(&local_comm);
    1535:     }
    1536:   }
    1537: #endif

    1539:   /*
    1540:      Close any open dynamic libraries
    1541:   */
    1542:   PetscFinalize_DynamicLibraries();

    1544:   /* Can be destroyed only after all the options are used */
    1545:   PetscOptionsDestroyDefault();

    1547:   PetscGlobalArgc = 0;
    1548:   PetscGlobalArgs = NULL;

    1550:   PetscFreeMPIResources();

    1552:   /*
    1553:      Destroy any known inner MPI_Comm's and attributes pointing to them
    1554:      Note this will not destroy any new communicators the user has created.

    1556:      If all PETSc objects were not destroyed those left over objects will have hanging references to
    1557:      the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again
    1558:  */
    1559:   {
    1560:     PetscCommCounter *counter;
    1561:     PetscMPIInt      flg;
    1562:     MPI_Comm         icomm;
    1563:     union {MPI_Comm comm; void *ptr;} ucomm;
    1564:     MPI_Comm_get_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ucomm,&flg);
    1565:     if (flg) {
    1566:       icomm = ucomm.comm;
    1567:       MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);
    1568:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");

    1570:       MPI_Comm_delete_attr(PETSC_COMM_SELF,Petsc_InnerComm_keyval);
    1571:       MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);
    1572:       MPI_Comm_free(&icomm);
    1573:     }
    1574:     MPI_Comm_get_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ucomm,&flg);
    1575:     if (flg) {
    1576:       icomm = ucomm.comm;
    1577:       MPI_Comm_get_attr(icomm,Petsc_Counter_keyval,&counter,&flg);
    1578:       if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory");

    1580:       MPI_Comm_delete_attr(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);
    1581:       MPI_Comm_delete_attr(icomm,Petsc_Counter_keyval);
    1582:       MPI_Comm_free(&icomm);
    1583:     }
    1584:   }

    1586:   MPI_Comm_free_keyval(&Petsc_Counter_keyval);
    1587:   MPI_Comm_free_keyval(&Petsc_InnerComm_keyval);
    1588:   MPI_Comm_free_keyval(&Petsc_OuterComm_keyval);
    1589:   MPI_Comm_free_keyval(&Petsc_ShmComm_keyval);

    1591:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen);
    1592:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout);
    1593:   PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr);
    1594:   PetscSpinlockDestroy(&PetscCommSpinLock);

    1596:   if (PetscBeganMPI) {
    1597: #if defined(PETSC_HAVE_MPI_FINALIZED)
    1598:     PetscMPIInt flag;
    1599:     MPI_Finalized(&flag);
    1600:     if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()");
    1601: #endif
    1602:     MPI_Finalize();
    1603:   }
    1604: /*

    1606:      Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because
    1607:    the communicator has some outstanding requests on it. Specifically if the
    1608:    flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See
    1609:    src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate()
    1610:    is never freed as it should be. Thus one may obtain messages of the form
    1611:    [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the
    1612:    memory was not freed.

    1614: */
    1615:   PetscMallocClear();

    1617:   PetscInitializeCalled = PETSC_FALSE;
    1618:   PetscFinalizeCalled   = PETSC_TRUE;
    1619: #if defined(PETSC_USE_GCOV)
    1620:   /*
    1621:      flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the
    1622:      gcov files are still being added to the directories as git tries to remove the directories.
    1623:    */
    1624:   __gcov_flush();
    1625: #endif
    1626:   return(0);
    1627: }

    1629: #if defined(PETSC_MISSING_LAPACK_lsame_)
    1630: PETSC_EXTERN int lsame_(char *a,char *b)
    1631: {
    1632:   if (*a == *b) return 1;
    1633:   if (*a + 32 == *b) return 1;
    1634:   if (*a - 32 == *b) return 1;
    1635:   return 0;
    1636: }
    1637: #endif

    1639: #if defined(PETSC_MISSING_LAPACK_lsame)
    1640: PETSC_EXTERN int lsame(char *a,char *b)
    1641: {
    1642:   if (*a == *b) return 1;
    1643:   if (*a + 32 == *b) return 1;
    1644:   if (*a - 32 == *b) return 1;
    1645:   return 0;
    1646: }
    1647: #endif