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