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