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 23*cf53795eSBarry 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))); 545e96ac45SJed Brown PetscFunctionReturn(0); 555e96ac45SJed Brown } 565e96ac45SJed Brown 57e5c89e4eSSatish Balay /*@C 58e5c89e4eSSatish Balay PetscSetDebugger - Sets options associated with the debugger. 59e5c89e4eSSatish Balay 60*cf53795eSBarry 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; 81e5c89e4eSSatish Balay PetscFunctionReturn(0); 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 104e5c89e4eSSatish Balay PetscFunctionReturn(0); 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 } 119e5c89e4eSSatish Balay PetscFunctionReturn(0); 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)); 160e5c89e4eSSatish Balay PetscFunctionReturn(0); 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; 1802a2a2941SBarry Smith return 0; 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 { 201ed50d614Sprj- #if !defined(PETSC_CANNOT_START_DEBUGGER) && defined(PETSC_HAVE_FORK) 202e5c89e4eSSatish Balay int child = 0; 203a6d0e24fSJed Brown PetscReal sleeptime = 0; 204e5c89e4eSSatish Balay char program[PETSC_MAX_PATH_LEN], display[256], hostname[64]; 205e5c89e4eSSatish Balay #endif 206e5c89e4eSSatish Balay 207e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) || !defined(PETSC_HAVE_FORK) 208e5c89e4eSSatish Balay (*PetscErrorPrintf)("System cannot start debugger\n"); 209e5c89e4eSSatish Balay (*PetscErrorPrintf)("On Cray run program in Totalview debugger\n"); 210e5c89e4eSSatish Balay (*PetscErrorPrintf)("On Windows use Developer Studio(MSDEV)\n"); 21141e02c4dSJunchao Zhang PETSCABORT(PETSC_COMM_WORLD, PETSC_ERR_SUP_SYS); 212e5c89e4eSSatish Balay #else 21363a3b9bcSJacob Faibussowitsch if (PetscUnlikely(PetscGetDisplay(display, sizeof(display)))) { 2145f80ce2aSJacob Faibussowitsch (*PetscErrorPrintf)("Cannot determine display\n"); 21511cc89d2SBarry Smith return PETSC_ERR_SYS; 2165f80ce2aSJacob Faibussowitsch } 21763a3b9bcSJacob Faibussowitsch if (PetscUnlikely(PetscGetProgramName(program, sizeof(program)))) { 21811cc89d2SBarry Smith (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n"); 21911cc89d2SBarry Smith return PETSC_ERR_SYS; 220e5c89e4eSSatish Balay } 2215f80ce2aSJacob Faibussowitsch if (PetscUnlikely(!program[0])) { 22211cc89d2SBarry Smith (*PetscErrorPrintf)("Cannot determine program name needed to attach debugger\n"); 22311cc89d2SBarry Smith return PETSC_ERR_SYS; 224e5c89e4eSSatish Balay } 225e5c89e4eSSatish Balay child = (int)fork(); 2265f80ce2aSJacob Faibussowitsch if (PetscUnlikely(child < 0)) { 227a995a477SBarry Smith (*PetscErrorPrintf)("Error in fork() prior to attaching debugger\n"); 22811cc89d2SBarry Smith return PETSC_ERR_SYS; 229e5c89e4eSSatish Balay } 230bf4d2887SBarry Smith petscindebugger = PETSC_TRUE; 231e5c89e4eSSatish Balay 232e5c89e4eSSatish Balay /* 233e5c89e4eSSatish Balay Swap role the parent and child. This is (I think) so that control c typed 234e5c89e4eSSatish Balay in the debugger goes to the correct process. 235e5c89e4eSSatish Balay */ 236234acd79SBarry Smith #if !defined(PETSC_DO_NOT_SWAP_CHILD_FOR_DEBUGGER) 23763a3b9bcSJacob Faibussowitsch child = child ? 0 : (int)getppid(); 238234acd79SBarry Smith #endif 239e5c89e4eSSatish Balay 240e5c89e4eSSatish Balay if (child) { /* I am the parent, will run the debugger */ 241e5c89e4eSSatish Balay const char *args[10]; 242e5c89e4eSSatish Balay char pid[10]; 2435e96ac45SJed Brown PetscInt j, jj; 2440e9bae81SBarry Smith PetscBool isdbx, isidb, isxldb, isxxgdb, isups, isxdb, isworkshop, isddd, iskdbg, islldb; 245e5c89e4eSSatish Balay 2469566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 247e5c89e4eSSatish Balay /* 248e5c89e4eSSatish Balay We need to send a continue signal to the "child" process on the 249e5c89e4eSSatish Balay alpha, otherwise it just stays off forever 250e5c89e4eSSatish Balay */ 251e5c89e4eSSatish Balay #if defined(PETSC_NEED_KILL_FOR_DEBUGGER) 252e5c89e4eSSatish Balay kill(child, SIGCONT); 253e5c89e4eSSatish Balay #endif 254e5c89e4eSSatish Balay sprintf(pid, "%d", child); 255e5c89e4eSSatish Balay 2569566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb)); 2579566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd)); 2589566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg)); 2599566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups)); 2609566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb)); 2619566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb)); 2629566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx)); 2639566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "idb", &isidb)); 2649566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "workshop", &isworkshop)); 2659566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb)); 266e5c89e4eSSatish Balay 267e5c89e4eSSatish Balay if (isxxgdb || isups || isddd) { 2689371c9d4SSatish Balay args[1] = program; 2699371c9d4SSatish Balay args[2] = pid; 2709371c9d4SSatish Balay args[3] = "-display"; 2719371c9d4SSatish Balay args[0] = PetscDebugger; 2729371c9d4SSatish Balay args[4] = display; 2739371c9d4SSatish Balay args[5] = NULL; 274c5888dd7SBarry Smith printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname); 275e5c89e4eSSatish Balay if (execvp(args[0], (char **)args) < 0) { 276e5c89e4eSSatish Balay perror("Unable to start debugger"); 277e5c89e4eSSatish Balay exit(0); 278e5c89e4eSSatish Balay } 279bf902449SSatish Balay } else if (iskdbg) { 2809371c9d4SSatish Balay args[1] = "-p"; 2819371c9d4SSatish Balay args[2] = pid; 2829371c9d4SSatish Balay args[3] = program; 2839371c9d4SSatish Balay args[4] = "-display"; 2849371c9d4SSatish Balay args[0] = PetscDebugger; 2859371c9d4SSatish Balay args[5] = display; 2869371c9d4SSatish Balay args[6] = NULL; 287c5888dd7SBarry Smith printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[3], pid, hostname); 288bf902449SSatish Balay if (execvp(args[0], (char **)args) < 0) { 289bf902449SSatish Balay perror("Unable to start debugger"); 290bf902449SSatish Balay exit(0); 291bf902449SSatish Balay } 292e5c89e4eSSatish Balay } else if (isxldb) { 2939371c9d4SSatish Balay args[1] = "-a"; 2949371c9d4SSatish Balay args[2] = pid; 2959371c9d4SSatish Balay args[3] = program; 2969371c9d4SSatish Balay args[4] = "-display"; 2979371c9d4SSatish Balay args[0] = PetscDebugger; 2989371c9d4SSatish Balay args[5] = display; 2999371c9d4SSatish Balay args[6] = NULL; 300c5888dd7SBarry Smith printf("PETSC: Attaching %s to %s %s on %s\n", args[0], args[1], pid, hostname); 301e5c89e4eSSatish Balay if (execvp(args[0], (char **)args) < 0) { 302e5c89e4eSSatish Balay perror("Unable to start debugger"); 303e5c89e4eSSatish Balay exit(0); 304e5c89e4eSSatish Balay } 305e5c89e4eSSatish Balay } else if (isworkshop) { 3069371c9d4SSatish Balay args[1] = "-s"; 3079371c9d4SSatish Balay args[2] = pid; 3089371c9d4SSatish Balay args[3] = "-D"; 3099371c9d4SSatish Balay args[4] = "-"; 3109371c9d4SSatish Balay args[0] = PetscDebugger; 3119371c9d4SSatish Balay args[5] = pid; 3129371c9d4SSatish Balay args[6] = "-display"; 3139371c9d4SSatish Balay args[7] = display; 3149371c9d4SSatish Balay args[8] = NULL; 315c5888dd7SBarry Smith printf("PETSC: Attaching %s to %s on %s\n", args[0], pid, hostname); 316e5c89e4eSSatish Balay if (execvp(args[0], (char **)args) < 0) { 317e5c89e4eSSatish Balay perror("Unable to start debugger"); 318e5c89e4eSSatish Balay exit(0); 319e5c89e4eSSatish Balay } 3205e96ac45SJed Brown } else { 3215e96ac45SJed Brown j = 0; 322c823fc1fSBarry Smith if (UseDebugTerminal) { 323ace3abfcSBarry Smith PetscBool cmp; 3245e96ac45SJed Brown char *tmp, *tmp1; 3259566063dSJacob Faibussowitsch PetscCall(PetscStrncmp(DebugTerminal, "Terminal", 8, &cmp)); 326c823fc1fSBarry Smith if (cmp) { 327c823fc1fSBarry Smith char command[1024]; 3289483a8a2SBarry Smith if (islldb) PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"lldb -p %s \"'\n", pid)); 3299483a8a2SBarry Smith else { 3309483a8a2SBarry Smith char fullprogram[PETSC_MAX_PATH_LEN]; 3319483a8a2SBarry Smith PetscCall(PetscGetFullPath(program, fullprogram, sizeof(fullprogram))); 3329483a8a2SBarry Smith PetscCall(PetscSNPrintf(command, sizeof(command), "osascript -e 'tell app \"Terminal\" to do script \"%s %s %s \"'\n", PetscDebugger, fullprogram, pid)); 3339483a8a2SBarry Smith } 3349566063dSJacob Faibussowitsch PetscCall(PetscPOpen(PETSC_COMM_SELF, NULL, command, "r", NULL)); 335c823fc1fSBarry Smith exit(0); 336c823fc1fSBarry Smith } 337c823fc1fSBarry Smith 3389566063dSJacob Faibussowitsch PetscCall(PetscStrncmp(DebugTerminal, "screen", 6, &cmp)); 3399566063dSJacob Faibussowitsch if (!cmp) PetscCall(PetscStrncmp(DebugTerminal, "gnome-terminal", 6, &cmp)); 3405e96ac45SJed Brown if (cmp) display[0] = 0; /* when using screen, we never pass -display */ 3415e96ac45SJed Brown args[j++] = tmp = DebugTerminal; 3425e96ac45SJed Brown if (display[0]) { 3439371c9d4SSatish Balay args[j++] = "-display"; 3449371c9d4SSatish Balay args[j++] = display; 3455e96ac45SJed Brown } 3465e96ac45SJed Brown while (*tmp) { 3479566063dSJacob Faibussowitsch PetscCall(PetscStrchr(tmp, ' ', &tmp1)); 3485e96ac45SJed Brown if (!tmp1) break; 3495e96ac45SJed Brown *tmp1 = 0; 3505e96ac45SJed Brown tmp = tmp1 + 1; 3515e96ac45SJed Brown args[j++] = tmp; 3525e96ac45SJed Brown } 3535e96ac45SJed Brown } 354b59f628eSBarry Smith args[j++] = PetscDebugger; 3555e96ac45SJed Brown jj = j; 356bf4d2887SBarry Smith /* this is for default gdb */ 357bf4d2887SBarry Smith args[j++] = program; 358bf4d2887SBarry Smith args[j++] = pid; 359bf4d2887SBarry Smith args[j++] = NULL; 3605e96ac45SJed Brown 361e5c89e4eSSatish Balay if (isidb) { 3625e96ac45SJed Brown j = jj; 3635e96ac45SJed Brown args[j++] = "-pid"; 3645e96ac45SJed Brown args[j++] = pid; 3655e96ac45SJed Brown args[j++] = "-gdb"; 3665e96ac45SJed Brown args[j++] = program; 36702c9f0b5SLisandro Dalcin args[j++] = NULL; 368e5c89e4eSSatish Balay } 3690e9bae81SBarry Smith if (islldb) { 3700e9bae81SBarry Smith j = jj; 3710e9bae81SBarry Smith args[j++] = "-p"; 3720e9bae81SBarry Smith args[j++] = pid; 37302c9f0b5SLisandro Dalcin args[j++] = NULL; 3740e9bae81SBarry Smith } 375e5c89e4eSSatish Balay if (isdbx) { 3765e96ac45SJed Brown j = jj; 3778d359177SBarry Smith #if defined(PETSC_USE_P_FOR_DEBUGGER) 3785e96ac45SJed Brown args[j++] = "-p"; 3795e96ac45SJed Brown args[j++] = pid; 3805e96ac45SJed Brown args[j++] = program; 381e5c89e4eSSatish Balay #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER) 3825e96ac45SJed Brown args[j++] = "-l"; 3835e96ac45SJed Brown args[j++] = "ALL"; 3845e96ac45SJed Brown args[j++] = "-P"; 3855e96ac45SJed Brown args[j++] = pid; 3865e96ac45SJed Brown args[j++] = program; 387e5c89e4eSSatish Balay #elif defined(PETSC_USE_A_FOR_DEBUGGER) 3885e96ac45SJed Brown args[j++] = "-a"; 3895e96ac45SJed Brown args[j++] = pid; 390e5c89e4eSSatish Balay #elif defined(PETSC_USE_PID_FOR_DEBUGGER) 3915e96ac45SJed Brown args[j++] = "-pid"; 3925e96ac45SJed Brown args[j++] = pid; 3935e96ac45SJed Brown args[j++] = program; 394493de400SSatish Balay #else 395493de400SSatish Balay args[j++] = program; 396493de400SSatish Balay args[j++] = pid; 3978d359177SBarry Smith #endif 39802c9f0b5SLisandro Dalcin args[j++] = NULL; 399e5c89e4eSSatish Balay } 400c823fc1fSBarry Smith if (UseDebugTerminal) { 401c5888dd7SBarry 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); 402c5888dd7SBarry Smith else printf("PETSC: Attaching %s to %s on pid %s on %s\n", PetscDebugger, program, pid, hostname); 403a297a907SKarl Rupp 4045e96ac45SJed Brown if (execvp(args[0], (char **)args) < 0) { 4055e96ac45SJed Brown perror("Unable to start debugger in xterm"); 4065e96ac45SJed Brown exit(0); 4075e96ac45SJed Brown } 4085e96ac45SJed Brown } else { 409c5888dd7SBarry Smith printf("PETSC: Attaching %s to %s of pid %s on %s\n", PetscDebugger, program, pid, hostname); 410e5c89e4eSSatish Balay if (execvp(args[0], (char **)args) < 0) { 411e5c89e4eSSatish Balay perror("Unable to start debugger"); 412e5c89e4eSSatish Balay exit(0); 413e5c89e4eSSatish Balay } 414e5c89e4eSSatish Balay } 415e5c89e4eSSatish Balay } 416e5c89e4eSSatish Balay } else { /* I am the child, continue with user code */ 417e5c89e4eSSatish Balay sleeptime = 10; /* default to sleep waiting for debugger */ 4189566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetReal(NULL, NULL, "-debugger_pause", &sleeptime, NULL)); 419e5c89e4eSSatish Balay if (sleeptime < 0) sleeptime = -sleeptime; 420e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP) 421e5c89e4eSSatish Balay /* 422e5c89e4eSSatish Balay HP cannot attach process to sleeping debugger, hence count instead 423e5c89e4eSSatish Balay */ 424e5c89e4eSSatish Balay { 425e5c89e4eSSatish Balay PetscReal x = 1.0; 426e5c89e4eSSatish Balay int i = 10000000; 427e5c89e4eSSatish Balay while (i--) x++; /* cannot attach to sleeper */ 428e5c89e4eSSatish Balay } 429e5c89e4eSSatish Balay #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY) 430e5c89e4eSSatish Balay /* 431e5c89e4eSSatish Balay IBM sleep may return at anytime, hence must see if there is more time to sleep 432e5c89e4eSSatish Balay */ 433e5c89e4eSSatish Balay { 434e5c89e4eSSatish Balay int left = sleeptime; 435a297a907SKarl Rupp while (left > 0) left = PetscSleep(left) - 1; 436e5c89e4eSSatish Balay } 437e5c89e4eSSatish Balay #else 438e5c89e4eSSatish Balay PetscSleep(sleeptime); 439e5c89e4eSSatish Balay #endif 440e5c89e4eSSatish Balay } 441e5c89e4eSSatish Balay #endif 44211cc89d2SBarry Smith return 0; 443e5c89e4eSSatish Balay } 444e5c89e4eSSatish Balay 445e5c89e4eSSatish Balay /*@C 446e5c89e4eSSatish Balay PetscAttachDebuggerErrorHandler - Error handler that attaches 447e5c89e4eSSatish Balay a debugger to a running process when an error is detected. 448e5c89e4eSSatish Balay This routine is useful for examining variables, etc. 449e5c89e4eSSatish Balay 450e5c89e4eSSatish Balay Not Collective 451e5c89e4eSSatish Balay 452e5c89e4eSSatish Balay Input Parameters: 453e32f2f54SBarry Smith + comm - communicator over which error occurred 454e32f2f54SBarry Smith . line - the line number of the error (indicated by __LINE__) 455e5c89e4eSSatish Balay . file - the file in which the error was detected (indicated by __FILE__) 456e5c89e4eSSatish Balay . message - an error text string, usually just printed to the screen 457e5c89e4eSSatish Balay . number - the generic error number 458811af0c4SBarry Smith . p - `PETSC_ERROR_INITIAL` if error just detected, otherwise `PETSC_ERROR_REPEAT` 459e5c89e4eSSatish Balay - ctx - error handler context 460e5c89e4eSSatish Balay 461e5c89e4eSSatish Balay Options Database Keys: 46245b666d6SBarry Smith + -on_error_attach_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] - Activates debugger attachment 46345b666d6SBarry Smith - -start_in_debugger [noxterm,dbx,xxgdb,xdb,xldb,gdb] [-display name] [-debugger_ranks m,n] 464e5c89e4eSSatish Balay 465e5c89e4eSSatish Balay Level: developer 466e5c89e4eSSatish Balay 467e5c89e4eSSatish Balay Notes: 468c4fb7a8fSRichard Tran Mills By default the GNU debugger, gdb, is used. Alternatives are cuda-gdb, lldb, dbx and 469e5c89e4eSSatish Balay xxgdb,xldb (on IBM rs6000), xdb (on HP-UX). 470e5c89e4eSSatish Balay 471e5c89e4eSSatish Balay Most users need not directly employ this routine and the other error 472e5c89e4eSSatish Balay handlers, but can instead use the simplified interface SETERR, which has 473e5c89e4eSSatish Balay the calling sequence 474e32f2f54SBarry Smith $ SETERRQ(PETSC_COMM_SELF,number,p,message) 475e5c89e4eSSatish Balay 476e5c89e4eSSatish Balay Notes for experienced users: 477811af0c4SBarry Smith Use `PetscPushErrorHandler()` to set the desired error handler. The 478e5c89e4eSSatish Balay currently available PETSc error handlers are 479e5c89e4eSSatish Balay $ PetscTraceBackErrorHandler() 480e5c89e4eSSatish Balay $ PetscAttachDebuggerErrorHandler() 481e5c89e4eSSatish Balay $ PetscAbortErrorHandler() 482e5c89e4eSSatish Balay or you may write your own. 483e5c89e4eSSatish Balay 484811af0c4SBarry Smith Developer Note: 485811af0c4SBarry Smith This routine calls abort instead of returning because if it returned then `MPI_Abort()` would get called which can generate an exception 48669412655SBarry Smith causing the debugger to be attached again in a cycle. 48769412655SBarry Smith 488db781477SPatrick Sanan .seealso: `PetscSetDebuggerFromString()`, `PetscSetDebugger()`, `PetscSetDefaultDebugger()`, `PetscError()`, `PetscPushErrorHandler()`, `PetscPopErrorHandler()`, `PetscTraceBackErrorHandler()`, 489db781477SPatrick Sanan `PetscAbortErrorHandler()`, `PetscMPIAbortErrorHandler()`, `PetscEmacsClientErrorHandler()`, `PetscReturnErrorHandler()`, `PetscSetDebugTermainal()` 490e5c89e4eSSatish Balay @*/ 491d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscAttachDebuggerErrorHandler(MPI_Comm comm, int line, const char *fun, const char *file, PetscErrorCode num, PetscErrorType p, const char *mess, void *ctx) 492d71ae5a4SJacob Faibussowitsch { 493e5c89e4eSSatish Balay if (!mess) mess = " "; 494e5c89e4eSSatish Balay 49549c86fc7SBarry Smith if (fun) (*PetscErrorPrintf)("%s() at %s:%d %s\n", fun, file, line, mess); 49649c86fc7SBarry Smith else (*PetscErrorPrintf)("%s:%d %s\n", file, line, mess); 497e5c89e4eSSatish Balay 49869412655SBarry Smith PetscAttachDebugger(); 499811af0c4SBarry Smith abort(); /* call abort because don't want to kill other MPI ranks that may successfully attach to debugger */ 500811af0c4SBarry Smith PetscFunctionReturn(0); 501e5c89e4eSSatish Balay } 502e5c89e4eSSatish Balay 503e5c89e4eSSatish Balay /*@C 504e5c89e4eSSatish Balay PetscStopForDebugger - Prints a message to the screen indicating how to 505e5c89e4eSSatish Balay attach to the process with the debugger and then waits for the 506e5c89e4eSSatish Balay debugger to attach. 507e5c89e4eSSatish Balay 508e5c89e4eSSatish Balay Not Collective 509e5c89e4eSSatish Balay 510811af0c4SBarry Smith Options Database Key: 5111f690a00SBarry Smith . -stop_for_debugger - will stop for you to attach the debugger when PetscInitialize() is called 5121f690a00SBarry Smith 5138d359177SBarry Smith Level: developer 514e5c89e4eSSatish Balay 515811af0c4SBarry Smith Note: 516811af0c4SBarry Smith This is likely never needed since `PetscAttachDebugger()` is easier to use and seems to always work. 5178d359177SBarry Smith 518811af0c4SBarry Smith Developer Note: 519811af0c4SBarry Smith Since this can be called by the error handler, should it be calling `SETERRQ()` and `PetscCall()`? 520f35f84d1SBarry Smith 521db781477SPatrick Sanan .seealso: `PetscSetDebugger()`, `PetscAttachDebugger()` 522e5c89e4eSSatish Balay @*/ 523d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscStopForDebugger(void) 524d71ae5a4SJacob Faibussowitsch { 525e5c89e4eSSatish Balay PetscErrorCode ierr; 526e5c89e4eSSatish Balay PetscInt sleeptime = 0; 527e5c89e4eSSatish Balay #if !defined(PETSC_CANNOT_START_DEBUGGER) 52851ec2c11SGlenn Hammond int ppid; 529e5c89e4eSSatish Balay PetscMPIInt rank; 530e5c89e4eSSatish Balay char program[PETSC_MAX_PATH_LEN], hostname[256]; 5318d359177SBarry Smith PetscBool isdbx, isxldb, isxxgdb, isddd, iskdbg, isups, isxdb, islldb; 532e5c89e4eSSatish Balay #endif 533e5c89e4eSSatish Balay 534e5c89e4eSSatish Balay PetscFunctionBegin; 535e5c89e4eSSatish Balay #if defined(PETSC_CANNOT_START_DEBUGGER) 536e5c89e4eSSatish Balay (*PetscErrorPrintf)("System cannot start debugger; just continuing program\n"); 537e5c89e4eSSatish Balay #else 538e5c89e4eSSatish Balay ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank); 539f35f84d1SBarry Smith if (ierr) rank = 0; /* ignore error since this may be already in error handler */ 540589a23caSBarry Smith ierr = PetscGetHostName(hostname, sizeof(hostname)); 541e5c89e4eSSatish Balay if (ierr) { 542e5c89e4eSSatish Balay (*PetscErrorPrintf)("Cannot determine hostname; just continuing program\n"); 543e5c89e4eSSatish Balay PetscFunctionReturn(0); 544e5c89e4eSSatish Balay } 545e5c89e4eSSatish Balay 546589a23caSBarry Smith ierr = PetscGetProgramName(program, sizeof(program)); 547e5c89e4eSSatish Balay if (ierr) { 548e5c89e4eSSatish Balay (*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"); 549e5c89e4eSSatish Balay PetscFunctionReturn(0); 550e5c89e4eSSatish Balay } 551e5c89e4eSSatish Balay if (!program[0]) { 552e5c89e4eSSatish Balay (*PetscErrorPrintf)("Cannot determine program name; just continuing program\n"); 553e5c89e4eSSatish Balay PetscFunctionReturn(0); 554e5c89e4eSSatish Balay } 555e5c89e4eSSatish Balay 556e5c89e4eSSatish Balay ppid = getpid(); 557e5c89e4eSSatish Balay 5589566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xxgdb", &isxxgdb)); 5599566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "ddd", &isddd)); 5609566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "kdbg", &iskdbg)); 5619566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "ups", &isups)); 5629566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xldb", &isxldb)); 5639566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "xdb", &isxdb)); 5649566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "dbx", &isdbx)); 5659566063dSJacob Faibussowitsch PetscCall(PetscStrcmp(PetscDebugger, "lldb", &islldb)); 566e5c89e4eSSatish Balay 567c5888dd7SBarry Smith if (isxxgdb || isups || isddd || iskdbg) printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid); 568c5888dd7SBarry Smith else if (isxldb) printf("[%d]%s>>%s -a %d %s\n", rank, hostname, PetscDebugger, ppid, program); 569c5888dd7SBarry Smith else if (islldb) printf("[%d]%s>>%s -p %d\n", rank, hostname, PetscDebugger, ppid); 5708d359177SBarry Smith else if (isdbx) { 571e5c89e4eSSatish Balay #if defined(PETSC_USE_P_FOR_DEBUGGER) 572c5888dd7SBarry Smith printf("[%d]%s>>%s -p %d %s\n", rank, hostname, PetscDebugger, ppid, program); 573e5c89e4eSSatish Balay #elif defined(PETSC_USE_LARGEP_FOR_DEBUGGER) 574c5888dd7SBarry Smith printf("[%d]%s>>%s -l ALL -P %d %s\n", rank, hostname, PetscDebugger, ppid, program); 575e5c89e4eSSatish Balay #elif defined(PETSC_USE_A_FOR_DEBUGGER) 576c5888dd7SBarry Smith printf("[%d]%s>>%s -a %d\n", rank, hostname, PetscDebugger, ppid); 577e5c89e4eSSatish Balay #elif defined(PETSC_USE_PID_FOR_DEBUGGER) 578c5888dd7SBarry Smith printf("[%d]%s>>%s -pid %d %s\n", rank, hostname, PetscDebugger, ppid, program); 579e5c89e4eSSatish Balay #else 580c5888dd7SBarry Smith printf("[%d]%s>>%s %s %d\n", rank, hostname, PetscDebugger, program, ppid); 581e5c89e4eSSatish Balay #endif 5828d359177SBarry Smith } 583e5c89e4eSSatish Balay #endif /* PETSC_CANNOT_START_DEBUGGER */ 584e5c89e4eSSatish Balay 585f35f84d1SBarry Smith fflush(stdout); /* ignore error because may already be in error handler */ 586e5c89e4eSSatish Balay 587e5c89e4eSSatish Balay sleeptime = 25; /* default to sleep waiting for debugger */ 588c5929fdfSBarry Smith PetscOptionsGetInt(NULL, NULL, "-debugger_pause", &sleeptime, NULL); /* ignore error because may already be in error handler */ 589e5c89e4eSSatish Balay if (sleeptime < 0) sleeptime = -sleeptime; 590e5c89e4eSSatish Balay #if defined(PETSC_NEED_DEBUGGER_NO_SLEEP) 591e5c89e4eSSatish Balay /* 592e5c89e4eSSatish Balay HP cannot attach process to sleeping debugger, hence count instead 593e5c89e4eSSatish Balay */ 594e5c89e4eSSatish Balay { 595e5c89e4eSSatish Balay PetscReal x = 1.0; 596e5c89e4eSSatish Balay int i = 10000000; 597e5c89e4eSSatish Balay while (i--) x++; /* cannot attach to sleeper */ 598e5c89e4eSSatish Balay } 599e5c89e4eSSatish Balay #elif defined(PETSC_HAVE_SLEEP_RETURNS_EARLY) 600e5c89e4eSSatish Balay /* 601e5c89e4eSSatish Balay IBM sleep may return at anytime, hence must see if there is more time to sleep 602e5c89e4eSSatish Balay */ 603e5c89e4eSSatish Balay { 604e5c89e4eSSatish Balay int left = sleeptime; 605a297a907SKarl Rupp while (left > 0) left = sleep(left) - 1; 606e5c89e4eSSatish Balay } 607e5c89e4eSSatish Balay #else 608e5c89e4eSSatish Balay PetscSleep(sleeptime); 609e5c89e4eSSatish Balay #endif 610e5c89e4eSSatish Balay PetscFunctionReturn(0); 611e5c89e4eSSatish Balay } 612