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> /*I "petscsys.h" I*/ 6 #include <petscviewer.h> 7 #include <petsc/private/garbagecollector.h> 8 9 #if !defined(PETSC_HAVE_WINDOWS_COMPILERS) 10 #include <petsc/private/valgrind/valgrind.h> 11 #endif 12 13 #if defined(PETSC_USE_FORTRAN_BINDINGS) 14 #include <petsc/private/fortranimpl.h> 15 #endif 16 17 #if PetscDefined(USE_COVERAGE) 18 EXTERN_C_BEGIN 19 #if defined(PETSC_HAVE___GCOV_DUMP) 20 #define __gcov_flush(x) __gcov_dump(x) 21 #endif 22 void __gcov_flush(void); 23 EXTERN_C_END 24 #endif 25 26 #if defined(PETSC_SERIALIZE_FUNCTIONS) 27 PETSC_INTERN PetscFPT PetscFPTData; 28 PetscFPT PetscFPTData = 0; 29 #endif 30 31 #if PetscDefined(HAVE_SAWS) 32 #include <petscviewersaws.h> 33 #endif 34 35 PETSC_INTERN FILE *petsc_history; 36 37 PETSC_INTERN PetscErrorCode PetscInitialize_DynamicLibraries(void); 38 PETSC_INTERN PetscErrorCode PetscFinalize_DynamicLibraries(void); 39 PETSC_INTERN PetscErrorCode PetscSequentialPhaseBegin_Private(MPI_Comm, int); 40 PETSC_INTERN PetscErrorCode PetscSequentialPhaseEnd_Private(MPI_Comm, int); 41 PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **); 42 43 /* user may set these BEFORE calling PetscInitialize() */ 44 MPI_Comm PETSC_COMM_WORLD = MPI_COMM_NULL; 45 #if PetscDefined(HAVE_MPI_INIT_THREAD) 46 PetscMPIInt PETSC_MPI_THREAD_REQUIRED = MPI_THREAD_FUNNELED; 47 #else 48 PetscMPIInt PETSC_MPI_THREAD_REQUIRED = 0; 49 #endif 50 51 PetscMPIInt Petsc_Counter_keyval = MPI_KEYVAL_INVALID; 52 PetscMPIInt Petsc_InnerComm_keyval = MPI_KEYVAL_INVALID; 53 PetscMPIInt Petsc_OuterComm_keyval = MPI_KEYVAL_INVALID; 54 PetscMPIInt Petsc_ShmComm_keyval = MPI_KEYVAL_INVALID; 55 PetscMPIInt Petsc_CreationIdx_keyval = MPI_KEYVAL_INVALID; 56 PetscMPIInt Petsc_Garbage_HMap_keyval = MPI_KEYVAL_INVALID; 57 58 PetscMPIInt Petsc_SharedWD_keyval = MPI_KEYVAL_INVALID; 59 PetscMPIInt Petsc_SharedTmp_keyval = MPI_KEYVAL_INVALID; 60 61 /* 62 Declare and set all the string names of the PETSc enums 63 */ 64 const char *const PetscBools[] = {"FALSE", "TRUE", "PetscBool", "PETSC_", NULL}; 65 const char *const PetscCopyModes[] = {"COPY_VALUES", "OWN_POINTER", "USE_POINTER", "PetscCopyMode", "PETSC_", NULL}; 66 67 PetscBool PetscPreLoadingUsed = PETSC_FALSE; 68 PetscBool PetscPreLoadingOn = PETSC_FALSE; 69 70 PetscInt PetscHotRegionDepth; 71 72 PetscBool PETSC_RUNNING_ON_VALGRIND = PETSC_FALSE; 73 74 #if defined(PETSC_HAVE_THREADSAFETY) 75 PetscSpinlock PetscViewerASCIISpinLockOpen; 76 PetscSpinlock PetscViewerASCIISpinLockStdout; 77 PetscSpinlock PetscViewerASCIISpinLockStderr; 78 PetscSpinlock PetscCommSpinLock; 79 #endif 80 81 /*@C 82 PetscInitializeNoPointers - Calls PetscInitialize() from C/C++ without the pointers to argc and args 83 84 Collective 85 86 Input Parameters: 87 + argc - number of args 88 . args - array of command line arguments 89 . filename - optional name of the program file, pass `NULL` to ignore 90 - help - optional help, pass `NULL` to ignore 91 92 Level: advanced 93 94 Notes: 95 this is called only by the PETSc Julia interface. Even though it might start MPI it sets the flag to 96 indicate that it did NOT start MPI so that the PetscFinalize() does not end MPI, thus allowing PetscInitialize() to 97 be called multiple times from Julia without the problem of trying to initialize MPI more than once. 98 99 Developer Notes: 100 Turns off PETSc signal handling to allow Julia to manage signals 101 102 .seealso: `PetscInitialize()`, `PetscInitializeFortran()`, `PetscInitializeNoArguments()` 103 */ 104 PetscErrorCode PetscInitializeNoPointers(int argc, char **args, const char *filename, const char *help) 105 { 106 int myargc = argc; 107 char **myargs = args; 108 109 PetscFunctionBegin; 110 PetscCall(PetscInitialize(&myargc, &myargs, filename, help)); 111 PetscCall(PetscPopSignalHandler()); 112 PetscBeganMPI = PETSC_FALSE; 113 PetscFunctionReturn(PETSC_SUCCESS); 114 } 115 116 /* 117 Used by Julia interface to get communicator 118 */ 119 PetscErrorCode PetscGetPETSC_COMM_SELF(MPI_Comm *comm) 120 { 121 PetscFunctionBegin; 122 if (PetscInitializeCalled) PetscAssertPointer(comm, 1); 123 *comm = PETSC_COMM_SELF; 124 PetscFunctionReturn(PETSC_SUCCESS); 125 } 126 127 /*@C 128 PetscInitializeNoArguments - Calls `PetscInitialize()` from C/C++ without 129 the command line arguments. 130 131 Collective 132 133 Level: advanced 134 135 .seealso: `PetscInitialize()`, `PetscInitializeFortran()` 136 @*/ 137 PetscErrorCode PetscInitializeNoArguments(void) 138 { 139 int argc = 0; 140 char **args = NULL; 141 142 PetscFunctionBegin; 143 PetscCall(PetscInitialize(&argc, &args, NULL, NULL)); 144 PetscFunctionReturn(PETSC_SUCCESS); 145 } 146 147 /*@ 148 PetscInitialized - Determine whether PETSc is initialized. 149 150 Output Parameter: 151 . isInitialized - `PETSC_TRUE` if PETSc is initialized, `PETSC_FALSE` otherwise 152 153 Level: beginner 154 155 .seealso: `PetscInitialize()`, `PetscInitializeNoArguments()`, `PetscInitializeFortran()` 156 @*/ 157 PetscErrorCode PetscInitialized(PetscBool *isInitialized) 158 { 159 PetscFunctionBegin; 160 if (PetscInitializeCalled) PetscAssertPointer(isInitialized, 1); 161 *isInitialized = PetscInitializeCalled; 162 PetscFunctionReturn(PETSC_SUCCESS); 163 } 164 165 /*@ 166 PetscFinalized - Determine whether `PetscFinalize()` has been called yet 167 168 Output Parameter: 169 . isFinalized - `PETSC_TRUE` if PETSc is finalized, `PETSC_FALSE` otherwise 170 171 Level: developer 172 173 .seealso: `PetscInitialize()`, `PetscInitializeNoArguments()`, `PetscInitializeFortran()` 174 @*/ 175 PetscErrorCode PetscFinalized(PetscBool *isFinalized) 176 { 177 PetscFunctionBegin; 178 if (!PetscFinalizeCalled) PetscAssertPointer(isFinalized, 1); 179 *isFinalized = PetscFinalizeCalled; 180 PetscFunctionReturn(PETSC_SUCCESS); 181 } 182 183 PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char[]); 184 185 /* 186 This function is the MPI reduction operation used to compute the sum of the 187 first half of the datatype and the max of the second half. 188 */ 189 MPI_Op MPIU_MAXSUM_OP = 0; 190 MPI_Op Petsc_Garbage_SetIntersectOp = 0; 191 192 PETSC_INTERN void MPIAPI MPIU_MaxSum_Local(void *in, void *out, int *cnt, MPI_Datatype *datatype) 193 { 194 PetscInt *xin = (PetscInt *)in, *xout = (PetscInt *)out, i, count = *cnt; 195 196 PetscFunctionBegin; 197 if (*datatype != MPIU_2INT) { 198 PetscErrorCode ierr = (*PetscErrorPrintf)("Can only handle MPIU_2INT data types"); 199 (void)ierr; 200 PETSCABORT(MPI_COMM_SELF, PETSC_ERR_ARG_WRONG); 201 } 202 203 for (i = 0; i < count; i++) { 204 xout[2 * i] = PetscMax(xout[2 * i], xin[2 * i]); 205 xout[2 * i + 1] += xin[2 * i + 1]; 206 } 207 PetscFunctionReturnVoid(); 208 } 209 210 /* 211 Returns the max of the first entry owned by this processor and the 212 sum of the second entry. 213 214 The reason sizes[2*i] contains lengths sizes[2*i+1] contains flag of 1 if length is nonzero 215 is so that the MPIU_MAXSUM_OP() can set TWO values, if we passed in only sizes[i] with lengths 216 there would be no place to store the both needed results. 217 */ 218 PetscErrorCode PetscMaxSum(MPI_Comm comm, const PetscInt sizes[], PetscInt *max, PetscInt *sum) 219 { 220 PetscFunctionBegin; 221 #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK) 222 { 223 struct { 224 PetscInt max, sum; 225 } work; 226 PetscCallMPI(MPI_Reduce_scatter_block((void *)sizes, &work, 1, MPIU_2INT, MPIU_MAXSUM_OP, comm)); 227 *max = work.max; 228 *sum = work.sum; 229 } 230 #else 231 { 232 PetscMPIInt size, rank; 233 struct { 234 PetscInt max, sum; 235 } *work; 236 PetscCallMPI(MPI_Comm_size(comm, &size)); 237 PetscCallMPI(MPI_Comm_rank(comm, &rank)); 238 PetscCall(PetscMalloc1(size, &work)); 239 PetscCall(MPIU_Allreduce((void *)sizes, work, size, MPIU_2INT, MPIU_MAXSUM_OP, comm)); 240 *max = work[rank].max; 241 *sum = work[rank].sum; 242 PetscCall(PetscFree(work)); 243 } 244 #endif 245 PetscFunctionReturn(PETSC_SUCCESS); 246 } 247 248 #if defined(PETSC_HAVE_REAL___FLOAT128) || defined(PETSC_HAVE_REAL___FP16) 249 #if defined(PETSC_HAVE_REAL___FLOAT128) 250 #include <quadmath.h> 251 #endif 252 MPI_Op MPIU_SUM___FP16___FLOAT128 = 0; 253 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 254 MPI_Op MPIU_SUM = 0; 255 #endif 256 257 PETSC_EXTERN void MPIAPI PetscSum_Local(void *in, void *out, PetscMPIInt *cnt, MPI_Datatype *datatype) 258 { 259 PetscInt i, count = *cnt; 260 261 PetscFunctionBegin; 262 if (*datatype == MPIU_REAL) { 263 PetscReal *xin = (PetscReal *)in, *xout = (PetscReal *)out; 264 for (i = 0; i < count; i++) xout[i] += xin[i]; 265 } 266 #if defined(PETSC_HAVE_COMPLEX) 267 else if (*datatype == MPIU_COMPLEX) { 268 PetscComplex *xin = (PetscComplex *)in, *xout = (PetscComplex *)out; 269 for (i = 0; i < count; i++) xout[i] += xin[i]; 270 } 271 #endif 272 #if defined(PETSC_HAVE_REAL___FLOAT128) 273 else if (*datatype == MPIU___FLOAT128) { 274 __float128 *xin = (__float128 *)in, *xout = (__float128 *)out; 275 for (i = 0; i < count; i++) xout[i] += xin[i]; 276 #if defined(PETSC_HAVE_COMPLEX) 277 } else if (*datatype == MPIU___COMPLEX128) { 278 __complex128 *xin = (__complex128 *)in, *xout = (__complex128 *)out; 279 for (i = 0; i < count; i++) xout[i] += xin[i]; 280 #endif 281 } 282 #endif 283 #if defined(PETSC_HAVE_REAL___FP16) 284 else if (*datatype == MPIU___FP16) { 285 __fp16 *xin = (__fp16 *)in, *xout = (__fp16 *)out; 286 for (i = 0; i < count; i++) xout[i] += xin[i]; 287 } 288 #endif 289 else { 290 #if !defined(PETSC_HAVE_REAL___FLOAT128) && !defined(PETSC_HAVE_REAL___FP16) 291 PetscCallAbort(MPI_COMM_SElF, (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types")); 292 #elif !defined(PETSC_HAVE_REAL___FP16) 293 PetscCallAbort(MPI_COMM_SELF, (*PetscErrorPrintf)("Can only handle MPIU_REAL, MPIU_COMPLEX, MPIU___FLOAT128, or MPIU___COMPLEX128 data types")); 294 #elif !defined(PETSC_HAVE_REAL___FLOAT128) 295 PetscCallAbort(MPI_COMM_SELF, (*PetscErrorPrintf)("Can only handle MPIU_REAL, MPIU_COMPLEX, or MPIU___FP16 data types")); 296 #else 297 PetscCallAbort(MPI_COMM_SELF, (*PetscErrorPrintf)("Can only handle MPIU_REAL, MPIU_COMPLEX, MPIU___FLOAT128, MPIU___COMPLEX128, or MPIU___FP16 data types")); 298 #endif 299 PETSCABORT(MPI_COMM_SELF, PETSC_ERR_ARG_WRONG); 300 } 301 PetscFunctionReturnVoid(); 302 } 303 #endif 304 305 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 306 MPI_Op MPIU_MAX = 0; 307 MPI_Op MPIU_MIN = 0; 308 309 PETSC_EXTERN void MPIAPI PetscMax_Local(void *in, void *out, PetscMPIInt *cnt, MPI_Datatype *datatype) 310 { 311 PetscInt i, count = *cnt; 312 313 PetscFunctionBegin; 314 if (*datatype == MPIU_REAL) { 315 PetscReal *xin = (PetscReal *)in, *xout = (PetscReal *)out; 316 for (i = 0; i < count; i++) xout[i] = PetscMax(xout[i], xin[i]); 317 } 318 #if defined(PETSC_HAVE_COMPLEX) 319 else if (*datatype == MPIU_COMPLEX) { 320 PetscComplex *xin = (PetscComplex *)in, *xout = (PetscComplex *)out; 321 for (i = 0; i < count; i++) xout[i] = PetscRealPartComplex(xout[i]) < PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 322 } 323 #endif 324 else { 325 PetscCallAbort(MPI_COMM_SELF, (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_COMPLEX data types")); 326 PETSCABORT(MPI_COMM_SELF, PETSC_ERR_ARG_WRONG); 327 } 328 PetscFunctionReturnVoid(); 329 } 330 331 PETSC_EXTERN void MPIAPI PetscMin_Local(void *in, void *out, PetscMPIInt *cnt, MPI_Datatype *datatype) 332 { 333 PetscInt i, count = *cnt; 334 335 PetscFunctionBegin; 336 if (*datatype == MPIU_REAL) { 337 PetscReal *xin = (PetscReal *)in, *xout = (PetscReal *)out; 338 for (i = 0; i < count; i++) xout[i] = PetscMin(xout[i], xin[i]); 339 } 340 #if defined(PETSC_HAVE_COMPLEX) 341 else if (*datatype == MPIU_COMPLEX) { 342 PetscComplex *xin = (PetscComplex *)in, *xout = (PetscComplex *)out; 343 for (i = 0; i < count; i++) xout[i] = PetscRealPartComplex(xout[i]) > PetscRealPartComplex(xin[i]) ? xin[i] : xout[i]; 344 } 345 #endif 346 else { 347 PetscCallAbort(MPI_COMM_SELF, (*PetscErrorPrintf)("Can only handle MPIU_REAL or MPIU_SCALAR data (i.e. double or complex) types")); 348 PETSCABORT(MPI_COMM_SELF, PETSC_ERR_ARG_WRONG); 349 } 350 PetscFunctionReturnVoid(); 351 } 352 #endif 353 354 /* 355 Private routine to delete internal tag/name counter storage when a communicator is freed. 356 357 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. 358 359 Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval() 360 361 */ 362 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_Counter_Attr_Delete_Fn(MPI_Comm comm, PetscMPIInt keyval, void *count_val, void *extra_state) 363 { 364 PetscCommCounter *counter = (PetscCommCounter *)count_val; 365 struct PetscCommStash *comms = counter->comms, *pcomm; 366 367 PetscFunctionBegin; 368 PetscCallMPI(PetscInfo(NULL, "Deleting counter data in an MPI_Comm %ld\n", (long)comm)); 369 PetscCallMPI(PetscFree(counter->iflags)); 370 while (comms) { 371 PetscCallMPI(MPI_Comm_free(&comms->comm)); 372 pcomm = comms; 373 comms = comms->next; 374 PetscCall(PetscFree(pcomm)); 375 } 376 PetscCallMPI(PetscFree(counter)); 377 PetscFunctionReturn(MPI_SUCCESS); 378 } 379 380 /* 381 This is invoked on the outer comm as a result of either PetscCommDestroy() (via MPI_Comm_delete_attr) or when the user 382 calls MPI_Comm_free(). 383 384 This is the only entry point for breaking the links between inner and outer comms. 385 386 This is called by MPI, not by users. This is called when MPI_Comm_free() is called on the communicator. 387 388 Note: this is declared extern "C" because it is passed to MPI_Comm_create_keyval() 389 390 */ 391 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_InnerComm_Attr_Delete_Fn(MPI_Comm comm, PetscMPIInt keyval, void *attr_val, void *extra_state) 392 { 393 union 394 { 395 MPI_Comm comm; 396 void *ptr; 397 } icomm; 398 399 PetscFunctionBegin; 400 if (keyval != Petsc_InnerComm_keyval) SETERRMPI(PETSC_COMM_SELF, PETSC_ERR_ARG_CORRUPT, "Unexpected keyval"); 401 icomm.ptr = attr_val; 402 if (PetscDefined(USE_DEBUG)) { 403 /* Error out if the inner/outer comms are not correctly linked through their Outer/InnterComm attributes */ 404 PetscMPIInt flg; 405 union 406 { 407 MPI_Comm comm; 408 void *ptr; 409 } ocomm; 410 PetscCallMPI(MPI_Comm_get_attr(icomm.comm, Petsc_OuterComm_keyval, &ocomm, &flg)); 411 if (!flg) SETERRMPI(PETSC_COMM_SELF, PETSC_ERR_ARG_CORRUPT, "Inner comm does not have OuterComm attribute"); 412 if (ocomm.comm != comm) SETERRMPI(PETSC_COMM_SELF, PETSC_ERR_ARG_CORRUPT, "Inner comm's OuterComm attribute does not point to outer PETSc comm"); 413 } 414 PetscCallMPI(MPI_Comm_delete_attr(icomm.comm, Petsc_OuterComm_keyval)); 415 PetscCallMPI(PetscInfo(NULL, "User MPI_Comm %ld is being unlinked from inner PETSc comm %ld\n", (long)comm, (long)icomm.comm)); 416 PetscFunctionReturn(MPI_SUCCESS); 417 } 418 419 /* 420 * 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. 421 */ 422 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_OuterComm_Attr_Delete_Fn(MPI_Comm comm, PetscMPIInt keyval, void *attr_val, void *extra_state) 423 { 424 PetscFunctionBegin; 425 PetscCallMPI(PetscInfo(NULL, "Removing reference to PETSc communicator embedded in a user MPI_Comm %ld\n", (long)comm)); 426 PetscFunctionReturn(MPI_SUCCESS); 427 } 428 429 PETSC_EXTERN PetscMPIInt MPIAPI Petsc_ShmComm_Attr_Delete_Fn(MPI_Comm, PetscMPIInt, void *, void *); 430 431 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 432 PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype, MPI_Aint *, void *); 433 PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void *, MPI_Datatype, PetscMPIInt, void *, MPI_Offset, void *); 434 PETSC_EXTERN PetscMPIInt PetscDataRep_write_conv_fn(void *, MPI_Datatype, PetscMPIInt, void *, MPI_Offset, void *); 435 #endif 436 437 PetscMPIInt PETSC_MPI_ERROR_CLASS = MPI_ERR_LASTCODE, PETSC_MPI_ERROR_CODE; 438 439 PETSC_INTERN int PetscGlobalArgc; 440 PETSC_INTERN char **PetscGlobalArgs; 441 int PetscGlobalArgc = 0; 442 char **PetscGlobalArgs = NULL; 443 PetscSegBuffer PetscCitationsList; 444 445 PetscErrorCode PetscCitationsInitialize(void) 446 { 447 PetscFunctionBegin; 448 PetscCall(PetscSegBufferCreate(1, 10000, &PetscCitationsList)); 449 450 PetscCall(PetscCitationsRegister("@TechReport{petsc-user-ref,\n\ 451 Author = {Satish Balay and Shrirang Abhyankar and Mark~F. Adams and Steven Benson and Jed Brown\n\ 452 and Peter Brune and Kris Buschelman and Emil Constantinescu and Lisandro Dalcin and Alp Dener\n\ 453 and Victor Eijkhout and Jacob Faibussowitsch and William~D. Gropp and V\'{a}clav Hapla and Tobin Isaac and Pierre Jolivet\n\ 454 and Dmitry Karpeev and Dinesh Kaushik and Matthew~G. Knepley and Fande Kong and Scott Kruger\n\ 455 and Dave~A. May and Lois Curfman McInnes and Richard Tran Mills and Lawrence Mitchell and Todd Munson\n\ 456 and Jose~E. Roman and Karl Rupp and Patrick Sanan and Jason Sarich and Barry~F. Smith\n\ 457 and Stefano Zampini and Hong Zhang and Hong Zhang and Junchao Zhang},\n\ 458 Title = {{PETSc/TAO} Users Manual},\n\ 459 Number = {ANL-21/39 - Revision 3.19},\n\ 460 Doi = {10.2172/1968587},\n\ 461 Institution = {Argonne National Laboratory},\n\ 462 Year = {2023}\n}\n", 463 NULL)); 464 465 PetscCall(PetscCitationsRegister("@InProceedings{petsc-efficient,\n\ 466 Author = {Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith},\n\ 467 Title = {Efficient Management of Parallelism in Object Oriented Numerical Software Libraries},\n\ 468 Booktitle = {Modern Software Tools in Scientific Computing},\n\ 469 Editor = {E. Arge and A. M. Bruaset and H. P. Langtangen},\n\ 470 Pages = {163--202},\n\ 471 Publisher = {Birkh{\\\"{a}}user Press},\n\ 472 Year = {1997}\n}\n", 473 NULL)); 474 475 PetscFunctionReturn(PETSC_SUCCESS); 476 } 477 478 static char programname[PETSC_MAX_PATH_LEN] = ""; /* HP includes entire path in name */ 479 480 PetscErrorCode PetscSetProgramName(const char name[]) 481 { 482 PetscFunctionBegin; 483 PetscCall(PetscStrncpy(programname, name, sizeof(programname))); 484 PetscFunctionReturn(PETSC_SUCCESS); 485 } 486 487 /*@C 488 PetscGetProgramName - Gets the name of the running program. 489 490 Not Collective 491 492 Input Parameter: 493 . len - length of the string name 494 495 Output Parameter: 496 . name - the name of the running program, provide a string of length `PETSC_MAX_PATH_LEN` 497 498 Level: advanced 499 500 .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArguments()`, `PetscInitialize()` 501 @*/ 502 PetscErrorCode PetscGetProgramName(char name[], size_t len) 503 { 504 PetscFunctionBegin; 505 PetscCall(PetscStrncpy(name, programname, len)); 506 PetscFunctionReturn(PETSC_SUCCESS); 507 } 508 509 /*@C 510 PetscGetArgs - Allows you to access the raw command line arguments anywhere 511 after PetscInitialize() is called but before `PetscFinalize()`. 512 513 Not Collective 514 515 Output Parameters: 516 + argc - count of number of command line arguments 517 - args - the command line arguments 518 519 Level: intermediate 520 521 Notes: 522 This is usually used to pass the command line arguments into other libraries 523 that are called internally deep in PETSc or the application. 524 525 The first argument contains the program name as is normal for C arguments. 526 527 .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArguments()`, `PetscInitialize()` 528 @*/ 529 PetscErrorCode PetscGetArgs(int *argc, char ***args) 530 { 531 PetscFunctionBegin; 532 PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled, PETSC_COMM_SELF, PETSC_ERR_ORDER, "You must call after PetscInitialize() but before PetscFinalize()"); 533 *argc = PetscGlobalArgc; 534 *args = PetscGlobalArgs; 535 PetscFunctionReturn(PETSC_SUCCESS); 536 } 537 538 /*@C 539 PetscGetArguments - Allows you to access the command line arguments anywhere 540 after `PetscInitialize()` is called but before `PetscFinalize()`. 541 542 Not Collective 543 544 Output Parameter: 545 . args - the command line arguments 546 547 Level: intermediate 548 549 Note: 550 This does NOT start with the program name and IS `NULL` terminated (final arg is void) 551 552 .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscFreeArguments()`, `PetscInitialize()` 553 @*/ 554 PetscErrorCode PetscGetArguments(char ***args) 555 { 556 PetscInt i, argc = PetscGlobalArgc; 557 558 PetscFunctionBegin; 559 PetscCheck(PetscInitializeCalled || !PetscFinalizeCalled, PETSC_COMM_SELF, PETSC_ERR_ORDER, "You must call after PetscInitialize() but before PetscFinalize()"); 560 if (!argc) { 561 *args = NULL; 562 PetscFunctionReturn(PETSC_SUCCESS); 563 } 564 PetscCall(PetscMalloc1(argc, args)); 565 for (i = 0; i < argc - 1; i++) PetscCall(PetscStrallocpy(PetscGlobalArgs[i + 1], &(*args)[i])); 566 (*args)[argc - 1] = NULL; 567 PetscFunctionReturn(PETSC_SUCCESS); 568 } 569 570 /*@C 571 PetscFreeArguments - Frees the memory obtained with `PetscGetArguments()` 572 573 Not Collective 574 575 Output Parameter: 576 . args - the command line arguments 577 578 Level: intermediate 579 580 .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscGetArguments()` 581 @*/ 582 PetscErrorCode PetscFreeArguments(char **args) 583 { 584 PetscFunctionBegin; 585 if (args) { 586 PetscInt i = 0; 587 588 while (args[i]) PetscCall(PetscFree(args[i++])); 589 PetscCall(PetscFree(args)); 590 } 591 PetscFunctionReturn(PETSC_SUCCESS); 592 } 593 594 #if PetscDefined(HAVE_SAWS) 595 #include <petscconfiginfo.h> 596 597 PETSC_INTERN PetscErrorCode PetscInitializeSAWs(const char help[]) 598 { 599 PetscFunctionBegin; 600 if (!PetscGlobalRank) { 601 char cert[PETSC_MAX_PATH_LEN], root[PETSC_MAX_PATH_LEN], *intro, programname[64], *appline, *options, version[64]; 602 int port; 603 PetscBool flg, rootlocal = PETSC_FALSE, flg2, selectport = PETSC_FALSE; 604 size_t applinelen, introlen; 605 char sawsurl[256]; 606 607 PetscCall(PetscOptionsHasName(NULL, NULL, "-saws_log", &flg)); 608 if (flg) { 609 char sawslog[PETSC_MAX_PATH_LEN]; 610 611 PetscCall(PetscOptionsGetString(NULL, NULL, "-saws_log", sawslog, sizeof(sawslog), NULL)); 612 if (sawslog[0]) { 613 PetscCallSAWs(SAWs_Set_Use_Logfile, (sawslog)); 614 } else { 615 PetscCallSAWs(SAWs_Set_Use_Logfile, (NULL)); 616 } 617 } 618 PetscCall(PetscOptionsGetString(NULL, NULL, "-saws_https", cert, sizeof(cert), &flg)); 619 if (flg) PetscCallSAWs(SAWs_Set_Use_HTTPS, (cert)); 620 PetscCall(PetscOptionsGetBool(NULL, NULL, "-saws_port_auto_select", &selectport, NULL)); 621 if (selectport) { 622 PetscCallSAWs(SAWs_Get_Available_Port, (&port)); 623 PetscCallSAWs(SAWs_Set_Port, (port)); 624 } else { 625 PetscCall(PetscOptionsGetInt(NULL, NULL, "-saws_port", &port, &flg)); 626 if (flg) PetscCallSAWs(SAWs_Set_Port, (port)); 627 } 628 PetscCall(PetscOptionsGetString(NULL, NULL, "-saws_root", root, sizeof(root), &flg)); 629 if (flg) { 630 PetscCallSAWs(SAWs_Set_Document_Root, (root)); 631 PetscCall(PetscStrcmp(root, ".", &rootlocal)); 632 } else { 633 PetscCall(PetscOptionsHasName(NULL, NULL, "-saws_options", &flg)); 634 if (flg) { 635 PetscCall(PetscStrreplace(PETSC_COMM_WORLD, "${PETSC_DIR}/share/petsc/saws", root, sizeof(root))); 636 PetscCallSAWs(SAWs_Set_Document_Root, (root)); 637 } 638 } 639 PetscCall(PetscOptionsHasName(NULL, NULL, "-saws_local", &flg2)); 640 if (flg2) { 641 char jsdir[PETSC_MAX_PATH_LEN]; 642 PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_SUP, "-saws_local option requires -saws_root option"); 643 PetscCall(PetscSNPrintf(jsdir, sizeof(jsdir), "%s/js", root)); 644 PetscCall(PetscTestDirectory(jsdir, 'r', &flg)); 645 PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_FILE_READ, "-saws_local option requires js directory in root directory"); 646 PetscCallSAWs(SAWs_Push_Local_Header, ()); 647 } 648 PetscCall(PetscGetProgramName(programname, sizeof(programname))); 649 PetscCall(PetscStrlen(help, &applinelen)); 650 introlen = 4096 + applinelen; 651 applinelen += 1024; 652 PetscCall(PetscMalloc(applinelen, &appline)); 653 PetscCall(PetscMalloc(introlen, &intro)); 654 655 if (rootlocal) { 656 PetscCall(PetscSNPrintf(appline, applinelen, "%s.c.html", programname)); 657 PetscCall(PetscTestFile(appline, 'r', &rootlocal)); 658 } 659 PetscCall(PetscOptionsGetAll(NULL, &options)); 660 if (rootlocal && help) { 661 PetscCall(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)); 662 } else if (help) { 663 PetscCall(PetscSNPrintf(appline, applinelen, "<center>Running %s %s</center><br><center><pre>%s</pre></center><br>", programname, options, help)); 664 } else { 665 PetscCall(PetscSNPrintf(appline, applinelen, "<center> Running %s %s</center><br>\n", programname, options)); 666 } 667 PetscCall(PetscFree(options)); 668 PetscCall(PetscGetVersion(version, sizeof(version))); 669 PetscCall(PetscSNPrintf(intro, introlen, 670 "<body>\n" 671 "<center><h2> <a href=\"https://petsc.org/\">PETSc</a> Application Web server powered by <a href=\"https://bitbucket.org/saws/saws\">SAWs</a> </h2></center>\n" 672 "<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" 673 "%s", 674 version, petscconfigureoptions, appline)); 675 PetscCallSAWs(SAWs_Push_Body, ("index.html", 0, intro)); 676 PetscCall(PetscFree(intro)); 677 PetscCall(PetscFree(appline)); 678 if (selectport) { 679 PetscBool silent; 680 681 /* another process may have grabbed the port so keep trying */ 682 while (SAWs_Initialize()) { 683 PetscCallSAWs(SAWs_Get_Available_Port, (&port)); 684 PetscCallSAWs(SAWs_Set_Port, (port)); 685 } 686 687 PetscCall(PetscOptionsGetBool(NULL, NULL, "-saws_port_auto_select_silent", &silent, NULL)); 688 if (!silent) { 689 PetscCallSAWs(SAWs_Get_FullURL, (sizeof(sawsurl), sawsurl)); 690 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "Point your browser to %s for SAWs\n", sawsurl)); 691 } 692 } else { 693 PetscCallSAWs(SAWs_Initialize, ()); 694 } 695 PetscCall(PetscCitationsRegister("@TechReport{ saws,\n" 696 " Author = {Matt Otten and Jed Brown and Barry Smith},\n" 697 " Title = {Scientific Application Web Server (SAWs) Users Manual},\n" 698 " Institution = {Argonne National Laboratory},\n" 699 " Year = 2013\n}\n", 700 NULL)); 701 } 702 PetscFunctionReturn(PETSC_SUCCESS); 703 } 704 #endif 705 706 /* Things must be done before MPI_Init() when MPI is not yet initialized, and can be shared between C init and Fortran init */ 707 PETSC_INTERN PetscErrorCode PetscPreMPIInit_Private(void) 708 { 709 PetscFunctionBegin; 710 #if defined(PETSC_HAVE_HWLOC_SOLARIS_BUG) 711 /* see MPI.py for details on this bug */ 712 (void)setenv("HWLOC_COMPONENTS", "-x86", 1); 713 #endif 714 PetscFunctionReturn(PETSC_SUCCESS); 715 } 716 717 #if PetscDefined(HAVE_ADIOS) 718 #include <adios.h> 719 #include <adios_read.h> 720 int64_t Petsc_adios_group; 721 #endif 722 #if PetscDefined(HAVE_OPENMP) 723 #include <omp.h> 724 PetscInt PetscNumOMPThreads; 725 #endif 726 727 #include <petsc/private/deviceimpl.h> 728 #if PetscDefined(HAVE_CUDA) 729 #include <petscdevice_cuda.h> 730 // REMOVE ME 731 cudaStream_t PetscDefaultCudaStream = NULL; 732 #endif 733 #if PetscDefined(HAVE_HIP) 734 #include <petscdevice_hip.h> 735 // REMOVE ME 736 hipStream_t PetscDefaultHipStream = NULL; 737 #endif 738 739 #if PetscDefined(HAVE_DLFCN_H) 740 #include <dlfcn.h> 741 #endif 742 PETSC_INTERN PetscErrorCode PetscLogInitialize(void); 743 #if PetscDefined(HAVE_VIENNACL) 744 PETSC_EXTERN PetscErrorCode PetscViennaCLInit(void); 745 PetscBool PetscViennaCLSynchronize = PETSC_FALSE; 746 #endif 747 748 PetscBool PetscCIEnabled = PETSC_FALSE, PetscCIEnabledPortableErrorOutput = PETSC_FALSE; 749 750 /* 751 PetscInitialize_Common - shared code between C and Fortran initialization 752 753 prog: program name 754 file: optional PETSc database file name. Might be in Fortran string format when 'ftn' is true 755 help: program help message 756 ftn: is it called from Fortran initialization (petscinitializef_)? 757 readarguments,len: used when fortran is true 758 */ 759 PETSC_INTERN PetscErrorCode PetscInitialize_Common(const char *prog, const char *file, const char *help, PetscBool ftn, PetscBool readarguments, PetscInt len) 760 { 761 PetscMPIInt size; 762 PetscBool flg = PETSC_TRUE; 763 char hostname[256]; 764 765 PetscFunctionBegin; 766 if (PetscInitializeCalled) PetscFunctionReturn(PETSC_SUCCESS); 767 /* these must be initialized in a routine, not as a constant declaration */ 768 PETSC_STDOUT = stdout; 769 PETSC_STDERR = stderr; 770 771 /* PetscCall can be used from now */ 772 PetscErrorHandlingInitialized = PETSC_TRUE; 773 774 /* 775 The checking over compatible runtime libraries is complicated by the MPI ABI initiative 776 https://wiki.mpich.org/mpich/index.php/ABI_Compatibility_Initiative which started with 777 MPICH v3.1 (Released February 2014) 778 IBM MPI v2.1 (December 2014) 779 Intel MPI Library v5.0 (2014) 780 Cray MPT v7.0.0 (June 2014) 781 As of July 31, 2017 the ABI number still appears to be 12, that is all of the versions 782 listed above and since that time are compatible. 783 784 Unfortunately the MPI ABI initiative has not defined a way to determine the ABI number 785 at compile time or runtime. Thus we will need to systematically track the allowed versions 786 and how they are represented in the mpi.h and MPI_Get_library_version() output in order 787 to perform the checking. 788 789 Currently we only check for pre MPI ABI versions (and packages that do not follow the MPI ABI). 790 791 Questions: 792 793 Should the checks for ABI incompatibility be only on the major version number below? 794 Presumably the output to stderr will be removed before a release. 795 */ 796 797 #if defined(PETSC_HAVE_MPI_GET_LIBRARY_VERSION) 798 { 799 char mpilibraryversion[MPI_MAX_LIBRARY_VERSION_STRING]; 800 PetscMPIInt mpilibraryversionlength; 801 802 PetscCallMPI(MPI_Get_library_version(mpilibraryversion, &mpilibraryversionlength)); 803 /* check for MPICH versions before MPI ABI initiative */ 804 #if defined(MPICH_VERSION) 805 #if MPICH_NUMVERSION < 30100000 806 { 807 char *ver, *lf; 808 PetscBool flg = PETSC_FALSE; 809 810 PetscCall(PetscStrstr(mpilibraryversion, "MPICH Version:", &ver)); 811 if (ver) { 812 PetscCall(PetscStrchr(ver, '\n', &lf)); 813 if (lf) { 814 *lf = 0; 815 PetscCall(PetscStrendswith(ver, MPICH_VERSION, &flg)); 816 } 817 } 818 if (!flg) { 819 PetscCall(PetscInfo(NULL, "PETSc warning --- MPICH library version \n%s does not match what PETSc was compiled with %s.\n", mpilibraryversion, MPICH_VERSION)); 820 flg = PETSC_TRUE; 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[MPI_MAX_LIBRARY_VERSION_STRING], *bsf; 828 PetscBool flg = PETSC_FALSE; 829 #define PSTRSZ 2 830 char ompistr1[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"Open MPI", "FUJITSU MPI"}; 831 char ompistr2[PSTRSZ][MPI_MAX_LIBRARY_VERSION_STRING] = {"v", "Library "}; 832 int i; 833 for (i = 0; i < PSTRSZ; i++) { 834 PetscCall(PetscStrstr(mpilibraryversion, ompistr1[i], &ver)); 835 if (ver) { 836 PetscCall(PetscSNPrintf(bs, MPI_MAX_LIBRARY_VERSION_STRING, "%s%d.%d", ompistr2[i], OMPI_MAJOR_VERSION, OMPI_MINOR_VERSION)); 837 PetscCall(PetscStrstr(ver, bs, &bsf)); 838 if (bsf) flg = PETSC_TRUE; 839 break; 840 } 841 } 842 if (!flg) { 843 PetscCall(PetscInfo(NULL, "PETSc warning --- Open MPI library version \n%s does not match what PETSc was compiled with %d.%d.\n", mpilibraryversion, OMPI_MAJOR_VERSION, OMPI_MINOR_VERSION)); 844 flg = PETSC_TRUE; 845 } 846 } 847 #endif 848 } 849 #endif 850 851 #if defined(PETSC_HAVE_DLADDR) && !(defined(__cray__) && defined(__clang__)) 852 /* 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 */ 853 PetscCheck(!dlsym(RTLD_DEFAULT, "ompi_mpi_init") || !dlsym(RTLD_DEFAULT, "MPID_Abort"), PETSC_COMM_SELF, PETSC_ERR_MPI_LIB_INCOMP, "Application was linked against both OpenMPI and MPICH based MPI libraries and will not run correctly"); 854 #endif 855 856 /* on Windows - set printf to default to printing 2 digit exponents */ 857 #if defined(PETSC_HAVE__SET_OUTPUT_FORMAT) 858 _set_output_format(_TWO_DIGIT_EXPONENT); 859 #endif 860 861 PetscCall(PetscOptionsCreateDefault()); 862 863 PetscFinalizeCalled = PETSC_FALSE; 864 865 PetscCall(PetscSetProgramName(prog)); 866 PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockOpen)); 867 PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStdout)); 868 PetscCall(PetscSpinlockCreate(&PetscViewerASCIISpinLockStderr)); 869 PetscCall(PetscSpinlockCreate(&PetscCommSpinLock)); 870 871 if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 872 PetscCallMPI(MPI_Comm_set_errhandler(PETSC_COMM_WORLD, MPI_ERRORS_RETURN)); 873 874 if (PETSC_MPI_ERROR_CLASS == MPI_ERR_LASTCODE) { 875 PetscCallMPI(MPI_Add_error_class(&PETSC_MPI_ERROR_CLASS)); 876 PetscCallMPI(MPI_Add_error_code(PETSC_MPI_ERROR_CLASS, &PETSC_MPI_ERROR_CODE)); 877 } 878 879 /* Done after init due to a bug in MPICH-GM? */ 880 PetscCall(PetscErrorPrintfInitialize()); 881 882 PetscCallMPI(MPI_Comm_rank(MPI_COMM_WORLD, &PetscGlobalRank)); 883 PetscCallMPI(MPI_Comm_size(MPI_COMM_WORLD, &PetscGlobalSize)); 884 885 MPIU_BOOL = MPI_INT; 886 MPIU_ENUM = MPI_INT; 887 MPIU_FORTRANADDR = (sizeof(void *) == sizeof(int)) ? MPI_INT : MPIU_INT64; 888 if (sizeof(size_t) == sizeof(unsigned)) MPIU_SIZE_T = MPI_UNSIGNED; 889 else if (sizeof(size_t) == sizeof(unsigned long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG; 890 #if defined(PETSC_SIZEOF_LONG_LONG) 891 else if (sizeof(size_t) == sizeof(unsigned long long)) MPIU_SIZE_T = MPI_UNSIGNED_LONG_LONG; 892 #endif 893 else SETERRQ(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS, "Could not find MPI type for size_t"); 894 895 /* 896 Initialized the global complex variable; this is because with 897 shared libraries the constructors for global variables 898 are not called; at least on IRIX. 899 */ 900 #if defined(PETSC_HAVE_COMPLEX) 901 { 902 #if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_REAL___FLOAT128) 903 PetscComplex ic(0.0, 1.0); 904 PETSC_i = ic; 905 #else 906 PETSC_i = _Complex_I; 907 #endif 908 } 909 #endif /* PETSC_HAVE_COMPLEX */ 910 911 /* 912 Create the PETSc MPI reduction operator that sums of the first 913 half of the entries and maxes the second half. 914 */ 915 PetscCallMPI(MPI_Op_create(MPIU_MaxSum_Local, 1, &MPIU_MAXSUM_OP)); 916 917 #if defined(PETSC_HAVE_REAL___FLOAT128) 918 PetscCallMPI(MPI_Type_contiguous(2, MPI_DOUBLE, &MPIU___FLOAT128)); 919 PetscCallMPI(MPI_Type_commit(&MPIU___FLOAT128)); 920 #if defined(PETSC_HAVE_COMPLEX) 921 PetscCallMPI(MPI_Type_contiguous(4, MPI_DOUBLE, &MPIU___COMPLEX128)); 922 PetscCallMPI(MPI_Type_commit(&MPIU___COMPLEX128)); 923 #endif 924 #endif 925 #if defined(PETSC_HAVE_REAL___FP16) 926 PetscCallMPI(MPI_Type_contiguous(2, MPI_CHAR, &MPIU___FP16)); 927 PetscCallMPI(MPI_Type_commit(&MPIU___FP16)); 928 #endif 929 930 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 931 PetscCallMPI(MPI_Op_create(PetscSum_Local, 1, &MPIU_SUM)); 932 PetscCallMPI(MPI_Op_create(PetscMax_Local, 1, &MPIU_MAX)); 933 PetscCallMPI(MPI_Op_create(PetscMin_Local, 1, &MPIU_MIN)); 934 #elif defined(PETSC_HAVE_REAL___FLOAT128) || defined(PETSC_HAVE_REAL___FP16) 935 PetscCallMPI(MPI_Op_create(PetscSum_Local, 1, &MPIU_SUM___FP16___FLOAT128)); 936 #endif 937 938 PetscCallMPI(MPI_Type_contiguous(2, MPIU_SCALAR, &MPIU_2SCALAR)); 939 PetscCallMPI(MPI_Op_create(PetscGarbageKeySortedIntersect, 1, &Petsc_Garbage_SetIntersectOp)); 940 PetscCallMPI(MPI_Type_commit(&MPIU_2SCALAR)); 941 942 /* create datatypes used by MPIU_MAXLOC, MPIU_MINLOC and PetscSplitReduction_Op */ 943 #if !defined(PETSC_HAVE_MPIUNI) 944 { 945 PetscMPIInt blockSizes[2] = {1, 1}; 946 MPI_Aint blockOffsets[2] = {offsetof(struct petsc_mpiu_real_int, v), offsetof(struct petsc_mpiu_real_int, i)}; 947 MPI_Datatype blockTypes[2] = {MPIU_REAL, MPIU_INT}, tmpStruct; 948 949 PetscCallMPI(MPI_Type_create_struct(2, blockSizes, blockOffsets, blockTypes, &tmpStruct)); 950 PetscCallMPI(MPI_Type_create_resized(tmpStruct, 0, sizeof(struct petsc_mpiu_real_int), &MPIU_REAL_INT)); 951 PetscCallMPI(MPI_Type_free(&tmpStruct)); 952 PetscCallMPI(MPI_Type_commit(&MPIU_REAL_INT)); 953 } 954 { 955 PetscMPIInt blockSizes[2] = {1, 1}; 956 MPI_Aint blockOffsets[2] = {offsetof(struct petsc_mpiu_scalar_int, v), offsetof(struct petsc_mpiu_scalar_int, i)}; 957 MPI_Datatype blockTypes[2] = {MPIU_SCALAR, MPIU_INT}, tmpStruct; 958 959 PetscCallMPI(MPI_Type_create_struct(2, blockSizes, blockOffsets, blockTypes, &tmpStruct)); 960 PetscCallMPI(MPI_Type_create_resized(tmpStruct, 0, sizeof(struct petsc_mpiu_scalar_int), &MPIU_SCALAR_INT)); 961 PetscCallMPI(MPI_Type_free(&tmpStruct)); 962 PetscCallMPI(MPI_Type_commit(&MPIU_SCALAR_INT)); 963 } 964 #endif 965 966 #if defined(PETSC_USE_64BIT_INDICES) 967 PetscCallMPI(MPI_Type_contiguous(2, MPIU_INT, &MPIU_2INT)); 968 PetscCallMPI(MPI_Type_commit(&MPIU_2INT)); 969 #endif 970 PetscCallMPI(MPI_Type_contiguous(4, MPI_INT, &MPI_4INT)); 971 PetscCallMPI(MPI_Type_commit(&MPI_4INT)); 972 PetscCallMPI(MPI_Type_contiguous(4, MPIU_INT, &MPIU_4INT)); 973 PetscCallMPI(MPI_Type_commit(&MPIU_4INT)); 974 975 /* 976 Attributes to be set on PETSc communicators 977 */ 978 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, Petsc_Counter_Attr_Delete_Fn, &Petsc_Counter_keyval, (void *)0)); 979 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, Petsc_InnerComm_Attr_Delete_Fn, &Petsc_InnerComm_keyval, (void *)0)); 980 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, Petsc_OuterComm_Attr_Delete_Fn, &Petsc_OuterComm_keyval, (void *)0)); 981 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, Petsc_ShmComm_Attr_Delete_Fn, &Petsc_ShmComm_keyval, (void *)0)); 982 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, MPI_COMM_NULL_DELETE_FN, &Petsc_CreationIdx_keyval, (void *)0)); 983 PetscCallMPI(MPI_Comm_create_keyval(MPI_COMM_NULL_COPY_FN, MPI_COMM_NULL_DELETE_FN, &Petsc_Garbage_HMap_keyval, (void *)0)); 984 985 #if defined(PETSC_USE_FORTRAN_BINDINGS) 986 if (ftn) PetscCall(PetscInitFortran_Private(readarguments, file, len)); 987 else 988 #endif 989 PetscCall(PetscOptionsInsert(NULL, &PetscGlobalArgc, &PetscGlobalArgs, file)); 990 991 /* call a second time so it can look in the options database */ 992 PetscCall(PetscErrorPrintfInitialize()); 993 994 /* 995 Check system options and print help 996 */ 997 PetscCall(PetscOptionsCheckInitial_Private(help)); 998 999 /* 1000 Creates the logging data structures; this is enabled even if logging is not turned on 1001 This is the last thing we do before returning to the user code to prevent having the 1002 logging numbers contaminated by any startup time associated with MPI 1003 */ 1004 PetscCall(PetscLogInitialize()); 1005 1006 /* 1007 Initialize PetscDevice and PetscDeviceContext 1008 1009 Note to any future devs thinking of moving this, proper initialization requires: 1010 1. MPI initialized 1011 2. Options DB initialized 1012 3. Petsc error handling initialized, specifically signal handlers. This expects to set up 1013 its own SIGSEV handler via the push/pop interface. 1014 4. Logging initialized 1015 */ 1016 PetscCall(PetscDeviceInitializeFromOptions_Internal(PETSC_COMM_WORLD)); 1017 1018 #if PetscDefined(HAVE_VIENNACL) 1019 flg = PETSC_FALSE; 1020 PetscCall(PetscOptionsHasName(NULL, NULL, "-log_view", &flg)); 1021 if (!flg) PetscCall(PetscOptionsGetBool(NULL, NULL, "-viennacl_synchronize", &flg, NULL)); 1022 PetscViennaCLSynchronize = flg; 1023 PetscCall(PetscViennaCLInit()); 1024 #endif 1025 1026 PetscCall(PetscCitationsInitialize()); 1027 1028 #if defined(PETSC_HAVE_SAWS) 1029 PetscCall(PetscInitializeSAWs(ftn ? NULL : help)); 1030 flg = PETSC_FALSE; 1031 PetscCall(PetscOptionsHasName(NULL, NULL, "-stack_view", &flg)); 1032 if (flg) PetscCall(PetscStackViewSAWs()); 1033 #endif 1034 1035 /* 1036 Load the dynamic libraries (on machines that support them), this registers all 1037 the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 1038 */ 1039 PetscCall(PetscInitialize_DynamicLibraries()); 1040 1041 PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD, &size)); 1042 PetscCall(PetscInfo(NULL, "PETSc successfully started: number of processors = %d\n", size)); 1043 PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 1044 PetscCall(PetscInfo(NULL, "Running on machine: %s\n", hostname)); 1045 #if defined(PETSC_HAVE_OPENMP) 1046 { 1047 PetscBool omp_view_flag; 1048 char *threads = getenv("OMP_NUM_THREADS"); 1049 1050 if (threads) { 1051 PetscCall(PetscInfo(NULL, "Number of OpenMP threads %s (as given by OMP_NUM_THREADS)\n", threads)); 1052 (void)sscanf(threads, "%" PetscInt_FMT, &PetscNumOMPThreads); 1053 } else { 1054 PetscNumOMPThreads = (PetscInt)omp_get_max_threads(); 1055 PetscCall(PetscInfo(NULL, "Number of OpenMP threads %" PetscInt_FMT " (as given by omp_get_max_threads())\n", PetscNumOMPThreads)); 1056 } 1057 PetscOptionsBegin(PETSC_COMM_WORLD, NULL, "OpenMP options", "Sys"); 1058 PetscCall(PetscOptionsInt("-omp_num_threads", "Number of OpenMP threads to use (can also use environmental variable OMP_NUM_THREADS", "None", PetscNumOMPThreads, &PetscNumOMPThreads, &flg)); 1059 PetscCall(PetscOptionsName("-omp_view", "Display OpenMP number of threads", NULL, &omp_view_flag)); 1060 PetscOptionsEnd(); 1061 if (flg) { 1062 PetscCall(PetscInfo(NULL, "Number of OpenMP theads %" PetscInt_FMT " (given by -omp_num_threads)\n", PetscNumOMPThreads)); 1063 omp_set_num_threads((int)PetscNumOMPThreads); 1064 } 1065 if (omp_view_flag) PetscCall(PetscPrintf(PETSC_COMM_WORLD, "OpenMP: number of threads %" PetscInt_FMT "\n", PetscNumOMPThreads)); 1066 } 1067 #endif 1068 1069 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 1070 /* 1071 Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 1072 1073 Currently not used because it is not supported by MPICH. 1074 */ 1075 if (!PetscBinaryBigEndian()) PetscCallMPI(MPI_Register_datarep((char *)"petsc", PetscDataRep_read_conv_fn, PetscDataRep_write_conv_fn, PetscDataRep_extent_fn, NULL)); 1076 #endif 1077 1078 #if defined(PETSC_SERIALIZE_FUNCTIONS) 1079 PetscCall(PetscFPTCreate(10000)); 1080 #endif 1081 1082 #if defined(PETSC_HAVE_HWLOC) 1083 { 1084 PetscViewer viewer; 1085 PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-process_view", &viewer, NULL, &flg)); 1086 if (flg) { 1087 PetscCall(PetscProcessPlacementView(viewer)); 1088 PetscCall(PetscViewerDestroy(&viewer)); 1089 } 1090 } 1091 #endif 1092 1093 flg = PETSC_TRUE; 1094 PetscCall(PetscOptionsGetBool(NULL, NULL, "-viewfromoptions", &flg, NULL)); 1095 if (!flg) PetscCall(PetscOptionsPushGetViewerOff(PETSC_TRUE)); 1096 1097 #if defined(PETSC_HAVE_ADIOS) 1098 PetscCallExternal(adios_init_noxml, PETSC_COMM_WORLD); 1099 PetscCallExternal(adios_declare_group, &Petsc_adios_group, "PETSc", "", adios_stat_default); 1100 PetscCallExternal(adios_select_method, Petsc_adios_group, "MPI", "", ""); 1101 PetscCallExternal(adios_read_init_method, ADIOS_READ_METHOD_BP, PETSC_COMM_WORLD, ""); 1102 #endif 1103 1104 #if defined(__VALGRIND_H) 1105 PETSC_RUNNING_ON_VALGRIND = RUNNING_ON_VALGRIND ? PETSC_TRUE : PETSC_FALSE; 1106 #if defined(PETSC_USING_DARWIN) && defined(PETSC_BLASLAPACK_SDOT_RETURNS_DOUBLE) 1107 if (PETSC_RUNNING_ON_VALGRIND) PetscCall(PetscPrintf(PETSC_COMM_WORLD, "WARNING: Running valgrind with the MacOS native BLAS and LAPACK can fail. If it fails suggest configuring with --download-fblaslapack or --download-f2cblaslapack")); 1108 #endif 1109 #endif 1110 /* 1111 Set flag that we are completely initialized 1112 */ 1113 PetscInitializeCalled = PETSC_TRUE; 1114 1115 PetscCall(PetscOptionsHasName(NULL, NULL, "-python", &flg)); 1116 if (flg) PetscCall(PetscPythonInitialize(NULL, NULL)); 1117 1118 PetscCall(PetscOptionsHasName(NULL, NULL, "-mpi_linear_solver_server", &flg)); 1119 if (PetscDefined(USE_SINGLE_LIBRARY) && flg) PetscCall(PCMPIServerBegin()); 1120 else PetscCheck(!flg, PETSC_COMM_WORLD, PETSC_ERR_SUP, "PETSc configured using -with-single-library=0; -mpi_linear_solver_server not supported in that case"); 1121 PetscFunctionReturn(PETSC_SUCCESS); 1122 } 1123 1124 // "Unknown section 'Environmental Variables'" 1125 // PetscClangLinter pragma disable: -fdoc-section-header-unknown 1126 /*@C 1127 PetscInitialize - Initializes the PETSc database and MPI. 1128 `PetscInitialize()` calls MPI_Init() if that has yet to be called, 1129 so this routine should always be called near the beginning of 1130 your program -- usually the very first line! 1131 1132 Collective on `MPI_COMM_WORLD` or `PETSC_COMM_WORLD` if it has been set 1133 1134 Input Parameters: 1135 + argc - count of number of command line arguments 1136 . args - the command line arguments 1137 . file - [optional] PETSc database file, append ":yaml" to filename to specify YAML options format. 1138 Use NULL or empty string to not check for code specific file. 1139 Also checks ~/.petscrc, .petscrc and petscrc. 1140 Use -skip_petscrc in the code specific file (or command line) to skip ~/.petscrc, .petscrc and petscrc files. 1141 - help - [optional] Help message to print, use NULL for no message 1142 1143 If you wish PETSc code to run ONLY on a subcommunicator of `MPI_COMM_WORLD`, create that 1144 communicator first and assign it to `PETSC_COMM_WORLD` BEFORE calling `PetscInitialize()`. Thus if you are running a 1145 four process job and two processes will run PETSc and have `PetscInitialize()` and PetscFinalize() and two process will not, 1146 then do this. If ALL processes in the job are using `PetscInitialize()` and `PetscFinalize()` then you don't need to do this, even 1147 if different subcommunicators of the job are doing different things with PETSc. 1148 1149 Options Database Keys: 1150 + -help [intro] - prints help method for each option; if intro is given the program stops after printing the introductory help message 1151 . -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 1152 . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 1153 . -on_error_emacs <machinename> - causes emacsclient to jump to error file 1154 . -on_error_abort - calls `abort()` when error detected (no traceback) 1155 . -on_error_mpiabort - calls `MPI_abort()` when error detected 1156 . -error_output_stdout - prints PETSc error messages to stdout instead of the default stderr 1157 . -error_output_none - does not print the error messages (but handles errors in the same way as if this was not called) 1158 . -debugger_ranks [rank1,rank2,...] - Indicates ranks to start in debugger 1159 . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 1160 . -stop_for_debugger - Print message on how to attach debugger manually to 1161 process and wait (-debugger_pause) seconds for attachment 1162 . -malloc_dump - prints a list of all unfreed memory at the end of the run 1163 . -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 1164 . -malloc_view - show a list of all allocated memory during `PetscFinalize()` 1165 . -malloc_view_threshold <t> - only list memory allocations of size greater than t with -malloc_view 1166 . -malloc_requested_size - malloc logging will record the requested size rather than size after alignment 1167 . -fp_trap - Stops on floating point exceptions 1168 . -no_signal_handler - Indicates not to trap error signals 1169 . -shared_tmp - indicates /tmp directory is shared by all processors 1170 . -not_shared_tmp - each processor has own /tmp 1171 . -tmp - alternative name of /tmp directory 1172 . -get_total_flops - returns total flops done by all processors 1173 - -memory_view - Print memory usage at end of run 1174 1175 Options Database Keys for Option Database: 1176 + -skip_petscrc - skip the default option files ~/.petscrc, .petscrc, petscrc 1177 . -options_monitor - monitor all set options to standard output for the whole program run 1178 - -options_monitor_cancel - cancel options monitoring hard-wired using `PetscOptionsMonitorSet()` 1179 1180 Options -options_monitor_{all,cancel} are 1181 position-independent and apply to all options set since the PETSc start. 1182 They can be used also in option files. 1183 1184 See `PetscOptionsMonitorSet()` to do monitoring programmatically. 1185 1186 Options Database Keys for Profiling: 1187 See Users-Manual: ch_profiling for details. 1188 + -info [filename][:[~]<list,of,classnames>[:[~]self]] - Prints verbose information. See `PetscInfo()`. 1189 . -log_sync - Enable barrier synchronization for all events. This option is useful to debug imbalance within each event, 1190 however it slows things down and gives a distorted view of the overall runtime. 1191 . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 1192 hangs without running in the debugger). See `PetscLogTraceBegin()`. 1193 . -log_view [:filename:format][,[:filename:format]...] - Prints summary of flop and timing information to screen or file, see `PetscLogView()` (up to 4 viewers) 1194 . -log_view_memory - Includes in the summary from -log_view the memory used in each event, see `PetscLogView()`. 1195 . -log_view_gpu_time - Includes in the summary from -log_view the time used in each GPU kernel, see `PetscLogView(). 1196 . -log_exclude: <vec,mat,pc,ksp,snes> - excludes subset of object classes from logging 1197 . -log [filename] - Logs profiling information in a dump file, see `PetscLogDump()`. 1198 . -log_all [filename] - Same as `-log`. 1199 . -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 1200 . -log_perfstubs - Starts a log handler with the perfstubs interface (which is used by TAU) 1201 . -viewfromoptions on,off - Enable or disable `XXXSetFromOptions()` calls, for applications with many small solves turn this off 1202 - -check_pointer_intensity 0,1,2 - if pointers are checked for validity (debug version only), using 0 will result in faster code 1203 1204 Options Database Keys for SAWs: 1205 + -saws_port <portnumber> - port number to publish SAWs data, default is 8080 1206 . -saws_port_auto_select - have SAWs select a new unique port number where it publishes the data, the URL is printed to the screen 1207 this is useful when you are running many jobs that utilize SAWs at the same time 1208 . -saws_log <filename> - save a log of all SAWs communication 1209 . -saws_https <certificate file> - have SAWs use HTTPS instead of HTTP 1210 - -saws_root <directory> - allow SAWs to have access to the given directory to search for requested resources and files 1211 1212 Environmental Variables: 1213 + `PETSC_TMP` - alternative tmp directory 1214 . `PETSC_SHARED_TMP` - tmp is shared by all processes 1215 . `PETSC_NOT_SHARED_TMP` - each process has its own private tmp 1216 . `PETSC_OPTIONS` - a string containing additional options for petsc in the form of command line "-key value" pairs 1217 . `PETSC_OPTIONS_YAML` - (requires configuring PETSc to use libyaml) a string containing additional options for petsc in the form of a YAML document 1218 . `PETSC_VIEWER_SOCKET_PORT` - socket number to use for socket viewer 1219 - `PETSC_VIEWER_SOCKET_MACHINE` - machine to use for socket viewer to connect to 1220 1221 Level: beginner 1222 1223 Note: 1224 If for some reason you must call `MPI_Init()` separately, call 1225 it before `PetscInitialize()`. 1226 1227 Fortran Notes: 1228 In Fortran this routine can be called with 1229 .vb 1230 call PetscInitialize(ierr) 1231 call PetscInitialize(file,ierr) or 1232 call PetscInitialize(file,help,ierr) 1233 .ve 1234 1235 If your main program is C but you call Fortran code that also uses PETSc you need to call `PetscInitializeFortran()` soon after 1236 calling `PetscInitialize()`. 1237 1238 Options Database Key for Developers: 1239 . -checkfunctionlist - automatically checks that function lists associated with objects are correctly cleaned up. Produces messages of the form: 1240 "function name: MatInodeGetInodeSizes_C" if they are not cleaned up. This flag is always set for the test harness (in framework.py) 1241 1242 .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscInitializeNoArguments()`, `PetscLogGpuTime()` 1243 @*/ 1244 PetscErrorCode PetscInitialize(int *argc, char ***args, const char file[], const char help[]) 1245 { 1246 PetscMPIInt flag; 1247 const char *prog = "Unknown Name", *mpienv; 1248 1249 PetscFunctionBegin; 1250 if (PetscInitializeCalled) PetscFunctionReturn(PETSC_SUCCESS); 1251 PetscCallMPI(MPI_Initialized(&flag)); 1252 if (!flag) { 1253 PetscCheck(PETSC_COMM_WORLD == MPI_COMM_NULL, PETSC_COMM_SELF, PETSC_ERR_SUP, "You cannot set PETSC_COMM_WORLD if you have not initialized MPI first"); 1254 PetscCall(PetscPreMPIInit_Private()); 1255 #if defined(PETSC_HAVE_MPI_INIT_THREAD) 1256 { 1257 PetscMPIInt PETSC_UNUSED provided; 1258 PetscCallMPI(MPI_Init_thread(argc, args, PETSC_MPI_THREAD_REQUIRED, &provided)); 1259 } 1260 #else 1261 PetscCallMPI(MPI_Init(argc, args)); 1262 #endif 1263 if (PetscDefined(HAVE_MPIUNI)) { 1264 mpienv = getenv("PMI_SIZE"); 1265 if (!mpienv) mpienv = getenv("OMPI_COMM_WORLD_SIZE"); 1266 if (mpienv) { 1267 PetscInt isize; 1268 PetscCall(PetscOptionsStringToInt(mpienv, &isize)); 1269 if (isize != 1) printf("You are using an MPI-uni (sequential) install of PETSc but trying to launch parallel jobs; you need full MPI version of PETSc\n"); 1270 PetscCheck(isize == 1, MPI_COMM_SELF, PETSC_ERR_MPI, "You are using an MPI-uni (sequential) install of PETSc but trying to launch parallel jobs; you need full MPI version of PETSc"); 1271 } 1272 } 1273 PetscBeganMPI = PETSC_TRUE; 1274 } 1275 1276 if (argc && *argc) prog = **args; 1277 if (argc && args) { 1278 PetscGlobalArgc = *argc; 1279 PetscGlobalArgs = *args; 1280 } 1281 PetscCall(PetscInitialize_Common(prog, file, help, PETSC_FALSE, PETSC_FALSE, 0)); 1282 PetscFunctionReturn(PETSC_SUCCESS); 1283 } 1284 1285 PETSC_INTERN PetscObject *PetscObjects; 1286 PETSC_INTERN PetscInt PetscObjectsCounts; 1287 PETSC_INTERN PetscInt PetscObjectsMaxCounts; 1288 PETSC_INTERN PetscBool PetscObjectsLog; 1289 1290 /* 1291 Frees all the MPI types and operations that PETSc may have created 1292 */ 1293 PetscErrorCode PetscFreeMPIResources(void) 1294 { 1295 PetscFunctionBegin; 1296 #if defined(PETSC_HAVE_REAL___FLOAT128) 1297 PetscCallMPI(MPI_Type_free(&MPIU___FLOAT128)); 1298 #if defined(PETSC_HAVE_COMPLEX) 1299 PetscCallMPI(MPI_Type_free(&MPIU___COMPLEX128)); 1300 #endif 1301 #endif 1302 #if defined(PETSC_HAVE_REAL___FP16) 1303 PetscCallMPI(MPI_Type_free(&MPIU___FP16)); 1304 #endif 1305 1306 #if defined(PETSC_USE_REAL___FLOAT128) || defined(PETSC_USE_REAL___FP16) 1307 PetscCallMPI(MPI_Op_free(&MPIU_SUM)); 1308 PetscCallMPI(MPI_Op_free(&MPIU_MAX)); 1309 PetscCallMPI(MPI_Op_free(&MPIU_MIN)); 1310 #elif defined(PETSC_HAVE_REAL___FLOAT128) || defined(PETSC_HAVE_REAL___FP16) 1311 PetscCallMPI(MPI_Op_free(&MPIU_SUM___FP16___FLOAT128)); 1312 #endif 1313 1314 PetscCallMPI(MPI_Type_free(&MPIU_2SCALAR)); 1315 PetscCallMPI(MPI_Type_free(&MPIU_REAL_INT)); 1316 PetscCallMPI(MPI_Type_free(&MPIU_SCALAR_INT)); 1317 #if defined(PETSC_USE_64BIT_INDICES) 1318 PetscCallMPI(MPI_Type_free(&MPIU_2INT)); 1319 #endif 1320 PetscCallMPI(MPI_Type_free(&MPI_4INT)); 1321 PetscCallMPI(MPI_Type_free(&MPIU_4INT)); 1322 PetscCallMPI(MPI_Op_free(&MPIU_MAXSUM_OP)); 1323 PetscCallMPI(MPI_Op_free(&Petsc_Garbage_SetIntersectOp)); 1324 PetscFunctionReturn(PETSC_SUCCESS); 1325 } 1326 1327 PETSC_INTERN PetscErrorCode PetscLogFinalize(void); 1328 1329 /*@C 1330 PetscFinalize - Checks for options to be called at the conclusion 1331 of the program. `MPI_Finalize()` is called only if the user had not 1332 called `MPI_Init()` before calling `PetscInitialize()`. 1333 1334 Collective on `PETSC_COMM_WORLD` 1335 1336 Options Database Keys: 1337 + -options_view - Calls `PetscOptionsView()` 1338 . -options_left - Prints unused options that remain in the database 1339 . -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 1340 . -mpidump - Calls PetscMPIDump() 1341 . -malloc_dump <optional filename> - Calls `PetscMallocDump()`, displays all memory allocated that has not been freed 1342 . -memory_view - Prints total memory usage 1343 - -malloc_view <optional filename> - Prints list of all memory allocated and in what functions 1344 1345 Level: beginner 1346 1347 Note: 1348 See `PetscInitialize()` for other runtime options. 1349 1350 .seealso: `PetscInitialize()`, `PetscOptionsView()`, `PetscMallocDump()`, `PetscMPIDump()`, `PetscEnd()` 1351 @*/ 1352 PetscErrorCode PetscFinalize(void) 1353 { 1354 PetscMPIInt rank; 1355 PetscInt nopt; 1356 PetscBool flg1 = PETSC_FALSE, flg2 = PETSC_FALSE, flg3 = PETSC_FALSE; 1357 PetscBool flg; 1358 char mname[PETSC_MAX_PATH_LEN]; 1359 1360 PetscFunctionBegin; 1361 PetscCheck(PetscInitializeCalled, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "PetscInitialize() must be called before PetscFinalize()"); 1362 PetscCall(PetscInfo(NULL, "PetscFinalize() called\n")); 1363 1364 PetscCall(PetscOptionsHasName(NULL, NULL, "-mpi_linear_solver_server", &flg)); 1365 if (PetscDefined(USE_SINGLE_LIBRARY) && flg) PetscCall(PCMPIServerEnd()); 1366 1367 /* Clean up Garbage automatically on COMM_SELF and COMM_WORLD at finalize */ 1368 { 1369 union 1370 { 1371 MPI_Comm comm; 1372 void *ptr; 1373 } ucomm; 1374 PetscMPIInt flg; 1375 void *tmp; 1376 1377 PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_SELF, Petsc_InnerComm_keyval, &ucomm, &flg)); 1378 if (flg) PetscCallMPI(MPI_Comm_get_attr(ucomm.comm, Petsc_Garbage_HMap_keyval, &tmp, &flg)); 1379 if (flg) PetscCall(PetscGarbageCleanup(PETSC_COMM_SELF)); 1380 PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_WORLD, Petsc_InnerComm_keyval, &ucomm, &flg)); 1381 if (flg) PetscCallMPI(MPI_Comm_get_attr(ucomm.comm, Petsc_Garbage_HMap_keyval, &tmp, &flg)); 1382 if (flg) PetscCall(PetscGarbageCleanup(PETSC_COMM_WORLD)); 1383 } 1384 1385 PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 1386 #if defined(PETSC_HAVE_ADIOS) 1387 PetscCallExternal(adios_read_finalize_method, ADIOS_READ_METHOD_BP_AGGREGATE); 1388 PetscCallExternal(adios_finalize, rank); 1389 #endif 1390 PetscCall(PetscOptionsHasName(NULL, NULL, "-citations", &flg)); 1391 if (flg) { 1392 char *cits, filename[PETSC_MAX_PATH_LEN]; 1393 FILE *fd = PETSC_STDOUT; 1394 1395 PetscCall(PetscOptionsGetString(NULL, NULL, "-citations", filename, sizeof(filename), NULL)); 1396 if (filename[0]) PetscCall(PetscFOpen(PETSC_COMM_WORLD, filename, "w", &fd)); 1397 PetscCall(PetscSegBufferGet(PetscCitationsList, 1, &cits)); 1398 cits[0] = 0; 1399 PetscCall(PetscSegBufferExtractAlloc(PetscCitationsList, &cits)); 1400 PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "If you publish results based on this computation please cite the following:\n")); 1401 PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "===========================================================================\n")); 1402 PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%s", cits)); 1403 PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "===========================================================================\n")); 1404 PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 1405 PetscCall(PetscFree(cits)); 1406 } 1407 PetscCall(PetscSegBufferDestroy(&PetscCitationsList)); 1408 1409 #if defined(PETSC_SERIALIZE_FUNCTIONS) 1410 PetscCall(PetscFPTDestroy()); 1411 #endif 1412 1413 #if defined(PETSC_HAVE_SAWS) 1414 flg = PETSC_FALSE; 1415 PetscCall(PetscOptionsGetBool(NULL, NULL, "-saw_options", &flg, NULL)); 1416 if (flg) PetscCall(PetscOptionsSAWsDestroy()); 1417 #endif 1418 1419 #if defined(PETSC_HAVE_X) 1420 flg1 = PETSC_FALSE; 1421 PetscCall(PetscOptionsGetBool(NULL, NULL, "-x_virtual", &flg1, NULL)); 1422 if (flg1) { 1423 /* this is a crude hack, but better than nothing */ 1424 PetscCall(PetscPOpen(PETSC_COMM_WORLD, NULL, "pkill -9 Xvfb", "r", NULL)); 1425 } 1426 #endif 1427 1428 #if !defined(PETSC_HAVE_THREADSAFETY) 1429 PetscCall(PetscOptionsGetBool(NULL, NULL, "-memory_view", &flg2, NULL)); 1430 if (flg2) PetscCall(PetscMemoryView(PETSC_VIEWER_STDOUT_WORLD, "Summary of Memory Usage in PETSc\n")); 1431 #endif 1432 1433 if (PetscDefined(USE_LOG)) { 1434 flg1 = PETSC_FALSE; 1435 PetscCall(PetscOptionsGetBool(NULL, NULL, "-get_total_flops", &flg1, NULL)); 1436 if (flg1) { 1437 PetscLogDouble flops = 0; 1438 PetscCallMPI(MPI_Reduce(&petsc_TotalFlops, &flops, 1, MPI_DOUBLE, MPI_SUM, 0, PETSC_COMM_WORLD)); 1439 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "Total flops over all processors %g\n", flops)); 1440 } 1441 } 1442 1443 if (PetscDefined(USE_LOG) && PetscDefined(HAVE_MPE)) { 1444 mname[0] = 0; 1445 PetscCall(PetscOptionsGetString(NULL, NULL, "-log_mpe", mname, sizeof(mname), &flg1)); 1446 if (flg1) PetscCall(PetscLogMPEDump(mname[0] ? mname : NULL)); 1447 } 1448 1449 // Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1450 PetscCall(PetscObjectRegisterDestroyAll()); 1451 1452 if (PetscDefined(USE_LOG)) { 1453 PetscCall(PetscOptionsPushGetViewerOff(PETSC_FALSE)); 1454 PetscCall(PetscLogViewFromOptions()); 1455 PetscCall(PetscOptionsPopGetViewerOff()); 1456 1457 // Free any objects created by the last block of code. 1458 PetscCall(PetscObjectRegisterDestroyAll()); 1459 1460 mname[0] = 0; 1461 PetscCall(PetscOptionsGetString(NULL, NULL, "-log_all", mname, sizeof(mname), &flg1)); 1462 PetscCall(PetscOptionsGetString(NULL, NULL, "-log", mname, sizeof(mname), &flg2)); 1463 if (flg1 || flg2) PetscCall(PetscLogDump(mname)); 1464 } 1465 1466 flg1 = PETSC_FALSE; 1467 PetscCall(PetscOptionsGetBool(NULL, NULL, "-no_signal_handler", &flg1, NULL)); 1468 if (!flg1) PetscCall(PetscPopSignalHandler()); 1469 flg1 = PETSC_FALSE; 1470 PetscCall(PetscOptionsGetBool(NULL, NULL, "-mpidump", &flg1, NULL)); 1471 if (flg1) PetscCall(PetscMPIDump(stdout)); 1472 flg1 = PETSC_FALSE; 1473 flg2 = PETSC_FALSE; 1474 /* preemptive call to avoid listing this option in options table as unused */ 1475 PetscCall(PetscOptionsHasName(NULL, NULL, "-malloc_dump", &flg1)); 1476 PetscCall(PetscOptionsHasName(NULL, NULL, "-objects_dump", &flg1)); 1477 PetscCall(PetscOptionsGetBool(NULL, NULL, "-options_view", &flg2, NULL)); 1478 1479 if (flg2) { 1480 PetscViewer viewer; 1481 PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &viewer)); 1482 PetscCall(PetscViewerSetType(viewer, PETSCVIEWERASCII)); 1483 PetscCall(PetscOptionsView(NULL, viewer)); 1484 PetscCall(PetscViewerDestroy(&viewer)); 1485 } 1486 1487 /* to prevent PETSc -options_left from warning */ 1488 PetscCall(PetscOptionsHasName(NULL, NULL, "-nox", &flg1)); 1489 PetscCall(PetscOptionsHasName(NULL, NULL, "-nox_warning", &flg1)); 1490 1491 flg3 = PETSC_FALSE; /* default value is required */ 1492 PetscCall(PetscOptionsGetBool(NULL, NULL, "-options_left", &flg3, &flg1)); 1493 if (!flg1) flg3 = PETSC_TRUE; 1494 if (flg3) { 1495 if (!flg2 && flg1) { /* have not yet printed the options */ 1496 PetscViewer viewer; 1497 PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &viewer)); 1498 PetscCall(PetscViewerSetType(viewer, PETSCVIEWERASCII)); 1499 PetscCall(PetscOptionsView(NULL, viewer)); 1500 PetscCall(PetscViewerDestroy(&viewer)); 1501 } 1502 PetscCall(PetscOptionsAllUsed(NULL, &nopt)); 1503 if (nopt) { 1504 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "WARNING! There are options you set that were not used!\n")); 1505 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "WARNING! could be spelling mistake, etc!\n")); 1506 if (nopt == 1) { 1507 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "There is one unused database option. It is:\n")); 1508 } else { 1509 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "There are %" PetscInt_FMT " unused database options. They are:\n", nopt)); 1510 } 1511 } else if (flg3 && flg1) { 1512 PetscCall(PetscPrintf(PETSC_COMM_WORLD, "There are no unused options.\n")); 1513 } 1514 PetscCall(PetscOptionsLeft(NULL)); 1515 } 1516 1517 #if defined(PETSC_HAVE_SAWS) 1518 if (!PetscGlobalRank) { 1519 PetscCall(PetscStackSAWsViewOff()); 1520 PetscCallSAWs(SAWs_Finalize, ()); 1521 } 1522 #endif 1523 1524 /* 1525 List all objects the user may have forgot to free 1526 */ 1527 if (PetscDefined(USE_LOG) && PetscObjectsLog) { 1528 PetscCall(PetscOptionsHasName(NULL, NULL, "-objects_dump", &flg1)); 1529 if (flg1) { 1530 MPI_Comm local_comm; 1531 char string[64]; 1532 1533 PetscCall(PetscOptionsGetString(NULL, NULL, "-objects_dump", string, sizeof(string), NULL)); 1534 PetscCallMPI(MPI_Comm_dup(PETSC_COMM_WORLD, &local_comm)); 1535 PetscCall(PetscSequentialPhaseBegin_Private(local_comm, 1)); 1536 PetscCall(PetscObjectsDump(stdout, (string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE)); 1537 PetscCall(PetscSequentialPhaseEnd_Private(local_comm, 1)); 1538 PetscCallMPI(MPI_Comm_free(&local_comm)); 1539 } 1540 } 1541 1542 PetscObjectsCounts = 0; 1543 PetscObjectsMaxCounts = 0; 1544 PetscCall(PetscFree(PetscObjects)); 1545 1546 /* 1547 Destroy any packages that registered a finalize 1548 */ 1549 PetscCall(PetscRegisterFinalizeAll()); 1550 1551 PetscCall(PetscLogFinalize()); 1552 1553 /* 1554 Print PetscFunctionLists that have not been properly freed 1555 */ 1556 if (PetscPrintFunctionList) PetscCall(PetscFunctionListPrintAll()); 1557 1558 if (petsc_history) { 1559 PetscCall(PetscCloseHistoryFile(&petsc_history)); 1560 petsc_history = NULL; 1561 } 1562 PetscCall(PetscOptionsHelpPrintedDestroy(&PetscOptionsHelpPrintedSingleton)); 1563 PetscCall(PetscInfoDestroy()); 1564 1565 #if !defined(PETSC_HAVE_THREADSAFETY) 1566 if (!(PETSC_RUNNING_ON_VALGRIND)) { 1567 char fname[PETSC_MAX_PATH_LEN]; 1568 char sname[PETSC_MAX_PATH_LEN]; 1569 FILE *fd; 1570 int err; 1571 1572 flg2 = PETSC_FALSE; 1573 flg3 = PETSC_FALSE; 1574 if (PetscDefined(USE_DEBUG)) PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_test", &flg2, NULL)); 1575 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_debug", &flg3, NULL)); 1576 fname[0] = 0; 1577 PetscCall(PetscOptionsGetString(NULL, NULL, "-malloc_dump", fname, sizeof(fname), &flg1)); 1578 if (flg1 && fname[0]) { 1579 PetscCall(PetscSNPrintf(sname, sizeof(sname), "%s_%d", fname, rank)); 1580 fd = fopen(sname, "w"); 1581 PetscCheck(fd, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open log file: %s", sname); 1582 PetscCall(PetscMallocDump(fd)); 1583 err = fclose(fd); 1584 PetscCheck(!err, PETSC_COMM_SELF, PETSC_ERR_SYS, "fclose() failed on file"); 1585 } else if (flg1 || flg2 || flg3) { 1586 MPI_Comm local_comm; 1587 1588 PetscCallMPI(MPI_Comm_dup(PETSC_COMM_WORLD, &local_comm)); 1589 PetscCall(PetscSequentialPhaseBegin_Private(local_comm, 1)); 1590 PetscCall(PetscMallocDump(stdout)); 1591 PetscCall(PetscSequentialPhaseEnd_Private(local_comm, 1)); 1592 PetscCallMPI(MPI_Comm_free(&local_comm)); 1593 } 1594 fname[0] = 0; 1595 PetscCall(PetscOptionsGetString(NULL, NULL, "-malloc_view", fname, sizeof(fname), &flg1)); 1596 if (flg1 && fname[0]) { 1597 PetscCall(PetscSNPrintf(sname, sizeof(sname), "%s_%d", fname, rank)); 1598 fd = fopen(sname, "w"); 1599 PetscCheck(fd, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open log file: %s", sname); 1600 PetscCall(PetscMallocView(fd)); 1601 err = fclose(fd); 1602 PetscCheck(!err, PETSC_COMM_SELF, PETSC_ERR_SYS, "fclose() failed on file"); 1603 } else if (flg1) { 1604 MPI_Comm local_comm; 1605 1606 PetscCallMPI(MPI_Comm_dup(PETSC_COMM_WORLD, &local_comm)); 1607 PetscCall(PetscSequentialPhaseBegin_Private(local_comm, 1)); 1608 PetscCall(PetscMallocView(stdout)); 1609 PetscCall(PetscSequentialPhaseEnd_Private(local_comm, 1)); 1610 PetscCallMPI(MPI_Comm_free(&local_comm)); 1611 } 1612 } 1613 #endif 1614 1615 /* 1616 Close any open dynamic libraries 1617 */ 1618 PetscCall(PetscFinalize_DynamicLibraries()); 1619 1620 /* Can be destroyed only after all the options are used */ 1621 PetscCall(PetscOptionsDestroyDefault()); 1622 1623 PetscGlobalArgc = 0; 1624 PetscGlobalArgs = NULL; 1625 1626 #if defined(PETSC_HAVE_KOKKOS) 1627 if (PetscBeganKokkos) { 1628 PetscCall(PetscKokkosFinalize_Private()); 1629 PetscBeganKokkos = PETSC_FALSE; 1630 PetscKokkosInitialized = PETSC_FALSE; 1631 } 1632 #endif 1633 1634 #if defined(PETSC_HAVE_NVSHMEM) 1635 if (PetscBeganNvshmem) { 1636 PetscCall(PetscNvshmemFinalize()); 1637 PetscBeganNvshmem = PETSC_FALSE; 1638 } 1639 #endif 1640 1641 PetscCall(PetscFreeMPIResources()); 1642 1643 /* 1644 Destroy any known inner MPI_Comm's and attributes pointing to them 1645 Note this will not destroy any new communicators the user has created. 1646 1647 If all PETSc objects were not destroyed those left over objects will have hanging references to 1648 the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1649 */ 1650 { 1651 PetscCommCounter *counter; 1652 PetscMPIInt flg; 1653 MPI_Comm icomm; 1654 union 1655 { 1656 MPI_Comm comm; 1657 void *ptr; 1658 } ucomm; 1659 PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_SELF, Petsc_InnerComm_keyval, &ucomm, &flg)); 1660 if (flg) { 1661 icomm = ucomm.comm; 1662 PetscCallMPI(MPI_Comm_get_attr(icomm, Petsc_Counter_keyval, &counter, &flg)); 1663 PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_CORRUPT, "Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1664 1665 PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_SELF, Petsc_InnerComm_keyval)); 1666 PetscCallMPI(MPI_Comm_delete_attr(icomm, Petsc_Counter_keyval)); 1667 PetscCallMPI(MPI_Comm_free(&icomm)); 1668 } 1669 PetscCallMPI(MPI_Comm_get_attr(PETSC_COMM_WORLD, Petsc_InnerComm_keyval, &ucomm, &flg)); 1670 if (flg) { 1671 icomm = ucomm.comm; 1672 PetscCallMPI(MPI_Comm_get_attr(icomm, Petsc_Counter_keyval, &counter, &flg)); 1673 PetscCheck(flg, PETSC_COMM_WORLD, PETSC_ERR_ARG_CORRUPT, "Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1674 1675 PetscCallMPI(MPI_Comm_delete_attr(PETSC_COMM_WORLD, Petsc_InnerComm_keyval)); 1676 PetscCallMPI(MPI_Comm_delete_attr(icomm, Petsc_Counter_keyval)); 1677 PetscCallMPI(MPI_Comm_free(&icomm)); 1678 } 1679 } 1680 1681 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_Counter_keyval)); 1682 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_InnerComm_keyval)); 1683 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_OuterComm_keyval)); 1684 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_ShmComm_keyval)); 1685 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_CreationIdx_keyval)); 1686 PetscCallMPI(MPI_Comm_free_keyval(&Petsc_Garbage_HMap_keyval)); 1687 1688 // Free keyvals which may be silently created by some routines 1689 if (Petsc_SharedWD_keyval != MPI_KEYVAL_INVALID) PetscCallMPI(MPI_Comm_free_keyval(&Petsc_SharedWD_keyval)); 1690 if (Petsc_SharedTmp_keyval != MPI_KEYVAL_INVALID) PetscCallMPI(MPI_Comm_free_keyval(&Petsc_SharedTmp_keyval)); 1691 1692 PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockOpen)); 1693 PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStdout)); 1694 PetscCall(PetscSpinlockDestroy(&PetscViewerASCIISpinLockStderr)); 1695 PetscCall(PetscSpinlockDestroy(&PetscCommSpinLock)); 1696 1697 if (PetscBeganMPI) { 1698 PetscMPIInt flag; 1699 PetscCallMPI(MPI_Finalized(&flag)); 1700 PetscCheck(!flag, PETSC_COMM_SELF, PETSC_ERR_LIB, "MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 1701 /* wait until the very last moment to disable error handling */ 1702 PetscErrorHandlingInitialized = PETSC_FALSE; 1703 PetscCallMPI(MPI_Finalize()); 1704 } else PetscErrorHandlingInitialized = PETSC_FALSE; 1705 1706 /* 1707 1708 Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1709 the communicator has some outstanding requests on it. Specifically if the 1710 flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1711 src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1712 is never freed as it should be. Thus one may obtain messages of the form 1713 [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1714 memory was not freed. 1715 1716 */ 1717 PetscCall(PetscMallocClear()); 1718 PetscCall(PetscStackReset()); 1719 1720 PetscInitializeCalled = PETSC_FALSE; 1721 PetscFinalizeCalled = PETSC_TRUE; 1722 #if defined(PETSC_USE_COVERAGE) 1723 /* 1724 flush gcov, otherwise during CI the flushing continues into the next pipeline resulting in git not being able to delete directories since the 1725 gcov files are still being added to the directories as git tries to remove the directories. 1726 */ 1727 __gcov_flush(); 1728 #endif 1729 /* To match PetscFunctionBegin() at the beginning of this function */ 1730 PetscStackClearTop; 1731 return PETSC_SUCCESS; 1732 } 1733 1734 #if defined(PETSC_MISSING_LAPACK_lsame_) 1735 PETSC_EXTERN int lsame_(char *a, char *b) 1736 { 1737 if (*a == *b) return 1; 1738 if (*a + 32 == *b) return 1; 1739 if (*a - 32 == *b) return 1; 1740 return 0; 1741 } 1742 #endif 1743 1744 #if defined(PETSC_MISSING_LAPACK_lsame) 1745 PETSC_EXTERN int lsame(char *a, char *b) 1746 { 1747 if (*a == *b) return 1; 1748 if (*a + 32 == *b) return 1; 1749 if (*a - 32 == *b) return 1; 1750 return 0; 1751 } 1752 #endif 1753