xref: /petsc/src/sys/error/adebug.c (revision accbd18bd454ccd9075081900ae464bfc6a7e7b0)
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 
235e96ac45SJed Brown    Not Collective
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 
445e96ac45SJed Brown    Fortran Note:
455e96ac45SJed Brown    This routine is not supported in Fortran.
465e96ac45SJed Brown 
47db781477SPatrick Sanan .seealso: `PetscSetDebugger()`
485e96ac45SJed Brown @*/
49d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebugTerminal(const char terminal[])
50d71ae5a4SJacob Faibussowitsch {
51c823fc1fSBarry Smith   PetscBool xterm;
525e96ac45SJed Brown 
535e96ac45SJed Brown   PetscFunctionBegin;
549566063dSJacob Faibussowitsch   PetscCall(PetscStrncpy(DebugTerminal, terminal, sizeof(DebugTerminal)));
559566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(terminal, "xterm", &xterm));
569566063dSJacob Faibussowitsch   if (xterm) PetscCall(PetscStrlcat(DebugTerminal, " -e", sizeof(DebugTerminal)));
575e96ac45SJed Brown   PetscFunctionReturn(0);
585e96ac45SJed Brown }
595e96ac45SJed Brown 
60e5c89e4eSSatish Balay /*@C
61e5c89e4eSSatish Balay    PetscSetDebugger - Sets options associated with the debugger.
62e5c89e4eSSatish Balay 
63e5c89e4eSSatish Balay    Not Collective
64e5c89e4eSSatish Balay 
65e5c89e4eSSatish Balay    Input Parameters:
66e5c89e4eSSatish Balay +  debugger - name of debugger, which should be in your path,
67c4fb7a8fSRichard Tran Mills               usually "lldb", "dbx", "gdb", "cuda-gdb", "idb", "xxgdb", "kdgb" or "ddd". Also, HP-UX
68e5c89e4eSSatish Balay               supports "xdb", and IBM rs6000 supports "xldb".
69e5c89e4eSSatish Balay 
70c823fc1fSBarry Smith -  usedebugterminal - flag to indicate debugger window, set to either PETSC_TRUE (to indicate
71c823fc1fSBarry Smith             debugger should be started in a new terminal window) or PETSC_FALSE (to start debugger
728d359177SBarry Smith             in initial window (the option PETSC_FALSE makes no sense when using more
738d359177SBarry Smith             than one MPI process.)
74e5c89e4eSSatish Balay 
75e5c89e4eSSatish Balay    Level: developer
76e5c89e4eSSatish Balay 
77e5c89e4eSSatish Balay    Fortran Note:
78e5c89e4eSSatish Balay    This routine is not supported in Fortran.
79e5c89e4eSSatish Balay 
80db781477SPatrick Sanan .seealso: `PetscAttachDebugger()`, `PetscAttachDebuggerErrorHandler()`, `PetscSetDebugTerminal()`
81e5c89e4eSSatish Balay @*/
82d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebugger(const char debugger[], PetscBool usedebugterminal)
83d71ae5a4SJacob Faibussowitsch {
84e5c89e4eSSatish Balay   PetscFunctionBegin;
859566063dSJacob Faibussowitsch   if (debugger) PetscCall(PetscStrncpy(PetscDebugger, debugger, sizeof(PetscDebugger)));
86c823fc1fSBarry Smith   if (UseDebugTerminal) UseDebugTerminal = usedebugterminal;
87e5c89e4eSSatish Balay   PetscFunctionReturn(0);
88e5c89e4eSSatish Balay }
89e5c89e4eSSatish Balay 
908d359177SBarry Smith /*@C
91c823fc1fSBarry Smith     PetscSetDefaultDebugger - Causes PETSc to use its default debugger and output terminal
92e5c89e4eSSatish Balay 
93e5c89e4eSSatish Balay    Not collective
94e5c89e4eSSatish Balay 
958d359177SBarry Smith     Level: developer
96e5c89e4eSSatish Balay 
97db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDebuggerFromString()`
98e5c89e4eSSatish Balay @*/
99d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDefaultDebugger(void)
100d71ae5a4SJacob Faibussowitsch {
101e5c89e4eSSatish Balay   PetscFunctionBegin;
1024211eb48SBarry Smith #if defined(PETSC_USE_DEBUGGER)
1039566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(PETSC_USE_DEBUGGER, PETSC_TRUE));
104e5c89e4eSSatish Balay #endif
105c823fc1fSBarry Smith #if defined(__APPLE__)
1069566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugTerminal("Terminal"));
107c823fc1fSBarry Smith #else
1089566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugTerminal("xterm"));
109c823fc1fSBarry Smith #endif
110e5c89e4eSSatish Balay   PetscFunctionReturn(0);
111e5c89e4eSSatish Balay }
112e5c89e4eSSatish Balay 
113d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscCheckDebugger_Private(const char defaultDbg[], const char string[], const char *debugger[])
114d71ae5a4SJacob Faibussowitsch {
115ace3abfcSBarry Smith   PetscBool exists;
116e5c89e4eSSatish Balay   char     *f;
117e5c89e4eSSatish Balay 
118e5c89e4eSSatish Balay   PetscFunctionBegin;
1199566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, defaultDbg, &f));
120e5c89e4eSSatish Balay   if (f) {
1219566063dSJacob Faibussowitsch     PetscCall(PetscTestFile(string, 'x', &exists));
122a297a907SKarl Rupp     if (exists) *debugger = string;
123a297a907SKarl Rupp     else *debugger = defaultDbg;
124e5c89e4eSSatish Balay   }
125e5c89e4eSSatish Balay   PetscFunctionReturn(0);
126e5c89e4eSSatish Balay }
127e5c89e4eSSatish Balay 
128e5c89e4eSSatish Balay /*@C
129e5c89e4eSSatish Balay     PetscSetDebuggerFromString - Set the complete path for the
130e5c89e4eSSatish Balay        debugger for PETSc to use.
131e5c89e4eSSatish Balay 
132e5c89e4eSSatish Balay    Not collective
133e5c89e4eSSatish Balay 
1347c764164SBarry Smith    Level: developer
135e5c89e4eSSatish Balay 
136db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`
137e5c89e4eSSatish Balay @*/
138d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebuggerFromString(const char *string)
139d71ae5a4SJacob Faibussowitsch {
1400298fd71SBarry Smith   const char *debugger    = NULL;
141c823fc1fSBarry Smith   PetscBool   useterminal = PETSC_TRUE;
142e5c89e4eSSatish Balay   char       *f;
143e5c89e4eSSatish Balay 
144e5c89e4eSSatish Balay   PetscFunctionBegin;
1459566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noxterm", &f));
146c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1479566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "ddd", &f));
148c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1499566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noterminal", &f));
150c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1519566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xdb", string, &debugger));
1529566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("dbx", string, &debugger));
1539566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xldb", string, &debugger));
1549566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("gdb", string, &debugger));
1559566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("cuda-gdb", string, &debugger));
1569566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("idb", string, &debugger));
1579566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xxgdb", string, &debugger));
1589566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ddd", string, &debugger));
1599566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("kdbg", string, &debugger));
1609566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ups", string, &debugger));
1619566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("workshop", string, &debugger));
1629566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pgdbg", string, &debugger));
1639566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pathdb", string, &debugger));
1649566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("lldb", string, &debugger));
1659566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(debugger, useterminal));
166e5c89e4eSSatish Balay   PetscFunctionReturn(0);
167e5c89e4eSSatish Balay }
168e5c89e4eSSatish Balay 
1692a2a2941SBarry Smith /*@
170811af0c4SBarry Smith    PetscWaitOnError - If an error is detected and the process would normally exit the main program with `MPI_Abort()` sleep instead
1712a2a2941SBarry Smith                       of exiting.
1722a2a2941SBarry Smith 
1732a2a2941SBarry Smith    Not Collective
1742a2a2941SBarry Smith 
1752a2a2941SBarry Smith    Level: advanced
1762a2a2941SBarry Smith 
177811af0c4SBarry Smith    Note:
1782a2a2941SBarry 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
1792a2a2941SBarry Smith       killing the user's debugging sessions.
1802a2a2941SBarry Smith 
181db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
1822a2a2941SBarry Smith @*/
183d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscWaitOnError()
184d71ae5a4SJacob Faibussowitsch {
185baae8e41SSatish Balay   petscwaitonerrorflg = PETSC_TRUE;
1862a2a2941SBarry Smith   return 0;
1872a2a2941SBarry Smith }
188e5c89e4eSSatish Balay 
189e30d2299SSatish Balay /*@
190e5c89e4eSSatish Balay    PetscAttachDebugger - Attaches the debugger to the running process.
191e5c89e4eSSatish Balay 
192e5c89e4eSSatish Balay    Not Collective
193e5c89e4eSSatish Balay 
1941f690a00SBarry Smith    Options Database Keys:
1951f690a00SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n] -debug_terminal xterm or Terminal (for Apple)
1961f690a00SBarry Smith .  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
1971f690a00SBarry Smith 
198e5c89e4eSSatish Balay    Level: advanced
199e5c89e4eSSatish Balay 
200811af0c4SBarry Smith    Developer Note:
201811af0c4SBarry Smith     Since this can be called by the error handler should it be calling `SETERRQ()` and `PetscCall()`?
202f35f84d1SBarry Smith 
203db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscSetDebugTerminal()`, `PetscAttachDebuggerErrorHandler()`, `PetscStopForDebugger()`
204e5c89e4eSSatish Balay @*/
205d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebugger(void)
206d71ae5a4SJacob Faibussowitsch {
207ed50d614Sprj- #if !defined(PETSC_CANNOT_START_DEBUGGER) && defined(PETSC_HAVE_FORK)
208e5c89e4eSSatish Balay   int       child     = 0;
209a6d0e24fSJed Brown   PetscReal sleeptime = 0;
210e5c89e4eSSatish Balay   char      program[PETSC_MAX_PATH_LEN], display[256], hostname[64];
211e5c89e4eSSatish Balay #endif
212e5c89e4eSSatish Balay 
213e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) || !defined(PETSC_HAVE_FORK)
214e5c89e4eSSatish Balay   (*PetscErrorPrintf)("System cannot start debugger\n");
215e5c89e4eSSatish Balay   (*PetscErrorPrintf)("On Cray run program in Totalview debugger\n");
216e5c89e4eSSatish Balay   (*PetscErrorPrintf)("On Windows use Developer Studio(MSDEV)\n");
21741e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS);
218e5c89e4eSSatish Balay #else
21963a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetDisplay(display, sizeof(display)))) {
2205f80ce2aSJacob Faibussowitsch     (*PetscErrorPrintf)("Cannot determine display\n");
22111cc89d2SBarry Smith     return PETSC_ERR_SYS;
2225f80ce2aSJacob Faibussowitsch   }
22363a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetProgramName(program, sizeof(program)))) {
22411cc89d2SBarry Smith     (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22511cc89d2SBarry Smith     return PETSC_ERR_SYS;
226e5c89e4eSSatish Balay   }
2275f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(!program[0])) {
22811cc89d2SBarry Smith     (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22911cc89d2SBarry Smith     return PETSC_ERR_SYS;
230e5c89e4eSSatish Balay   }
231e5c89e4eSSatish Balay   child = (int)fork();
2325f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(child < 0)) {
233a995a477SBarry Smith     (*PetscErrorPrintf)("Error in fork() prior to attaching debugger\n");
23411cc89d2SBarry Smith     return PETSC_ERR_SYS;
235e5c89e4eSSatish Balay   }
236bf4d2887SBarry Smith   petscindebugger = PETSC_TRUE;
237e5c89e4eSSatish Balay 
238e5c89e4eSSatish Balay   /*
239e5c89e4eSSatish Balay       Swap role the parent and child. This is (I think) so that control c typed
240e5c89e4eSSatish Balay     in the debugger goes to the correct process.
241e5c89e4eSSatish Balay   */
242234acd79SBarry Smith   #if !defined(PETSC_DO_NOT_SWAP_CHILD_FOR_DEBUGGER)
24363a3b9bcSJacob Faibussowitsch   child = child ? 0 : (int)getppid();
244234acd79SBarry Smith   #endif
245e5c89e4eSSatish Balay 
246e5c89e4eSSatish Balay   if (child) { /* I am the parent, will run the debugger */
247e5c89e4eSSatish Balay     const char *args[10];
248e5c89e4eSSatish Balay     char        pid[10];
2495e96ac45SJed Brown     PetscInt    j, jj;
2500e9bae81SBarry Smith     PetscBool   isdbx, isidb, isxldb, isxxgdb, isups, isxdb, isworkshop, isddd, iskdbg, islldb;
251e5c89e4eSSatish Balay 
2529566063dSJacob Faibussowitsch     PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
253e5c89e4eSSatish Balay     /*
254e5c89e4eSSatish Balay          We need to send a continue signal to the "child" process on the
255e5c89e4eSSatish Balay        alpha, otherwise it just stays off forever
256e5c89e4eSSatish Balay     */
257e5c89e4eSSatish Balay   #if defined(PETSC_NEED_KILL_FOR_DEBUGGER)
258e5c89e4eSSatish Balay     kill(child, SIGCONT);
259e5c89e4eSSatish Balay   #endif
260e5c89e4eSSatish Balay     sprintf(pid, "%d", child);
261e5c89e4eSSatish Balay 
2629566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
2639566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
2649566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
2659566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
2669566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
2679566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
2689566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
2699566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "idb", &isidb));
2709566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "workshop", &isworkshop));
2719566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
272e5c89e4eSSatish Balay 
273e5c89e4eSSatish Balay     if (isxxgdb || isups || isddd) {
2749371c9d4SSatish Balay       args[1] = program;
2759371c9d4SSatish Balay       args[2] = pid;
2769371c9d4SSatish Balay       args[3] = "-display";
2779371c9d4SSatish Balay       args[0] = PetscDebugger;
2789371c9d4SSatish Balay       args[4] = display;
2799371c9d4SSatish Balay       args[5] = NULL;
280c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
281e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
282e5c89e4eSSatish Balay         perror("Unable to start debugger");
283e5c89e4eSSatish Balay         exit(0);
284e5c89e4eSSatish Balay       }
285bf902449SSatish Balay     } else if (iskdbg) {
2869371c9d4SSatish Balay       args[1] = "-p";
2879371c9d4SSatish Balay       args[2] = pid;
2889371c9d4SSatish Balay       args[3] = program;
2899371c9d4SSatish Balay       args[4] = "-display";
2909371c9d4SSatish Balay       args[0] = PetscDebugger;
2919371c9d4SSatish Balay       args[5] = display;
2929371c9d4SSatish Balay       args[6] = NULL;
293c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[3], pid, hostname);
294bf902449SSatish Balay       if (execvp(args[0], (char **)args) < 0) {
295bf902449SSatish Balay         perror("Unable to start debugger");
296bf902449SSatish Balay         exit(0);
297bf902449SSatish Balay       }
298e5c89e4eSSatish Balay     } else if (isxldb) {
2999371c9d4SSatish Balay       args[1] = "-a";
3009371c9d4SSatish Balay       args[2] = pid;
3019371c9d4SSatish Balay       args[3] = program;
3029371c9d4SSatish Balay       args[4] = "-display";
3039371c9d4SSatish Balay       args[0] = PetscDebugger;
3049371c9d4SSatish Balay       args[5] = display;
3059371c9d4SSatish Balay       args[6] = NULL;
306c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
307e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
308e5c89e4eSSatish Balay         perror("Unable to start debugger");
309e5c89e4eSSatish Balay         exit(0);
310e5c89e4eSSatish Balay       }
311e5c89e4eSSatish Balay     } else if (isworkshop) {
3129371c9d4SSatish Balay       args[1] = "-s";
3139371c9d4SSatish Balay       args[2] = pid;
3149371c9d4SSatish Balay       args[3] = "-D";
3159371c9d4SSatish Balay       args[4] = "-";
3169371c9d4SSatish Balay       args[0] = PetscDebugger;
3179371c9d4SSatish Balay       args[5] = pid;
3189371c9d4SSatish Balay       args[6] = "-display";
3199371c9d4SSatish Balay       args[7] = display;
3209371c9d4SSatish Balay       args[8] = NULL;
321c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s on %s\n", args[0], pid, hostname);
322e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
323e5c89e4eSSatish Balay         perror("Unable to start debugger");
324e5c89e4eSSatish Balay         exit(0);
325e5c89e4eSSatish Balay       }
3265e96ac45SJed Brown     } else {
3275e96ac45SJed Brown       j = 0;
328c823fc1fSBarry Smith       if (UseDebugTerminal) {
329ace3abfcSBarry Smith         PetscBool cmp;
3305e96ac45SJed Brown         char     *tmp, *tmp1;
3319566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "Terminal", 8, &cmp));
332c823fc1fSBarry Smith         if (cmp) {
333c823fc1fSBarry Smith           char command[1024];
3349483a8a2SBarry Smith           if (islldb) PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"lldb  -p %s \"'\n", pid));
3359483a8a2SBarry Smith           else {
3369483a8a2SBarry Smith             char fullprogram[PETSC_MAX_PATH_LEN];
3379483a8a2SBarry Smith             PetscCall(PetscGetFullPath(program, fullprogram, sizeof(fullprogram)));
3389483a8a2SBarry Smith             PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"%s  %s %s \"'\n", PetscDebugger, fullprogram, pid));
3399483a8a2SBarry Smith           }
340*accbd18bSBarry Smith   #if defined(PETSC_HAVE_POPEN)
3419566063dSJacob Faibussowitsch           PetscCall(PetscPOpen(PETSC_COMM_SELF, NULL, command, "r", NULL));
342*accbd18bSBarry Smith   #else
343*accbd18bSBarry Smith           printf("-debug_terminal Terminal is not available on this system since PETSC_HAVE_POPEN is not defined in this configuration\n");
344*accbd18bSBarry Smith   #endif
345c823fc1fSBarry Smith           exit(0);
346c823fc1fSBarry Smith         }
347c823fc1fSBarry Smith 
3489566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "screen", 6, &cmp));
3499566063dSJacob Faibussowitsch         if (!cmp) PetscCall(PetscStrncmp(DebugTerminal, "gnome-terminal", 6, &cmp));
3505e96ac45SJed Brown         if (cmp) display[0] = 0; /* when using screen, we never pass -display */
3515e96ac45SJed Brown         args[j++] = tmp = DebugTerminal;
3525e96ac45SJed Brown         if (display[0]) {
3539371c9d4SSatish Balay           args[j++] = "-display";
3549371c9d4SSatish Balay           args[j++] = display;
3555e96ac45SJed Brown         }
3565e96ac45SJed Brown         while (*tmp) {
3579566063dSJacob Faibussowitsch           PetscCall(PetscStrchr(tmp, ' ', &tmp1));
3585e96ac45SJed Brown           if (!tmp1) break;
3595e96ac45SJed Brown           *tmp1     = 0;
3605e96ac45SJed Brown           tmp       = tmp1 + 1;
3615e96ac45SJed Brown           args[j++] = tmp;
3625e96ac45SJed Brown         }
3635e96ac45SJed Brown       }
364b59f628eSBarry Smith       args[j++] = PetscDebugger;
3655e96ac45SJed Brown       jj        = j;
366bf4d2887SBarry Smith       /* this is for default gdb */
367bf4d2887SBarry Smith       args[j++] = program;
368bf4d2887SBarry Smith       args[j++] = pid;
369bf4d2887SBarry Smith       args[j++] = NULL;
3705e96ac45SJed Brown 
371e5c89e4eSSatish Balay       if (isidb) {
3725e96ac45SJed Brown         j         = jj;
3735e96ac45SJed Brown         args[j++] = "-pid";
3745e96ac45SJed Brown         args[j++] = pid;
3755e96ac45SJed Brown         args[j++] = "-gdb";
3765e96ac45SJed Brown         args[j++] = program;
37702c9f0b5SLisandro Dalcin         args[j++] = NULL;
378e5c89e4eSSatish Balay       }
3790e9bae81SBarry Smith       if (islldb) {
3800e9bae81SBarry Smith         j         = jj;
3810e9bae81SBarry Smith         args[j++] = "-p";
3820e9bae81SBarry Smith         args[j++] = pid;
38302c9f0b5SLisandro Dalcin         args[j++] = NULL;
3840e9bae81SBarry Smith       }
385e5c89e4eSSatish Balay       if (isdbx) {
3865e96ac45SJed Brown         j         = jj;
3878d359177SBarry Smith   #if defined(PETSC_USE_P_FOR_DEBUGGER)
3885e96ac45SJed Brown         args[j++] = "-p";
3895e96ac45SJed Brown         args[j++] = pid;
3905e96ac45SJed Brown         args[j++] = program;
391e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
3925e96ac45SJed Brown         args[j++] = "-l";
3935e96ac45SJed Brown         args[j++] = "ALL";
3945e96ac45SJed Brown         args[j++] = "-P";
3955e96ac45SJed Brown         args[j++] = pid;
3965e96ac45SJed Brown         args[j++] = program;
397e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
3985e96ac45SJed Brown         args[j++] = "-a";
3995e96ac45SJed Brown         args[j++] = pid;
400e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
4015e96ac45SJed Brown         args[j++] = "-pid";
4025e96ac45SJed Brown         args[j++] = pid;
4035e96ac45SJed Brown         args[j++] = program;
404493de400SSatish Balay   #else
405493de400SSatish Balay         args[j++] = program;
406493de400SSatish Balay         args[j++] = pid;
4078d359177SBarry Smith   #endif
40802c9f0b5SLisandro Dalcin         args[j++] = NULL;
409e5c89e4eSSatish Balay       }
410c823fc1fSBarry Smith       if (UseDebugTerminal) {
411c5888dd7SBarry 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);
412c5888dd7SBarry Smith         else printf("PETSC: Attaching %s to %s on pid %s on %s\n", PetscDebugger, program, pid, hostname);
413a297a907SKarl Rupp 
4145e96ac45SJed Brown         if (execvp(args[0], (char **)args) < 0) {
4155e96ac45SJed Brown           perror("Unable to start debugger in xterm");
4165e96ac45SJed Brown           exit(0);
4175e96ac45SJed Brown         }
4185e96ac45SJed Brown       } else {
419c5888dd7SBarry Smith         printf("PETSC: Attaching %s to %s of pid %s on %s\n", PetscDebugger, program, pid, hostname);
420e5c89e4eSSatish Balay         if (execvp(args[0], (char **)args) < 0) {
421e5c89e4eSSatish Balay           perror("Unable to start debugger");
422e5c89e4eSSatish Balay           exit(0);
423e5c89e4eSSatish Balay         }
424e5c89e4eSSatish Balay       }
425e5c89e4eSSatish Balay     }
426e5c89e4eSSatish Balay   } else {          /* I am the child, continue with user code */
427e5c89e4eSSatish Balay     sleeptime = 10; /* default to sleep waiting for debugger */
4289566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetReal(NULL, NULL, "-debugger_pause", &sleeptime, NULL));
429e5c89e4eSSatish Balay     if (sleeptime < 0) sleeptime = -sleeptime;
430e5c89e4eSSatish Balay   #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
431e5c89e4eSSatish Balay     /*
432e5c89e4eSSatish Balay         HP cannot attach process to sleeping debugger, hence count instead
433e5c89e4eSSatish Balay     */
434e5c89e4eSSatish Balay     {
435e5c89e4eSSatish Balay       PetscReal x = 1.0;
436e5c89e4eSSatish Balay       int       i = 10000000;
437e5c89e4eSSatish Balay       while (i--) x++; /* cannot attach to sleeper */
438e5c89e4eSSatish Balay     }
439e5c89e4eSSatish Balay   #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
440e5c89e4eSSatish Balay     /*
441e5c89e4eSSatish Balay         IBM sleep may return at anytime, hence must see if there is more time to sleep
442e5c89e4eSSatish Balay     */
443e5c89e4eSSatish Balay     {
444e5c89e4eSSatish Balay       int left = sleeptime;
445a297a907SKarl Rupp       while (left > 0) left = PetscSleep(left) - 1;
446e5c89e4eSSatish Balay     }
447e5c89e4eSSatish Balay   #else
448e5c89e4eSSatish Balay     PetscSleep(sleeptime);
449e5c89e4eSSatish Balay   #endif
450e5c89e4eSSatish Balay   }
451e5c89e4eSSatish Balay #endif
45211cc89d2SBarry Smith   return 0;
453e5c89e4eSSatish Balay }
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay /*@C
456e5c89e4eSSatish Balay    PetscAttachDebuggerErrorHandler - Error handler that attaches
457e5c89e4eSSatish Balay    a debugger to a running process when an error is detected.
458e5c89e4eSSatish Balay    This routine is useful for examining variables, etc.
459e5c89e4eSSatish Balay 
460e5c89e4eSSatish Balay    Not Collective
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay    Input Parameters:
463e32f2f54SBarry Smith +  comm - communicator over which error occurred
464e32f2f54SBarry Smith .  line - the line number of the error (indicated by __LINE__)
465e5c89e4eSSatish Balay .  file - the file in which the error was detected (indicated by __FILE__)
466e5c89e4eSSatish Balay .  message - an error text string, usually just printed to the screen
467e5c89e4eSSatish Balay .  number - the generic error number
468811af0c4SBarry Smith .  p - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
469e5c89e4eSSatish Balay -  ctx - error handler context
470e5c89e4eSSatish Balay 
471e5c89e4eSSatish Balay    Options Database Keys:
47245b666d6SBarry Smith +  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
47345b666d6SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n]
474e5c89e4eSSatish Balay 
475e5c89e4eSSatish Balay    Level: developer
476e5c89e4eSSatish Balay 
477e5c89e4eSSatish Balay    Notes:
478c4fb7a8fSRichard Tran Mills    By default the GNU debugger, gdb, is used.  Alternatives are cuda-gdb, lldb, dbx and
479e5c89e4eSSatish Balay    xxgdb,xldb (on IBM rs6000), xdb (on HP-UX).
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay    Most users need not directly employ this routine and the other error
482e5c89e4eSSatish Balay    handlers, but can instead use the simplified interface SETERR, which has
483e5c89e4eSSatish Balay    the calling sequence
484e32f2f54SBarry Smith $     SETERRQ(PETSC_COMM_SELF,number,p,message)
485e5c89e4eSSatish Balay 
486e5c89e4eSSatish Balay    Notes for experienced users:
487811af0c4SBarry Smith    Use `PetscPushErrorHandler()` to set the desired error handler.  The
488e5c89e4eSSatish Balay    currently available PETSc error handlers are
489e5c89e4eSSatish Balay $    PetscTraceBackErrorHandler()
490e5c89e4eSSatish Balay $    PetscAttachDebuggerErrorHandler()
491e5c89e4eSSatish Balay $    PetscAbortErrorHandler()
492e5c89e4eSSatish Balay    or you may write your own.
493e5c89e4eSSatish Balay 
494811af0c4SBarry Smith    Developer Note:
495811af0c4SBarry Smith      This routine calls abort instead of returning because if it returned then `MPI_Abort()` would get called which can generate an exception
49669412655SBarry Smith      causing the debugger to be attached again in a cycle.
49769412655SBarry Smith 
498db781477SPatrick Sanan .seealso: `PetscSetDebuggerFromString()`, `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`,
499db781477SPatrick Sanan           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`, `PetscSetDebugTermainal()`
500e5c89e4eSSatish Balay @*/
501d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode num, PetscErrorType p, const char *mess, void *ctx)
502d71ae5a4SJacob Faibussowitsch {
503e5c89e4eSSatish Balay   if (!mess) mess = " ";
504e5c89e4eSSatish Balay 
50549c86fc7SBarry Smith   if (fun) (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
50649c86fc7SBarry Smith   else (*PetscErrorPrintf)("%s:%d %s\n", file, line, mess);
507e5c89e4eSSatish Balay 
50869412655SBarry Smith   PetscAttachDebugger();
509811af0c4SBarry Smith   abort(); /* call abort because don't want to kill other MPI ranks that may successfully attach to debugger */
510811af0c4SBarry Smith   PetscFunctionReturn(0);
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)
546e5c89e4eSSatish Balay   (*PetscErrorPrintf)("System cannot start debugger; just continuing program\n");
547e5c89e4eSSatish Balay #else
548e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);
549f35f84d1SBarry Smith   if (ierr) rank = 0; /* ignore error since this may be already in error handler */
550589a23caSBarry Smith   ierr = PetscGetHostName(hostname, sizeof(hostname));
551e5c89e4eSSatish Balay   if (ierr) {
552e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Cannot determine hostname; just continuing program\n");
553e5c89e4eSSatish Balay     PetscFunctionReturn(0);
554e5c89e4eSSatish Balay   }
555e5c89e4eSSatish Balay 
556589a23caSBarry Smith   ierr = PetscGetProgramName(program, sizeof(program));
557e5c89e4eSSatish Balay   if (ierr) {
558e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Cannot determine program name; just continuing program\n");
559e5c89e4eSSatish Balay     PetscFunctionReturn(0);
560e5c89e4eSSatish Balay   }
561e5c89e4eSSatish Balay   if (!program[0]) {
562e5c89e4eSSatish Balay     (*PetscErrorPrintf)("Cannot determine program name; just continuing program\n");
563e5c89e4eSSatish Balay     PetscFunctionReturn(0);
564e5c89e4eSSatish Balay   }
565e5c89e4eSSatish Balay 
566e5c89e4eSSatish Balay   ppid = getpid();
567e5c89e4eSSatish Balay 
5689566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
5699566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
5709566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
5719566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
5729566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
5739566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
5749566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
5759566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
576e5c89e4eSSatish Balay 
577c5888dd7SBarry Smith   if (isxxgdb || isups || isddd || iskdbg) printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
578c5888dd7SBarry Smith   else if (isxldb) printf("[%d]%s>>%s -a %d %s\n", rank, hostname, PetscDebugger, ppid, program);
579c5888dd7SBarry Smith   else if (islldb) printf("[%d]%s>>%s -p %d\n", rank, hostname, PetscDebugger, ppid);
5808d359177SBarry Smith   else if (isdbx) {
581e5c89e4eSSatish Balay   #if defined(PETSC_USE_P_FOR_DEBUGGER)
582c5888dd7SBarry Smith     printf("[%d]%s>>%s -p %d %s\n", rank, hostname, PetscDebugger, ppid, program);
583e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
584c5888dd7SBarry Smith     printf("[%d]%s>>%s -l ALL -P %d %s\n", rank, hostname, PetscDebugger, ppid, program);
585e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
586c5888dd7SBarry Smith     printf("[%d]%s>>%s -a %d\n", rank, hostname, PetscDebugger, ppid);
587e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
588c5888dd7SBarry Smith     printf("[%d]%s>>%s -pid %d %s\n", rank, hostname, PetscDebugger, ppid, program);
589e5c89e4eSSatish Balay   #else
590c5888dd7SBarry Smith     printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
591e5c89e4eSSatish Balay   #endif
5928d359177SBarry Smith   }
593e5c89e4eSSatish Balay #endif /* PETSC_CANNOT_START_DEBUGGER */
594e5c89e4eSSatish Balay 
595f35f84d1SBarry Smith   fflush(stdout); /* ignore error because may already be in error handler */
596e5c89e4eSSatish Balay 
597e5c89e4eSSatish Balay   sleeptime = 25;                                                      /* default to sleep waiting for debugger */
598c5929fdfSBarry Smith   PetscOptionsGetInt(NULL, NULL, "-debugger_pause", &sleeptime, NULL); /* ignore error because may already be in error handler */
599e5c89e4eSSatish Balay   if (sleeptime < 0) sleeptime = -sleeptime;
600e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
601e5c89e4eSSatish Balay   /*
602e5c89e4eSSatish Balay       HP cannot attach process to sleeping debugger, hence count instead
603e5c89e4eSSatish Balay   */
604e5c89e4eSSatish Balay   {
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
618e5c89e4eSSatish Balay   PetscSleep(sleeptime);
619e5c89e4eSSatish Balay #endif
620e5c89e4eSSatish Balay   PetscFunctionReturn(0);
621e5c89e4eSSatish Balay }
622