Actual source code: pinit.c

petsc-master 2019-12-13
Report Typos and Errors

  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>

  9: #if defined(PETSC_USE_LOG)
 10: PETSC_INTERN PetscErrorCode PetscLogFinalize(void);
 11: #endif

 13: #if defined(PETSC_SERIALIZE_FUNCTIONS)
 14: PETSC_INTERN PetscFPT PetscFPTData;
 15: PetscFPT PetscFPTData = 0;
 16: #endif

 18: #if defined(PETSC_HAVE_SAWS)
 19:  #include <petscviewersaws.h>
 20: #endif

 22: #if defined(PETSC_HAVE_OPENMPI_MAJOR)
 23: #include "mpi-ext.h" /* Needed for CUDA-aware check */
 24: #endif
 25: /* -----------------------------------------------------------------------------------------*/

 27: PETSC_INTERN FILE *petsc_history;

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

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

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

 44: /* Do not need put this in a guard like PETSC_HAVE_CUDA. Without configuring PETSc --with-cuda, users can still use option -use_gpu_aware_mpi */
 45: PetscBool use_gpu_aware_mpi = PETSC_FALSE;
 46: #if defined(PETSC_HAVE_CUDA)
 47: PetscBool sf_use_default_cuda_stream = PETSC_FALSE;
 48: #endif

 50: /*
 51:      Declare and set all the string names of the PETSc enums
 52: */
 53: const char *const PetscBools[]     = {"FALSE","TRUE","PetscBool","PETSC_",0};
 54: const char *const PetscCopyModes[] = {"COPY_VALUES","OWN_POINTER","USE_POINTER","PetscCopyMode","PETSC_",0};

 56: PetscBool PetscPreLoadingUsed = PETSC_FALSE;
 57: PetscBool PetscPreLoadingOn   = PETSC_FALSE;

 59: PetscInt PetscHotRegionDepth;

 61: #if defined(PETSC_HAVE_THREADSAFETY)
 62: PetscSpinlock PetscViewerASCIISpinLockOpen;
 63: PetscSpinlock PetscViewerASCIISpinLockStdout;
 64: PetscSpinlock PetscViewerASCIISpinLockStderr;
 65: PetscSpinlock PetscCommSpinLock;
 66: #endif

 68: /*
 69:        Checks the options database for initializations related to the
 70:     PETSc components
 71: */
 72: PETSC_INTERN PetscErrorCode  PetscOptionsCheckInitial_Components(void)
 73: {
 74:   PetscBool      flg;

 78:   PetscOptionsHasHelp(NULL,&flg);
 79:   if (flg) {
 80: #if defined(PETSC_USE_LOG)
 81:     MPI_Comm comm = PETSC_COMM_WORLD;
 82:     (*PetscHelpPrintf)(comm,"------Additional PETSc component options--------\n");
 83:     (*PetscHelpPrintf)(comm," -log_exclude: <vec,mat,pc,ksp,snes,tao,ts>\n");
 84:     (*PetscHelpPrintf)(comm," -info_exclude: <null,vec,mat,pc,ksp,snes,tao,ts>\n");
 85:     (*PetscHelpPrintf)(comm,"-----------------------------------------------\n");
 86: #endif
 87:   }
 88:   return(0);
 89: }

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

 94:    Collective

 96:    Level: advanced

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

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

105: .seealso: PetscInitialize(), PetscInitializeFortran(), PetscInitializeNoArguments()
106: */
107: PetscErrorCode  PetscInitializeNoPointers(int argc,char **args,const char *filename,const char *help)
108: {
110:   int            myargc   = argc;
111:   char           **myargs = args;

114:   PetscInitialize(&myargc,&myargs,filename,help);if (ierr) return ierr;
115:   PetscPopSignalHandler();
116:   PetscBeganMPI = PETSC_FALSE;
117:   PetscFunctionReturn(ierr);
118: }

