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