xref: /petsc/src/sys/error/adebug.c (revision 20f4b53cbb5e9bd9ef12b76a8697d60d197cda17)
1e5c89e4eSSatish Balay /*
2e5c89e4eSSatish Balay       Code to handle PETSc starting up in debuggers,etc.
3e5c89e4eSSatish Balay */
4e5c89e4eSSatish Balay 
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.
27c823fc1fSBarry Smith               For example xterm, "urxvt -e", "gnome-terminal -x".
28c823fc1fSBarry Smith               On Apple MacOS you can use Terminal (note the capital T)
295e96ac45SJed Brown 
30811af0c4SBarry Smith    Options Database Key:
31c823fc1fSBarry 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 
38a6404fbfSBarry 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 
44db781477SPatrick Sanan .seealso: `PetscSetDebugger()`
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 
87*20f4b53cSBarry Smith    Not Collective
88e5c89e4eSSatish Balay 
898d359177SBarry Smith     Level: developer
90e5c89e4eSSatish Balay 
91db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDebuggerFromString()`
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 
127*20f4b53cSBarry Smith    Not Collective
128e5c89e4eSSatish Balay 
1297c764164SBarry Smith    Level: developer
130e5c89e4eSSatish Balay 
131db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`
132e5c89e4eSSatish Balay @*/
133d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebuggerFromString(const char *string)
134d71ae5a4SJacob Faibussowitsch {
1350298fd71SBarry Smith   const char *debugger    = NULL;
136c823fc1fSBarry Smith   PetscBool   useterminal = PETSC_TRUE;
137bbcf679cSJacob Faibussowitsch   char       *f           = NULL;
138e5c89e4eSSatish Balay 
139e5c89e4eSSatish Balay   PetscFunctionBegin;
1409566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noxterm", &f));
141c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1429566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "ddd", &f));
143c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1449566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noterminal", &f));
145c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1469566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xdb", string, &debugger));
1479566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("dbx", string, &debugger));
1489566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xldb", string, &debugger));
1499566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("gdb", string, &debugger));
1509566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("cuda-gdb", string, &debugger));
1519566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("idb", string, &debugger));
1529566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xxgdb", string, &debugger));
1539566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ddd", string, &debugger));
1549566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("kdbg", string, &debugger));
1559566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ups", string, &debugger));
1569566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("workshop", string, &debugger));
1579566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pgdbg", string, &debugger));
1589566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pathdb", string, &debugger));
1599566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("lldb", string, &debugger));
1609566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(debugger, useterminal));
1613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
162e5c89e4eSSatish Balay }
163e5c89e4eSSatish Balay 
1642a2a2941SBarry Smith /*@
165811af0c4SBarry Smith    PetscWaitOnError - If an error is detected and the process would normally exit the main program with `MPI_Abort()` sleep instead
1662a2a2941SBarry Smith                       of exiting.
1672a2a2941SBarry Smith 
1682a2a2941SBarry Smith    Not Collective
1692a2a2941SBarry Smith 
1702a2a2941SBarry Smith    Level: advanced
1712a2a2941SBarry Smith 
172811af0c4SBarry Smith    Note:
1732a2a2941SBarry 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
1742a2a2941SBarry Smith       killing the user's debugging sessions.
1752a2a2941SBarry Smith 
176db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
1772a2a2941SBarry Smith @*/
1783274405dSPierre Jolivet PetscErrorCode PetscWaitOnError(void)
179d71ae5a4SJacob Faibussowitsch {
180baae8e41SSatish Balay   petscwaitonerrorflg = PETSC_TRUE;
1813ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
1822a2a2941SBarry Smith }
183e5c89e4eSSatish Balay 
184e30d2299SSatish Balay /*@
185e5c89e4eSSatish Balay    PetscAttachDebugger - Attaches the debugger to the running process.
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay    Not Collective
188e5c89e4eSSatish Balay 
1891f690a00SBarry Smith    Options Database Keys:
1901f690a00SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n] -debug_terminal xterm or Terminal (for Apple)
1911f690a00SBarry Smith .  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
1921f690a00SBarry Smith 
193e5c89e4eSSatish Balay    Level: advanced
194e5c89e4eSSatish Balay 
195811af0c4SBarry Smith    Developer Note:
196811af0c4SBarry Smith     Since this can be called by the error handler should it be calling `SETERRQ()` and `PetscCall()`?
197f35f84d1SBarry Smith 
198db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscSetDebugTerminal()`, `PetscAttachDebuggerErrorHandler()`, `PetscStopForDebugger()`
199e5c89e4eSSatish Balay @*/
200d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebugger(void)
201d71ae5a4SJacob Faibussowitsch {
2023ba16761SJacob Faibussowitsch   PetscErrorCode PETSC_UNUSED ierr;
203ed50d614Sprj- #if !defined(PETSC_CANNOT_START_DEBUGGER) && defined(PETSC_HAVE_FORK)
204e5c89e4eSSatish Balay   int       child     = 0;
205a6d0e24fSJed Brown   PetscReal sleeptime = 0;
206e5c89e4eSSatish Balay   char      program[PETSC_MAX_PATH_LEN], display[256], hostname[64];
207e5c89e4eSSatish Balay #endif
208e5c89e4eSSatish Balay 
209e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) || !defined(PETSC_HAVE_FORK)
2103ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("System cannot start debugger\n");
2113ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Cray run program in Totalview debugger\n");
2123ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Windows use Developer Studio(MSDEV)\n");
21341e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS);
214e5c89e4eSSatish Balay #else
21563a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetDisplay(display, sizeof(display)))) {
2163ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine display\n");
21711cc89d2SBarry Smith     return PETSC_ERR_SYS;
2185f80ce2aSJacob Faibussowitsch   }
21963a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetProgramName(program, sizeof(program)))) {
2203ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22111cc89d2SBarry Smith     return PETSC_ERR_SYS;
222e5c89e4eSSatish Balay   }
2235f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(!program[0])) {
2243ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22511cc89d2SBarry Smith     return PETSC_ERR_SYS;
226e5c89e4eSSatish Balay   }
227e5c89e4eSSatish Balay   child = (int)fork();
2285f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(child < 0)) {
2293ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Error in fork() prior to attaching debugger\n");
23011cc89d2SBarry Smith     return PETSC_ERR_SYS;
231e5c89e4eSSatish Balay   }
232bf4d2887SBarry Smith   petscindebugger = PETSC_TRUE;
233e5c89e4eSSatish Balay 
234e5c89e4eSSatish Balay   /*
235e5c89e4eSSatish Balay       Swap role the parent and child. This is (I think) so that control c typed
236e5c89e4eSSatish Balay     in the debugger goes to the correct process.
237e5c89e4eSSatish Balay   */
238234acd79SBarry Smith   #if !defined(PETSC_DO_NOT_SWAP_CHILD_FOR_DEBUGGER)
23963a3b9bcSJacob Faibussowitsch   child = child ? 0 : (int)getppid();
240234acd79SBarry Smith   #endif
241e5c89e4eSSatish Balay 
242e5c89e4eSSatish Balay   if (child) { /* I am the parent, will run the debugger */
243e5c89e4eSSatish Balay     const char *args[10];
244e5c89e4eSSatish Balay     char        pid[10];
2455e96ac45SJed Brown     PetscInt    j, jj;
2460e9bae81SBarry Smith     PetscBool   isdbx, isidb, isxldb, isxxgdb, isups, isxdb, isworkshop, isddd, iskdbg, islldb;
247e5c89e4eSSatish Balay 
2489566063dSJacob Faibussowitsch     PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
249e5c89e4eSSatish Balay     /*
250e5c89e4eSSatish Balay          We need to send a continue signal to the "child" process on the
251e5c89e4eSSatish Balay        alpha, otherwise it just stays off forever
252e5c89e4eSSatish Balay     */
253e5c89e4eSSatish Balay   #if defined(PETSC_NEED_KILL_FOR_DEBUGGER)
254e5c89e4eSSatish Balay     kill(child, SIGCONT);
255e5c89e4eSSatish Balay   #endif
256a364092eSJacob Faibussowitsch     PetscCall(PetscSNPrintf(pid, PETSC_STATIC_ARRAY_LENGTH(pid), "%d", child));
257e5c89e4eSSatish Balay 
2589566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
2599566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
2609566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
2619566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
2629566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
2639566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
2649566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
2659566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "idb", &isidb));
2669566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "workshop", &isworkshop));
2679566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
268e5c89e4eSSatish Balay 
269e5c89e4eSSatish Balay     if (isxxgdb || isups || isddd) {
2709371c9d4SSatish Balay       args[1] = program;
2719371c9d4SSatish Balay       args[2] = pid;
2729371c9d4SSatish Balay       args[3] = "-display";
2739371c9d4SSatish Balay       args[0] = PetscDebugger;
2749371c9d4SSatish Balay       args[4] = display;
2759371c9d4SSatish Balay       args[5] = NULL;
276c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
277e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
278e5c89e4eSSatish Balay         perror("Unable to start debugger");
279e5c89e4eSSatish Balay         exit(0);
280e5c89e4eSSatish Balay       }
281bf902449SSatish Balay     } else if (iskdbg) {
2829371c9d4SSatish Balay       args[1] = "-p";
2839371c9d4SSatish Balay       args[2] = pid;
2849371c9d4SSatish Balay       args[3] = program;
2859371c9d4SSatish Balay       args[4] = "-display";
2869371c9d4SSatish Balay       args[0] = PetscDebugger;
2879371c9d4SSatish Balay       args[5] = display;
2889371c9d4SSatish Balay       args[6] = NULL;
289c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[3], pid, hostname);
290bf902449SSatish Balay       if (execvp(args[0], (char **)args) < 0) {
291bf902449SSatish Balay         perror("Unable to start debugger");
292bf902449SSatish Balay         exit(0);
293bf902449SSatish Balay       }
294e5c89e4eSSatish Balay     } else if (isxldb) {
2959371c9d4SSatish Balay       args[1] = "-a";
2969371c9d4SSatish Balay       args[2] = pid;
2979371c9d4SSatish Balay       args[3] = program;
2989371c9d4SSatish Balay       args[4] = "-display";
2999371c9d4SSatish Balay       args[0] = PetscDebugger;
3009371c9d4SSatish Balay       args[5] = display;
3019371c9d4SSatish Balay       args[6] = NULL;
302c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
303e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
304e5c89e4eSSatish Balay         perror("Unable to start debugger");
305e5c89e4eSSatish Balay         exit(0);
306e5c89e4eSSatish Balay       }
307e5c89e4eSSatish Balay     } else if (isworkshop) {
3089371c9d4SSatish Balay       args[1] = "-s";
3099371c9d4SSatish Balay       args[2] = pid;
3109371c9d4SSatish Balay       args[3] = "-D";
3119371c9d4SSatish Balay       args[4] = "-";
3129371c9d4SSatish Balay       args[0] = PetscDebugger;
3139371c9d4SSatish Balay       args[5] = pid;
3149371c9d4SSatish Balay       args[6] = "-display";
3159371c9d4SSatish Balay       args[7] = display;
3169371c9d4SSatish Balay       args[8] = NULL;
317c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s on %s\n", args[0], pid, hostname);
318e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
319e5c89e4eSSatish Balay         perror("Unable to start debugger");
320e5c89e4eSSatish Balay         exit(0);
321e5c89e4eSSatish Balay       }
3225e96ac45SJed Brown     } else {
3235e96ac45SJed Brown       j = 0;
324c823fc1fSBarry Smith       if (UseDebugTerminal) {
325ace3abfcSBarry Smith         PetscBool cmp;
326bbcf679cSJacob Faibussowitsch         char     *tmp, *tmp1 = NULL;
3279566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "Terminal", 8, &cmp));
328c823fc1fSBarry Smith         if (cmp) {
329c823fc1fSBarry Smith           char command[1024];
3309483a8a2SBarry Smith           if (islldb) PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"lldb  -p %s \"'\n", pid));
3319483a8a2SBarry Smith           else {
3329483a8a2SBarry Smith             char fullprogram[PETSC_MAX_PATH_LEN];
3339483a8a2SBarry Smith             PetscCall(PetscGetFullPath(program, fullprogram, sizeof(fullprogram)));
3349483a8a2SBarry Smith             PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"%s  %s %s \"'\n", PetscDebugger, fullprogram, pid));
3359483a8a2SBarry Smith           }
336accbd18bSBarry Smith   #if defined(PETSC_HAVE_POPEN)
3379566063dSJacob Faibussowitsch           PetscCall(PetscPOpen(PETSC_COMM_SELF, NULL, command, "r", NULL));
338accbd18bSBarry Smith   #else
339accbd18bSBarry Smith           printf("-debug_terminal Terminal is not available on this system since PETSC_HAVE_POPEN is not defined in this configuration\n");
340accbd18bSBarry Smith   #endif
341c823fc1fSBarry Smith           exit(0);
342c823fc1fSBarry Smith         }
343c823fc1fSBarry Smith 
3449566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "screen", 6, &cmp));
3459566063dSJacob Faibussowitsch         if (!cmp) PetscCall(PetscStrncmp(DebugTerminal, "gnome-terminal", 6, &cmp));
3465e96ac45SJed Brown         if (cmp) display[0] = 0; /* when using screen, we never pass -display */
3475e96ac45SJed Brown         args[j++] = tmp = DebugTerminal;
3485e96ac45SJed Brown         if (display[0]) {
3499371c9d4SSatish Balay           args[j++] = "-display";
3509371c9d4SSatish Balay           args[j++] = display;
3515e96ac45SJed Brown         }
3525e96ac45SJed Brown         while (*tmp) {
3539566063dSJacob Faibussowitsch           PetscCall(PetscStrchr(tmp, ' ', &tmp1));
3545e96ac45SJed Brown           if (!tmp1) break;
3555e96ac45SJed Brown           *tmp1     = 0;
3565e96ac45SJed Brown           tmp       = tmp1 + 1;
3575e96ac45SJed Brown           args[j++] = tmp;
3585e96ac45SJed Brown         }
3595e96ac45SJed Brown       }
360b59f628eSBarry Smith       args[j++] = PetscDebugger;
3615e96ac45SJed Brown       jj        = j;
362bf4d2887SBarry Smith       /* this is for default gdb */
363bf4d2887SBarry Smith       args[j++] = program;
364bf4d2887SBarry Smith       args[j++] = pid;
365bf4d2887SBarry Smith       args[j++] = NULL;
3665e96ac45SJed Brown 
367e5c89e4eSSatish Balay       if (isidb) {
3685e96ac45SJed Brown         j         = jj;
3695e96ac45SJed Brown         args[j++] = "-pid";
3705e96ac45SJed Brown         args[j++] = pid;
3715e96ac45SJed Brown         args[j++] = "-gdb";
3725e96ac45SJed Brown         args[j++] = program;
37302c9f0b5SLisandro Dalcin         args[j++] = NULL;
374e5c89e4eSSatish Balay       }
3750e9bae81SBarry Smith       if (islldb) {
3760e9bae81SBarry Smith         j         = jj;
3770e9bae81SBarry Smith         args[j++] = "-p";
3780e9bae81SBarry Smith         args[j++] = pid;
37902c9f0b5SLisandro Dalcin         args[j++] = NULL;
3800e9bae81SBarry Smith       }
381e5c89e4eSSatish Balay       if (isdbx) {
3825e96ac45SJed Brown         j         = jj;
3838d359177SBarry Smith   #if defined(PETSC_USE_P_FOR_DEBUGGER)
3845e96ac45SJed Brown         args[j++] = "-p";
3855e96ac45SJed Brown         args[j++] = pid;
3865e96ac45SJed Brown         args[j++] = program;
387e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
3885e96ac45SJed Brown         args[j++] = "-l";
3895e96ac45SJed Brown         args[j++] = "ALL";
3905e96ac45SJed Brown         args[j++] = "-P";
3915e96ac45SJed Brown         args[j++] = pid;
3925e96ac45SJed Brown         args[j++] = program;
393e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
3945e96ac45SJed Brown         args[j++] = "-a";
3955e96ac45SJed Brown         args[j++] = pid;
396e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
3975e96ac45SJed Brown         args[j++] = "-pid";
3985e96ac45SJed Brown         args[j++] = pid;
3995e96ac45SJed Brown         args[j++] = program;
400493de400SSatish Balay   #else
401493de400SSatish Balay         args[j++] = program;
402493de400SSatish Balay         args[j++] = pid;
4038d359177SBarry Smith   #endif
40402c9f0b5SLisandro Dalcin         args[j++] = NULL;
405e5c89e4eSSatish Balay       }
406c823fc1fSBarry Smith       if (UseDebugTerminal) {
407c5888dd7SBarry 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);
408c5888dd7SBarry Smith         else printf("PETSC: Attaching %s to %s on pid %s on %s\n", PetscDebugger, program, pid, hostname);
409a297a907SKarl Rupp 
4105e96ac45SJed Brown         if (execvp(args[0], (char **)args) < 0) {
4115e96ac45SJed Brown           perror("Unable to start debugger in xterm");
4125e96ac45SJed Brown           exit(0);
4135e96ac45SJed Brown         }
4145e96ac45SJed Brown       } else {
415c5888dd7SBarry Smith         printf("PETSC: Attaching %s to %s of pid %s on %s\n", PetscDebugger, program, pid, hostname);
416e5c89e4eSSatish Balay         if (execvp(args[0], (char **)args) < 0) {
417e5c89e4eSSatish Balay           perror("Unable to start debugger");
418e5c89e4eSSatish Balay           exit(0);
419e5c89e4eSSatish Balay         }
420e5c89e4eSSatish Balay       }
421e5c89e4eSSatish Balay     }
422e5c89e4eSSatish Balay   } else {          /* I am the child, continue with user code */
423e5c89e4eSSatish Balay     sleeptime = 10; /* default to sleep waiting for debugger */
4249566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetReal(NULL, NULL, "-debugger_pause", &sleeptime, NULL));
425e5c89e4eSSatish Balay     if (sleeptime < 0) sleeptime = -sleeptime;
426e5c89e4eSSatish Balay   #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
427e5c89e4eSSatish Balay     /*
428e5c89e4eSSatish Balay         HP cannot attach process to sleeping debugger, hence count instead
429e5c89e4eSSatish Balay     */
430e5c89e4eSSatish Balay     {
431e5c89e4eSSatish Balay       PetscReal x = 1.0;
432e5c89e4eSSatish Balay       int       i = 10000000;
433e5c89e4eSSatish Balay       while (i--) x++; /* cannot attach to sleeper */
434e5c89e4eSSatish Balay     }
435e5c89e4eSSatish Balay   #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
436e5c89e4eSSatish Balay     /*
437e5c89e4eSSatish Balay         IBM sleep may return at anytime, hence must see if there is more time to sleep
438e5c89e4eSSatish Balay     */
439e5c89e4eSSatish Balay     {
440e5c89e4eSSatish Balay       int left = sleeptime;
441a297a907SKarl Rupp       while (left > 0) left = PetscSleep(left) - 1;
442e5c89e4eSSatish Balay     }
443e5c89e4eSSatish Balay   #else
4443ba16761SJacob Faibussowitsch     PetscCall(PetscSleep(sleeptime));
445e5c89e4eSSatish Balay   #endif
446e5c89e4eSSatish Balay   }
447e5c89e4eSSatish Balay #endif
4483ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
449e5c89e4eSSatish Balay }
450e5c89e4eSSatish Balay 
451e5c89e4eSSatish Balay /*@C
452e5c89e4eSSatish Balay    PetscAttachDebuggerErrorHandler - Error handler that attaches
453e5c89e4eSSatish Balay    a debugger to a running process when an error is detected.
454e5c89e4eSSatish Balay    This routine is useful for examining variables, etc.
455e5c89e4eSSatish Balay 
456e5c89e4eSSatish Balay    Not Collective
457e5c89e4eSSatish Balay 
458e5c89e4eSSatish Balay    Input Parameters:
459e32f2f54SBarry Smith +  comm - communicator over which error occurred
460e32f2f54SBarry Smith .  line - the line number of the error (indicated by __LINE__)
461e5c89e4eSSatish Balay .  file - the file in which the error was detected (indicated by __FILE__)
462e5c89e4eSSatish Balay .  message - an error text string, usually just printed to the screen
463e5c89e4eSSatish Balay .  number - the generic error number
464811af0c4SBarry Smith .  p - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
465e5c89e4eSSatish Balay -  ctx - error handler context
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay    Options Database Keys:
46845b666d6SBarry Smith +  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
46945b666d6SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n]
470e5c89e4eSSatish Balay 
471e5c89e4eSSatish Balay    Level: developer
472e5c89e4eSSatish Balay 
473e5c89e4eSSatish Balay    Notes:
474c4fb7a8fSRichard Tran Mills    By default the GNU debugger, gdb, is used.  Alternatives are cuda-gdb, lldb, dbx and
475e5c89e4eSSatish Balay    xxgdb,xldb (on IBM rs6000), xdb (on HP-UX).
476e5c89e4eSSatish Balay 
477e5c89e4eSSatish Balay    Most users need not directly employ this routine and the other error
478e5c89e4eSSatish Balay    handlers, but can instead use the simplified interface SETERR, which has
479e5c89e4eSSatish Balay    the calling sequence
480e32f2f54SBarry Smith $     SETERRQ(PETSC_COMM_SELF,number,p,message)
481e5c89e4eSSatish Balay 
482e5c89e4eSSatish Balay    Notes for experienced users:
483811af0c4SBarry Smith    Use `PetscPushErrorHandler()` to set the desired error handler.  The
484e5c89e4eSSatish Balay    currently available PETSc error handlers are
485*20f4b53cSBarry Smith .vb
486*20f4b53cSBarry Smith     PetscTraceBackErrorHandler()
487*20f4b53cSBarry Smith     PetscAttachDebuggerErrorHandler()
488*20f4b53cSBarry Smith     PetscAbortErrorHandler()
489*20f4b53cSBarry Smith .ve
490e5c89e4eSSatish Balay   or you may write your own.
491e5c89e4eSSatish Balay 
492811af0c4SBarry Smith    Developer Note:
493811af0c4SBarry Smith      This routine calls abort instead of returning because if it returned then `MPI_Abort()` would get called which can generate an exception
49469412655SBarry Smith      causing the debugger to be attached again in a cycle.
49569412655SBarry Smith 
496db781477SPatrick Sanan .seealso: `PetscSetDebuggerFromString()`, `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`,
497db781477SPatrick Sanan           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`, `PetscSetDebugTermainal()`
498e5c89e4eSSatish Balay @*/
499d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode num, PetscErrorType p, const char *mess, void *ctx)
500d71ae5a4SJacob Faibussowitsch {
5013ba16761SJacob Faibussowitsch   PetscErrorCode ierr;
502e5c89e4eSSatish Balay   if (!mess) mess = " ";
503e5c89e4eSSatish Balay 
5043ba16761SJacob Faibussowitsch   if (fun) ierr = (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
5053ba16761SJacob Faibussowitsch   else ierr = (*PetscErrorPrintf)("%s:%d %s\n", file, line, mess);
506e5c89e4eSSatish Balay 
5073ba16761SJacob Faibussowitsch   ierr = PetscAttachDebugger();
5083ba16761SJacob Faibussowitsch   (void)ierr;
509811af0c4SBarry Smith   abort(); /* call abort because don't want to kill other MPI ranks that may successfully attach to debugger */
5103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
511e5c89e4eSSatish Balay }
512e5c89e4eSSatish Balay 
513e5c89e4eSSatish Balay /*@C
514e5c89e4eSSatish Balay    PetscStopForDebugger - Prints a message to the screen indicating how to
515e5c89e4eSSatish Balay          attach to the process with the debugger and then waits for the
516e5c89e4eSSatish Balay          debugger to attach.
517e5c89e4eSSatish Balay 
518e5c89e4eSSatish Balay    Not Collective
519e5c89e4eSSatish Balay 
520811af0c4SBarry Smith    Options Database Key:
5211f690a00SBarry Smith .   -stop_for_debugger - will stop for you to attach the debugger when PetscInitialize() is called
5221f690a00SBarry Smith 
5238d359177SBarry Smith    Level: developer
524e5c89e4eSSatish Balay 
525811af0c4SBarry Smith    Note:
526811af0c4SBarry Smith     This is likely never needed since `PetscAttachDebugger()` is easier to use and seems to always work.
5278d359177SBarry Smith 
528811af0c4SBarry Smith    Developer Note:
529811af0c4SBarry Smith     Since this can be called by the error handler, should it be calling `SETERRQ()` and `PetscCall()`?
530f35f84d1SBarry Smith 
531db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
532e5c89e4eSSatish Balay @*/
533d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscStopForDebugger(void)
534d71ae5a4SJacob Faibussowitsch {
535e5c89e4eSSatish Balay   PetscErrorCode ierr;
536e5c89e4eSSatish Balay   PetscInt       sleeptime = 0;
537e5c89e4eSSatish Balay #if !defined(PETSC_CANNOT_START_DEBUGGER)
53851ec2c11SGlenn Hammond   int         ppid;
539e5c89e4eSSatish Balay   PetscMPIInt rank;
540e5c89e4eSSatish Balay   char        program[PETSC_MAX_PATH_LEN], hostname[256];
5418d359177SBarry Smith   PetscBool   isdbx, isxldb, isxxgdb, isddd, iskdbg, isups, isxdb, islldb;
542e5c89e4eSSatish Balay #endif
543e5c89e4eSSatish Balay 
544e5c89e4eSSatish Balay   PetscFunctionBegin;
545e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER)
5463ba16761SJacob Faibussowitsch   PetscCall((*PetscErrorPrintf)("System cannot start debugger; just continuing program\n"));
547e5c89e4eSSatish Balay #else
5483ba16761SJacob Faibussowitsch   if (MPI_Comm_rank(PETSC_COMM_WORLD, &rank)) rank = 0; /* ignore error since this may be already in error handler */
549589a23caSBarry Smith   ierr = PetscGetHostName(hostname, sizeof(hostname));
550e5c89e4eSSatish Balay   if (ierr) {
5513ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine hostname; just continuing program\n"));
5523ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
553e5c89e4eSSatish Balay   }
554e5c89e4eSSatish Balay 
555589a23caSBarry Smith   ierr = PetscGetProgramName(program, sizeof(program));
556e5c89e4eSSatish Balay   if (ierr) {
5573ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
5583ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
559e5c89e4eSSatish Balay   }
560e5c89e4eSSatish Balay   if (!program[0]) {
5613ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
5623ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
563e5c89e4eSSatish Balay   }
564e5c89e4eSSatish Balay 
565e5c89e4eSSatish Balay   ppid = getpid();
566e5c89e4eSSatish Balay 
5679566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
5689566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
5699566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
5709566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
5719566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
5729566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
5739566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
5749566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
575e5c89e4eSSatish Balay 
576c5888dd7SBarry Smith   if (isxxgdb || isups || isddd || iskdbg) printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
577c5888dd7SBarry Smith   else if (isxldb) printf("[%d]%s>>%s -a %d %s\n", rank, hostname, PetscDebugger, ppid, program);
578c5888dd7SBarry Smith   else if (islldb) printf("[%d]%s>>%s -p %d\n", rank, hostname, PetscDebugger, ppid);
5798d359177SBarry Smith   else if (isdbx) {
580e5c89e4eSSatish Balay   #if defined(PETSC_USE_P_FOR_DEBUGGER)
581c5888dd7SBarry Smith     printf("[%d]%s>>%s -p %d %s\n", rank, hostname, PetscDebugger, ppid, program);
582e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
583c5888dd7SBarry Smith     printf("[%d]%s>>%s -l ALL -P %d %s\n", rank, hostname, PetscDebugger, ppid, program);
584e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
585c5888dd7SBarry Smith     printf("[%d]%s>>%s -a %d\n", rank, hostname, PetscDebugger, ppid);
586e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
587c5888dd7SBarry Smith     printf("[%d]%s>>%s -pid %d %s\n", rank, hostname, PetscDebugger, ppid, program);
588e5c89e4eSSatish Balay   #else
589c5888dd7SBarry Smith     printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
590e5c89e4eSSatish Balay   #endif
5918d359177SBarry Smith   }
592e5c89e4eSSatish Balay #endif /* PETSC_CANNOT_START_DEBUGGER */
593e5c89e4eSSatish Balay 
594f35f84d1SBarry Smith   fflush(stdout); /* ignore error because may already be in error handler */
595e5c89e4eSSatish Balay 
596e5c89e4eSSatish Balay   sleeptime = 25;                                                                         /* default to sleep waiting for debugger */
5973ba16761SJacob Faibussowitsch   PetscCallContinue(PetscOptionsGetInt(NULL, NULL, "-debugger_pause", &sleeptime, NULL)); /* ignore error because may already be in error handler */
598e5c89e4eSSatish Balay   if (sleeptime < 0) sleeptime = -sleeptime;
599e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
600e5c89e4eSSatish Balay   /*
601e5c89e4eSSatish Balay       HP cannot attach process to sleeping debugger, hence count instead
602e5c89e4eSSatish Balay   */
603e5c89e4eSSatish Balay   {
6043ba16761SJacob Faibussowitsch     // this *will* get optimized away by any compiler known to man
605e5c89e4eSSatish Balay     PetscReal x = 1.0;
606e5c89e4eSSatish Balay     int       i = 10000000;
607e5c89e4eSSatish Balay     while (i--) x++; /* cannot attach to sleeper */
608e5c89e4eSSatish Balay   }
609e5c89e4eSSatish Balay #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
610e5c89e4eSSatish Balay   /*
611e5c89e4eSSatish Balay       IBM sleep may return at anytime, hence must see if there is more time to sleep
612e5c89e4eSSatish Balay   */
613e5c89e4eSSatish Balay   {
614e5c89e4eSSatish Balay     int left = sleeptime;
615a297a907SKarl Rupp     while (left > 0) left = sleep(left) - 1;
616e5c89e4eSSatish Balay   }
617e5c89e4eSSatish Balay #else
6183ba16761SJacob Faibussowitsch   PetscCall(PetscSleep(sleeptime));
619e5c89e4eSSatish Balay #endif
6203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
621e5c89e4eSSatish Balay }
622