120: /*
121:       Used by Julia interface to get communicator
122: */
123: PetscErrorCode  PetscGetPETSC_COMM_SELF(MPI_Comm *comm)
124: {
126:   *comm = PETSC_COMM_SELF;
127:   return(0);
128: }

130: /*@C
131:       PetscInitializeNoArguments - Calls PetscInitialize() from C/C++ without
132:         the command line arguments.

134:    Collective

136:    Level: advanced

138: .seealso: PetscInitialize(), PetscInitializeFortran()
139: @*/
140: PetscErrorCode  PetscInitializeNoArguments(void)
141: {
143:   int            argc   = 0;
144:   char           **args = 0;

147:   PetscInitialize(&argc,&args,NULL,NULL);
148:   PetscFunctionReturn(ierr);
149: }

151: /*@
152:       PetscInitialized - Determine whether PETSc is initialized.

154:    Level: beginner

156: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
157: @*/
158: PetscErrorCode PetscInitialized(PetscBool  *isInitialized)
159: {
160:   *isInitialized = PetscInitializeCalled;
161:   return 0;
162: }

164: /*@
165:       PetscFinalized - Determine whether PetscFinalize() has been called yet

167:    Level: developer

169: .seealso: PetscInitialize(), PetscInitializeNoArguments(), PetscInitializeFortran()
170: @*/
171: PetscErrorCode  PetscFinalized(PetscBool  *isFinalized)
172: {
173:   *isFinalized = PetscFinalizeCalled;
174:   return 0;
175: }

177: PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(void);

179: /*
180:        This function is the MPI reduction operation used to compute the sum of the
181:    first half of the datatype and the max of the second half.
182: */
183: MPI_Op MPIU_MAXSUM_OP = 0;

185: PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in,void *out,int *cnt,MPI_Datatype *datatype)
186: {
187:   PetscInt *xin = (PetscInt*)in,*xout = (PetscInt*)out,i,count = *cnt;

190:   if (*datatype != MPIU_2INT) {
191:     (*PetscErrorPrintf)("Can only handle MPIU_2INT data types");
192:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
193:   }

195:   for (i=0; i<count; i++) {
196:     xout[2*i]    = PetscMax(xout[2*i],xin[2*i]);
197:     xout[2*i+1] += xin[2*i+1];
198:   }
199:   PetscFunctionReturnVoid();
200: }

202: /*
203:     Returns the max of the first entry owned by this processor and the
204: sum of the second entry.

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

215: #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
216:   {
217:     struct {PetscInt max,sum;} work;
218:     MPI_Reduce_scatter_block((void*)sizes,&work,1,MPIU_2INT,MPIU_MAXSUM_OP,comm);
219:     *max = work.max;
220:     *sum = work.sum;
221:   }
222: #else
223:   {
224:     PetscMPIInt    size,rank;
225:     struct {PetscInt max,sum;} *work;
226:     MPI_Comm_size(comm,&size);
227:     MPI_Comm_rank(comm,&rank);
228:     PetscMalloc1(size,&work);
229:     MPIU_Allreduce((void*)sizes,work,size,MPIU_2INT,MPIU_MAXSUM_OP,comm);
230:     *max = work[rank].max;
231:     *sum = work[rank].sum;
232:     PetscFree(work);
233:   }
234: #endif
235:   return(0);
236: }

238: /* ----------------------------------------------------------------------------*/

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

243: PETSC_EXTERN void PetscSum_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] += 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++) xout[i] += xin[i];
256:   }
257: #endif
258:   else {
259:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types");
260:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
261:   }
262:   PetscFunctionReturnVoid();
263: }
264: #endif

266: #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16)
267: MPI_Op MPIU_MAX = 0;
268: MPI_Op MPIU_MIN = 0;

