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