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