270: PETSC_EXTERN void PetscMax_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
271: {
272:   PetscInt i,count = *cnt;

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

294: PETSC_EXTERN void PetscMin_Local(void *in,void *out,PetscMPIInt *cnt,MPI_Datatype *datatype)
295: {
296:   PetscInt    i,count = *cnt;

299:   if (*datatype == MPIU_REAL) {
300:     PetscReal *xin = (PetscReal*)in,*xout = (PetscReal*)out;
301:     for (i=0; i<count; i++) xout[i] = PetscMin(xout[i],xin[i]);
302:   }
303: #if defined(PETSC_HAVE_COMPLEX)
304:   else if (*datatype == MPIU_COMPLEX) {
305:     PetscComplex *xin = (PetscComplex*)in,*xout = (PetscComplex*)out;
306:     for (i=0; i<count; i++) {
307:       xout[i] = PetscRealPartComplex(xout[i])>PetscRealPartComplex(xin[i]) ? xin[i] : xout[i];
308:     }
309:   }
310: #endif
311:   else {
312:     (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types");
313:     PETSCABORT(MPI_COMM_SELF,PETSC_ERR_ARG_WRONG);
314:   }
315:   PetscFunctionReturnVoid();
316: }
317: #endif

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

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

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

326: */
327: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelCounter(MPI_Comm comm,PetscMPIInt keyval,void *count_val,void *extra_state)
328: {

332:   PetscInfo1(0,"Deleting counter data in an MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
333:   PetscFree(count_val);CHKERRMPI(ierr);
334:   PetscFunctionReturn(MPI_SUCCESS);
335: }

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

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

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

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

347: */
348: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Outer(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
349: {
350:   PetscErrorCode                    ierr;
351:   PetscMPIInt                       flg;
352:   union {MPI_Comm comm; void *ptr;} icomm,ocomm;

355:   if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Unexpected keyval");
356:   icomm.ptr = attr_val;

358:   MPI_Comm_get_attr(icomm.comm,Petsc_OuterComm_keyval,&ocomm,&flg);CHKERRMPI(ierr);
359:   if (!flg) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected reference to outer comm");
360:   if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm has reference to non-matching outer comm");
361:   MPI_Comm_delete_attr(icomm.comm,Petsc_OuterComm_keyval);CHKERRMPI(ierr);
362:   PetscInfo1(0,"User MPI_Comm %ld is being freed after removing reference from inner PETSc comm to this outer comm\n",(long)comm);CHKERRMPI(ierr);
363:   PetscFunctionReturn(MPI_SUCCESS);
364: }

366: /*
367:  * This is invoked on the inner comm when Petsc_DelComm_Outer calls MPI_Comm_delete_attr.  It should not be reached any other way.
368:  */
369: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Inner(MPI_Comm comm,PetscMPIInt keyval,void *attr_val,void *extra_state)
370: {

374:   PetscInfo1(0,"Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n",(long)comm);CHKERRMPI(ierr);
375:   PetscFunctionReturn(MPI_SUCCESS);
376: }

378: PETSC_EXTERN PetscMPIInt MPIAPI Petsc_DelComm_Shm(MPI_Comm,PetscMPIInt,void *,void *);

380: #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
381: PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype,MPI_Aint*,void*);
382: PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
383: PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void*, MPI_Datatype,PetscMPIInt,void*,MPI_Offset,void*);
384: #endif

386: PetscMPIInt PETSC_MPI_ERROR_CLASS,PETSC_MPI_ERROR_CODE;

388: PETSC_INTERN int  PetscGlobalArgc;
389: PETSC_INTERN char **PetscGlobalArgs;
390: int  PetscGlobalArgc   = 0;
391: char **PetscGlobalArgs = 0;
392: PetscSegBuffer PetscCitationsList;

394: PetscErrorCode PetscCitationsInitialize(void)
395: {

399:   PetscSegBufferCreate(1,10000,&PetscCitationsList);
400:   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);
401:   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);
402:   return(0);
403: }

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

407: PetscErrorCode  PetscSetProgramName(const char name[])
408: {

412:   PetscStrncpy(programname,name,PETSC_MAX_PATH_LEN);
413:   return(0);
414: }

