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>
10: #if defined(PETSC_HAVE_UNISTD_H)
11: #include <unistd.h>
12: #endif
14: /* ------------------------Nasty global variables -------------------------------*/
15: /*
16: Indicates if PETSc started up MPI, or it was
17: already started before PETSc was initialized.
18: */
19: PetscBool PetscBeganMPI = PETSC_FALSE;
20: PetscBool PetscErrorHandlingInitialized = PETSC_FALSE;
21: PetscBool PetscInitializeCalled = PETSC_FALSE;
22: PetscBool PetscFinalizeCalled = PETSC_FALSE;
24: PetscMPIInt PetscGlobalRank = -1;
25: PetscMPIInt PetscGlobalSize = -1;
27: #if defined(PETSC_HAVE_KOKKOS)
28: PetscBool PetscBeganKokkos = PETSC_FALSE;
29: #endif
31: #if defined(PETSC_HAVE_NVSHMEM)
32: PetscBool PetscBeganNvshmem = PETSC_FALSE;
33: PetscBool PetscNvshmemInitialized = PETSC_FALSE;
34: #endif
36: PetscBool use_gpu_aware_mpi = PetscDefined(HAVE_MPIUNI) ? PETSC_FALSE : PETSC_TRUE;
38: PetscBool PetscPrintFunctionList = PETSC_FALSE;
40: #if defined(PETSC_HAVE_COMPLEX)
41: #if defined(PETSC_COMPLEX_INSTANTIATE)
42: template <>
43: class std::complex<double>; /* instantiate complex template class */
44: #endif
46: /*MC
47: PETSC_i - the imaginary number i
49: Synopsis:
50: #include <petscsys.h>
51: PetscComplex PETSC_i;
53: Level: beginner
55: Note:
56: Complex numbers are automatically available if PETSc located a working complex implementation
58: .seealso: `PetscRealPart()`, `PetscImaginaryPart()`, `PetscRealPartComplex()`, `PetscImaginaryPartComplex()`
59: M*/
60: PetscComplex PETSC_i;
61: MPI_Datatype MPIU___COMPLEX128 = 0;
62: #endif /* PETSC_HAVE_COMPLEX */
63: #if defined(PETSC_HAVE_REAL___FLOAT128)
64: MPI_Datatype MPIU___FLOAT128 = 0;
65: #endif
66: #if defined(PETSC_HAVE_REAL___FP16)
67: MPI_Datatype MPIU___FP16 = 0;
68: #endif
69: MPI_Datatype MPIU_2SCALAR = 0;
70: MPI_Datatype MPIU_REAL_INT = 0;
71: MPI_Datatype MPIU_SCALAR_INT = 0;
72: #if defined(PETSC_USE_64BIT_INDICES)
73: MPI_Datatype MPIU_2INT = 0;
74: #endif
75: MPI_Datatype MPI_4INT = 0;
76: MPI_Datatype MPIU_4INT = 0;
77: MPI_Datatype MPIU_BOOL;
78: MPI_Datatype MPIU_ENUM;
79: MPI_Datatype MPIU_FORTRANADDR;
80: MPI_Datatype MPIU_SIZE_T;
82: /*
83: Function that is called to display all error messages
84: */
85: PetscErrorCode (*PetscErrorPrintf)(const char[], ...) = PetscErrorPrintfDefault;
86: PetscErrorCode (*PetscHelpPrintf)(MPI_Comm, const char[], ...) = PetscHelpPrintfDefault;
87: PetscErrorCode (*PetscVFPrintf)(FILE *, const char[], va_list) = PetscVFPrintfDefault;
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;
96: 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];
102: PetscFunctionBegin;
103: PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
104: if (rank == 0) {
105: char arch[10];
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: }
119: *fd = fopen(fname, "a");
120: PetscCheck(fd, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
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"));
128: PetscCall(PetscFFlush(*fd));
129: }
130: PetscFunctionReturn(PETSC_SUCCESS);
131: }
133: PETSC_INTERN PetscErrorCode PetscCloseHistoryFile(FILE **fd)
134: {
135: PetscMPIInt rank;
137: PetscFunctionBegin;
138: PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
139: if (rank == 0) {
140: char date[64];
141: int err;
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: }
154: /* ------------------------------------------------------------------------------*/
156: /*
157: This is ugly and probably belongs somewhere else, but I want to
158: be able to put a true MPI abort error handler with command line args.
160: This is so MPI errors in the debugger will leave all the stack
161: frames. The default MP_Abort() cleans up and exits thus providing no useful information
162: in the debugger hence we call abort() instead of MPI_Abort().
163: */
165: void Petsc_MPI_AbortOnError(PETSC_UNUSED MPI_Comm *comm, PetscMPIInt *flag, ...)
166: {
167: PetscFunctionBegin;
168: PetscCallContinue((*PetscErrorPrintf)("MPI error %d\n", *flag));
169: abort();
170: }
172: void Petsc_MPI_DebuggerOnError(MPI_Comm *comm, PetscMPIInt *flag, ...)
173: {
174: PetscFunctionBegin;
175: PetscCallContinue((*PetscErrorPrintf)("MPI error %d\n", *flag));
176: if (PetscAttachDebugger()) PETSCABORT(*comm, (PetscErrorCode)*flag); /* hopeless so get out */
177: }
179: /*@C
180: PetscEnd - Calls `PetscFinalize()` and then ends the program. This is useful if one
181: wishes a clean exit somewhere deep in the program.
183: Collective on `PETSC_COMM_WORLD`
185: Options Database Keys are the same as for `PetscFinalize()`
187: Level: advanced
189: Note:
190: See `PetscInitialize()` for more general runtime options.
192: .seealso: `PetscInitialize()`, `PetscOptionsView()`, `PetscMallocDump()`, `PetscMPIDump()`, `PetscFinalize()`
193: @*/
194: PetscErrorCode PetscEnd(void)
195: {
196: PetscFunctionBegin;
197: PetscCall(PetscFinalize());
198: exit(0);
199: return PETSC_SUCCESS;
200: }
202: PetscBool PetscOptionsPublish = PETSC_FALSE;
203: PETSC_INTERN PetscErrorCode PetscSetUseHBWMalloc_Private(void);
204: PETSC_INTERN PetscBool petscsetmallocvisited;
205: static char emacsmachinename[256];
207: PetscErrorCode (*PetscExternalVersionFunction)(MPI_Comm) = NULL;
208: PetscErrorCode (*PetscExternalHelpFunction)(MPI_Comm) = NULL;
210: #if PetscDefined(USE_LOG)
211: #include <petscviewer.h>
212: #endif
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.
219: Input Parameters:
220: + help - the help function (may be NULL)
221: - version - the version function (may be NULL)
223: Level: developer
225: @*/
226: PetscErrorCode PetscSetHelpVersionFunctions(PetscErrorCode (*help)(MPI_Comm), PetscErrorCode (*version)(MPI_Comm))
227: {
228: PetscFunctionBegin;
229: PetscExternalHelpFunction = help;
230: PetscExternalVersionFunction = version;
231: PetscFunctionReturn(PETSC_SUCCESS);
232: }
234: #if defined(PETSC_USE_LOG)
235: PETSC_INTERN PetscBool PetscObjectsLog;
236: #endif
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: #if defined(PETSC_USE_LOG)
250: char mname[PETSC_MAX_PATH_LEN];
251: PetscViewerFormat format;
252: PetscBool flg4 = PETSC_FALSE;
253: #endif
255: PetscFunctionBegin;
256: PetscCallMPI(MPI_Comm_rank(comm, &rank));
258: if (PetscDefined(USE_DEBUG) && !PetscDefined(HAVE_THREADSAFETY)) checkstack = PETSC_TRUE;
259: PetscCall(PetscOptionsGetBool(NULL, NULL, "-checkstack", &checkstack, NULL));
260: PetscCall(PetscStackSetCheck(checkstack));
262: PetscCall(PetscOptionsGetBool(NULL, NULL, "-checkfunctionlist", &PetscPrintFunctionList, NULL));
264: #if !defined(PETSC_HAVE_THREADSAFETY)
265: if (!(PETSC_RUNNING_ON_VALGRIND)) {
266: /*
267: Setup the memory management; support for tracing malloc() usage
268: */
269: PetscBool mdebug = PETSC_FALSE, eachcall = PETSC_FALSE, initializenan = PETSC_FALSE, mlog = PETSC_FALSE;
270: PetscBool flg3 = PETSC_FALSE;
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: }
292: PetscCall(PetscOptionsGetBool(NULL, NULL, "-malloc_requested_size", &flg1, &flg2));
293: if (flg2) PetscCall(PetscMallocLogRequestedSizeSet(flg1));
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: }
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());
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
328: #if defined(PETSC_USE_LOG)
329: PetscCall(PetscOptionsHasName(NULL, NULL, "-objects_dump", &PetscObjectsLog));
330: #endif
332: /*
333: Set the display variable for graphics
334: */
335: PetscCall(PetscSetDisplay());
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: }
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));
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 https://petsc.org/release/changes for recent updates.\n"));
360: PetscCall((*PetscHelpPrintf)(comm, "See https://petsc.org/release/faq for problems.\n"));
361: PetscCall((*PetscHelpPrintf)(comm, "See https://petsc.org/release/manualpages for help. \n"));
362: PetscCall((*PetscHelpPrintf)(comm, "Libraries linked from %s\n", PETSC_LIB_DIR));
363: PetscCall((*PetscHelpPrintf)(comm, "----------------------------------------\n"));
364: }
366: /*
367: Print "higher-level" package help message
368: */
369: if (hasHelp) {
370: PetscBool hasHelpIntro;
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: }
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));
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;
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;
449: PetscCall(PetscOptionsGetBool(NULL, NULL, quietopt, &quiet, NULL));
450: if (!quiet) {
451: PetscCall(PetscStrncpy(msg, "** PETSc DEPRECATION WARNING ** : the option ", sizeof(msg)));
452: PetscCall(PetscStrlcat(msg, "-debugger_nodes", sizeof(msg)));
453: PetscCall(PetscStrlcat(msg, " is deprecated as of version ", sizeof(msg)));
454: PetscCall(PetscStrlcat(msg, "3.14", sizeof(msg)));
455: PetscCall(PetscStrlcat(msg, " and will be removed in a future release.", sizeof(msg)));
456: PetscCall(PetscStrlcat(msg, " Please use the option ", sizeof(msg)));
457: PetscCall(PetscStrlcat(msg, "-debugger_ranks", sizeof(msg)));
458: PetscCall(PetscStrlcat(msg, " instead.", sizeof(msg)));
459: PetscCall(PetscStrlcat(msg, " (Silence this warning with ", sizeof(msg)));
460: PetscCall(PetscStrlcat(msg, quietopt, sizeof(msg)));
461: PetscCall(PetscStrlcat(msg, ")\n", sizeof(msg)));
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: }
492: PetscCall(PetscOptionsGetString(NULL, NULL, "-on_error_emacs", emacsmachinename, sizeof(emacsmachinename), &flg1));
493: if (flg1 && rank == 0) PetscCall(PetscPushErrorHandler(PetscEmacsClientErrorHandler, emacsmachinename));
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: }
520: PetscCall(PetscOptionsGetBool(NULL, NULL, "-log_sync", &PetscLogSyncOn, NULL));
522: PetscBool flg3 = PETSC_FALSE;
523: #if defined(PETSC_HAVE_MPE)
524: flg1 = PETSC_FALSE;
525: PetscCall(PetscOptionsHasName(NULL, NULL, "-log_mpe", &flg1));
526: if (flg1) PetscCall(PetscLogMPEBegin());
527: #endif
528: flg1 = 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());
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: PetscCall(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: }
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
562: PetscCall(PetscOptionsGetBool(NULL, NULL, "-saws_options", &PetscOptionsPublish, NULL));
563: PetscCall(PetscOptionsGetBool(NULL, NULL, "-use_gpu_aware_mpi", &use_gpu_aware_mpi, &flg1));
564: if (!flg1) PetscCall(PetscOptionsGetBool(NULL, NULL, "-sf_use_gpu_aware_mpi", &use_gpu_aware_mpi, &flg1)); // an alias option
566: /*
567: Print basic help message
568: */
569: if (hasHelp) {
570: PetscCall((*PetscHelpPrintf)(comm, "Options for all PETSc programs:\n"));
571: PetscCall((*PetscHelpPrintf)(comm, " -version: prints PETSc version\n"));
572: PetscCall((*PetscHelpPrintf)(comm, " -help intro: prints example description and PETSc version, and exits\n"));
573: PetscCall((*PetscHelpPrintf)(comm, " -help: prints example description, PETSc version, and available options for used routines\n"));
574: PetscCall((*PetscHelpPrintf)(comm, " -on_error_abort: cause an abort when an error is detected. Useful \n "));
575: PetscCall((*PetscHelpPrintf)(comm, " only when run in the debugger\n"));
576: PetscCall((*PetscHelpPrintf)(comm, " -on_error_attach_debugger [gdb,dbx,xxgdb,ups,noxterm]\n"));
577: PetscCall((*PetscHelpPrintf)(comm, " start the debugger in new xterm\n"));
578: PetscCall((*PetscHelpPrintf)(comm, " unless noxterm is given\n"));
579: PetscCall((*PetscHelpPrintf)(comm, " -start_in_debugger [gdb,dbx,xxgdb,ups,noxterm]\n"));
580: PetscCall((*PetscHelpPrintf)(comm, " start all processes in the debugger\n"));
581: PetscCall((*PetscHelpPrintf)(comm, " -on_error_emacs <machinename>\n"));
582: PetscCall((*PetscHelpPrintf)(comm, " emacs jumps to error file\n"));
583: PetscCall((*PetscHelpPrintf)(comm, " -debugger_ranks [n1,n2,..] Ranks to start in debugger\n"));
584: PetscCall((*PetscHelpPrintf)(comm, " -debugger_pause [m] : delay (in seconds) to attach debugger\n"));
585: PetscCall((*PetscHelpPrintf)(comm, " -stop_for_debugger : prints message on how to attach debugger manually\n"));
586: PetscCall((*PetscHelpPrintf)(comm, " waits the delay for you to attach\n"));
587: PetscCall((*PetscHelpPrintf)(comm, " -display display: Location where X window graphics and debuggers are displayed\n"));
588: PetscCall((*PetscHelpPrintf)(comm, " -no_signal_handler: do not trap error signals\n"));
589: PetscCall((*PetscHelpPrintf)(comm, " -mpi_return_on_error: MPI returns error code, rather than abort on internal error\n"));
590: PetscCall((*PetscHelpPrintf)(comm, " -fp_trap: stop on floating point exceptions\n"));
591: PetscCall((*PetscHelpPrintf)(comm, " note on IBM RS6000 this slows run greatly\n"));
592: PetscCall((*PetscHelpPrintf)(comm, " -malloc_dump <optional filename>: dump list of unfreed memory at conclusion\n"));
593: PetscCall((*PetscHelpPrintf)(comm, " -malloc: use PETSc error checking malloc (deprecated, use -malloc_debug)\n"));
594: PetscCall((*PetscHelpPrintf)(comm, " -malloc no: don't use PETSc error checking malloc (deprecated, use -malloc_debug no)\n"));
595: PetscCall((*PetscHelpPrintf)(comm, " -malloc_info: prints total memory usage\n"));
596: PetscCall((*PetscHelpPrintf)(comm, " -malloc_view <optional filename>: keeps log of all memory allocations, displays in PetscFinalize()\n"));
597: PetscCall((*PetscHelpPrintf)(comm, " -malloc_debug <true or false>: enables or disables extended checking for memory corruption\n"));
598: PetscCall((*PetscHelpPrintf)(comm, " -options_view: dump list of options inputted\n"));
599: PetscCall((*PetscHelpPrintf)(comm, " -options_left: dump list of unused options\n"));
600: PetscCall((*PetscHelpPrintf)(comm, " -options_left no: don't dump list of unused options\n"));
601: PetscCall((*PetscHelpPrintf)(comm, " -tmp tmpdir: alternative /tmp directory\n"));
602: PetscCall((*PetscHelpPrintf)(comm, " -shared_tmp: tmp directory is shared by all processors\n"));
603: PetscCall((*PetscHelpPrintf)(comm, " -not_shared_tmp: each processor has separate tmp directory\n"));
604: PetscCall((*PetscHelpPrintf)(comm, " -memory_view: print memory usage at end of run\n"));
605: #if defined(PETSC_USE_LOG)
606: PetscCall((*PetscHelpPrintf)(comm, " -get_total_flops: total flops over all processors\n"));
607: PetscCall((*PetscHelpPrintf)(comm, " -log_view [:filename:[format]]: logging objects and events\n"));
608: PetscCall((*PetscHelpPrintf)(comm, " -log_trace [filename]: prints trace of all PETSc calls\n"));
609: PetscCall((*PetscHelpPrintf)(comm, " -log_exclude <list,of,classnames>: exclude given classes from logging\n"));
610: #if defined(PETSC_HAVE_DEVICE)
611: PetscCall((*PetscHelpPrintf)(comm, " -log_view_gpu_time: log the GPU time for each and event\n"));
612: #endif
613: #if defined(PETSC_HAVE_MPE)
614: PetscCall((*PetscHelpPrintf)(comm, " -log_mpe: Also create logfile viewable through Jumpshot\n"));
615: #endif
616: #endif
617: #if defined(PETSC_USE_INFO)
618: PetscCall((*PetscHelpPrintf)(comm, " -info [filename][:[~]<list,of,classnames>[:[~]self]]: print verbose information\n"));
619: #endif
620: PetscCall((*PetscHelpPrintf)(comm, " -options_file <file>: reads options from file\n"));
621: PetscCall((*PetscHelpPrintf)(comm, " -options_monitor: monitor options to standard output, including that set previously e.g. in option files\n"));
622: PetscCall((*PetscHelpPrintf)(comm, " -options_monitor_cancel: cancels all hardwired option monitors\n"));
623: PetscCall((*PetscHelpPrintf)(comm, " -petsc_sleep n: sleeps n seconds before running program\n"));
624: }
626: #if defined(PETSC_HAVE_POPEN)
627: {
628: char machine[128];
629: PetscCall(PetscOptionsGetString(NULL, NULL, "-popen_machine", machine, sizeof(machine), &flg1));
630: if (flg1) PetscCall(PetscPOpenSetMachine(machine));
631: }
632: #endif
634: PetscCall(PetscOptionsGetReal(NULL, NULL, "-petsc_sleep", &si, &flg1));
635: if (flg1) PetscCall(PetscSleep(si));
636: PetscFunctionReturn(PETSC_SUCCESS);
637: }