1 /* 2 3 This file defines part of the initialization of PETSc 4 5 This file uses regular malloc and free because it cannot be known 6 what malloc is being used until it has already processed the input. 7 */ 8 #include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/ 9 10 #if defined(PETSC_HAVE_UNISTD_H) 11 #include <unistd.h> 12 #endif 13 14 /* ------------------------Nasty global variables -------------------------------*/ 15 /* 16 Indicates if PETSc started up MPI, or it was 17 already started before PETSc was initialized. 18 */ 19 PetscBool PetscBeganMPI = PETSC_FALSE; 20 PetscBool PetscErrorHandlingInitialized = PETSC_FALSE; 21 PetscBool PetscInitializeCalled = PETSC_FALSE; 22 PetscBool PetscFinalizeCalled = PETSC_FALSE; 23 24 PetscMPIInt PetscGlobalRank = -1; 25 PetscMPIInt PetscGlobalSize = -1; 26 27 #if defined(PETSC_HAVE_KOKKOS) 28 PetscBool PetscBeganKokkos = PETSC_FALSE; 29 #endif 30 31 #if defined(PETSC_HAVE_NVSHMEM) 32 PetscBool PetscBeganNvshmem = PETSC_FALSE; 33 PetscBool PetscNvshmemInitialized = PETSC_FALSE; 34 #endif 35 36 PetscBool use_gpu_aware_mpi = PetscDefined(HAVE_MPIUNI) ? PETSC_FALSE : PETSC_TRUE; 37 38 PetscBool PetscPrintFunctionList = PETSC_FALSE; 39 40 #if defined(PETSC_HAVE_COMPLEX) 41 #if defined(PETSC_COMPLEX_INSTANTIATE) 42 template <> 43 class std::complex<double>; /* instantiate complex template class */ 44 #endif 45 46 /*MC 47 PETSC_i - the imaginary number i 48 49 Synopsis: 50 #include <petscsys.h> 51 PetscComplex PETSC_i; 52 53 Level: beginner 54 55 Note: 56 Complex numbers are automatically available if PETSc located a working complex implementation 57 58 .seealso: `PetscRealPart()`, `PetscImaginaryPart()`, `PetscRealPartComplex()`, `PetscImaginaryPartComplex()` 59 M*/ 60 PetscComplex PETSC_i; 61 MPI_Datatype MPIU___COMPLEX128 = 0; 62 #endif /* PETSC_HAVE_COMPLEX */ 63 #if defined(PETSC_HAVE_REAL___FLOAT128) 64 MPI_Datatype MPIU___FLOAT128 = 0; 65 #endif 66 #if defined(PETSC_HAVE_REAL___FP16) 67 MPI_Datatype MPIU___FP16 = 0; 68 #endif 69 MPI_Datatype MPIU_2SCALAR = 0; 70 MPI_Datatype MPIU_REAL_INT = 0; 71 MPI_Datatype MPIU_SCALAR_INT = 0; 72 #if defined(PETSC_USE_64BIT_INDICES) 73 MPI_Datatype MPIU_2INT = 0; 74 #endif 75 MPI_Datatype MPI_4INT = 0; 76 MPI_Datatype MPIU_4INT = 0; 77 MPI_Datatype MPIU_BOOL; 78 MPI_Datatype MPIU_ENUM; 79 MPI_Datatype MPIU_FORTRANADDR; 80 MPI_Datatype MPIU_SIZE_T; 81 82 /* 83 Function that is called to display all error messages 84 */ 85 PetscErrorCode (*PetscErrorPrintf)(const char[], ...) = PetscErrorPrintfDefault; 86 PetscErrorCode (*PetscHelpPrintf)(MPI_Comm, const char[], ...) = PetscHelpPrintfDefault; 87 PetscErrorCode (*PetscVFPrintf)(FILE *, const char[], va_list) = PetscVFPrintfDefault; 88 89 /* 90 Optional file where all PETSc output from various prints is saved 91 */ 92 PETSC_INTERN FILE *petsc_history; 93 FILE *petsc_history = NULL; 94 95 PetscErrorCode PetscOpenHistoryFile(const char filename[], FILE **fd) 96 { 97 PetscMPIInt rank, size; 98 char pfile[PETSC_MAX_PATH_LEN], pname[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN], date[64]; 99 char version[256]; 100 101 PetscFunctionBegin; 102 PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 103 if (rank == 0) { 104 char arch[10]; 105 106 PetscCall(PetscGetArchType(arch, 10)); 107 PetscCall(PetscGetDate(date, 64)); 108 PetscCall(PetscGetVersion(version, 256)); 109 PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD, &size)); 110 if (filename) { 111 PetscCall(PetscFixFilename(filename, fname)); 112 } else { 113 PetscCall(PetscGetHomeDirectory(pfile, sizeof(pfile))); 114 PetscCall(PetscStrlcat(pfile, "/.petschistory", sizeof(pfile))); 115 PetscCall(PetscFixFilename(pfile, fname)); 116 } 117 118 *fd = fopen(fname, "a"); 119 PetscCheck(fd, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 120 121 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "----------------------------------------\n")); 122 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "%s %s\n", version, date)); 123 PetscCall(PetscGetProgramName(pname, sizeof(pname))); 124 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "%s on a %s, %d proc. with options:\n", pname, arch, size)); 125 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "----------------------------------------\n")); 126 127 PetscCall(PetscFFlush(*fd)); 128 } 129 PetscFunctionReturn(PETSC_SUCCESS); 130 } 131 132 PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd) 133 { 134 PetscMPIInt rank; 135 136 PetscFunctionBegin; 137 PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 138 if (rank == 0) { 139 char date[64]; 140 int err; 141 142 PetscCall(PetscGetDate(date, sizeof(date))); 143 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "----------------------------------------\n")); 144 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "Finished at %s\n", date)); 145 PetscCall(PetscFPrintf(PETSC_COMM_SELF, *fd, "----------------------------------------\n")); 146 PetscCall(PetscFFlush(*fd)); 147 err = fclose(*fd); 148 PetscCheck(!err, PETSC_COMM_SELF, PETSC_ERR_SYS, "fclose() failed on file"); 149 } 150 PetscFunctionReturn(PETSC_SUCCESS); 151 } 152 153 /* 154 This is ugly and probably belongs somewhere else, but I want to 155 be able to put a true MPI abort error handler with command line args. 156 157 This is so MPI errors in the debugger will leave all the stack 158 frames. The default MP_Abort() cleans up and exits thus providing no useful information 159 in the debugger hence we call abort() instead of MPI_Abort(). 160 */ 161 162 void Petsc_MPI_AbortOnError(PETSC_UNUSED MPI_Comm *comm, PetscMPIInt *flag, ...) 163 { 164 PetscFunctionBegin; 165 PetscCallContinue((*PetscErrorPrintf)("MPI error %d\n", *flag)); 166 abort(); 167 } 168 169 void Petsc_MPI_DebuggerOnError(MPI_Comm *comm, PetscMPIInt *flag, ...) 170 { 171 PetscFunctionBegin; 172 PetscCallContinue((*PetscErrorPrintf)("MPI error %d\n", *flag)); 173 if (PetscAttachDebugger()) PETSCABORT(*comm, (PetscErrorCode)*flag); /* hopeless so get out */ 174 } 175 176 /*@C 177 PetscEnd - Calls `PetscFinalize()` and then ends the program. This is useful if one 178 wishes a clean exit somewhere deep in the program. 179 180 Collective on `PETSC_COMM_WORLD` 181 182 Level: advanced 183 184 Note: 185 See `PetscInitialize()` for more general runtime options. 186 187 .seealso: `PetscInitialize()`, `PetscOptionsView()`, `PetscMallocDump()`, `PetscMPIDump()`, `PetscFinalize()` 188 @*/ 189 PetscErrorCode PetscEnd(void) 190 { 191 PetscFunctionBegin; 192 PetscCall(PetscFinalize()); 193 exit(0); 194 return PETSC_SUCCESS; 195 } 196 197 PetscBool PetscOptionsPublish = PETSC_FALSE; 198 PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void); 199 PETSC_INTERN PetscBool petscsetmallocvisited; 200 static char emacsmachinename[256]; 201 202 PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL; 203 PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm) = NULL; 204 205 #include <petscviewer.h> 206 207 /*@C 208 PetscSetHelpVersionFunctions - Sets functions that print help and version information 209 before the PETSc help and version information is printed. 210 211 Input Parameters: 212 + help - the help function (may be `NULL`) 213 - version - the version function (may be `NULL`) 214 215 Level: developer 216 217 Notes: 218 Must call BEFORE `PetscInitialize()`. 219 220 This routine enables a "higher-level" package that uses PETSc to print its messages first and 221 control how the PETSc help messages are printed. 222 223 .seealso: `PetscInitialize()` 224 @*/ 225 PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm), PetscErrorCode (*version)(MPI_Comm)) 226 { 227 PetscFunctionBegin; 228 PetscExternalHelpFunction = help; 229 PetscExternalVersionFunction = version; 230 PetscFunctionReturn(PETSC_SUCCESS); 231 } 232 233 PETSC_INTERN PetscBool PetscObjectsLog; 234 235 PETSC_INTERN PetscErrorCode PetscOptionsCheckInitial_Private(const char help[]) 236 { 237 char string[64]; 238 MPI_Comm comm = PETSC_COMM_WORLD; 239 PetscBool flg1 = PETSC_FALSE, flg2 = PETSC_FALSE, flag, hasHelp; 240 PetscBool checkstack = PETSC_FALSE; 241 PetscReal si; 242 PetscInt intensity; 243 int i; 244 PetscMPIInt rank; 245 char version[256]; 246 247 PetscFunctionBegin; 248 PetscCallMPI(MPI_Comm_rank(comm, &rank)); 249 250 if (PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)) checkstack = PETSC_TRUE; 251 PetscCall(PetscOptionsGetBool(NULL, NULL, "-checkstack", &checkstack, NULL)); 252 PetscCall(PetscStackSetCheck(checkstack)); 253 254 PetscCall(PetscOptionsGetBool(NULL, NULL, "-checkfunctionlist", &PetscPrintFunctionList, NULL)); 255 256 #if !defined(PETSC_HAVE_THREADSAFETY) 257 if (!(PETSC_RUNNING_ON_VALGRIND)) { 258 /* 259 Setup the memory management; support for tracing malloc() usage 260 */ 261 PetscBool mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE; 262 PetscBool flg3 = PETSC_FALSE; 263 264 if (PetscDefined(USE_DEBUG)) { 265 mdebug = PETSC_TRUE; 266 initializenan = PETSC_TRUE; 267 PetscCall(PetscOptionsHasName(NULL, NULL, "-malloc_test", &flg1)); 268 } else { 269 /* don't warn about unused option */ 270 PetscCall(PetscOptionsHasName(NULL, NULL, "-malloc_test", &flg1)); 271 flg1 = PETSC_FALSE; 272 } 273 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_debug", &flg2, &flg3)); 274 if (flg1 || flg2) { 275 mdebug = PETSC_TRUE; 276 eachcall = PETSC_TRUE; 277 initializenan = PETSC_TRUE; 278 } else if (flg3 && !flg2) { 279 mdebug = PETSC_FALSE; 280 eachcall = PETSC_FALSE; 281 initializenan = PETSC_FALSE; 282 } 283 284 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_requested_size", &flg1, &flg2)); 285 if (flg2) PetscCall(PetscMallocLogRequestedSizeSet(flg1)); 286 287 PetscCall(PetscOptionsHasName(NULL, NULL, "-malloc_view", &mlog)); 288 if (mlog) mdebug = PETSC_TRUE; 289 /* the next line is deprecated */ 290 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_dump", &mdebug, NULL)); 291 PetscCall(PetscOptionsGetBool(NULL, NULL, "-log_view_memory", &mdebug, NULL)); 292 if (mdebug) PetscCall(PetscMallocSetDebug(eachcall, initializenan)); 293 if (mlog) { 294 PetscReal logthreshold = 0; 295 PetscCall(PetscOptionsGetReal(NULL, NULL, "-malloc_view_threshold", &logthreshold, NULL)); 296 PetscCall(PetscMallocViewSet(logthreshold)); 297 } 298 PetscCall(PetscOptionsGetBool(NULL, NULL, "-log_view_memory", &PetscLogMemory, NULL)); 299 } 300 301 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_coalesce", &flg1, &flg2)); 302 if (flg2) PetscCall(PetscMallocSetCoalesce(flg1)); 303 flg1 = PETSC_FALSE; 304 PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_hbw", &flg1, NULL)); 305 /* ignore this option if malloc is already set */ 306 if (flg1 && !petscsetmallocvisited) PetscCall(PetscSetUseHBWMalloc_Private()); 307 308 flg1 = PETSC_FALSE; 309 PetscCall(PetscOptionsGetBool(NULL, NULL, "-memory_view", &flg1, NULL)); 310 if (flg1) PetscCall(PetscMemorySetGetMaximumUsage()); 311 #endif 312 313 PetscCall(PetscOptionsHasName(NULL, NULL, "-objects_dump", &PetscObjectsLog)); 314 315 /* 316 Set the display variable for graphics 317 */ 318 PetscCall(PetscSetDisplay()); 319 320 /* 321 Print main application help message 322 */ 323 PetscCall(PetscOptionsHasHelp(NULL, &hasHelp)); 324 if (help && hasHelp) { 325 PetscCall(PetscPrintf(comm, "%s", help)); 326 PetscCall(PetscPrintf(comm, "----------------------------------------\n")); 327 } 328 329 /* 330 Print the PETSc version information 331 */ 332 PetscCall(PetscOptionsHasName(NULL, NULL, "-version", &flg1)); 333 if (flg1 || hasHelp) { 334 /* 335 Print "higher-level" package version message 336 */ 337 if (PetscExternalVersionFunction) PetscCall((*PetscExternalVersionFunction)(comm)); 338 339 PetscCall(PetscGetVersion(version, 256)); 340 if (!PetscCIEnabledPortableErrorOutput) PetscCall((*PetscHelpPrintf)(comm, "%s\n", version)); 341 PetscCall((*PetscHelpPrintf)(comm, "%s", PETSC_AUTHOR_INFO)); 342 PetscCall((*PetscHelpPrintf)(comm, "See https://petsc.org/release/changes for recent updates.\n")); 343 PetscCall((*PetscHelpPrintf)(comm, "See https://petsc.org/release/faq for problems.\n")); 344 PetscCall((*PetscHelpPrintf)(comm, "See https://petsc.org/release/manualpages for help. \n")); 345 if (!PetscCIEnabledPortableErrorOutput) PetscCall((*PetscHelpPrintf)(comm, "Libraries linked from %s\n", PETSC_LIB_DIR)); 346 PetscCall((*PetscHelpPrintf)(comm, "----------------------------------------\n")); 347 } 348 349 /* 350 Print "higher-level" package help message 351 */ 352 if (hasHelp) { 353 PetscBool hasHelpIntro; 354 355 if (PetscExternalHelpFunction) PetscCall((*PetscExternalHelpFunction)(comm)); 356 PetscCall(PetscOptionsHasHelpIntro_Internal(NULL, &hasHelpIntro)); 357 if (hasHelpIntro) { 358 PetscCall(PetscOptionsDestroyDefault()); 359 PetscCall(PetscFreeMPIResources()); 360 PetscCallMPI(MPI_Finalize()); 361 exit(0); 362 } 363 } 364 365 /* 366 Setup the error handling 367 */ 368 flg1 = PETSC_FALSE; 369 PetscCall(PetscOptionsGetBool(NULL, NULL, "-on_error_abort", &flg1, NULL)); 370 if (flg1) { 371 PetscCallMPI(MPI_Comm_set_errhandler(comm, MPI_ERRORS_ARE_FATAL)); 372 PetscCall(PetscPushErrorHandler(PetscAbortErrorHandler, NULL)); 373 } 374 flg1 = PETSC_FALSE; 375 PetscCall(PetscOptionsGetBool(NULL, NULL, "-on_error_mpiabort", &flg1, NULL)); 376 if (flg1) PetscCall(PetscPushErrorHandler(PetscMPIAbortErrorHandler, NULL)); 377 flg1 = PETSC_FALSE; 378 PetscCall(PetscOptionsGetBool(NULL, NULL, "-mpi_return_on_error", &flg1, NULL)); 379 if (flg1) PetscCallMPI(MPI_Comm_set_errhandler(comm, MPI_ERRORS_RETURN)); 380 flg1 = PETSC_FALSE; 381 PetscCall(PetscOptionsGetBool(NULL, NULL, "-no_signal_handler", &flg1, NULL)); 382 if (!flg1) PetscCall(PetscPushSignalHandler(PetscSignalHandlerDefault, (void *)0)); 383 384 /* 385 Setup debugger information 386 */ 387 PetscCall(PetscSetDefaultDebugger()); 388 PetscCall(PetscOptionsGetString(NULL, NULL, "-on_error_attach_debugger", string, sizeof(string), &flg1)); 389 if (flg1) { 390 MPI_Errhandler err_handler; 391 392 PetscCall(PetscSetDebuggerFromString(string)); 393 PetscCallMPI(MPI_Comm_create_errhandler(Petsc_MPI_DebuggerOnError, &err_handler)); 394 PetscCallMPI(MPI_Comm_set_errhandler(comm, err_handler)); 395 PetscCall(PetscPushErrorHandler(PetscAttachDebuggerErrorHandler, NULL)); 396 } 397 PetscCall(PetscOptionsGetString(NULL, NULL, "-debug_terminal", string, sizeof(string), &flg1)); 398 if (flg1) PetscCall(PetscSetDebugTerminal(string)); 399 PetscCall(PetscOptionsGetString(NULL, NULL, "-start_in_debugger", string, sizeof(string), &flg1)); 400 PetscCall(PetscOptionsGetString(NULL, NULL, "-stop_for_debugger", string, sizeof(string), &flg2)); 401 if (flg1 || flg2) { 402 PetscMPIInt size; 403 PetscInt lsize, *ranks; 404 MPI_Errhandler err_handler; 405 /* 406 we have to make sure that all processors have opened 407 connections to all other processors, otherwise once the 408 debugger has stated it is likely to receive a SIGUSR1 409 and kill the program. 410 */ 411 PetscCallMPI(MPI_Comm_size(comm, &size)); 412 if (size > 2) { 413 PetscMPIInt dummy = 0; 414 MPI_Status status; 415 for (i = 0; i < size; i++) { 416 if (rank != i) PetscCallMPI(MPI_Send(&dummy, 1, MPI_INT, i, 109, comm)); 417 } 418 for (i = 0; i < size; i++) { 419 if (rank != i) PetscCallMPI(MPI_Recv(&dummy, 1, MPI_INT, i, 109, comm, &status)); 420 } 421 } 422 /* check if this processor node should be in debugger */ 423 PetscCall(PetscMalloc1(size, &ranks)); 424 lsize = size; 425 /* Deprecated in 3.14 */ 426 PetscCall(PetscOptionsGetIntArray(NULL, NULL, "-debugger_nodes", ranks, &lsize, &flag)); 427 if (flag) { 428 const char *const quietopt = "-options_suppress_deprecated_warnings"; 429 char msg[4096]; 430 PetscBool quiet = PETSC_FALSE; 431 432 PetscCall(PetscOptionsGetBool(NULL, NULL, quietopt, &quiet, NULL)); 433 if (!quiet) { 434 PetscCall(PetscStrncpy(msg, "** PETSc DEPRECATION WARNING ** : the option ", sizeof(msg))); 435 PetscCall(PetscStrlcat(msg, "-debugger_nodes", sizeof(msg))); 436 PetscCall(PetscStrlcat(msg, " is deprecated as of version ", sizeof(msg))); 437 PetscCall(PetscStrlcat(msg, "3.14", sizeof(msg))); 438 PetscCall(PetscStrlcat(msg, " and will be removed in a future release.", sizeof(msg))); 439 PetscCall(PetscStrlcat(msg, " Please use the option ", sizeof(msg))); 440 PetscCall(PetscStrlcat(msg, "-debugger_ranks", sizeof(msg))); 441 PetscCall(PetscStrlcat(msg, " instead.", sizeof(msg))); 442 PetscCall(PetscStrlcat(msg, " (Silence this warning with ", sizeof(msg))); 443 PetscCall(PetscStrlcat(msg, quietopt, sizeof(msg))); 444 PetscCall(PetscStrlcat(msg, ")\n", sizeof(msg))); 445 PetscCall(PetscPrintf(comm, "%s", msg)); 446 } 447 } else { 448 lsize = size; 449 PetscCall(PetscOptionsGetIntArray(NULL, NULL, "-debugger_ranks", ranks, &lsize, &flag)); 450 } 451 if (flag) { 452 for (i = 0; i < lsize; i++) { 453 if (ranks[i] == rank) { 454 flag = PETSC_FALSE; 455 break; 456 } 457 } 458 } 459 if (!flag) { 460 PetscCall(PetscSetDebuggerFromString(string)); 461 PetscCall(PetscPushErrorHandler(PetscAbortErrorHandler, NULL)); 462 if (flg1) { 463 PetscCall(PetscAttachDebugger()); 464 } else { 465 PetscCall(PetscStopForDebugger()); 466 } 467 PetscCallMPI(MPI_Comm_create_errhandler(Petsc_MPI_AbortOnError, &err_handler)); 468 PetscCallMPI(MPI_Comm_set_errhandler(comm, err_handler)); 469 } else { 470 PetscCall(PetscWaitOnError()); 471 } 472 PetscCall(PetscFree(ranks)); 473 } 474 475 PetscCall(PetscOptionsGetString(NULL, NULL, "-on_error_emacs", emacsmachinename, sizeof(emacsmachinename), &flg1)); 476 if (flg1 && rank == 0) PetscCall(PetscPushErrorHandler(PetscEmacsClientErrorHandler, emacsmachinename)); 477 478 /* 479 Setup profiling and logging 480 */ 481 if (PetscDefined(USE_LOG)) { PetscCall(PetscInfoSetFromOptions(NULL)); } 482 PetscCall(PetscDetermineInitialFPTrap()); 483 flg1 = PETSC_FALSE; 484 PetscCall(PetscOptionsGetBool(NULL, NULL, "-fp_trap", &flg1, &flag)); 485 if (flag) PetscCall(PetscSetFPTrap(flg1 ? PETSC_FP_TRAP_ON : PETSC_FP_TRAP_OFF)); 486 PetscCall(PetscOptionsGetInt(NULL, NULL, "-check_pointer_intensity", &intensity, &flag)); 487 if (flag) PetscCall(PetscCheckPointerSetIntensity(intensity)); 488 if (PetscDefined(USE_LOG)) { 489 char mname[PETSC_MAX_PATH_LEN]; 490 PetscViewerFormat format; 491 PetscBool flg4 = PETSC_FALSE; 492 493 mname[0] = 0; 494 PetscCall(PetscOptionsGetString(NULL, NULL, "-history", mname, sizeof(mname), &flg1)); 495 if (flg1) { 496 if (mname[0]) { 497 PetscCall(PetscOpenHistoryFile(mname, &petsc_history)); 498 } else { 499 PetscCall(PetscOpenHistoryFile(NULL, &petsc_history)); 500 } 501 } 502 503 PetscCall(PetscOptionsGetBool(NULL, NULL, "-log_sync", &PetscLogSyncOn, NULL)); 504 505 if (PetscDefined(HAVE_MPE)) { 506 flg1 = PETSC_FALSE; 507 PetscCall(PetscOptionsHasName(NULL, NULL, "-log_mpe", &flg1)); 508 if (flg1) PetscCall(PetscLogMPEBegin()); 509 } 510 if (PetscDefined(HAVE_TAU_PERFSTUBS)) { 511 flg1 = PETSC_FALSE; 512 PetscCall(PetscOptionsHasName(NULL, NULL, "-log_perfstubs", &flg1)); 513 if (flg1) PetscCall(PetscLogPerfstubsBegin()); 514 } 515 flg1 = PETSC_FALSE; 516 PetscCall(PetscOptionsGetBool(NULL, NULL, "-log_all", &flg1, NULL)); 517 PetscCall(PetscOptionsGetBool(NULL, NULL, "-log", &flg2, NULL)); 518 if (flg1 || flg2) PetscCall(PetscLogDefaultBegin()); 519 520 PetscCall(PetscOptionsGetString(NULL, NULL, "-log_trace", mname, sizeof(mname), &flg1)); 521 if (flg1) { 522 char name[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 523 FILE *file; 524 if (mname[0]) { 525 PetscCall(PetscSNPrintf(name, PETSC_MAX_PATH_LEN, "%s.%d", mname, rank)); 526 PetscCall(PetscFixFilename(name, fname)); 527 file = fopen(fname, "w"); 528 PetscCheck(file, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to open trace file: %s", fname); 529 } else file = PETSC_STDOUT; 530 PetscCall(PetscLogTraceBegin(file)); 531 } 532 533 PetscCall(PetscOptionsGetViewer(comm, NULL, NULL, "-log_view", NULL, &format, &flg4)); 534 if (flg4) { 535 if (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 536 PetscCall(PetscLogNestedBegin()); 537 } else { 538 PetscCall(PetscLogDefaultBegin()); 539 } 540 } 541 if (flg4 && (format == PETSC_VIEWER_ASCII_XML || format == PETSC_VIEWER_ASCII_FLAMEGRAPH)) { 542 PetscReal threshold = PetscRealConstant(0.01); 543 PetscCall(PetscOptionsGetReal(NULL, NULL, "-log_threshold", &threshold, &flg1)); 544 if (flg1) PetscCall(PetscLogSetThreshold((PetscLogDouble)threshold, NULL)); 545 } 546 } 547 548 PetscCall(PetscOptionsGetBool(NULL, NULL, "-saws_options", &PetscOptionsPublish, NULL)); 549 PetscCall(PetscOptionsGetBool(NULL, NULL, "-use_gpu_aware_mpi", &use_gpu_aware_mpi, &flg1)); 550 if (!flg1) PetscCall(PetscOptionsGetBool(NULL, NULL, "-sf_use_gpu_aware_mpi", &use_gpu_aware_mpi, &flg1)); // an alias option 551 552 /* 553 Print basic help message 554 */ 555 if (hasHelp) { 556 PetscCall((*PetscHelpPrintf)(comm, "Options for all PETSc programs:\n")); 557 PetscCall((*PetscHelpPrintf)(comm, " -version: prints PETSc version\n")); 558 PetscCall((*PetscHelpPrintf)(comm, " -help intro: prints example description and PETSc version, and exits\n")); 559 PetscCall((*PetscHelpPrintf)(comm, " -help: prints example description, PETSc version, and available options for used routines\n")); 560 PetscCall((*PetscHelpPrintf)(comm, " -on_error_abort: cause an abort when an error is detected. Useful \n ")); 561 PetscCall((*PetscHelpPrintf)(comm, " only when run in the debugger\n")); 562 PetscCall((*PetscHelpPrintf)(comm, " -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n")); 563 PetscCall((*PetscHelpPrintf)(comm, " start the debugger in new xterm\n")); 564 PetscCall((*PetscHelpPrintf)(comm, " unless noxterm is given\n")); 565 PetscCall((*PetscHelpPrintf)(comm, " -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n")); 566 PetscCall((*PetscHelpPrintf)(comm, " start all processes in the debugger\n")); 567 PetscCall((*PetscHelpPrintf)(comm, " -on_error_emacs <machinename>\n")); 568 PetscCall((*PetscHelpPrintf)(comm, " emacs jumps to error file\n")); 569 PetscCall((*PetscHelpPrintf)(comm, " -debugger_ranks [n1,n2,..] Ranks to start in debugger\n")); 570 PetscCall((*PetscHelpPrintf)(comm, " -debugger_pause [m] : delay (in seconds) to attach debugger\n")); 571 PetscCall((*PetscHelpPrintf)(comm, " -stop_for_debugger : prints message on how to attach debugger manually\n")); 572 PetscCall((*PetscHelpPrintf)(comm, " waits the delay for you to attach\n")); 573 PetscCall((*PetscHelpPrintf)(comm, " -display display: Location where X window graphics and debuggers are displayed\n")); 574 PetscCall((*PetscHelpPrintf)(comm, " -no_signal_handler: do not trap error signals\n")); 575 PetscCall((*PetscHelpPrintf)(comm, " -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n")); 576 PetscCall((*PetscHelpPrintf)(comm, " -fp_trap: stop on floating point exceptions\n")); 577 PetscCall((*PetscHelpPrintf)(comm, " note on IBM RS6000 this slows run greatly\n")); 578 PetscCall((*PetscHelpPrintf)(comm, " -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n")); 579 PetscCall((*PetscHelpPrintf)(comm, " -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n")); 580 PetscCall((*PetscHelpPrintf)(comm, " -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n")); 581 PetscCall((*PetscHelpPrintf)(comm, " -options_view: dump list of options inputted\n")); 582 PetscCall((*PetscHelpPrintf)(comm, " -options_left: dump list of unused options\n")); 583 PetscCall((*PetscHelpPrintf)(comm, " -options_left no: don't dump list of unused options\n")); 584 PetscCall((*PetscHelpPrintf)(comm, " -tmp tmpdir: alternative /tmp directory\n")); 585 PetscCall((*PetscHelpPrintf)(comm, " -shared_tmp: tmp directory is shared by all processors\n")); 586 PetscCall((*PetscHelpPrintf)(comm, " -not_shared_tmp: each processor has separate tmp directory\n")); 587 PetscCall((*PetscHelpPrintf)(comm, " -memory_view: print memory usage at end of run\n")); 588 #if defined(PETSC_USE_LOG) 589 PetscCall((*PetscHelpPrintf)(comm, " -get_total_flops: total flops over all processors\n")); 590 PetscCall((*PetscHelpPrintf)(comm, " -log_view [:filename:[format]]: logging objects and events\n")); 591 PetscCall((*PetscHelpPrintf)(comm, " -log_trace [filename]: prints trace of all PETSc calls\n")); 592 PetscCall((*PetscHelpPrintf)(comm, " -log_exclude <list,of,classnames>: exclude given classes from logging\n")); 593 #if defined(PETSC_HAVE_DEVICE) 594 PetscCall((*PetscHelpPrintf)(comm, " -log_view_gpu_time: log the GPU time for each and event\n")); 595 #endif 596 #if defined(PETSC_HAVE_MPE) 597 PetscCall((*PetscHelpPrintf)(comm, " -log_mpe: Also create logfile viewable through Jumpshot\n")); 598 #endif 599 #endif 600 #if defined(PETSC_USE_INFO) 601 PetscCall((*PetscHelpPrintf)(comm, " -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n")); 602 #endif 603 PetscCall((*PetscHelpPrintf)(comm, " -options_file <file>: reads options from file\n")); 604 PetscCall((*PetscHelpPrintf)(comm, " -options_monitor: monitor options to standard output, including that set previously e.g. in option files\n")); 605 PetscCall((*PetscHelpPrintf)(comm, " -options_monitor_cancel: cancels all hardwired option monitors\n")); 606 PetscCall((*PetscHelpPrintf)(comm, " -petsc_sleep n: sleeps n seconds before running program\n")); 607 } 608 609 #if defined(PETSC_HAVE_POPEN) 610 { 611 char machine[128]; 612 PetscCall(PetscOptionsGetString(NULL, NULL, "-popen_machine", machine, sizeof(machine), &flg1)); 613 if (flg1) PetscCall(PetscPOpenSetMachine(machine)); 614 } 615 #endif 616 617 PetscCall(PetscOptionsGetReal(NULL, NULL, "-petsc_sleep", &si, &flg1)); 618 if (flg1) PetscCall(PetscSleep(si)); 619 PetscFunctionReturn(PETSC_SUCCESS); 620 } 621