416: /*@C
417:     PetscGetProgramName - Gets the name of the running program.

419:     Not Collective

421:     Input Parameter:
422: .   len - length of the string name

424:     Output Parameter:
425: .   name - the name of the running program

427:    Level: advanced

429:     Notes:
430:     The name of the program is copied into the user-provided character
431:     array of length len.  On some machines the program name includes
432:     its entire path, so one should generally set len >= PETSC_MAX_PATH_LEN.
433: @*/
434: PetscErrorCode  PetscGetProgramName(char name[],size_t len)
435: {

439:    PetscStrncpy(name,programname,len);
440:   return(0);
441: }

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

447:    Not Collective

449:    Output Parameters:
450: +  argc - count of number of command line arguments
451: -  args - the command line arguments

453:    Level: intermediate

455:    Notes:
456:       This is usually used to pass the command line arguments into other libraries
457:    that are called internally deep in PETSc or the application.

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

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

463: @*/
464: PetscErrorCode  PetscGetArgs(int *argc,char ***args)
465: {
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:   return(0);
471: }

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

477:    Not Collective

479:    Output Parameters:
480: .  args - the command line arguments

482:    Level: intermediate

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

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

489: @*/
490: PetscErrorCode  PetscGetArguments(char ***args)
491: {
492:   PetscInt       i,argc = PetscGlobalArgc;

496:   if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()");
497:   if (!argc) {*args = NULL; return(0);}
498:   PetscMalloc1(argc,args);
499:   for (i=0; i<argc-1; i++) {
500:     PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);
501:   }
502:   (*args)[argc-1] = NULL;
503:   return(0);
504: }

506: /*@C
507:    PetscFreeArguments - Frees the memory obtained with PetscGetArguments()

509:    Not Collective

511:    Output Parameters:
512: .  args - the command line arguments

514:    Level: intermediate

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

518: @*/
519: PetscErrorCode  PetscFreeArguments(char **args)
520: {
521:   PetscInt       i = 0;

525:   if (!args) return(0);
526:   while (args[i]) {
527:     PetscFree(args[i]);
528:     i++;
529:   }
530:   PetscFree(args);
531:   return(0);
532: }

534: #if defined(PETSC_HAVE_SAWS)
535: #include <petscconfiginfo.h>

537: PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[])
538: {
539:   if (!PetscGlobalRank) {
540:     char           cert[PETSC_MAX_PATH_LEN],root[PETSC_MAX_PATH_LEN],*intro,programname[64],*appline,*options,version[64];
541:     int            port;
542:     PetscBool      flg,rootlocal = PETSC_FALSE,flg2,selectport = PETSC_FALSE;
543:     size_t         applinelen,introlen;
545:     char           sawsurl[256];

547:     PetscOptionsHasName(NULL,NULL,"-saws_log",&flg);
548:     if (flg) {
549:       char  sawslog[PETSC_MAX_PATH_LEN];

551:       PetscOptionsGetString(NULL,NULL,"-saws_log",sawslog,PETSC_MAX_PATH_LEN,NULL);
552:       if (sawslog[0]) {
553:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(sawslog));
554:       } else {
555:         PetscStackCallSAWs(SAWs_Set_Use_Logfile,(NULL));
556:       }
557:     }
558:     PetscOptionsGetString(NULL,NULL,"-saws_https",cert,PETSC_MAX_PATH_LEN,&flg);
559:     if (flg) {
560:       PetscStackCallSAWs(SAWs_Set_Use_HTTPS,(cert));
561:     }
562:     PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select",&selectport,NULL);
563:     if (selectport) {
564:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
565:         PetscStackCallSAWs(SAWs_Set_Port,(port));
566:     } else {
567:       PetscOptionsGetInt(NULL,NULL,"-saws_port",&port,&flg);
568:       if (flg) {
569:         PetscStackCallSAWs(SAWs_Set_Port,(port));
570:       }
571:     }
572:     PetscOptionsGetString(NULL,NULL,"-saws_root",root,PETSC_MAX_PATH_LEN,&flg);
573:     if (flg) {
574:       PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
575:       PetscStrcmp(root,".",&rootlocal);
576:     } else {
577:       PetscOptionsHasName(NULL,NULL,"-saws_options",&flg);
578:       if (flg) {
579:         PetscStrreplace(PETSC_COMM_WORLD,"${PETSC_DIR}/share/petsc/saws",root,PETSC_MAX_PATH_LEN);
580:         PetscStackCallSAWs(SAWs_Set_Document_Root,(root));
581:       }
582:     }
583:     PetscOptionsHasName(NULL,NULL,"-saws_local",&flg2);
584:     if (flg2) {
585:       char jsdir[PETSC_MAX_PATH_LEN];
586:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"-saws_local option requires -saws_root option");
587:       PetscSNPrintf(jsdir,PETSC_MAX_PATH_LEN,"%s/js",root);
588:       PetscTestDirectory(jsdir,'r',&flg);
589:       if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"-saws_local option requires js directory in root directory");
590:       PetscStackCallSAWs(SAWs_Push_Local_Header,());
591:     }
592:     PetscGetProgramName(programname,64);
593:     PetscStrlen(help,&applinelen);
594:     introlen   = 4096 + applinelen;
595:     applinelen += 1024;
596:     PetscMalloc(applinelen,&appline);
597:     PetscMalloc(introlen,&intro);

