xref: /petsc/src/sys/error/adebug.c (revision 10450e9e44b354a0a3da7bbd573407bdf051df10)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay       Code to handle PETSc starting up in debuggers,etc.
3e5c89e4eSSatish Balay */
4cfbfffeaSBarry Smith #define PETSC_DESIRE_FEATURE_TEST_MACROS /* for fileno() */
5c6db04a5SJed Brown #include <petscsys.h>                    /*I   "petscsys.h"   I*/
6e5c89e4eSSatish Balay #include <signal.h>
7e5c89e4eSSatish Balay #if defined(PETSC_HAVE_UNISTD_H)
8e5c89e4eSSatish Balay   #include <unistd.h>
9e5c89e4eSSatish Balay #endif
10e5c89e4eSSatish Balay 
11e5c89e4eSSatish Balay /*
12e5c89e4eSSatish Balay       These are the debugger and display used if the debugger is started up
13e5c89e4eSSatish Balay */
14b59f628eSBarry Smith static char      PetscDebugger[PETSC_MAX_PATH_LEN];
155e96ac45SJed Brown static char      DebugTerminal[PETSC_MAX_PATH_LEN];
16c823fc1fSBarry Smith static PetscBool UseDebugTerminal    = PETSC_TRUE;
17baae8e41SSatish Balay PetscBool        petscwaitonerrorflg = PETSC_FALSE;
18bf4d2887SBarry Smith PetscBool        petscindebugger     = PETSC_FALSE;
19e5c89e4eSSatish Balay 
205e96ac45SJed Brown /*@C
21c823fc1fSBarry Smith   PetscSetDebugTerminal - Sets the terminal to use for debugging.
225e96ac45SJed Brown 
23cf53795eSBarry Smith   Not Collective; No Fortran Support
245e96ac45SJed Brown 
25811af0c4SBarry Smith   Input Parameter:
26a2b725a8SWilliam Gropp . terminal - name of terminal and any flags required to execute a program.
27c3cd2bb4SBarry Smith               For example "xterm", "urxvt -e", "gnome-terminal -x".
28c3cd2bb4SBarry Smith               On Apple macOS you can use "Terminal} (note the capital T)
295e96ac45SJed Brown 
30811af0c4SBarry Smith   Options Database Key:
31c3cd2bb4SBarry Smith . -debug_terminal terminal - use this terminal instead of the default
325e96ac45SJed Brown 
335e96ac45SJed Brown   Level: developer
345e96ac45SJed Brown 
355e96ac45SJed Brown   Notes:
365e96ac45SJed Brown   You can start the debugger for all processes in the same GNU screen session.
375e96ac45SJed Brown 
38c3cd2bb4SBarry Smith $     mpiexec -n 4 ./myapp -start_in_debugger -debug_terminal "screen -X -S debug screen"
395e96ac45SJed Brown 
405e96ac45SJed Brown   will open 4 windows in the session named "debug".
415e96ac45SJed Brown 
42c823fc1fSBarry Smith   The default on Apple is Terminal, on other systems the default is xterm
43c823fc1fSBarry Smith 
44c3cd2bb4SBarry Smith .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
455e96ac45SJed Brown @*/
46d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebugTerminal(const char terminal[])
47d71ae5a4SJacob Faibussowitsch {
48c823fc1fSBarry Smith   PetscBool xterm;
495e96ac45SJed Brown 
505e96ac45SJed Brown   PetscFunctionBegin;
519566063dSJacob Faibussowitsch   PetscCall(PetscStrncpy(DebugTerminal, terminal, sizeof(DebugTerminal)));
529566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(terminal, "xterm", &xterm));
539566063dSJacob Faibussowitsch   if (xterm) PetscCall(PetscStrlcat(DebugTerminal, " -e", sizeof(DebugTerminal)));
543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
555e96ac45SJed Brown }
565e96ac45SJed Brown 
57e5c89e4eSSatish Balay /*@C
58e5c89e4eSSatish Balay   PetscSetDebugger - Sets options associated with the debugger.
59e5c89e4eSSatish Balay 
60cf53795eSBarry Smith   Not Collective; No Fortran Support
61e5c89e4eSSatish Balay 
62e5c89e4eSSatish Balay   Input Parameters:
63e5c89e4eSSatish Balay + debugger         - name of debugger, which should be in your path,
64c4fb7a8fSRichard Tran Mills               usually "lldb", "dbx", "gdb", "cuda-gdb", "idb", "xxgdb", "kdgb" or "ddd". Also, HP-UX
65e5c89e4eSSatish Balay               supports "xdb", and IBM rs6000 supports "xldb".
66e5c89e4eSSatish Balay 
67c823fc1fSBarry Smith - usedebugterminal - flag to indicate debugger window, set to either PETSC_TRUE (to indicate
68c823fc1fSBarry Smith             debugger should be started in a new terminal window) or PETSC_FALSE (to start debugger
698d359177SBarry Smith             in initial window (the option PETSC_FALSE makes no sense when using more
708d359177SBarry Smith             than one MPI process.)
71e5c89e4eSSatish Balay 
72e5c89e4eSSatish Balay   Level: developer
73e5c89e4eSSatish Balay 
74db781477SPatrick Sanan .seealso: `PetscAttachDebugger()`, `PetscAttachDebuggerErrorHandler()`, `PetscSetDebugTerminal()`
75e5c89e4eSSatish Balay @*/
76d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebugger(const char debugger[], PetscBool usedebugterminal)
77d71ae5a4SJacob Faibussowitsch {
78e5c89e4eSSatish Balay   PetscFunctionBegin;
799566063dSJacob Faibussowitsch   if (debugger) PetscCall(PetscStrncpy(PetscDebugger, debugger, sizeof(PetscDebugger)));
80c823fc1fSBarry Smith   if (UseDebugTerminal) UseDebugTerminal = usedebugterminal;
813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82e5c89e4eSSatish Balay }
83e5c89e4eSSatish Balay 
848d359177SBarry Smith /*@C
85c823fc1fSBarry Smith   PetscSetDefaultDebugger - Causes PETSc to use its default debugger and output terminal
86e5c89e4eSSatish Balay 
8720f4b53cSBarry Smith   Not Collective
88e5c89e4eSSatish Balay 
898d359177SBarry Smith   Level: developer
90e5c89e4eSSatish Balay 
91c3cd2bb4SBarry Smith .seealso: `PetscSetDebugger()`, `PetscSetDebuggerFromString()`, `PetscAttachDebugger()`
92e5c89e4eSSatish Balay @*/
93d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDefaultDebugger(void)
94d71ae5a4SJacob Faibussowitsch {
95e5c89e4eSSatish Balay   PetscFunctionBegin;
964211eb48SBarry Smith #if defined(PETSC_USE_DEBUGGER)
979566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(PETSC_USE_DEBUGGER, PETSC_TRUE));
98e5c89e4eSSatish Balay #endif
99c823fc1fSBarry Smith #if defined(__APPLE__)
1009566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugTerminal("Terminal"));
101c823fc1fSBarry Smith #else
1029566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugTerminal("xterm"));
103c823fc1fSBarry Smith #endif
1043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
105e5c89e4eSSatish Balay }
106e5c89e4eSSatish Balay 
107d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscCheckDebugger_Private(const char defaultDbg[], const char string[], const char *debugger[])
108d71ae5a4SJacob Faibussowitsch {
109bbcf679cSJacob Faibussowitsch   char *f = NULL;
110e5c89e4eSSatish Balay 
111e5c89e4eSSatish Balay   PetscFunctionBegin;
1129566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, defaultDbg, &f));
113e5c89e4eSSatish Balay   if (f) {
114bbcf679cSJacob Faibussowitsch     PetscBool exists;
115bbcf679cSJacob Faibussowitsch 
1169566063dSJacob Faibussowitsch     PetscCall(PetscTestFile(string, 'x', &exists));
117a297a907SKarl Rupp     if (exists) *debugger = string;
118a297a907SKarl Rupp     else *debugger = defaultDbg;
119e5c89e4eSSatish Balay   }
1203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
121e5c89e4eSSatish Balay }
122e5c89e4eSSatish Balay 
123e5c89e4eSSatish Balay /*@C
124e5c89e4eSSatish Balay   PetscSetDebuggerFromString - Set the complete path for the
125e5c89e4eSSatish Balay   debugger for PETSc to use.
126e5c89e4eSSatish Balay 
12720f4b53cSBarry Smith   Not Collective
128e5c89e4eSSatish Balay 
129*10450e9eSJacob Faibussowitsch   Input Parameter:
130*10450e9eSJacob Faibussowitsch . string - the name of the debugger, for example "gdb"
131*10450e9eSJacob Faibussowitsch 
1327c764164SBarry Smith   Level: developer
133e5c89e4eSSatish Balay 
134c3cd2bb4SBarry Smith .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscAttachDebugger()`
135e5c89e4eSSatish Balay @*/
136d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebuggerFromString(const char *string)
137d71ae5a4SJacob Faibussowitsch {
1380298fd71SBarry Smith   const char *debugger    = NULL;
139c823fc1fSBarry Smith   PetscBool   useterminal = PETSC_TRUE;
140bbcf679cSJacob Faibussowitsch   char       *f           = NULL;
141e5c89e4eSSatish Balay 
142e5c89e4eSSatish Balay   PetscFunctionBegin;
1439566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noxterm", &f));
144c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1459566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "ddd", &f));
146c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1479566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noterminal", &f));
148c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1499566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xdb", string, &debugger));
1509566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("dbx", string, &debugger));
1519566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xldb", string, &debugger));
1529566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("gdb", string, &debugger));
1539566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("cuda-gdb", string, &debugger));
1549566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("idb", string, &debugger));
1559566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xxgdb", string, &debugger));
1569566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ddd", string, &debugger));
1579566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("kdbg", string, &debugger));
1589566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ups", string, &debugger));
1599566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("workshop", string, &debugger));
1609566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pgdbg", string, &debugger));
1619566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pathdb", string, &debugger));
1629566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("lldb", string, &debugger));
1639566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(debugger, useterminal));
1643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
165e5c89e4eSSatish Balay }
166e5c89e4eSSatish Balay 
1672a2a2941SBarry Smith /*@
168811af0c4SBarry Smith   PetscWaitOnError - If an error is detected and the process would normally exit the main program with `MPI_Abort()` sleep instead
1692a2a2941SBarry Smith   of exiting.
1702a2a2941SBarry Smith 
1712a2a2941SBarry Smith   Not Collective
1722a2a2941SBarry Smith 
1732a2a2941SBarry Smith   Level: advanced
1742a2a2941SBarry Smith 
175811af0c4SBarry Smith   Note:
176c3cd2bb4SBarry Smith   When `-start_in_debugger -debugger_ranks x,y,z` is used this prevents the processes NOT listed in x,y,z from calling `MPI_Abort()` and
1772a2a2941SBarry Smith   killing the user's debugging sessions.
1782a2a2941SBarry Smith 
179db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
1802a2a2941SBarry Smith @*/
1813274405dSPierre Jolivet PetscErrorCode PetscWaitOnError(void)
182d71ae5a4SJacob Faibussowitsch {
183baae8e41SSatish Balay   petscwaitonerrorflg = PETSC_TRUE;
1843ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
1852a2a2941SBarry Smith }
186e5c89e4eSSatish Balay 
187e30d2299SSatish Balay /*@
188e5c89e4eSSatish Balay   PetscAttachDebugger - Attaches the debugger to the running process.
189e5c89e4eSSatish Balay 
190e5c89e4eSSatish Balay   Not Collective
191e5c89e4eSSatish Balay 
1921f690a00SBarry Smith   Options Database Keys:
193aec76313SJacob Faibussowitsch + -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n] - set debugger debug_terminal xterm or Terminal (for Apple)
1941f690a00SBarry Smith . -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name]                - Activates debugger attachment
195c3cd2bb4SBarry Smith - -stop_for_debugger                                                                        - print a message on how to attach the process with a debugger and then wait for the user to attach
1961f690a00SBarry Smith 
197e5c89e4eSSatish Balay   Level: advanced
198e5c89e4eSSatish Balay 
199c3cd2bb4SBarry Smith   Note:
200c3cd2bb4SBarry Smith   If you get the message " stdin is not a tty, hence unable to attach debugger, see PetscAttachDebugger()", this means the application
201c3cd2bb4SBarry Smith   is likely running in a batch system and you do not have terminal access to the process. You can try
202c3cd2bb4SBarry Smith   running with `-start_in_debugger` without the `noxterm` argument or `-stop_for_debugger`
203c3cd2bb4SBarry Smith 
204aec76313SJacob Faibussowitsch   Developer Notes:
205c3cd2bb4SBarry Smith   Since this can be called by the error handler, should it be calling `SETERRQ()` and `PetscCall()`?
206f35f84d1SBarry Smith 
207db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscSetDebugTerminal()`, `PetscAttachDebuggerErrorHandler()`, `PetscStopForDebugger()`
208e5c89e4eSSatish Balay @*/
209d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebugger(void)
210d71ae5a4SJacob Faibussowitsch {
2113ba16761SJacob Faibussowitsch   PetscErrorCode PETSC_UNUSED ierr;
212ed50d614Sprj- #if !defined(PETSC_CANNOT_START_DEBUGGER) && defined(PETSC_HAVE_FORK)
213e5c89e4eSSatish Balay   int       child     = 0;
214a6d0e24fSJed Brown   PetscReal sleeptime = 0;
215e5c89e4eSSatish Balay   char      program[PETSC_MAX_PATH_LEN], display[256], hostname[64];
216e5c89e4eSSatish Balay #endif
217e5c89e4eSSatish Balay 
218e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) || !defined(PETSC_HAVE_FORK)
2193ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("System cannot start debugger\n");
2203ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Cray run program in Totalview debugger\n");
2213ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Windows use Developer Studio(MSDEV)\n");
22241e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS);
223e5c89e4eSSatish Balay #else
22463a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetDisplay(display, sizeof(display)))) {
225cfbfffeaSBarry Smith     ierr = (*PetscErrorPrintf)("PetscAttachDebugger: Cannot determine display\n");
22611cc89d2SBarry Smith     return PETSC_ERR_SYS;
2275f80ce2aSJacob Faibussowitsch   }
22863a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetProgramName(program, sizeof(program)))) {
229cfbfffeaSBarry Smith     ierr = (*PetscErrorPrintf)("PetscAttachDebugger: Cannot determine program name needed to attach debugger\n");
23011cc89d2SBarry Smith     return PETSC_ERR_SYS;
231e5c89e4eSSatish Balay   }
2325f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(!program[0])) {
233cfbfffeaSBarry Smith     ierr = (*PetscErrorPrintf)("PetscAttachDebugger: Cannot determine program name needed to attach debugger\n");
234cfbfffeaSBarry Smith     return PETSC_ERR_SYS;
235cfbfffeaSBarry Smith   }
236ca85ed89SBarry Smith   if (PetscUnlikely(!isatty(fileno(stdin))) && !UseDebugTerminal) { printf("If the debugger exits immediately or hangs, this indicates you cannot use PetscAttachDebugger() in this situation\n\n"); }
237e5c89e4eSSatish Balay   child = (int)fork();
2385f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(child < 0)) {
239cfbfffeaSBarry Smith     ierr = (*PetscErrorPrintf)("PetscAttachDebugger: Error in fork() prior to attaching debugger\n");
24011cc89d2SBarry Smith     return PETSC_ERR_SYS;
241e5c89e4eSSatish Balay   }
242bf4d2887SBarry Smith   petscindebugger = PETSC_TRUE;
243e5c89e4eSSatish Balay 
244e5c89e4eSSatish Balay   /*
245e5c89e4eSSatish Balay       Swap role the parent and child. This is (I think) so that control c typed
246e5c89e4eSSatish Balay     in the debugger goes to the correct process.
247e5c89e4eSSatish Balay   */
248234acd79SBarry Smith   #if !defined(PETSC_DO_NOT_SWAP_CHILD_FOR_DEBUGGER)
24963a3b9bcSJacob Faibussowitsch   child = child ? 0 : (int)getppid();
250234acd79SBarry Smith   #endif
251e5c89e4eSSatish Balay 
252e5c89e4eSSatish Balay   if (child) { /* I am the parent, will run the debugger */
253e5c89e4eSSatish Balay     const char *args[10];
254e5c89e4eSSatish Balay     char        pid[10];
2555e96ac45SJed Brown     PetscInt    j, jj;
2560e9bae81SBarry Smith     PetscBool   isdbx, isidb, isxldb, isxxgdb, isups, isxdb, isworkshop, isddd, iskdbg, islldb;
257e5c89e4eSSatish Balay 
2589566063dSJacob Faibussowitsch     PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
259e5c89e4eSSatish Balay     /*
260e5c89e4eSSatish Balay          We need to send a continue signal to the "child" process on the
261e5c89e4eSSatish Balay        alpha, otherwise it just stays off forever
262e5c89e4eSSatish Balay     */
263e5c89e4eSSatish Balay   #if defined(PETSC_NEED_KILL_FOR_DEBUGGER)
264e5c89e4eSSatish Balay     kill(child, SIGCONT);
265e5c89e4eSSatish Balay   #endif
266a364092eSJacob Faibussowitsch     PetscCall(PetscSNPrintf(pid, PETSC_STATIC_ARRAY_LENGTH(pid), "%d", child));
267e5c89e4eSSatish Balay 
2689566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
2699566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
2709566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
2719566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
2729566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
2739566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
2749566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
2759566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "idb", &isidb));
2769566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "workshop", &isworkshop));
2779566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
278e5c89e4eSSatish Balay 
279e5c89e4eSSatish Balay     if (isxxgdb || isups || isddd) {
2809371c9d4SSatish Balay       args[1] = program;
2819371c9d4SSatish Balay       args[2] = pid;
2829371c9d4SSatish Balay       args[3] = "-display";
2839371c9d4SSatish Balay       args[0] = PetscDebugger;
2849371c9d4SSatish Balay       args[4] = display;
2859371c9d4SSatish Balay       args[5] = NULL;
286c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
287e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
288e5c89e4eSSatish Balay         perror("Unable to start debugger");
289e5c89e4eSSatish Balay         exit(0);
290e5c89e4eSSatish Balay       }
291bf902449SSatish Balay     } else if (iskdbg) {
2929371c9d4SSatish Balay       args[1] = "-p";
2939371c9d4SSatish Balay       args[2] = pid;
2949371c9d4SSatish Balay       args[3] = program;
2959371c9d4SSatish Balay       args[4] = "-display";
2969371c9d4SSatish Balay       args[0] = PetscDebugger;
2979371c9d4SSatish Balay       args[5] = display;
2989371c9d4SSatish Balay       args[6] = NULL;
299c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[3], pid, hostname);
300bf902449SSatish Balay       if (execvp(args[0], (char **)args) < 0) {
301bf902449SSatish Balay         perror("Unable to start debugger");
302bf902449SSatish Balay         exit(0);
303bf902449SSatish Balay       }
304e5c89e4eSSatish Balay     } else if (isxldb) {
3059371c9d4SSatish Balay       args[1] = "-a";
3069371c9d4SSatish Balay       args[2] = pid;
3079371c9d4SSatish Balay       args[3] = program;
3089371c9d4SSatish Balay       args[4] = "-display";
3099371c9d4SSatish Balay       args[0] = PetscDebugger;
3109371c9d4SSatish Balay       args[5] = display;
3119371c9d4SSatish Balay       args[6] = NULL;
312c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
313e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
314e5c89e4eSSatish Balay         perror("Unable to start debugger");
315e5c89e4eSSatish Balay         exit(0);
316e5c89e4eSSatish Balay       }
317e5c89e4eSSatish Balay     } else if (isworkshop) {
3189371c9d4SSatish Balay       args[1] = "-s";
3199371c9d4SSatish Balay       args[2] = pid;
3209371c9d4SSatish Balay       args[3] = "-D";
3219371c9d4SSatish Balay       args[4] = "-";
3229371c9d4SSatish Balay       args[0] = PetscDebugger;
3239371c9d4SSatish Balay       args[5] = pid;
3249371c9d4SSatish Balay       args[6] = "-display";
3259371c9d4SSatish Balay       args[7] = display;
3269371c9d4SSatish Balay       args[8] = NULL;
327c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s on %s\n", args[0], pid, hostname);
328e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
329e5c89e4eSSatish Balay         perror("Unable to start debugger");
330e5c89e4eSSatish Balay         exit(0);
331e5c89e4eSSatish Balay       }
3325e96ac45SJed Brown     } else {
3335e96ac45SJed Brown       j = 0;
334c823fc1fSBarry Smith       if (UseDebugTerminal) {
335ace3abfcSBarry Smith         PetscBool cmp;
336bbcf679cSJacob Faibussowitsch         char     *tmp, *tmp1 = NULL;
3379566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "Terminal", 8, &cmp));
338c823fc1fSBarry Smith         if (cmp) {
339c823fc1fSBarry Smith           char command[1024];
3409483a8a2SBarry Smith           if (islldb) PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"lldb  -p %s \"'\n", pid));
3419483a8a2SBarry Smith           else {
3429483a8a2SBarry Smith             char fullprogram[PETSC_MAX_PATH_LEN];
3439483a8a2SBarry Smith             PetscCall(PetscGetFullPath(program, fullprogram, sizeof(fullprogram)));
3449483a8a2SBarry Smith             PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"%s  %s %s \"'\n", PetscDebugger, fullprogram, pid));
3459483a8a2SBarry Smith           }
346accbd18bSBarry Smith   #if defined(PETSC_HAVE_POPEN)
3479566063dSJacob Faibussowitsch           PetscCall(PetscPOpen(PETSC_COMM_SELF, NULL, command, "r", NULL));
348accbd18bSBarry Smith   #else
349accbd18bSBarry Smith           printf("-debug_terminal Terminal is not available on this system since PETSC_HAVE_POPEN is not defined in this configuration\n");
350accbd18bSBarry Smith   #endif
351c823fc1fSBarry Smith           exit(0);
352c823fc1fSBarry Smith         }
353c823fc1fSBarry Smith 
3549566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "screen", 6, &cmp));
3559566063dSJacob Faibussowitsch         if (!cmp) PetscCall(PetscStrncmp(DebugTerminal, "gnome-terminal", 6, &cmp));
3565e96ac45SJed Brown         if (cmp) display[0] = 0; /* when using screen, we never pass -display */
3575e96ac45SJed Brown         args[j++] = tmp = DebugTerminal;
3585e96ac45SJed Brown         if (display[0]) {
3599371c9d4SSatish Balay           args[j++] = "-display";
3609371c9d4SSatish Balay           args[j++] = display;
3615e96ac45SJed Brown         }
3625e96ac45SJed Brown         while (*tmp) {
3639566063dSJacob Faibussowitsch           PetscCall(PetscStrchr(tmp, ' ', &tmp1));
3645e96ac45SJed Brown           if (!tmp1) break;
3655e96ac45SJed Brown           *tmp1     = 0;
3665e96ac45SJed Brown           tmp       = tmp1 + 1;
3675e96ac45SJed Brown           args[j++] = tmp;
3685e96ac45SJed Brown         }
3695e96ac45SJed Brown       }
370b59f628eSBarry Smith       args[j++] = PetscDebugger;
3715e96ac45SJed Brown       jj        = j;
372bf4d2887SBarry Smith       /* this is for default gdb */
373bf4d2887SBarry Smith       args[j++] = program;
374bf4d2887SBarry Smith       args[j++] = pid;
375bf4d2887SBarry Smith       args[j++] = NULL;
3765e96ac45SJed Brown 
377e5c89e4eSSatish Balay       if (isidb) {
3785e96ac45SJed Brown         j         = jj;
3795e96ac45SJed Brown         args[j++] = "-pid";
3805e96ac45SJed Brown         args[j++] = pid;
3815e96ac45SJed Brown         args[j++] = "-gdb";
3825e96ac45SJed Brown         args[j++] = program;
38302c9f0b5SLisandro Dalcin         args[j++] = NULL;
384e5c89e4eSSatish Balay       }
3850e9bae81SBarry Smith       if (islldb) {
3860e9bae81SBarry Smith         j         = jj;
3870e9bae81SBarry Smith         args[j++] = "-p";
3880e9bae81SBarry Smith         args[j++] = pid;
38902c9f0b5SLisandro Dalcin         args[j++] = NULL;
3900e9bae81SBarry Smith       }
391e5c89e4eSSatish Balay       if (isdbx) {
3925e96ac45SJed Brown         j         = jj;
3938d359177SBarry Smith   #if defined(PETSC_USE_P_FOR_DEBUGGER)
3945e96ac45SJed Brown         args[j++] = "-p";
3955e96ac45SJed Brown         args[j++] = pid;
3965e96ac45SJed Brown         args[j++] = program;
397e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
3985e96ac45SJed Brown         args[j++] = "-l";
3995e96ac45SJed Brown         args[j++] = "ALL";
4005e96ac45SJed Brown         args[j++] = "-P";
4015e96ac45SJed Brown         args[j++] = pid;
4025e96ac45SJed Brown         args[j++] = program;
403e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
4045e96ac45SJed Brown         args[j++] = "-a";
4055e96ac45SJed Brown         args[j++] = pid;
406e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
4075e96ac45SJed Brown         args[j++] = "-pid";
4085e96ac45SJed Brown         args[j++] = pid;
4095e96ac45SJed Brown         args[j++] = program;
410493de400SSatish Balay   #else
411493de400SSatish Balay         args[j++] = program;
412493de400SSatish Balay         args[j++] = pid;
4138d359177SBarry Smith   #endif
41402c9f0b5SLisandro Dalcin         args[j++] = NULL;
415e5c89e4eSSatish Balay       }
416c823fc1fSBarry Smith       if (UseDebugTerminal) {
417c5888dd7SBarry Smith         if (display[0]) printf("PETSC: Attaching %s to %s of pid %s on display %s on machine %s\n", PetscDebugger, program, pid, display, hostname);
418c5888dd7SBarry Smith         else printf("PETSC: Attaching %s to %s on pid %s on %s\n", PetscDebugger, program, pid, hostname);
419a297a907SKarl Rupp 
4205e96ac45SJed Brown         if (execvp(args[0], (char **)args) < 0) {
4215e96ac45SJed Brown           perror("Unable to start debugger in xterm");
4225e96ac45SJed Brown           exit(0);
4235e96ac45SJed Brown         }
4245e96ac45SJed Brown       } else {
425c5888dd7SBarry Smith         printf("PETSC: Attaching %s to %s of pid %s on %s\n", PetscDebugger, program, pid, hostname);
426e5c89e4eSSatish Balay         if (execvp(args[0], (char **)args) < 0) {
427e5c89e4eSSatish Balay           perror("Unable to start debugger");
428e5c89e4eSSatish Balay           exit(0);
429e5c89e4eSSatish Balay         }
430e5c89e4eSSatish Balay       }
431e5c89e4eSSatish Balay     }
432e5c89e4eSSatish Balay   } else {          /* I am the child, continue with user code */
433e5c89e4eSSatish Balay     sleeptime = 10; /* default to sleep waiting for debugger */
4349566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetReal(NULL, NULL, "-debugger_pause", &sleeptime, NULL));
435e5c89e4eSSatish Balay     if (sleeptime < 0) sleeptime = -sleeptime;
436e5c89e4eSSatish Balay   #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
437e5c89e4eSSatish Balay     /*
438e5c89e4eSSatish Balay         HP cannot attach process to sleeping debugger, hence count instead
439e5c89e4eSSatish Balay     */
440e5c89e4eSSatish Balay     {
441e5c89e4eSSatish Balay       PetscReal x = 1.0;
442e5c89e4eSSatish Balay       int       i = 10000000;
443e5c89e4eSSatish Balay       while (i--) x++; /* cannot attach to sleeper */
444e5c89e4eSSatish Balay     }
445e5c89e4eSSatish Balay   #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
446e5c89e4eSSatish Balay     /*
447e5c89e4eSSatish Balay         IBM sleep may return at anytime, hence must see if there is more time to sleep
448e5c89e4eSSatish Balay     */
449e5c89e4eSSatish Balay     {
450e5c89e4eSSatish Balay       int left = sleeptime;
451a297a907SKarl Rupp       while (left > 0) left = PetscSleep(left) - 1;
452e5c89e4eSSatish Balay     }
453e5c89e4eSSatish Balay   #else
4543ba16761SJacob Faibussowitsch     PetscCall(PetscSleep(sleeptime));
455e5c89e4eSSatish Balay   #endif
456e5c89e4eSSatish Balay   }
457e5c89e4eSSatish Balay #endif
4583ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
459e5c89e4eSSatish Balay }
460e5c89e4eSSatish Balay 
461e5c89e4eSSatish Balay /*@C
462e5c89e4eSSatish Balay   PetscAttachDebuggerErrorHandler - Error handler that attaches
463e5c89e4eSSatish Balay   a debugger to a running process when an error is detected.
464e5c89e4eSSatish Balay   This routine is useful for examining variables, etc.
465e5c89e4eSSatish Balay 
466e5c89e4eSSatish Balay   Not Collective
467e5c89e4eSSatish Balay 
468e5c89e4eSSatish Balay   Input Parameters:
469e32f2f54SBarry Smith + comm - communicator over which error occurred
470c3cd2bb4SBarry Smith . line - the line number of the error (indicated by `__LINE__`)
471*10450e9eSJacob Faibussowitsch . fun  - the function name
472c3cd2bb4SBarry Smith . file - the file in which the error was detected (indicated by `__FILE__`)
473*10450e9eSJacob Faibussowitsch . mess - an error text string, usually just printed to the screen
474*10450e9eSJacob Faibussowitsch . num  - the generic error number
475811af0c4SBarry Smith . p    - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
476e5c89e4eSSatish Balay - ctx  - error handler context
477e5c89e4eSSatish Balay 
478e5c89e4eSSatish Balay   Level: developer
479e5c89e4eSSatish Balay 
480e5c89e4eSSatish Balay   Notes:
481c3cd2bb4SBarry Smith   By default the Gnu debugger, gdb, is used.  Alternatives are cuda-gdb, lldb, dbx and
482e5c89e4eSSatish Balay   xxgdb,xldb (on IBM rs6000), xdb (on HP-UX).
483e5c89e4eSSatish Balay 
484e5c89e4eSSatish Balay   Most users need not directly employ this routine and the other error
485e5c89e4eSSatish Balay   handlers, but can instead use the simplified interface SETERR, which has
486e5c89e4eSSatish Balay   the calling sequence
487e32f2f54SBarry Smith $     SETERRQ(PETSC_COMM_SELF, number, p, message)
488e5c89e4eSSatish Balay 
489e5c89e4eSSatish Balay   Notes for experienced users:
490811af0c4SBarry Smith   Use `PetscPushErrorHandler()` to set the desired error handler.  The
491e5c89e4eSSatish Balay   currently available PETSc error handlers are
49220f4b53cSBarry Smith .vb
49320f4b53cSBarry Smith     PetscTraceBackErrorHandler()
49420f4b53cSBarry Smith     PetscAttachDebuggerErrorHandler()
49520f4b53cSBarry Smith     PetscAbortErrorHandler()
49620f4b53cSBarry Smith .ve
497e5c89e4eSSatish Balay   or you may write your own.
498e5c89e4eSSatish Balay 
499aec76313SJacob Faibussowitsch   Developer Notes:
500811af0c4SBarry Smith   This routine calls abort instead of returning because if it returned then `MPI_Abort()` would get called which can generate an exception
50169412655SBarry Smith   causing the debugger to be attached again in a cycle.
50269412655SBarry Smith 
503db781477SPatrick Sanan .seealso: `PetscSetDebuggerFromString()`, `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`,
504db781477SPatrick Sanan           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`, `PetscSetDebugTermainal()`
505e5c89e4eSSatish Balay @*/
506d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode num, PetscErrorType p, const char *mess, void *ctx)
507d71ae5a4SJacob Faibussowitsch {
5083ba16761SJacob Faibussowitsch   PetscErrorCode ierr;
509*10450e9eSJacob Faibussowitsch 
510*10450e9eSJacob Faibussowitsch   (void)comm;
511*10450e9eSJacob Faibussowitsch   (void)num;
512*10450e9eSJacob Faibussowitsch   (void)p;
513*10450e9eSJacob Faibussowitsch   (void)ctx;
514e5c89e4eSSatish Balay   if (!mess) mess = " ";
515e5c89e4eSSatish Balay 
5163ba16761SJacob Faibussowitsch   if (fun) ierr = (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
5173ba16761SJacob Faibussowitsch   else ierr = (*PetscErrorPrintf)("%s:%d %s\n", file, line, mess);
518e5c89e4eSSatish Balay 
5193ba16761SJacob Faibussowitsch   ierr = PetscAttachDebugger();
5203ba16761SJacob Faibussowitsch   (void)ierr;
521811af0c4SBarry Smith   abort(); /* call abort because don't want to kill other MPI ranks that may successfully attach to debugger */
5223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
523e5c89e4eSSatish Balay }
524e5c89e4eSSatish Balay 
525e5c89e4eSSatish Balay /*@C
526e5c89e4eSSatish Balay   PetscStopForDebugger - Prints a message to the screen indicating how to
527e5c89e4eSSatish Balay   attach to the process with the debugger and then waits for the
528e5c89e4eSSatish Balay   debugger to attach.
529e5c89e4eSSatish Balay 
530e5c89e4eSSatish Balay   Not Collective
531e5c89e4eSSatish Balay 
532811af0c4SBarry Smith   Options Database Key:
5331f690a00SBarry Smith . -stop_for_debugger - will stop for you to attach the debugger when PetscInitialize() is called
5341f690a00SBarry Smith 
5358d359177SBarry Smith   Level: developer
536e5c89e4eSSatish Balay 
537811af0c4SBarry Smith   Note:
538811af0c4SBarry Smith   This is likely never needed since `PetscAttachDebugger()` is easier to use and seems to always work.
5398d359177SBarry Smith 
540aec76313SJacob Faibussowitsch   Developer Notes:
541811af0c4SBarry Smith   Since this can be called by the error handler, should it be calling `SETERRQ()` and `PetscCall()`?
542f35f84d1SBarry Smith 
543db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
544e5c89e4eSSatish Balay @*/
545d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscStopForDebugger(void)
546d71ae5a4SJacob Faibussowitsch {
547e5c89e4eSSatish Balay   PetscErrorCode ierr;
548e5c89e4eSSatish Balay   PetscInt       sleeptime = 0;
549e5c89e4eSSatish Balay #if !defined(PETSC_CANNOT_START_DEBUGGER)
55051ec2c11SGlenn Hammond   int         ppid;
551e5c89e4eSSatish Balay   PetscMPIInt rank;
552e5c89e4eSSatish Balay   char        program[PETSC_MAX_PATH_LEN], hostname[256];
5538d359177SBarry Smith   PetscBool   isdbx, isxldb, isxxgdb, isddd, iskdbg, isups, isxdb, islldb;
554e5c89e4eSSatish Balay #endif
555e5c89e4eSSatish Balay 
556e5c89e4eSSatish Balay   PetscFunctionBegin;
557e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER)
5583ba16761SJacob Faibussowitsch   PetscCall((*PetscErrorPrintf)("System cannot start debugger; just continuing program\n"));
559e5c89e4eSSatish Balay #else
5603ba16761SJacob Faibussowitsch   if (MPI_Comm_rank(PETSC_COMM_WORLD, &rank)) rank = 0; /* ignore error since this may be already in error handler */
561589a23caSBarry Smith   ierr = PetscGetHostName(hostname, sizeof(hostname));
562e5c89e4eSSatish Balay   if (ierr) {
5633ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine hostname; just continuing program\n"));
5643ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
565e5c89e4eSSatish Balay   }
566e5c89e4eSSatish Balay 
567589a23caSBarry Smith   ierr = PetscGetProgramName(program, sizeof(program));
568e5c89e4eSSatish Balay   if (ierr) {
5693ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
5703ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
571e5c89e4eSSatish Balay   }
572e5c89e4eSSatish Balay   if (!program[0]) {
5733ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
5743ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
575e5c89e4eSSatish Balay   }
576e5c89e4eSSatish Balay 
577e5c89e4eSSatish Balay   ppid = getpid();
578e5c89e4eSSatish Balay 
5799566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
5809566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
5819566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
5829566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
5839566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
5849566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
5859566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
5869566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
587e5c89e4eSSatish Balay 
588c5888dd7SBarry Smith   if (isxxgdb || isups || isddd || iskdbg) printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
589c5888dd7SBarry Smith   else if (isxldb) printf("[%d]%s>>%s -a %d %s\n", rank, hostname, PetscDebugger, ppid, program);
590c5888dd7SBarry Smith   else if (islldb) printf("[%d]%s>>%s -p %d\n", rank, hostname, PetscDebugger, ppid);
5918d359177SBarry Smith   else if (isdbx) {
592e5c89e4eSSatish Balay   #if defined(PETSC_USE_P_FOR_DEBUGGER)
593c5888dd7SBarry Smith     printf("[%d]%s>>%s -p %d %s\n", rank, hostname, PetscDebugger, ppid, program);
594e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
595c5888dd7SBarry Smith     printf("[%d]%s>>%s -l ALL -P %d %s\n", rank, hostname, PetscDebugger, ppid, program);
596e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
597c5888dd7SBarry Smith     printf("[%d]%s>>%s -a %d\n", rank, hostname, PetscDebugger, ppid);
598e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
599c5888dd7SBarry Smith     printf("[%d]%s>>%s -pid %d %s\n", rank, hostname, PetscDebugger, ppid, program);
600e5c89e4eSSatish Balay   #else
601c5888dd7SBarry Smith     printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
602e5c89e4eSSatish Balay   #endif
6038d359177SBarry Smith   }
604e5c89e4eSSatish Balay #endif /* PETSC_CANNOT_START_DEBUGGER */
605e5c89e4eSSatish Balay 
606f35f84d1SBarry Smith   fflush(stdout); /* ignore error because may already be in error handler */
607e5c89e4eSSatish Balay 
608e5c89e4eSSatish Balay   sleeptime = 25;                                                                         /* default to sleep waiting for debugger */
6093ba16761SJacob Faibussowitsch   PetscCallContinue(PetscOptionsGetInt(NULL, NULL, "-debugger_pause", &sleeptime, NULL)); /* ignore error because may already be in error handler */
610e5c89e4eSSatish Balay   if (sleeptime < 0) sleeptime = -sleeptime;
611e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
612e5c89e4eSSatish Balay   /*
613e5c89e4eSSatish Balay       HP cannot attach process to sleeping debugger, hence count instead
614e5c89e4eSSatish Balay   */
615e5c89e4eSSatish Balay   {
6163ba16761SJacob Faibussowitsch     // this *will* get optimized away by any compiler known to man
617e5c89e4eSSatish Balay     PetscReal x = 1.0;
618e5c89e4eSSatish Balay     int       i = 10000000;
619e5c89e4eSSatish Balay     while (i--) x++; /* cannot attach to sleeper */
620e5c89e4eSSatish Balay   }
621e5c89e4eSSatish Balay #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
622e5c89e4eSSatish Balay   /*
623e5c89e4eSSatish Balay       IBM sleep may return at anytime, hence must see if there is more time to sleep
624e5c89e4eSSatish Balay   */
625e5c89e4eSSatish Balay   {
626e5c89e4eSSatish Balay     int left = sleeptime;
627a297a907SKarl Rupp     while (left > 0) left = sleep(left) - 1;
628e5c89e4eSSatish Balay   }
629e5c89e4eSSatish Balay #else
6303ba16761SJacob Faibussowitsch   PetscCall(PetscSleep(sleeptime));
631e5c89e4eSSatish Balay #endif
6323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
633e5c89e4eSSatish Balay }
634