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 PetscFunctionListDestroyAll(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 436 #undef __FUNCT__ 437 #define __FUNCT__ "PetscGetArgs" 438 /*@C 439 PetscGetArgs - Allows you to access the raw command line arguments anywhere 440 after PetscInitialize() is called but before PetscFinalize(). 441 442 Not Collective 443 444 Output Parameters: 445 + argc - count of number of command line arguments 446 - args - the command line arguments 447 448 Level: intermediate 449 450 Notes: 451 This is usually used to pass the command line arguments into other libraries 452 that are called internally deep in PETSc or the application. 453 454 The first argument contains the program name as is normal for C arguments. 455 456 Concepts: command line arguments 457 458 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArguments() 459 460 @*/ 461 PetscErrorCode PetscGetArgs(int *argc,char ***args) 462 { 463 PetscFunctionBegin; 464 if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 465 *argc = PetscGlobalArgc; 466 *args = PetscGlobalArgs; 467 PetscFunctionReturn(0); 468 } 469 470 #undef __FUNCT__ 471 #define __FUNCT__ "PetscGetArguments" 472 /*@C 473 PetscGetArguments - Allows you to access the command line arguments anywhere 474 after PetscInitialize() is called but before PetscFinalize(). 475 476 Not Collective 477 478 Output Parameters: 479 . args - the command line arguments 480 481 Level: intermediate 482 483 Notes: 484 This does NOT start with the program name and IS null terminated (final arg is void) 485 486 Concepts: command line arguments 487 488 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscFreeArguments() 489 490 @*/ 491 PetscErrorCode PetscGetArguments(char ***args) 492 { 493 PetscInt i,argc = PetscGlobalArgc; 494 PetscErrorCode ierr; 495 496 PetscFunctionBegin; 497 if (!PetscInitializeCalled && PetscFinalizeCalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER,"You must call after PetscInitialize() but before PetscFinalize()"); 498 if (!argc) {*args = 0; PetscFunctionReturn(0);} 499 ierr = PetscMalloc(argc*sizeof(char*),args);CHKERRQ(ierr); 500 for (i=0; i<argc-1; i++) { 501 ierr = PetscStrallocpy(PetscGlobalArgs[i+1],&(*args)[i]);CHKERRQ(ierr); 502 } 503 (*args)[argc-1] = 0; 504 PetscFunctionReturn(0); 505 } 506 507 #undef __FUNCT__ 508 #define __FUNCT__ "PetscFreeArguments" 509 /*@C 510 PetscFreeArguments - Frees the memory obtained with PetscGetArguments() 511 512 Not Collective 513 514 Output Parameters: 515 . args - the command line arguments 516 517 Level: intermediate 518 519 Concepts: command line arguments 520 521 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscGetArguments() 522 523 @*/ 524 PetscErrorCode PetscFreeArguments(char **args) 525 { 526 PetscInt i = 0; 527 PetscErrorCode ierr; 528 529 PetscFunctionBegin; 530 if (!args) PetscFunctionReturn(0); 531 while (args[i]) { 532 ierr = PetscFree(args[i]);CHKERRQ(ierr); 533 i++; 534 } 535 ierr = PetscFree(args);CHKERRQ(ierr); 536 PetscFunctionReturn(0); 537 } 538 539 #undef __FUNCT__ 540 #define __FUNCT__ "PetscInitialize" 541 /*@C 542 PetscInitialize - Initializes the PETSc database and MPI. 543 PetscInitialize() calls MPI_Init() if that has yet to be called, 544 so this routine should always be called near the beginning of 545 your program -- usually the very first line! 546 547 Collective on MPI_COMM_WORLD or PETSC_COMM_WORLD if it has been set 548 549 Input Parameters: 550 + argc - count of number of command line arguments 551 . args - the command line arguments 552 . file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL to not check for 553 code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 554 - help - [optional] Help message to print, use NULL for no message 555 556 If you wish PETSc code to run ONLY on a subcommunicator of MPI_COMM_WORLD, create that 557 communicator first and assign it to PETSC_COMM_WORLD BEFORE calling PetscInitialize(). Thus if you are running a 558 four process job and two processes will run PETSc and have PetscInitialize() and PetscFinalize() and two process will not, 559 then do this. If ALL processes in the job are using PetscInitialize() and PetscFinalize() then you don't need to do this, even 560 if different subcommunicators of the job are doing different things with PETSc. 561 562 Options Database Keys: 563 + -start_in_debugger [noxterm,dbx,xdb,gdb,...] - Starts program in debugger 564 . -on_error_attach_debugger [noxterm,dbx,xdb,gdb,...] - Starts debugger when error detected 565 . -on_error_emacs <machinename> causes emacsclient to jump to error file 566 . -on_error_abort calls abort() when error detected (no traceback) 567 . -on_error_mpiabort calls MPI_abort() when error detected 568 . -error_output_stderr prints error messages to stderr instead of the default stdout 569 . -error_output_none does not print the error messages (but handles errors in the same way as if this was not called) 570 . -debugger_nodes [node1,node2,...] - Indicates nodes to start in debugger 571 . -debugger_pause [sleeptime] (in seconds) - Pauses debugger 572 . -stop_for_debugger - Print message on how to attach debugger manually to 573 process and wait (-debugger_pause) seconds for attachment 574 . -malloc - Indicates use of PETSc error-checking malloc (on by default for debug version of libraries) 575 . -malloc no - Indicates not to use error-checking malloc 576 . -malloc_debug - check for memory corruption at EVERY malloc or free 577 . -malloc_test - like -malloc_dump -malloc_debug, but only active for debugging builds 578 . -fp_trap - Stops on floating point exceptions (Note that on the 579 IBM RS6000 this slows code by at least a factor of 10.) 580 . -no_signal_handler - Indicates not to trap error signals 581 . -shared_tmp - indicates /tmp directory is shared by all processors 582 . -not_shared_tmp - each processor has own /tmp 583 . -tmp - alternative name of /tmp directory 584 . -get_total_flops - returns total flops done by all processors 585 . -memory_info - Print memory usage at end of run 586 - -server <port> - start PETSc webserver (default port is 8080) 587 588 Options Database Keys for Profiling: 589 See the <a href="../../docs/manual.pdf#nameddest=ch_profiling">profiling chapter of the users manual</a> for details. 590 + -info <optional filename> - Prints verbose information to the screen 591 . -info_exclude <null,vec,mat,pc,ksp,snes,ts> - Excludes some of the verbose messages 592 . -log_sync - Log the synchronization in scatters, inner products and norms 593 . -log_trace [filename] - Print traces of all PETSc calls to the screen (useful to determine where a program 594 hangs without running in the debugger). See PetscLogTraceBegin(). 595 . -log_summary [filename] - Prints summary of flop and timing information to screen. If the filename is specified the 596 summary is written to the file. See PetscLogView(). 597 . -log_summary_python [filename] - Prints data on of flop and timing usage to a file or screen. See PetscLogPrintSViewPython(). 598 . -log_all [filename] - Logs extensive profiling information See PetscLogDump(). 599 . -log [filename] - Logs basic profiline information See PetscLogDump(). 600 - -log_mpe [filename] - Creates a logfile viewable by the utility Jumpshot (in MPICH distribution) 601 602 Only one of -log_trace, -log_summary, -log_all, -log, or -log_mpe may be used at a time 603 604 Environmental Variables: 605 + PETSC_TMP - alternative tmp directory 606 . PETSC_SHARED_TMP - tmp is shared by all processes 607 . PETSC_NOT_SHARED_TMP - each process has its own private tmp 608 . PETSC_VIEWER_SOCKET_PORT - socket number to use for socket viewer 609 - PETSC_VIEWER_SOCKET_MACHINE - machine to use for socket viewer to connect to 610 611 612 Level: beginner 613 614 Notes: 615 If for some reason you must call MPI_Init() separately, call 616 it before PetscInitialize(). 617 618 Fortran Version: 619 In Fortran this routine has the format 620 $ call PetscInitialize(file,ierr) 621 622 + ierr - error return code 623 - file - [optional] PETSc database file, also checks ~username/.petscrc and .petscrc use NULL_CHARACTER to not check for 624 code specific file. Use -skip_petscrc in the code specific file to skip the .petscrc files 625 626 Important Fortran Note: 627 In Fortran, you MUST use NULL_CHARACTER to indicate a 628 null character string; you CANNOT just use NULL as 629 in the C version. See the <a href="../../docs/manual.pdf">users manual</a> for details. 630 631 If your main program is C but you call Fortran code that also uses PETSc you need to call PetscInitializeFortran() soon after 632 calling PetscInitialize(). 633 634 Concepts: initializing PETSc 635 636 .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 637 638 @*/ 639 PetscErrorCode PetscInitialize(int *argc,char ***args,const char file[],const char help[]) 640 { 641 PetscErrorCode ierr; 642 PetscMPIInt flag, size; 643 PetscInt nodesize; 644 PetscBool flg; 645 char hostname[256]; 646 647 PetscFunctionBegin; 648 if (PetscInitializeCalled) PetscFunctionReturn(0); 649 650 /* these must be initialized in a routine, not as a constant declaration*/ 651 PETSC_STDOUT = stdout; 652 PETSC_STDERR = stderr; 653 654 ierr = PetscOptionsCreate();CHKERRQ(ierr); 655 656 /* 657 We initialize the program name here (before MPI_Init()) because MPICH has a bug in 658 it that it sets args[0] on all processors to be args[0] on the first processor. 659 */ 660 if (argc && *argc) { 661 ierr = PetscSetProgramName(**args);CHKERRQ(ierr); 662 } else { 663 ierr = PetscSetProgramName("Unknown Name");CHKERRQ(ierr); 664 } 665 666 ierr = MPI_Initialized(&flag);CHKERRQ(ierr); 667 if (!flag) { 668 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"); 669 #if defined(PETSC_HAVE_MPI_INIT_THREAD) 670 { 671 PetscMPIInt provided; 672 ierr = MPI_Init_thread(argc,args,MPI_THREAD_FUNNELED,&provided);CHKERRQ(ierr); 673 } 674 #else 675 ierr = MPI_Init(argc,args);CHKERRQ(ierr); 676 #endif 677 PetscBeganMPI = PETSC_TRUE; 678 } 679 if (argc && args) { 680 PetscGlobalArgc = *argc; 681 PetscGlobalArgs = *args; 682 } 683 PetscFinalizeCalled = PETSC_FALSE; 684 685 if (PETSC_COMM_WORLD == MPI_COMM_NULL) PETSC_COMM_WORLD = MPI_COMM_WORLD; 686 ierr = MPI_Comm_set_errhandler(PETSC_COMM_WORLD,MPI_ERRORS_RETURN);CHKERRQ(ierr); 687 688 /* Done after init due to a bug in MPICH-GM? */ 689 ierr = PetscErrorPrintfInitialize();CHKERRQ(ierr); 690 691 ierr = MPI_Comm_rank(MPI_COMM_WORLD,&PetscGlobalRank);CHKERRQ(ierr); 692 ierr = MPI_Comm_size(MPI_COMM_WORLD,&PetscGlobalSize);CHKERRQ(ierr); 693 694 MPIU_BOOL = MPI_INT; 695 MPIU_ENUM = MPI_INT; 696 697 /* 698 Initialized the global complex variable; this is because with 699 shared libraries the constructors for global variables 700 are not called; at least on IRIX. 701 */ 702 #if defined(PETSC_HAVE_COMPLEX) 703 { 704 #if defined(PETSC_CLANGUAGE_CXX) 705 PetscComplex ic(0.0,1.0); 706 PETSC_i = ic; 707 #elif defined(PETSC_CLANGUAGE_C) 708 PETSC_i = _Complex_I; 709 #endif 710 } 711 712 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 713 ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 714 ierr = MPI_Type_commit(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 715 ierr = MPI_Type_contiguous(2,MPI_FLOAT,&MPIU_C_COMPLEX);CHKERRQ(ierr); 716 ierr = MPI_Type_commit(&MPIU_C_COMPLEX);CHKERRQ(ierr); 717 #endif 718 #endif /* PETSC_HAVE_COMPLEX */ 719 720 /* 721 Create the PETSc MPI reduction operator that sums of the first 722 half of the entries and maxes the second half. 723 */ 724 ierr = MPI_Op_create(PetscMaxSum_Local,1,&PetscMaxSum_Op);CHKERRQ(ierr); 725 726 #if defined(PETSC_USE_REAL___FLOAT128) 727 ierr = MPI_Type_contiguous(2,MPI_DOUBLE,&MPIU___FLOAT128);CHKERRQ(ierr); 728 ierr = MPI_Type_commit(&MPIU___FLOAT128);CHKERRQ(ierr); 729 #if defined(PETSC_HAVE_COMPLEX) 730 ierr = MPI_Type_contiguous(4,MPI_DOUBLE,&MPIU___COMPLEX128);CHKERRQ(ierr); 731 ierr = MPI_Type_commit(&MPIU___COMPLEX128);CHKERRQ(ierr); 732 #endif 733 ierr = MPI_Op_create(PetscMax_Local,1,&MPIU_MAX);CHKERRQ(ierr); 734 ierr = MPI_Op_create(PetscMin_Local,1,&MPIU_MIN);CHKERRQ(ierr); 735 #endif 736 737 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 738 ierr = MPI_Op_create(PetscSum_Local,1,&MPIU_SUM);CHKERRQ(ierr); 739 #endif 740 741 ierr = MPI_Type_contiguous(2,MPIU_SCALAR,&MPIU_2SCALAR);CHKERRQ(ierr); 742 ierr = MPI_Type_commit(&MPIU_2SCALAR);CHKERRQ(ierr); 743 ierr = MPI_Op_create(PetscADMax_Local,1,&PetscADMax_Op);CHKERRQ(ierr); 744 ierr = MPI_Op_create(PetscADMin_Local,1,&PetscADMin_Op);CHKERRQ(ierr); 745 746 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 747 ierr = MPI_Type_contiguous(2,MPIU_INT,&MPIU_2INT);CHKERRQ(ierr); 748 ierr = MPI_Type_commit(&MPIU_2INT);CHKERRQ(ierr); 749 #endif 750 751 /* 752 Attributes to be set on PETSc communicators 753 */ 754 ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelCounter,&Petsc_Counter_keyval,(void*)0);CHKERRQ(ierr); 755 ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_InnerComm_keyval,(void*)0);CHKERRQ(ierr); 756 ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,Petsc_DelComm,&Petsc_OuterComm_keyval,(void*)0);CHKERRQ(ierr); 757 758 /* 759 Build the options database 760 */ 761 ierr = PetscOptionsInsert(argc,args,file);CHKERRQ(ierr); 762 763 764 /* 765 Print main application help message 766 */ 767 ierr = PetscOptionsHasName(NULL,"-help",&flg);CHKERRQ(ierr); 768 if (help && flg) { 769 ierr = PetscPrintf(PETSC_COMM_WORLD,help);CHKERRQ(ierr); 770 } 771 ierr = PetscOptionsCheckInitial_Private();CHKERRQ(ierr); 772 773 /* SHOULD PUT IN GUARDS: Make sure logging is initialized, even if we do not print it out */ 774 #if defined(PETSC_USE_LOG) 775 ierr = PetscLogBegin_Private();CHKERRQ(ierr); 776 #endif 777 778 /* 779 Load the dynamic libraries (on machines that support them), this registers all 780 the solvers etc. (On non-dynamic machines this initializes the PetscDraw and PetscViewer classes) 781 */ 782 ierr = PetscInitialize_DynamicLibraries();CHKERRQ(ierr); 783 784 ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr); 785 ierr = PetscInfo1(0,"PETSc successfully started: number of processors = %d\n",size);CHKERRQ(ierr); 786 ierr = PetscGetHostName(hostname,256);CHKERRQ(ierr); 787 ierr = PetscInfo1(0,"Running on machine: %s\n",hostname);CHKERRQ(ierr); 788 789 ierr = PetscOptionsCheckInitial_Components();CHKERRQ(ierr); 790 /* Check the options database for options related to the options database itself */ 791 ierr = PetscOptionsSetFromOptions();CHKERRQ(ierr); 792 793 #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 794 /* 795 Tell MPI about our own data representation converter, this would/should be used if extern32 is not supported by the MPI 796 797 Currently not used because it is not supported by MPICH. 798 */ 799 #if !defined(PETSC_WORDS_BIGENDIAN) 800 ierr = MPI_Register_datarep((char*)"petsc",PetscDataRep_read_conv_fn,PetscDataRep_write_conv_fn,PetscDataRep_extent_fn,NULL);CHKERRQ(ierr); 801 #endif 802 #endif 803 804 ierr = PetscOptionsGetInt(NULL,"-hmpi_spawn_size",&nodesize,&flg);CHKERRQ(ierr); 805 if (flg) { 806 #if defined(PETSC_HAVE_MPI_COMM_SPAWN) 807 ierr = PetscHMPISpawn((PetscMPIInt) nodesize);CHKERRQ(ierr); /* worker nodes never return from here; they go directly to PetscEnd() */ 808 #else 809 SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PETSc built without MPI 2 (MPI_Comm_spawn) support, use -hmpi_merge_size instead"); 810 #endif 811 } else { 812 ierr = PetscOptionsGetInt(NULL,"-hmpi_merge_size",&nodesize,&flg);CHKERRQ(ierr); 813 if (flg) { 814 ierr = PetscHMPIMerge((PetscMPIInt) nodesize,NULL,NULL);CHKERRQ(ierr); 815 if (PetscHMPIWorker) { /* if worker then never enter user code */ 816 PetscInitializeCalled = PETSC_TRUE; 817 PetscEnd(); 818 } 819 } 820 } 821 822 #if defined(PETSC_HAVE_CUDA) 823 { 824 PetscMPIInt p; 825 for (p = 0; p < PetscGlobalSize; ++p) { 826 if (p == PetscGlobalRank) cublasInit(); 827 ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 828 } 829 } 830 #endif 831 832 #if defined(PETSC_HAVE_AMS) 833 ierr = PetscOptionsHasName(NULL,"-ams_publish_objects",&flg);CHKERRQ(ierr); 834 if (flg) PetscAMSPublishAll = PETSC_TRUE; 835 #endif 836 837 ierr = PetscOptionsHasName(NULL,"-python",&flg);CHKERRQ(ierr); 838 if (flg) { 839 PetscInitializeCalled = PETSC_TRUE; 840 ierr = PetscPythonInitialize(NULL,NULL);CHKERRQ(ierr); 841 } 842 843 ierr = PetscThreadCommInitializePackage(NULL);CHKERRQ(ierr); 844 845 /* 846 Setup building of stack frames for all function calls 847 */ 848 #if defined(PETSC_USE_DEBUG) 849 PetscThreadLocalRegister((PetscThreadKey*)&petscstack); /* Creates petscstack_key if needed */ 850 ierr = PetscStackCreate();CHKERRQ(ierr); 851 #endif 852 853 #if defined(PETSC_SERIALIZE_FUNCTIONS) 854 ierr = PetscFPTCreate(10000);CHKERRQ(ierr); 855 #endif 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 #if defined(PETSC_HAVE_AMS) 899 PetscBool flg = PETSC_FALSE; 900 #endif 901 #if defined(PETSC_USE_LOG) 902 char mname[PETSC_MAX_PATH_LEN]; 903 #endif 904 905 PetscFunctionBegin; 906 if (!PetscInitializeCalled) { 907 printf("PetscInitialize() must be called before PetscFinalize()\n"); 908 PetscFunctionReturn(PETSC_ERR_ARG_WRONGSTATE); 909 } 910 ierr = PetscInfo(NULL,"PetscFinalize() called\n");CHKERRQ(ierr); 911 912 #if defined(PETSC_SERIALIZE_FUNCTIONS) 913 ierr = PetscFPTDestroy();CHKERRQ(ierr); 914 #endif 915 916 917 #if defined(PETSC_HAVE_AMS) 918 ierr = PetscOptionsGetBool(NULL,"-options_gui",&flg,NULL);CHKERRQ(ierr); 919 if (flg) { 920 ierr = PetscOptionsAMSDestroy();CHKERRQ(ierr); 921 } 922 #endif 923 924 ierr = PetscHMPIFinalize();CHKERRQ(ierr); 925 926 ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr); 927 ierr = PetscOptionsGetBool(NULL,"-malloc_info",&flg2,NULL);CHKERRQ(ierr); 928 if (!flg2) { 929 flg2 = PETSC_FALSE; 930 ierr = PetscOptionsGetBool(NULL,"-memory_info",&flg2,NULL);CHKERRQ(ierr); 931 } 932 if (flg2) { 933 ierr = PetscMemoryShowUsage(PETSC_VIEWER_STDOUT_WORLD,"Summary of Memory Usage in PETSc\n");CHKERRQ(ierr); 934 } 935 936 #if defined(PETSC_USE_LOG) 937 flg1 = PETSC_FALSE; 938 ierr = PetscOptionsGetBool(NULL,"-get_total_flops",&flg1,NULL);CHKERRQ(ierr); 939 if (flg1) { 940 PetscLogDouble flops = 0; 941 ierr = MPI_Reduce(&petsc_TotalFlops,&flops,1,MPI_DOUBLE,MPI_SUM,0,PETSC_COMM_WORLD);CHKERRQ(ierr); 942 ierr = PetscPrintf(PETSC_COMM_WORLD,"Total flops over all processors %g\n",flops);CHKERRQ(ierr); 943 } 944 #endif 945 946 947 #if defined(PETSC_USE_LOG) 948 #if defined(PETSC_HAVE_MPE) 949 mname[0] = 0; 950 951 ierr = PetscOptionsGetString(NULL,"-log_mpe",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 952 if (flg1) { 953 if (mname[0]) {ierr = PetscLogMPEDump(mname);CHKERRQ(ierr);} 954 else {ierr = PetscLogMPEDump(0);CHKERRQ(ierr);} 955 } 956 #endif 957 mname[0] = 0; 958 959 ierr = PetscOptionsGetString(NULL,"-log_summary",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 960 if (flg1) { 961 PetscViewer viewer; 962 if (mname[0]) { 963 ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 964 ierr = PetscLogView(viewer);CHKERRQ(ierr); 965 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 966 } else { 967 viewer = PETSC_VIEWER_STDOUT_WORLD; 968 ierr = PetscLogView(viewer);CHKERRQ(ierr); 969 } 970 } 971 972 mname[0] = 0; 973 974 ierr = PetscOptionsGetString(NULL,"-log_summary_python",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 975 if (flg1) { 976 PetscViewer viewer; 977 if (mname[0]) { 978 ierr = PetscViewerASCIIOpen(PETSC_COMM_WORLD,mname,&viewer);CHKERRQ(ierr); 979 ierr = PetscLogViewPython(viewer);CHKERRQ(ierr); 980 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 981 } else { 982 viewer = PETSC_VIEWER_STDOUT_WORLD; 983 ierr = PetscLogViewPython(viewer);CHKERRQ(ierr); 984 } 985 } 986 987 ierr = PetscOptionsGetString(NULL,"-log_detailed",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 988 if (flg1) { 989 if (mname[0]) {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,mname);CHKERRQ(ierr);} 990 else {ierr = PetscLogPrintDetailed(PETSC_COMM_WORLD,0);CHKERRQ(ierr);} 991 } 992 993 mname[0] = 0; 994 995 ierr = PetscOptionsGetString(NULL,"-log_all",mname,PETSC_MAX_PATH_LEN,&flg1);CHKERRQ(ierr); 996 ierr = PetscOptionsGetString(NULL,"-log",mname,PETSC_MAX_PATH_LEN,&flg2);CHKERRQ(ierr); 997 if (flg1 || flg2) { 998 if (mname[0]) PetscLogDump(mname); 999 else PetscLogDump(0); 1000 } 1001 #endif 1002 1003 /* 1004 Free all objects registered with PetscObjectRegisterDestroy() such as PETSC_VIEWER_XXX_(). 1005 */ 1006 ierr = PetscObjectRegisterDestroyAll();CHKERRQ(ierr); 1007 1008 { 1009 PetscThreadComm tcomm_world; 1010 ierr = PetscGetThreadCommWorld(&tcomm_world);CHKERRQ(ierr); 1011 /* Free global thread communicator */ 1012 ierr = PetscThreadCommDestroy(&tcomm_world);CHKERRQ(ierr); 1013 } 1014 1015 #if defined(PETSC_USE_DEBUG) 1016 ierr = PetscStackDestroy();CHKERRQ(ierr); 1017 #endif 1018 1019 flg1 = PETSC_FALSE; 1020 ierr = PetscOptionsGetBool(NULL,"-no_signal_handler",&flg1,NULL);CHKERRQ(ierr); 1021 if (!flg1) { ierr = PetscPopSignalHandler();CHKERRQ(ierr);} 1022 flg1 = PETSC_FALSE; 1023 ierr = PetscOptionsGetBool(NULL,"-mpidump",&flg1,NULL);CHKERRQ(ierr); 1024 if (flg1) { 1025 ierr = PetscMPIDump(stdout);CHKERRQ(ierr); 1026 } 1027 flg1 = PETSC_FALSE; 1028 flg2 = PETSC_FALSE; 1029 /* preemptive call to avoid listing this option in options table as unused */ 1030 ierr = PetscOptionsHasName(NULL,"-malloc_dump",&flg1);CHKERRQ(ierr); 1031 ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1032 ierr = PetscOptionsGetBool(NULL,"-options_table",&flg2,NULL);CHKERRQ(ierr); 1033 1034 if (flg2) { 1035 PetscViewer viewer; 1036 ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 1037 ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1038 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1039 } 1040 1041 /* to prevent PETSc -options_left from warning */ 1042 ierr = PetscOptionsHasName(NULL,"-nox",&flg1);CHKERRQ(ierr); 1043 ierr = PetscOptionsHasName(NULL,"-nox_warning",&flg1);CHKERRQ(ierr); 1044 1045 if (!PetscHMPIWorker) { /* worker processes skip this because they do not usually process options */ 1046 flg3 = PETSC_FALSE; /* default value is required */ 1047 ierr = PetscOptionsGetBool(NULL,"-options_left",&flg3,&flg1);CHKERRQ(ierr); 1048 ierr = PetscOptionsAllUsed(&nopt);CHKERRQ(ierr); 1049 if (flg3) { 1050 if (!flg2) { /* have not yet printed the options */ 1051 PetscViewer viewer; 1052 ierr = PetscViewerASCIIGetStdout(PETSC_COMM_WORLD,&viewer);CHKERRQ(ierr); 1053 ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 1054 ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1055 } 1056 if (!nopt) { 1057 ierr = PetscPrintf(PETSC_COMM_WORLD,"There are no unused options.\n");CHKERRQ(ierr); 1058 } else if (nopt == 1) { 1059 ierr = PetscPrintf(PETSC_COMM_WORLD,"There is one unused database option. It is:\n");CHKERRQ(ierr); 1060 } else { 1061 ierr = PetscPrintf(PETSC_COMM_WORLD,"There are %D unused database options. They are:\n",nopt);CHKERRQ(ierr); 1062 } 1063 } 1064 #if defined(PETSC_USE_DEBUG) 1065 if (nopt && !flg3 && !flg1) { 1066 ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! There are options you set that were not used!\n");CHKERRQ(ierr); 1067 ierr = PetscPrintf(PETSC_COMM_WORLD,"WARNING! could be spelling mistake, etc!\n");CHKERRQ(ierr); 1068 ierr = PetscOptionsLeft();CHKERRQ(ierr); 1069 } else if (nopt && flg3) { 1070 #else 1071 if (nopt && flg3) { 1072 #endif 1073 ierr = PetscOptionsLeft();CHKERRQ(ierr); 1074 } 1075 } 1076 1077 /* 1078 List all objects the user may have forgot to free 1079 */ 1080 ierr = PetscOptionsHasName(NULL,"-objects_dump",&flg1);CHKERRQ(ierr); 1081 if (flg1) { 1082 MPI_Comm local_comm; 1083 char string[64]; 1084 1085 ierr = PetscOptionsGetString(NULL,"-objects_dump",string,64,NULL);CHKERRQ(ierr); 1086 ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1087 ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1088 ierr = PetscObjectsDump(stdout,(string[0] == 'a') ? PETSC_TRUE : PETSC_FALSE);CHKERRQ(ierr); 1089 ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1090 ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 1091 } 1092 PetscObjectsCounts = 0; 1093 PetscObjectsMaxCounts = 0; 1094 1095 ierr = PetscFree(PetscObjects);CHKERRQ(ierr); 1096 1097 #if defined(PETSC_USE_LOG) 1098 ierr = PetscLogDestroy();CHKERRQ(ierr); 1099 #endif 1100 1101 /* 1102 Free all the registered create functions, such as KSPList, VecList, SNESList, etc 1103 */ 1104 ierr = PetscFunctionListDestroyAll();CHKERRQ(ierr); 1105 1106 /* 1107 Destroy any packages that registered a finalize 1108 */ 1109 ierr = PetscRegisterFinalizeAll();CHKERRQ(ierr); 1110 1111 /* 1112 Destroy all the function registration lists created 1113 */ 1114 ierr = PetscFinalize_DynamicLibraries();CHKERRQ(ierr); 1115 1116 if (petsc_history) { 1117 ierr = PetscCloseHistoryFile(&petsc_history);CHKERRQ(ierr); 1118 petsc_history = 0; 1119 } 1120 1121 ierr = PetscInfoAllow(PETSC_FALSE,NULL);CHKERRQ(ierr); 1122 1123 { 1124 char fname[PETSC_MAX_PATH_LEN]; 1125 FILE *fd; 1126 int err; 1127 1128 fname[0] = 0; 1129 1130 ierr = PetscOptionsGetString(NULL,"-malloc_dump",fname,250,&flg1);CHKERRQ(ierr); 1131 flg2 = PETSC_FALSE; 1132 ierr = PetscOptionsGetBool(NULL,"-malloc_test",&flg2,NULL);CHKERRQ(ierr); 1133 #if defined(PETSC_USE_DEBUG) 1134 if (PETSC_RUNNING_ON_VALGRIND) flg2 = PETSC_FALSE; 1135 #else 1136 flg2 = PETSC_FALSE; /* Skip reporting for optimized builds regardless of -malloc_test */ 1137 #endif 1138 if (flg1 && fname[0]) { 1139 char sname[PETSC_MAX_PATH_LEN]; 1140 1141 sprintf(sname,"%s_%d",fname,rank); 1142 fd = fopen(sname,"w"); if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",sname); 1143 ierr = PetscMallocDump(fd);CHKERRQ(ierr); 1144 err = fclose(fd); 1145 if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1146 } else if (flg1 || flg2) { 1147 MPI_Comm local_comm; 1148 1149 ierr = MPI_Comm_dup(MPI_COMM_WORLD,&local_comm);CHKERRQ(ierr); 1150 ierr = PetscSequentialPhaseBegin_Private(local_comm,1);CHKERRQ(ierr); 1151 ierr = PetscMallocDump(stdout);CHKERRQ(ierr); 1152 ierr = PetscSequentialPhaseEnd_Private(local_comm,1);CHKERRQ(ierr); 1153 ierr = MPI_Comm_free(&local_comm);CHKERRQ(ierr); 1154 } 1155 } 1156 1157 { 1158 char fname[PETSC_MAX_PATH_LEN]; 1159 FILE *fd = NULL; 1160 1161 fname[0] = 0; 1162 1163 ierr = PetscOptionsGetString(NULL,"-malloc_log",fname,250,&flg1);CHKERRQ(ierr); 1164 ierr = PetscOptionsHasName(NULL,"-malloc_log_threshold",&flg2);CHKERRQ(ierr); 1165 if (flg1 && fname[0]) { 1166 int err; 1167 1168 if (!rank) { 1169 fd = fopen(fname,"w"); 1170 if (!fd) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open log file: %s",fname); 1171 } 1172 ierr = PetscMallocDumpLog(fd);CHKERRQ(ierr); 1173 if (fd) { 1174 err = fclose(fd); 1175 if (err) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SYS,"fclose() failed on file"); 1176 } 1177 } else if (flg1 || flg2) { 1178 ierr = PetscMallocDumpLog(stdout);CHKERRQ(ierr); 1179 } 1180 } 1181 /* Can be destroyed only after all the options are used */ 1182 ierr = PetscOptionsDestroy();CHKERRQ(ierr); 1183 1184 PetscGlobalArgc = 0; 1185 PetscGlobalArgs = 0; 1186 1187 #if defined(PETSC_USE_REAL___FLOAT128) 1188 ierr = MPI_Type_free(&MPIU___FLOAT128);CHKERRQ(ierr); 1189 #if defined(PETSC_HAVE_COMPLEX) 1190 ierr = MPI_Type_free(&MPIU___COMPLEX128);CHKERRQ(ierr); 1191 #endif 1192 ierr = MPI_Op_free(&MPIU_MAX);CHKERRQ(ierr); 1193 ierr = MPI_Op_free(&MPIU_MIN);CHKERRQ(ierr); 1194 #endif 1195 1196 #if defined(PETSC_HAVE_COMPLEX) 1197 #if !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX) 1198 ierr = MPI_Type_free(&MPIU_C_DOUBLE_COMPLEX);CHKERRQ(ierr); 1199 ierr = MPI_Type_free(&MPIU_C_COMPLEX);CHKERRQ(ierr); 1200 #endif 1201 #endif 1202 1203 #if (defined(PETSC_HAVE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)) || defined(PETSC_USE_REAL___FLOAT128) 1204 ierr = MPI_Op_free(&MPIU_SUM);CHKERRQ(ierr); 1205 #endif 1206 1207 ierr = MPI_Type_free(&MPIU_2SCALAR);CHKERRQ(ierr); 1208 #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT) 1209 ierr = MPI_Type_free(&MPIU_2INT);CHKERRQ(ierr); 1210 #endif 1211 ierr = MPI_Op_free(&PetscMaxSum_Op);CHKERRQ(ierr); 1212 ierr = MPI_Op_free(&PetscADMax_Op);CHKERRQ(ierr); 1213 ierr = MPI_Op_free(&PetscADMin_Op);CHKERRQ(ierr); 1214 1215 /* 1216 Destroy any known inner MPI_Comm's and attributes pointing to them 1217 Note this will not destroy any new communicators the user has created. 1218 1219 If all PETSc objects were not destroyed those left over objects will have hanging references to 1220 the MPI_Comms that were freed; but that is ok because those PETSc objects will never be used again 1221 */ 1222 { 1223 PetscCommCounter *counter; 1224 PetscMPIInt flg; 1225 MPI_Comm icomm; 1226 void *ptr; 1227 ierr = MPI_Attr_get(PETSC_COMM_SELF,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr); 1228 if (flg) { 1229 /* Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers */ 1230 ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr); 1231 ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1232 if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1233 1234 ierr = MPI_Attr_delete(PETSC_COMM_SELF,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1235 ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1236 ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1237 } 1238 ierr = MPI_Attr_get(PETSC_COMM_WORLD,Petsc_InnerComm_keyval,&ptr,&flg);CHKERRQ(ierr); 1239 if (flg) { 1240 /* Use PetscMemcpy() because casting from pointer to integer of different size is not allowed with some compilers */ 1241 ierr = PetscMemcpy(&icomm,&ptr,sizeof(MPI_Comm));CHKERRQ(ierr); 1242 ierr = MPI_Attr_get(icomm,Petsc_Counter_keyval,&counter,&flg);CHKERRQ(ierr); 1243 if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_ARG_CORRUPT,"Inner MPI_Comm does not have expected tag/name counter, problem with corrupted memory"); 1244 1245 ierr = MPI_Attr_delete(PETSC_COMM_WORLD,Petsc_InnerComm_keyval);CHKERRQ(ierr); 1246 ierr = MPI_Attr_delete(icomm,Petsc_Counter_keyval);CHKERRQ(ierr); 1247 ierr = MPI_Comm_free(&icomm);CHKERRQ(ierr); 1248 } 1249 } 1250 1251 ierr = MPI_Keyval_free(&Petsc_Counter_keyval);CHKERRQ(ierr); 1252 ierr = MPI_Keyval_free(&Petsc_InnerComm_keyval);CHKERRQ(ierr); 1253 ierr = MPI_Keyval_free(&Petsc_OuterComm_keyval);CHKERRQ(ierr); 1254 1255 #if defined(PETSC_HAVE_CUDA) 1256 { 1257 PetscInt p; 1258 for (p = 0; p < PetscGlobalSize; ++p) { 1259 if (p == PetscGlobalRank) cublasShutdown(); 1260 ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 1261 } 1262 } 1263 #endif 1264 1265 if (PetscBeganMPI) { 1266 #if defined(PETSC_HAVE_MPI_FINALIZED) 1267 PetscMPIInt flag; 1268 ierr = MPI_Finalized(&flag);CHKERRQ(ierr); 1269 if (flag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"MPI_Finalize() has already been called, even though MPI_Init() was called by PetscInitialize()"); 1270 #endif 1271 ierr = MPI_Finalize();CHKERRQ(ierr); 1272 } 1273 /* 1274 1275 Note: In certain cases PETSC_COMM_WORLD is never MPI_Comm_free()ed because 1276 the communicator has some outstanding requests on it. Specifically if the 1277 flag PETSC_HAVE_BROKEN_REQUEST_FREE is set (for IBM MPI implementation). See 1278 src/vec/utils/vpscat.c. Due to this the memory allocated in PetscCommDuplicate() 1279 is never freed as it should be. Thus one may obtain messages of the form 1280 [ 1] 8 bytes PetscCommDuplicate() line 645 in src/sys/mpiu.c indicating the 1281 memory was not freed. 1282 1283 */ 1284 ierr = PetscMallocClear();CHKERRQ(ierr); 1285 1286 PetscInitializeCalled = PETSC_FALSE; 1287 PetscFinalizeCalled = PETSC_TRUE; 1288 PetscFunctionReturn(ierr); 1289 } 1290 1291 #if defined(PETSC_MISSING_LAPACK_lsame_) 1292 PETSC_EXTERN int lsame_(char *a,char *b) 1293 { 1294 if (*a == *b) return 1; 1295 if (*a + 32 == *b) return 1; 1296 if (*a - 32 == *b) return 1; 1297 return 0; 1298 } 1299 #endif 1300 1301 #if defined(PETSC_MISSING_LAPACK_lsame) 1302 PETSC_EXTERN int lsame(char *a,char *b) 1303 { 1304 if (*a == *b) return 1; 1305 if (*a + 32 == *b) return 1; 1306 if (*a - 32 == *b) return 1; 1307 return 0; 1308 } 1309 #endif 1310