599:     if (rootlocal) {
600:       PetscSNPrintf(appline,applinelen,"%s.c.html",programname);
601:       PetscTestFile(appline,'r',&rootlocal);
602:     }
603:     PetscOptionsGetAll(NULL,&options);
604:     if (rootlocal && help) {
605:       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);
606:     } else if (help) {
607:       PetscSNPrintf(appline,applinelen,"<center>Running %s %s</center><br><center><pre>%s</pre></center><br>",programname,options,help);
608:     } else {
609:       PetscSNPrintf(appline,applinelen,"<center> Running %s %s</center><br>\n",programname,options);
610:     }
611:     PetscFree(options);
612:     PetscGetVersion(version,sizeof(version));
613:     PetscSNPrintf(intro,introlen,"<body>\n"
614:                                     "<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"
615:                                     "<center>This is the default PETSc application dashboard, from it you can access any published PETSc objects or logging data</center><br><center>%s configured with %s</center><br>\n"
616:                                     "%s",version,petscconfigureoptions,appline);
617:     PetscStackCallSAWs(SAWs_Push_Body,("index.html",0,intro));
618:     PetscFree(intro);
619:     PetscFree(appline);
620:     if (selectport) {
621:       PetscBool silent;

623:       SAWs_Initialize();
624:       /* another process may have grabbed the port so keep trying */
625:       while (ierr) {
626:         PetscStackCallSAWs(SAWs_Get_Available_Port,(&port));
627:         PetscStackCallSAWs(SAWs_Set_Port,(port));
628:         SAWs_Initialize();
629:       }

631:       PetscOptionsGetBool(NULL,NULL,"-saws_port_auto_select_silent",&silent,NULL);
632:       if (!silent) {
633:         PetscStackCallSAWs(SAWs_Get_FullURL,(sizeof(sawsurl),sawsurl));
634:         PetscPrintf(PETSC_COMM_WORLD,"Point your browser to %s for SAWs\n",sawsurl);
635:       }
636:     } else {
637:       PetscStackCallSAWs(SAWs_Initialize,());
638:     }
639:     PetscCitationsRegister("@TechReport{ saws,\n"
640:                                   "  Author = {Matt Otten and Jed Brown and Barry Smith},\n"
641:                                   "  Title  = {Scientific Application Web Server (SAWs) Users Manual},\n"
642:                                   "  Institution = {Argonne National Laboratory},\n"
643:                                   "  Year   = 2013\n}\n",NULL);
644:   }
645:   return(0);
646: }
647: #endif

