xref: /petsc/src/sys/error/adebug.c (revision 3ba1676111f5c958fe6c2729b46ca4d523958bb3)
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)));
54*3ba16761SJacob 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;
81*3ba16761SJacob 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 
87e5c89e4eSSatish Balay    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
104*3ba16761SJacob 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 {
109ace3abfcSBarry Smith   PetscBool exists;
110e5c89e4eSSatish Balay   char     *f;
111e5c89e4eSSatish Balay 
112e5c89e4eSSatish Balay   PetscFunctionBegin;
1139566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, defaultDbg, &f));
114e5c89e4eSSatish Balay   if (f) {
1159566063dSJacob Faibussowitsch     PetscCall(PetscTestFile(string, 'x', &exists));
116a297a907SKarl Rupp     if (exists) *debugger = string;
117a297a907SKarl Rupp     else *debugger = defaultDbg;
118e5c89e4eSSatish Balay   }
119*3ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
120e5c89e4eSSatish Balay }
121e5c89e4eSSatish Balay 
122e5c89e4eSSatish Balay /*@C
123e5c89e4eSSatish Balay     PetscSetDebuggerFromString - Set the complete path for the
124e5c89e4eSSatish Balay        debugger for PETSc to use.
125e5c89e4eSSatish Balay 
126e5c89e4eSSatish Balay    Not collective
127e5c89e4eSSatish Balay 
1287c764164SBarry Smith    Level: developer
129e5c89e4eSSatish Balay 
130db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`
131e5c89e4eSSatish Balay @*/
132d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscSetDebuggerFromString(const char *string)
133d71ae5a4SJacob Faibussowitsch {
1340298fd71SBarry Smith   const char *debugger    = NULL;
135c823fc1fSBarry Smith   PetscBool   useterminal = PETSC_TRUE;
136e5c89e4eSSatish Balay   char       *f;
137e5c89e4eSSatish Balay 
138e5c89e4eSSatish Balay   PetscFunctionBegin;
1399566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noxterm", &f));
140c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1419566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "ddd", &f));
142c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1439566063dSJacob Faibussowitsch   PetscCall(PetscStrstr(string, "noterminal", &f));
144c823fc1fSBarry Smith   if (f) useterminal = PETSC_FALSE;
1459566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xdb", string, &debugger));
1469566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("dbx", string, &debugger));
1479566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xldb", string, &debugger));
1489566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("gdb", string, &debugger));
1499566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("cuda-gdb", string, &debugger));
1509566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("idb", string, &debugger));
1519566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("xxgdb", string, &debugger));
1529566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ddd", string, &debugger));
1539566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("kdbg", string, &debugger));
1549566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("ups", string, &debugger));
1559566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("workshop", string, &debugger));
1569566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pgdbg", string, &debugger));
1579566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("pathdb", string, &debugger));
1589566063dSJacob Faibussowitsch   PetscCall(PetscCheckDebugger_Private("lldb", string, &debugger));
1599566063dSJacob Faibussowitsch   PetscCall(PetscSetDebugger(debugger, useterminal));
160*3ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
161e5c89e4eSSatish Balay }
162e5c89e4eSSatish Balay 
1632a2a2941SBarry Smith /*@
164811af0c4SBarry Smith    PetscWaitOnError - If an error is detected and the process would normally exit the main program with `MPI_Abort()` sleep instead
1652a2a2941SBarry Smith                       of exiting.
1662a2a2941SBarry Smith 
1672a2a2941SBarry Smith    Not Collective
1682a2a2941SBarry Smith 
1692a2a2941SBarry Smith    Level: advanced
1702a2a2941SBarry Smith 
171811af0c4SBarry Smith    Note:
1722a2a2941SBarry 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
1732a2a2941SBarry Smith       killing the user's debugging sessions.
1742a2a2941SBarry Smith 
175db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
1762a2a2941SBarry Smith @*/
1773274405dSPierre Jolivet PetscErrorCode PetscWaitOnError(void)
178d71ae5a4SJacob Faibussowitsch {
179baae8e41SSatish Balay   petscwaitonerrorflg = PETSC_TRUE;
180*3ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
1812a2a2941SBarry Smith }
182e5c89e4eSSatish Balay 
183e30d2299SSatish Balay /*@
184e5c89e4eSSatish Balay    PetscAttachDebugger - Attaches the debugger to the running process.
185e5c89e4eSSatish Balay 
186e5c89e4eSSatish Balay    Not Collective
187e5c89e4eSSatish Balay 
1881f690a00SBarry Smith    Options Database Keys:
1891f690a00SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n] -debug_terminal xterm or Terminal (for Apple)
1901f690a00SBarry Smith .  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
1911f690a00SBarry Smith 
192e5c89e4eSSatish Balay    Level: advanced
193e5c89e4eSSatish Balay 
194811af0c4SBarry Smith    Developer Note:
195811af0c4SBarry Smith     Since this can be called by the error handler should it be calling `SETERRQ()` and `PetscCall()`?
196f35f84d1SBarry Smith 
197db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscSetDebugTerminal()`, `PetscAttachDebuggerErrorHandler()`, `PetscStopForDebugger()`
198e5c89e4eSSatish Balay @*/
199d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebugger(void)
200d71ae5a4SJacob Faibussowitsch {
201*3ba16761SJacob Faibussowitsch   PetscErrorCode PETSC_UNUSED ierr;
202ed50d614Sprj- #if !defined(PETSC_CANNOT_START_DEBUGGER) && defined(PETSC_HAVE_FORK)
203e5c89e4eSSatish Balay   int       child     = 0;
204a6d0e24fSJed Brown   PetscReal sleeptime = 0;
205e5c89e4eSSatish Balay   char      program[PETSC_MAX_PATH_LEN], display[256], hostname[64];
206e5c89e4eSSatish Balay #endif
207e5c89e4eSSatish Balay 
208e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) || !defined(PETSC_HAVE_FORK)
209*3ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("System cannot start debugger\n");
210*3ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Cray run program in Totalview debugger\n");
211*3ba16761SJacob Faibussowitsch   ierr = (*PetscErrorPrintf)("On Windows use Developer Studio(MSDEV)\n");
21241e02c4dSJunchao Zhang   PETSCABORT(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS);
213e5c89e4eSSatish Balay #else
21463a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetDisplay(display, sizeof(display)))) {
215*3ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine display\n");
21611cc89d2SBarry Smith     return PETSC_ERR_SYS;
2175f80ce2aSJacob Faibussowitsch   }
21863a3b9bcSJacob Faibussowitsch   if (PetscUnlikely(PetscGetProgramName(program, sizeof(program)))) {
219*3ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22011cc89d2SBarry Smith     return PETSC_ERR_SYS;
221e5c89e4eSSatish Balay   }
2225f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(!program[0])) {
223*3ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n");
22411cc89d2SBarry Smith     return PETSC_ERR_SYS;
225e5c89e4eSSatish Balay   }
226e5c89e4eSSatish Balay   child = (int)fork();
2275f80ce2aSJacob Faibussowitsch   if (PetscUnlikely(child < 0)) {
228*3ba16761SJacob Faibussowitsch     ierr = (*PetscErrorPrintf)("Error in fork() prior to attaching debugger\n");
22911cc89d2SBarry Smith     return PETSC_ERR_SYS;
230e5c89e4eSSatish Balay   }
231bf4d2887SBarry Smith   petscindebugger = PETSC_TRUE;
232e5c89e4eSSatish Balay 
233e5c89e4eSSatish Balay   /*
234e5c89e4eSSatish Balay       Swap role the parent and child. This is (I think) so that control c typed
235e5c89e4eSSatish Balay     in the debugger goes to the correct process.
236e5c89e4eSSatish Balay   */
237234acd79SBarry Smith   #if !defined(PETSC_DO_NOT_SWAP_CHILD_FOR_DEBUGGER)
23863a3b9bcSJacob Faibussowitsch   child = child ? 0 : (int)getppid();
239234acd79SBarry Smith   #endif
240e5c89e4eSSatish Balay 
241e5c89e4eSSatish Balay   if (child) { /* I am the parent, will run the debugger */
242e5c89e4eSSatish Balay     const char *args[10];
243e5c89e4eSSatish Balay     char        pid[10];
2445e96ac45SJed Brown     PetscInt    j, jj;
2450e9bae81SBarry Smith     PetscBool   isdbx, isidb, isxldb, isxxgdb, isups, isxdb, isworkshop, isddd, iskdbg, islldb;
246e5c89e4eSSatish Balay 
2479566063dSJacob Faibussowitsch     PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
248e5c89e4eSSatish Balay     /*
249e5c89e4eSSatish Balay          We need to send a continue signal to the "child" process on the
250e5c89e4eSSatish Balay        alpha, otherwise it just stays off forever
251e5c89e4eSSatish Balay     */
252e5c89e4eSSatish Balay   #if defined(PETSC_NEED_KILL_FOR_DEBUGGER)
253e5c89e4eSSatish Balay     kill(child, SIGCONT);
254e5c89e4eSSatish Balay   #endif
255a364092eSJacob Faibussowitsch     PetscCall(PetscSNPrintf(pid, PETSC_STATIC_ARRAY_LENGTH(pid), "%d", child));
256e5c89e4eSSatish Balay 
2579566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
2589566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
2599566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
2609566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
2619566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
2629566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
2639566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
2649566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "idb", &isidb));
2659566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "workshop", &isworkshop));
2669566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
267e5c89e4eSSatish Balay 
268e5c89e4eSSatish Balay     if (isxxgdb || isups || isddd) {
2699371c9d4SSatish Balay       args[1] = program;
2709371c9d4SSatish Balay       args[2] = pid;
2719371c9d4SSatish Balay       args[3] = "-display";
2729371c9d4SSatish Balay       args[0] = PetscDebugger;
2739371c9d4SSatish Balay       args[4] = display;
2749371c9d4SSatish Balay       args[5] = NULL;
275c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
276e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
277e5c89e4eSSatish Balay         perror("Unable to start debugger");
278e5c89e4eSSatish Balay         exit(0);
279e5c89e4eSSatish Balay       }
280bf902449SSatish Balay     } else if (iskdbg) {
2819371c9d4SSatish Balay       args[1] = "-p";
2829371c9d4SSatish Balay       args[2] = pid;
2839371c9d4SSatish Balay       args[3] = program;
2849371c9d4SSatish Balay       args[4] = "-display";
2859371c9d4SSatish Balay       args[0] = PetscDebugger;
2869371c9d4SSatish Balay       args[5] = display;
2879371c9d4SSatish Balay       args[6] = NULL;
288c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[3], pid, hostname);
289bf902449SSatish Balay       if (execvp(args[0], (char **)args) < 0) {
290bf902449SSatish Balay         perror("Unable to start debugger");
291bf902449SSatish Balay         exit(0);
292bf902449SSatish Balay       }
293e5c89e4eSSatish Balay     } else if (isxldb) {
2949371c9d4SSatish Balay       args[1] = "-a";
2959371c9d4SSatish Balay       args[2] = pid;
2969371c9d4SSatish Balay       args[3] = program;
2979371c9d4SSatish Balay       args[4] = "-display";
2989371c9d4SSatish Balay       args[0] = PetscDebugger;
2999371c9d4SSatish Balay       args[5] = display;
3009371c9d4SSatish Balay       args[6] = NULL;
301c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname);
302e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
303e5c89e4eSSatish Balay         perror("Unable to start debugger");
304e5c89e4eSSatish Balay         exit(0);
305e5c89e4eSSatish Balay       }
306e5c89e4eSSatish Balay     } else if (isworkshop) {
3079371c9d4SSatish Balay       args[1] = "-s";
3089371c9d4SSatish Balay       args[2] = pid;
3099371c9d4SSatish Balay       args[3] = "-D";
3109371c9d4SSatish Balay       args[4] = "-";
3119371c9d4SSatish Balay       args[0] = PetscDebugger;
3129371c9d4SSatish Balay       args[5] = pid;
3139371c9d4SSatish Balay       args[6] = "-display";
3149371c9d4SSatish Balay       args[7] = display;
3159371c9d4SSatish Balay       args[8] = NULL;
316c5888dd7SBarry Smith       printf("PETSC: Attaching %s to %s on %s\n", args[0], pid, hostname);
317e5c89e4eSSatish Balay       if (execvp(args[0], (char **)args) < 0) {
318e5c89e4eSSatish Balay         perror("Unable to start debugger");
319e5c89e4eSSatish Balay         exit(0);
320e5c89e4eSSatish Balay       }
3215e96ac45SJed Brown     } else {
3225e96ac45SJed Brown       j = 0;
323c823fc1fSBarry Smith       if (UseDebugTerminal) {
324ace3abfcSBarry Smith         PetscBool cmp;
3255e96ac45SJed Brown         char     *tmp, *tmp1;
3269566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "Terminal", 8, &cmp));
327c823fc1fSBarry Smith         if (cmp) {
328c823fc1fSBarry Smith           char command[1024];
3299483a8a2SBarry Smith           if (islldb) PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"lldb  -p %s \"'\n", pid));
3309483a8a2SBarry Smith           else {
3319483a8a2SBarry Smith             char fullprogram[PETSC_MAX_PATH_LEN];
3329483a8a2SBarry Smith             PetscCall(PetscGetFullPath(program, fullprogram, sizeof(fullprogram)));
3339483a8a2SBarry Smith             PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"%s  %s %s \"'\n", PetscDebugger, fullprogram, pid));
3349483a8a2SBarry Smith           }
335accbd18bSBarry Smith   #if defined(PETSC_HAVE_POPEN)
3369566063dSJacob Faibussowitsch           PetscCall(PetscPOpen(PETSC_COMM_SELF, NULL, command, "r", NULL));
337accbd18bSBarry Smith   #else
338accbd18bSBarry Smith           printf("-debug_terminal Terminal is not available on this system since PETSC_HAVE_POPEN is not defined in this configuration\n");
339accbd18bSBarry Smith   #endif
340c823fc1fSBarry Smith           exit(0);
341c823fc1fSBarry Smith         }
342c823fc1fSBarry Smith 
3439566063dSJacob Faibussowitsch         PetscCall(PetscStrncmp(DebugTerminal, "screen", 6, &cmp));
3449566063dSJacob Faibussowitsch         if (!cmp) PetscCall(PetscStrncmp(DebugTerminal, "gnome-terminal", 6, &cmp));
3455e96ac45SJed Brown         if (cmp) display[0] = 0; /* when using screen, we never pass -display */
3465e96ac45SJed Brown         args[j++] = tmp = DebugTerminal;
3475e96ac45SJed Brown         if (display[0]) {
3489371c9d4SSatish Balay           args[j++] = "-display";
3499371c9d4SSatish Balay           args[j++] = display;
3505e96ac45SJed Brown         }
3515e96ac45SJed Brown         while (*tmp) {
3529566063dSJacob Faibussowitsch           PetscCall(PetscStrchr(tmp, ' ', &tmp1));
3535e96ac45SJed Brown           if (!tmp1) break;
3545e96ac45SJed Brown           *tmp1     = 0;
3555e96ac45SJed Brown           tmp       = tmp1 + 1;
3565e96ac45SJed Brown           args[j++] = tmp;
3575e96ac45SJed Brown         }
3585e96ac45SJed Brown       }
359b59f628eSBarry Smith       args[j++] = PetscDebugger;
3605e96ac45SJed Brown       jj        = j;
361bf4d2887SBarry Smith       /* this is for default gdb */
362bf4d2887SBarry Smith       args[j++] = program;
363bf4d2887SBarry Smith       args[j++] = pid;
364bf4d2887SBarry Smith       args[j++] = NULL;
3655e96ac45SJed Brown 
366e5c89e4eSSatish Balay       if (isidb) {
3675e96ac45SJed Brown         j         = jj;
3685e96ac45SJed Brown         args[j++] = "-pid";
3695e96ac45SJed Brown         args[j++] = pid;
3705e96ac45SJed Brown         args[j++] = "-gdb";
3715e96ac45SJed Brown         args[j++] = program;
37202c9f0b5SLisandro Dalcin         args[j++] = NULL;
373e5c89e4eSSatish Balay       }
3740e9bae81SBarry Smith       if (islldb) {
3750e9bae81SBarry Smith         j         = jj;
3760e9bae81SBarry Smith         args[j++] = "-p";
3770e9bae81SBarry Smith         args[j++] = pid;
37802c9f0b5SLisandro Dalcin         args[j++] = NULL;
3790e9bae81SBarry Smith       }
380e5c89e4eSSatish Balay       if (isdbx) {
3815e96ac45SJed Brown         j         = jj;
3828d359177SBarry Smith   #if defined(PETSC_USE_P_FOR_DEBUGGER)
3835e96ac45SJed Brown         args[j++] = "-p";
3845e96ac45SJed Brown         args[j++] = pid;
3855e96ac45SJed Brown         args[j++] = program;
386e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
3875e96ac45SJed Brown         args[j++] = "-l";
3885e96ac45SJed Brown         args[j++] = "ALL";
3895e96ac45SJed Brown         args[j++] = "-P";
3905e96ac45SJed Brown         args[j++] = pid;
3915e96ac45SJed Brown         args[j++] = program;
392e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
3935e96ac45SJed Brown         args[j++] = "-a";
3945e96ac45SJed Brown         args[j++] = pid;
395e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
3965e96ac45SJed Brown         args[j++] = "-pid";
3975e96ac45SJed Brown         args[j++] = pid;
3985e96ac45SJed Brown         args[j++] = program;
399493de400SSatish Balay   #else
400493de400SSatish Balay         args[j++] = program;
401493de400SSatish Balay         args[j++] = pid;
4028d359177SBarry Smith   #endif
40302c9f0b5SLisandro Dalcin         args[j++] = NULL;
404e5c89e4eSSatish Balay       }
405c823fc1fSBarry Smith       if (UseDebugTerminal) {
406c5888dd7SBarry 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);
407c5888dd7SBarry Smith         else printf("PETSC: Attaching %s to %s on pid %s on %s\n", PetscDebugger, program, pid, hostname);
408a297a907SKarl Rupp 
4095e96ac45SJed Brown         if (execvp(args[0], (char **)args) < 0) {
4105e96ac45SJed Brown           perror("Unable to start debugger in xterm");
4115e96ac45SJed Brown           exit(0);
4125e96ac45SJed Brown         }
4135e96ac45SJed Brown       } else {
414c5888dd7SBarry Smith         printf("PETSC: Attaching %s to %s of pid %s on %s\n", PetscDebugger, program, pid, hostname);
415e5c89e4eSSatish Balay         if (execvp(args[0], (char **)args) < 0) {
416e5c89e4eSSatish Balay           perror("Unable to start debugger");
417e5c89e4eSSatish Balay           exit(0);
418e5c89e4eSSatish Balay         }
419e5c89e4eSSatish Balay       }
420e5c89e4eSSatish Balay     }
421e5c89e4eSSatish Balay   } else {          /* I am the child, continue with user code */
422e5c89e4eSSatish Balay     sleeptime = 10; /* default to sleep waiting for debugger */
4239566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetReal(NULL, NULL, "-debugger_pause", &sleeptime, NULL));
424e5c89e4eSSatish Balay     if (sleeptime < 0) sleeptime = -sleeptime;
425e5c89e4eSSatish Balay   #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
426e5c89e4eSSatish Balay     /*
427e5c89e4eSSatish Balay         HP cannot attach process to sleeping debugger, hence count instead
428e5c89e4eSSatish Balay     */
429e5c89e4eSSatish Balay     {
430e5c89e4eSSatish Balay       PetscReal x = 1.0;
431e5c89e4eSSatish Balay       int       i = 10000000;
432e5c89e4eSSatish Balay       while (i--) x++; /* cannot attach to sleeper */
433e5c89e4eSSatish Balay     }
434e5c89e4eSSatish Balay   #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
435e5c89e4eSSatish Balay     /*
436e5c89e4eSSatish Balay         IBM sleep may return at anytime, hence must see if there is more time to sleep
437e5c89e4eSSatish Balay     */
438e5c89e4eSSatish Balay     {
439e5c89e4eSSatish Balay       int left = sleeptime;
440a297a907SKarl Rupp       while (left > 0) left = PetscSleep(left) - 1;
441e5c89e4eSSatish Balay     }
442e5c89e4eSSatish Balay   #else
443*3ba16761SJacob Faibussowitsch     PetscCall(PetscSleep(sleeptime));
444e5c89e4eSSatish Balay   #endif
445e5c89e4eSSatish Balay   }
446e5c89e4eSSatish Balay #endif
447*3ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
448e5c89e4eSSatish Balay }
449e5c89e4eSSatish Balay 
450e5c89e4eSSatish Balay /*@C
451e5c89e4eSSatish Balay    PetscAttachDebuggerErrorHandler - Error handler that attaches
452e5c89e4eSSatish Balay    a debugger to a running process when an error is detected.
453e5c89e4eSSatish Balay    This routine is useful for examining variables, etc.
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay    Not Collective
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay    Input Parameters:
458e32f2f54SBarry Smith +  comm - communicator over which error occurred
459e32f2f54SBarry Smith .  line - the line number of the error (indicated by __LINE__)
460e5c89e4eSSatish Balay .  file - the file in which the error was detected (indicated by __FILE__)
461e5c89e4eSSatish Balay .  message - an error text string, usually just printed to the screen
462e5c89e4eSSatish Balay .  number - the generic error number
463811af0c4SBarry Smith .  p - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT`
464e5c89e4eSSatish Balay -  ctx - error handler context
465e5c89e4eSSatish Balay 
466e5c89e4eSSatish Balay    Options Database Keys:
46745b666d6SBarry Smith +  -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment
46845b666d6SBarry Smith -  -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n]
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay    Level: developer
471e5c89e4eSSatish Balay 
472e5c89e4eSSatish Balay    Notes:
473c4fb7a8fSRichard Tran Mills    By default the GNU debugger, gdb, is used.  Alternatives are cuda-gdb, lldb, dbx and
474e5c89e4eSSatish Balay    xxgdb,xldb (on IBM rs6000), xdb (on HP-UX).
475e5c89e4eSSatish Balay 
476e5c89e4eSSatish Balay    Most users need not directly employ this routine and the other error
477e5c89e4eSSatish Balay    handlers, but can instead use the simplified interface SETERR, which has
478e5c89e4eSSatish Balay    the calling sequence
479e32f2f54SBarry Smith $     SETERRQ(PETSC_COMM_SELF,number,p,message)
480e5c89e4eSSatish Balay 
481e5c89e4eSSatish Balay    Notes for experienced users:
482811af0c4SBarry Smith    Use `PetscPushErrorHandler()` to set the desired error handler.  The
483e5c89e4eSSatish Balay    currently available PETSc error handlers are
484e5c89e4eSSatish Balay $    PetscTraceBackErrorHandler()
485e5c89e4eSSatish Balay $    PetscAttachDebuggerErrorHandler()
486e5c89e4eSSatish Balay $    PetscAbortErrorHandler()
487e5c89e4eSSatish Balay    or you may write your own.
488e5c89e4eSSatish Balay 
489811af0c4SBarry Smith    Developer Note:
490811af0c4SBarry Smith      This routine calls abort instead of returning because if it returned then `MPI_Abort()` would get called which can generate an exception
49169412655SBarry Smith      causing the debugger to be attached again in a cycle.
49269412655SBarry Smith 
493db781477SPatrick Sanan .seealso: `PetscSetDebuggerFromString()`, `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`,
494db781477SPatrick Sanan           `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`, `PetscSetDebugTermainal()`
495e5c89e4eSSatish Balay @*/
496d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode num, PetscErrorType p, const char *mess, void *ctx)
497d71ae5a4SJacob Faibussowitsch {
498*3ba16761SJacob Faibussowitsch   PetscErrorCode ierr;
499e5c89e4eSSatish Balay   if (!mess) mess = " ";
500e5c89e4eSSatish Balay 
501*3ba16761SJacob Faibussowitsch   if (fun) ierr = (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess);
502*3ba16761SJacob Faibussowitsch   else ierr = (*PetscErrorPrintf)("%s:%d %s\n", file, line, mess);
503e5c89e4eSSatish Balay 
504*3ba16761SJacob Faibussowitsch   ierr = PetscAttachDebugger();
505*3ba16761SJacob Faibussowitsch   (void)ierr;
506811af0c4SBarry Smith   abort(); /* call abort because don't want to kill other MPI ranks that may successfully attach to debugger */
507*3ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
508e5c89e4eSSatish Balay }
509e5c89e4eSSatish Balay 
510e5c89e4eSSatish Balay /*@C
511e5c89e4eSSatish Balay    PetscStopForDebugger - Prints a message to the screen indicating how to
512e5c89e4eSSatish Balay          attach to the process with the debugger and then waits for the
513e5c89e4eSSatish Balay          debugger to attach.
514e5c89e4eSSatish Balay 
515e5c89e4eSSatish Balay    Not Collective
516e5c89e4eSSatish Balay 
517811af0c4SBarry Smith    Options Database Key:
5181f690a00SBarry Smith .   -stop_for_debugger - will stop for you to attach the debugger when PetscInitialize() is called
5191f690a00SBarry Smith 
5208d359177SBarry Smith    Level: developer
521e5c89e4eSSatish Balay 
522811af0c4SBarry Smith    Note:
523811af0c4SBarry Smith     This is likely never needed since `PetscAttachDebugger()` is easier to use and seems to always work.
5248d359177SBarry Smith 
525811af0c4SBarry Smith    Developer Note:
526811af0c4SBarry Smith     Since this can be called by the error handler, should it be calling `SETERRQ()` and `PetscCall()`?
527f35f84d1SBarry Smith 
528db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()`
529e5c89e4eSSatish Balay @*/
530d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscStopForDebugger(void)
531d71ae5a4SJacob Faibussowitsch {
532e5c89e4eSSatish Balay   PetscErrorCode ierr;
533e5c89e4eSSatish Balay   PetscInt       sleeptime = 0;
534e5c89e4eSSatish Balay #if !defined(PETSC_CANNOT_START_DEBUGGER)
53551ec2c11SGlenn Hammond   int         ppid;
536e5c89e4eSSatish Balay   PetscMPIInt rank;
537e5c89e4eSSatish Balay   char        program[PETSC_MAX_PATH_LEN], hostname[256];
5388d359177SBarry Smith   PetscBool   isdbx, isxldb, isxxgdb, isddd, iskdbg, isups, isxdb, islldb;
539e5c89e4eSSatish Balay #endif
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay   PetscFunctionBegin;
542e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER)
543*3ba16761SJacob Faibussowitsch   PetscCall((*PetscErrorPrintf)("System cannot start debugger; just continuing program\n"));
544e5c89e4eSSatish Balay #else
545*3ba16761SJacob Faibussowitsch   if (MPI_Comm_rank(PETSC_COMM_WORLD, &rank)) rank = 0; /* ignore error since this may be already in error handler */
546589a23caSBarry Smith   ierr = PetscGetHostName(hostname, sizeof(hostname));
547e5c89e4eSSatish Balay   if (ierr) {
548*3ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine hostname; just continuing program\n"));
549*3ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
550e5c89e4eSSatish Balay   }
551e5c89e4eSSatish Balay 
552589a23caSBarry Smith   ierr = PetscGetProgramName(program, sizeof(program));
553e5c89e4eSSatish Balay   if (ierr) {
554*3ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
555*3ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
556e5c89e4eSSatish Balay   }
557e5c89e4eSSatish Balay   if (!program[0]) {
558*3ba16761SJacob Faibussowitsch     PetscCall((*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"));
559*3ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
560e5c89e4eSSatish Balay   }
561e5c89e4eSSatish Balay 
562e5c89e4eSSatish Balay   ppid = getpid();
563e5c89e4eSSatish Balay 
5649566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb));
5659566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd));
5669566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg));
5679566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups));
5689566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb));
5699566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb));
5709566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx));
5719566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb));
572e5c89e4eSSatish Balay 
573c5888dd7SBarry Smith   if (isxxgdb || isups || isddd || iskdbg) printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
574c5888dd7SBarry Smith   else if (isxldb) printf("[%d]%s>>%s -a %d %s\n", rank, hostname, PetscDebugger, ppid, program);
575c5888dd7SBarry Smith   else if (islldb) printf("[%d]%s>>%s -p %d\n", rank, hostname, PetscDebugger, ppid);
5768d359177SBarry Smith   else if (isdbx) {
577e5c89e4eSSatish Balay   #if defined(PETSC_USE_P_FOR_DEBUGGER)
578c5888dd7SBarry Smith     printf("[%d]%s>>%s -p %d %s\n", rank, hostname, PetscDebugger, ppid, program);
579e5c89e4eSSatish Balay   #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER)
580c5888dd7SBarry Smith     printf("[%d]%s>>%s -l ALL -P %d %s\n", rank, hostname, PetscDebugger, ppid, program);
581e5c89e4eSSatish Balay   #elif defined(PETSC_USE_A_FOR_DEBUGGER)
582c5888dd7SBarry Smith     printf("[%d]%s>>%s -a %d\n", rank, hostname, PetscDebugger, ppid);
583e5c89e4eSSatish Balay   #elif defined(PETSC_USE_PID_FOR_DEBUGGER)
584c5888dd7SBarry Smith     printf("[%d]%s>>%s -pid %d %s\n", rank, hostname, PetscDebugger, ppid, program);
585e5c89e4eSSatish Balay   #else
586c5888dd7SBarry Smith     printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid);
587e5c89e4eSSatish Balay   #endif
5888d359177SBarry Smith   }
589e5c89e4eSSatish Balay #endif /* PETSC_CANNOT_START_DEBUGGER */
590e5c89e4eSSatish Balay 
591f35f84d1SBarry Smith   fflush(stdout); /* ignore error because may already be in error handler */
592e5c89e4eSSatish Balay 
593e5c89e4eSSatish Balay   sleeptime = 25;                                                                         /* default to sleep waiting for debugger */
594*3ba16761SJacob Faibussowitsch   PetscCallContinue(PetscOptionsGetInt(NULL, NULL, "-debugger_pause", &sleeptime, NULL)); /* ignore error because may already be in error handler */
595e5c89e4eSSatish Balay   if (sleeptime < 0) sleeptime = -sleeptime;
596e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP)
597e5c89e4eSSatish Balay   /*
598e5c89e4eSSatish Balay       HP cannot attach process to sleeping debugger, hence count instead
599e5c89e4eSSatish Balay   */
600e5c89e4eSSatish Balay   {
601*3ba16761SJacob Faibussowitsch     // this *will* get optimized away by any compiler known to man
602e5c89e4eSSatish Balay     PetscReal x = 1.0;
603e5c89e4eSSatish Balay     int       i = 10000000;
604e5c89e4eSSatish Balay     while (i--) x++; /* cannot attach to sleeper */
605e5c89e4eSSatish Balay   }
606e5c89e4eSSatish Balay #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY)
607e5c89e4eSSatish Balay   /*
608e5c89e4eSSatish Balay       IBM sleep may return at anytime, hence must see if there is more time to sleep
609e5c89e4eSSatish Balay   */
610e5c89e4eSSatish Balay   {
611e5c89e4eSSatish Balay     int left = sleeptime;
612a297a907SKarl Rupp     while (left > 0) left = sleep(left) - 1;
613e5c89e4eSSatish Balay   }
614e5c89e4eSSatish Balay #else
615*3ba16761SJacob Faibussowitsch   PetscCall(PetscSleep(sleeptime));
616e5c89e4eSSatish Balay #endif
617*3ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
618e5c89e4eSSatish Balay }
619