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