649: /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */
650: PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void)
651: {
653: #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG)
654:     /* see MPI.py for details on this bug */
655:     (void) setenv("HWLOC_COMPONENTS","-x86",1);
656: #endif
657:   return(0);
658: }

660: #if defined(PETSC_HAVE_ADIOS)
661: #include <adios.h>
662: #include <adios_read.h>
663: int64_t Petsc_adios_group;
664: #endif
665: #if defined(PETSC_HAVE_ADIOS2)
666: #include <adios2_c.h>
667: #endif
668: #if defined(PETSC_HAVE_OPENMP)
669: #include <omp.h>
670: PetscInt PetscNumOMPThreads;
671: #endif

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

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

681:    Input Parameters:
682: +  argc - count of number of command line arguments
683: .  args - the command line arguments
684: .  file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for
685:           code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files
686: -  help - [optional] Help message to print, use NULL for no message

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

694:    Options Database Keys:
695: +  -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message
696: .  -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger
697: .  -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected
698: .  -on_error_emacs <machinename> - causes emacsclient to jump to error file
699: .  -on_error_abort - calls abort() when error detected (no traceback)
700: .  -on_error_mpiabort - calls MPI_abort() when error detected
701: .  -error_output_stderr - prints error messages to stderr instead of the default stdout
702: .  -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called)
703: .  -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger
704: .  -debugger_pause [sleeptime] (in seconds) - Pauses debugger
705: .  -stop_for_debugger - Print message on how to attach debugger manually to
706:                         process and wait (-debugger_pause) seconds for attachment
707: .  -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) (deprecated, use -malloc_debug)
708: .  -malloc no - Indicates not to use error-checking malloc (deprecated, use -malloc_debug no)
709: .  -malloc_debug - check for memory corruption at EVERY malloc or free, see PetscMallocSetDebug()
710: .  -malloc_dump - prints a list of all unfreed memory at the end of the run
711: .  -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
712: .  -malloc_view - show a list of all allocated memory during PetscFinalize()
713: .  -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view
714: .  -fp_trap - Stops on floating point exceptions
715: .  -no_signal_handler - Indicates not to trap error signals
716: .  -shared_tmp - indicates /tmp directory is shared by all processors
717: .  -not_shared_tmp - each processor has own /tmp
718: .  -tmp - alternative name of /tmp directory
719: .  -get_total_flops - returns total flops done by all processors
720: -  -memory_view - Print memory usage at end of run

722:    Options Database Keys for Profiling:
723:    See Users-Manual: Chapter 13 Profiling for details.
724: +  -info <optional filename> - Prints verbose information to the screen
725: .  -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages
726: .  -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event,
727:         however it slows things down and gives a distorted view of the overall runtime.
728: .  -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program
729:         hangs without running in the debugger).  See PetscLogTraceBegin().
730: .  -log_view [:filename:format] - Prints summary of flop and timing information to screen or file, see PetscLogView().
731: .  -log_view_memory - Includes in the summary from -log_view the memory used in each method, see PetscLogView().
732: .  -log_summary [filename] - (Deprecated, use -log_view) Prints summary of flop and timing information to screen. If the filename is specified the
733:         summary is written to the file.  See PetscLogView().
734: .  -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging
735: .  -log_all [filename] - Logs extensive profiling information  See PetscLogDump().
736: .  -log [filename] - Logs basic profiline information  See PetscLogDump().
737: .  -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution)
738: .  -viewfromoptions on,off - Enable or disable XXXSetFromOptions() calls, for applications with many small solves turn this off
739: -  -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code

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

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

751:    Environmental Variables:
752: +   PETSC_TMP - alternative tmp directory
753: .   PETSC_SHARED_TMP - tmp is shared by all processes
754: .   PETSC_NOT_SHARED_TMP - each process has its own private tmp
755: .   PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer
756: -   PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to


759:    Level: beginner

761:    Notes:
762:    If for some reason you must call