Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1 | #include "Python.h" |
| 2 | #include "pythread.h" |
| 3 | #include <signal.h> |
| 4 | #include <object.h> |
| 5 | #include <frameobject.h> |
| 6 | #include <signal.h> |
Victor Stinner | 0aafa4f | 2011-06-29 23:28:02 +0200 | [diff] [blame] | 7 | #if defined(HAVE_PTHREAD_SIGMASK) && !defined(HAVE_BROKEN_PTHREAD_SIGMASK) |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 8 | # include <pthread.h> |
| 9 | #endif |
| 10 | #ifdef MS_WINDOWS |
| 11 | # include <windows.h> |
| 12 | #endif |
| 13 | #ifdef HAVE_SYS_RESOURCE_H |
| 14 | # include <sys/resource.h> |
Victor Stinner | 0aafa4f | 2011-06-29 23:28:02 +0200 | [diff] [blame] | 15 | #endif |
| 16 | |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 17 | /* Allocate at maximum 100 MB of the stack to raise the stack overflow */ |
| 18 | #define STACK_OVERFLOW_MAX_SIZE (100*1024*1024) |
| 19 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 20 | #ifdef WITH_THREAD |
| 21 | # define FAULTHANDLER_LATER |
| 22 | #endif |
| 23 | |
| 24 | #ifndef MS_WINDOWS |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 25 | /* register() is useless on Windows, because only SIGSEGV, SIGABRT and |
| 26 | SIGILL can be handled by the process, and these signals can only be used |
| 27 | with enable(), not using register() */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 28 | # define FAULTHANDLER_USER |
| 29 | #endif |
| 30 | |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 31 | #define PUTS(fd, str) _Py_write_noraise(fd, str, strlen(str)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 32 | |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 33 | _Py_IDENTIFIER(enable); |
| 34 | _Py_IDENTIFIER(fileno); |
| 35 | _Py_IDENTIFIER(flush); |
| 36 | _Py_IDENTIFIER(stderr); |
| 37 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 38 | #ifdef HAVE_SIGACTION |
| 39 | typedef struct sigaction _Py_sighandler_t; |
| 40 | #else |
| 41 | typedef PyOS_sighandler_t _Py_sighandler_t; |
| 42 | #endif |
| 43 | |
| 44 | typedef struct { |
| 45 | int signum; |
| 46 | int enabled; |
| 47 | const char* name; |
| 48 | _Py_sighandler_t previous; |
| 49 | int all_threads; |
| 50 | } fault_handler_t; |
| 51 | |
| 52 | static struct { |
| 53 | int enabled; |
| 54 | PyObject *file; |
| 55 | int fd; |
| 56 | int all_threads; |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 57 | PyInterpreterState *interp; |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 58 | #ifdef MS_WINDOWS |
| 59 | void *exc_handler; |
| 60 | #endif |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 61 | } fatal_error = {0, NULL, -1, 0}; |
| 62 | |
| 63 | #ifdef FAULTHANDLER_LATER |
| 64 | static struct { |
| 65 | PyObject *file; |
| 66 | int fd; |
Victor Stinner | 9418932 | 2011-04-08 13:00:31 +0200 | [diff] [blame] | 67 | PY_TIMEOUT_T timeout_us; /* timeout in microseconds */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 68 | int repeat; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 69 | PyInterpreterState *interp; |
| 70 | int exit; |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 71 | char *header; |
| 72 | size_t header_len; |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 73 | /* The main thread always holds this lock. It is only released when |
| 74 | faulthandler_thread() is interrupted before this thread exits, or at |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 75 | Python exit. */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 76 | PyThread_type_lock cancel_event; |
| 77 | /* released by child thread when joined */ |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 78 | PyThread_type_lock running; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 79 | } thread; |
| 80 | #endif |
| 81 | |
| 82 | #ifdef FAULTHANDLER_USER |
| 83 | typedef struct { |
| 84 | int enabled; |
| 85 | PyObject *file; |
| 86 | int fd; |
| 87 | int all_threads; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 88 | int chain; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 89 | _Py_sighandler_t previous; |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 90 | PyInterpreterState *interp; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 91 | } user_signal_t; |
| 92 | |
| 93 | static user_signal_t *user_signals; |
| 94 | |
| 95 | /* the following macros come from Python: Modules/signalmodule.c */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 96 | #ifndef NSIG |
| 97 | # if defined(_NSIG) |
| 98 | # define NSIG _NSIG /* For BSD/SysV */ |
| 99 | # elif defined(_SIGMAX) |
| 100 | # define NSIG (_SIGMAX + 1) /* For QNX */ |
| 101 | # elif defined(SIGMAX) |
| 102 | # define NSIG (SIGMAX + 1) /* For djgpp */ |
| 103 | # else |
| 104 | # define NSIG 64 /* Use a reasonable default value */ |
| 105 | # endif |
| 106 | #endif |
| 107 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 108 | static void faulthandler_user(int signum); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 109 | #endif /* FAULTHANDLER_USER */ |
| 110 | |
| 111 | |
| 112 | static fault_handler_t faulthandler_handlers[] = { |
| 113 | #ifdef SIGBUS |
| 114 | {SIGBUS, 0, "Bus error", }, |
| 115 | #endif |
| 116 | #ifdef SIGILL |
| 117 | {SIGILL, 0, "Illegal instruction", }, |
| 118 | #endif |
| 119 | {SIGFPE, 0, "Floating point exception", }, |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 120 | {SIGABRT, 0, "Aborted", }, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 121 | /* define SIGSEGV at the end to make it the default choice if searching the |
| 122 | handler fails in faulthandler_fatal_error() */ |
| 123 | {SIGSEGV, 0, "Segmentation fault", } |
| 124 | }; |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 125 | static const size_t faulthandler_nsignals = \ |
Victor Stinner | 6394188 | 2011-09-29 00:42:28 +0200 | [diff] [blame] | 126 | Py_ARRAY_LENGTH(faulthandler_handlers); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 127 | |
| 128 | #ifdef HAVE_SIGALTSTACK |
| 129 | static stack_t stack; |
Christophe Zeitouny | 20fbf8a | 2017-03-23 10:14:29 -0700 | [diff] [blame] | 130 | static stack_t old_stack; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 131 | #endif |
| 132 | |
| 133 | |
| 134 | /* Get the file descriptor of a file by calling its fileno() method and then |
| 135 | call its flush() method. |
| 136 | |
| 137 | If file is NULL or Py_None, use sys.stderr as the new file. |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 138 | If file is an integer, it will be treated as file descriptor. |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 139 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 140 | On success, return the file descriptor and write the new file into *file_ptr. |
| 141 | On error, return -1. */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 142 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 143 | static int |
| 144 | faulthandler_get_fileno(PyObject **file_ptr) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 145 | { |
| 146 | PyObject *result; |
| 147 | long fd_long; |
| 148 | int fd; |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 149 | PyObject *file = *file_ptr; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 150 | |
| 151 | if (file == NULL || file == Py_None) { |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 152 | file = _PySys_GetObjectId(&PyId_stderr); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 153 | if (file == NULL) { |
| 154 | PyErr_SetString(PyExc_RuntimeError, "unable to get sys.stderr"); |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 155 | return -1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 156 | } |
Victor Stinner | e2d6690 | 2014-05-14 17:15:50 +0200 | [diff] [blame] | 157 | if (file == Py_None) { |
| 158 | PyErr_SetString(PyExc_RuntimeError, "sys.stderr is None"); |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 159 | return -1; |
Victor Stinner | e2d6690 | 2014-05-14 17:15:50 +0200 | [diff] [blame] | 160 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 161 | } |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 162 | else if (PyLong_Check(file)) { |
| 163 | fd = _PyLong_AsInt(file); |
| 164 | if (fd == -1 && PyErr_Occurred()) |
| 165 | return -1; |
Steve Dower | 940f33a | 2016-09-08 11:21:54 -0700 | [diff] [blame] | 166 | if (fd < 0) { |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 167 | PyErr_SetString(PyExc_ValueError, |
| 168 | "file is not a valid file descripter"); |
| 169 | return -1; |
| 170 | } |
| 171 | *file_ptr = NULL; |
| 172 | return fd; |
| 173 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 174 | |
Victor Stinner | 3466bde | 2016-09-05 18:16:01 -0700 | [diff] [blame] | 175 | result = _PyObject_CallMethodId(file, &PyId_fileno, NULL); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 176 | if (result == NULL) |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 177 | return -1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 178 | |
| 179 | fd = -1; |
| 180 | if (PyLong_Check(result)) { |
| 181 | fd_long = PyLong_AsLong(result); |
| 182 | if (0 <= fd_long && fd_long < INT_MAX) |
| 183 | fd = (int)fd_long; |
| 184 | } |
| 185 | Py_DECREF(result); |
| 186 | |
| 187 | if (fd == -1) { |
| 188 | PyErr_SetString(PyExc_RuntimeError, |
| 189 | "file.fileno() is not a valid file descriptor"); |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 190 | return -1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 191 | } |
| 192 | |
Victor Stinner | 3466bde | 2016-09-05 18:16:01 -0700 | [diff] [blame] | 193 | result = _PyObject_CallMethodId(file, &PyId_flush, NULL); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 194 | if (result != NULL) |
| 195 | Py_DECREF(result); |
| 196 | else { |
| 197 | /* ignore flush() error */ |
| 198 | PyErr_Clear(); |
| 199 | } |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 200 | *file_ptr = file; |
| 201 | return fd; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 202 | } |
| 203 | |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 204 | /* Get the state of the current thread: only call this function if the current |
| 205 | thread holds the GIL. Raise an exception on error. */ |
| 206 | static PyThreadState* |
| 207 | get_thread_state(void) |
| 208 | { |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 209 | PyThreadState *tstate = _PyThreadState_UncheckedGet(); |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 210 | if (tstate == NULL) { |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 211 | /* just in case but very unlikely... */ |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 212 | PyErr_SetString(PyExc_RuntimeError, |
| 213 | "unable to get the current thread state"); |
| 214 | return NULL; |
| 215 | } |
| 216 | return tstate; |
| 217 | } |
| 218 | |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 219 | static void |
| 220 | faulthandler_dump_traceback(int fd, int all_threads, |
| 221 | PyInterpreterState *interp) |
| 222 | { |
| 223 | static volatile int reentrant = 0; |
| 224 | PyThreadState *tstate; |
| 225 | |
| 226 | if (reentrant) |
| 227 | return; |
| 228 | |
| 229 | reentrant = 1; |
| 230 | |
| 231 | #ifdef WITH_THREAD |
| 232 | /* SIGSEGV, SIGFPE, SIGABRT, SIGBUS and SIGILL are synchronous signals and |
| 233 | are thus delivered to the thread that caused the fault. Get the Python |
| 234 | thread state of the current thread. |
| 235 | |
| 236 | PyThreadState_Get() doesn't give the state of the thread that caused the |
| 237 | fault if the thread released the GIL, and so this function cannot be |
| 238 | used. Read the thread local storage (TLS) instead: call |
| 239 | PyGILState_GetThisThreadState(). */ |
| 240 | tstate = PyGILState_GetThisThreadState(); |
| 241 | #else |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 242 | tstate = _PyThreadState_UncheckedGet(); |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 243 | #endif |
| 244 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 245 | if (all_threads) { |
| 246 | (void)_Py_DumpTracebackThreads(fd, NULL, tstate); |
| 247 | } |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 248 | else { |
| 249 | if (tstate != NULL) |
| 250 | _Py_DumpTraceback(fd, tstate); |
| 251 | } |
| 252 | |
| 253 | reentrant = 0; |
| 254 | } |
| 255 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 256 | static PyObject* |
| 257 | faulthandler_dump_traceback_py(PyObject *self, |
| 258 | PyObject *args, PyObject *kwargs) |
| 259 | { |
| 260 | static char *kwlist[] = {"file", "all_threads", NULL}; |
| 261 | PyObject *file = NULL; |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 262 | int all_threads = 1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 263 | PyThreadState *tstate; |
| 264 | const char *errmsg; |
| 265 | int fd; |
| 266 | |
| 267 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, |
| 268 | "|Oi:dump_traceback", kwlist, |
| 269 | &file, &all_threads)) |
| 270 | return NULL; |
| 271 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 272 | fd = faulthandler_get_fileno(&file); |
| 273 | if (fd < 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 274 | return NULL; |
| 275 | |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 276 | tstate = get_thread_state(); |
| 277 | if (tstate == NULL) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 278 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 279 | |
| 280 | if (all_threads) { |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 281 | errmsg = _Py_DumpTracebackThreads(fd, NULL, tstate); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 282 | if (errmsg != NULL) { |
| 283 | PyErr_SetString(PyExc_RuntimeError, errmsg); |
| 284 | return NULL; |
| 285 | } |
| 286 | } |
| 287 | else { |
| 288 | _Py_DumpTraceback(fd, tstate); |
| 289 | } |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 290 | |
| 291 | if (PyErr_CheckSignals()) |
| 292 | return NULL; |
| 293 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 294 | Py_RETURN_NONE; |
| 295 | } |
| 296 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 297 | static void |
| 298 | faulthandler_disable_fatal_handler(fault_handler_t *handler) |
| 299 | { |
| 300 | if (!handler->enabled) |
| 301 | return; |
| 302 | handler->enabled = 0; |
| 303 | #ifdef HAVE_SIGACTION |
| 304 | (void)sigaction(handler->signum, &handler->previous, NULL); |
| 305 | #else |
| 306 | (void)signal(handler->signum, handler->previous); |
| 307 | #endif |
| 308 | } |
| 309 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 310 | |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 311 | /* Handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS and SIGILL signals. |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 312 | |
| 313 | Display the current Python traceback, restore the previous handler and call |
| 314 | the previous handler. |
| 315 | |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 316 | On Windows, don't explicitly call the previous handler, because the Windows |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 317 | signal handler would not be called (for an unknown reason). The execution of |
| 318 | the program continues at faulthandler_fatal_error() exit, but the same |
| 319 | instruction will raise the same fault (signal), and so the previous handler |
| 320 | will be called. |
| 321 | |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 322 | This function is signal-safe and should only call signal-safe functions. */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 323 | |
| 324 | static void |
Victor Stinner | 44e31ba | 2011-04-07 11:39:03 +0200 | [diff] [blame] | 325 | faulthandler_fatal_error(int signum) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 326 | { |
| 327 | const int fd = fatal_error.fd; |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 328 | size_t i; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 329 | fault_handler_t *handler = NULL; |
Victor Stinner | c925617 | 2011-05-07 12:20:11 +0200 | [diff] [blame] | 330 | int save_errno = errno; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 331 | |
| 332 | if (!fatal_error.enabled) |
| 333 | return; |
| 334 | |
| 335 | for (i=0; i < faulthandler_nsignals; i++) { |
| 336 | handler = &faulthandler_handlers[i]; |
| 337 | if (handler->signum == signum) |
| 338 | break; |
| 339 | } |
| 340 | if (handler == NULL) { |
| 341 | /* faulthandler_nsignals == 0 (unlikely) */ |
| 342 | return; |
| 343 | } |
| 344 | |
| 345 | /* restore the previous handler */ |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 346 | faulthandler_disable_fatal_handler(handler); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 347 | |
| 348 | PUTS(fd, "Fatal Python error: "); |
| 349 | PUTS(fd, handler->name); |
| 350 | PUTS(fd, "\n\n"); |
| 351 | |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 352 | faulthandler_dump_traceback(fd, fatal_error.all_threads, |
| 353 | fatal_error.interp); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 354 | |
Victor Stinner | c925617 | 2011-05-07 12:20:11 +0200 | [diff] [blame] | 355 | errno = save_errno; |
Victor Stinner | bc6a4db | 2011-04-01 12:08:57 +0200 | [diff] [blame] | 356 | #ifdef MS_WINDOWS |
| 357 | if (signum == SIGSEGV) { |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 358 | /* don't explicitly call the previous handler for SIGSEGV in this signal |
Victor Stinner | bc6a4db | 2011-04-01 12:08:57 +0200 | [diff] [blame] | 359 | handler, because the Windows signal handler would not be called */ |
| 360 | return; |
| 361 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 362 | #endif |
R David Murray | fc06999 | 2013-12-13 20:52:19 -0500 | [diff] [blame] | 363 | /* call the previous signal handler: it is called immediately if we use |
Victor Stinner | bc6a4db | 2011-04-01 12:08:57 +0200 | [diff] [blame] | 364 | sigaction() thanks to SA_NODEFER flag, otherwise it is deferred */ |
| 365 | raise(signum); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 366 | } |
| 367 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 368 | #ifdef MS_WINDOWS |
| 369 | static LONG WINAPI |
| 370 | faulthandler_exc_handler(struct _EXCEPTION_POINTERS *exc_info) |
| 371 | { |
| 372 | const int fd = fatal_error.fd; |
| 373 | DWORD code = exc_info->ExceptionRecord->ExceptionCode; |
Victor Stinner | 412a5e7 | 2016-03-23 14:44:14 +0100 | [diff] [blame] | 374 | DWORD flags = exc_info->ExceptionRecord->ExceptionFlags; |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 375 | |
Steve Dower | e6a23c8 | 2017-06-05 15:54:15 -0700 | [diff] [blame] | 376 | /* bpo-30557: only log fatal exceptions */ |
| 377 | if (!(code & 0x80000000)) { |
Victor Stinner | 412a5e7 | 2016-03-23 14:44:14 +0100 | [diff] [blame] | 378 | /* call the next exception handler */ |
| 379 | return EXCEPTION_CONTINUE_SEARCH; |
| 380 | } |
| 381 | |
| 382 | PUTS(fd, "Windows fatal exception: "); |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 383 | switch (code) |
| 384 | { |
| 385 | /* only format most common errors */ |
| 386 | case EXCEPTION_ACCESS_VIOLATION: PUTS(fd, "access violation"); break; |
| 387 | case EXCEPTION_FLT_DIVIDE_BY_ZERO: PUTS(fd, "float divide by zero"); break; |
| 388 | case EXCEPTION_FLT_OVERFLOW: PUTS(fd, "float overflow"); break; |
| 389 | case EXCEPTION_INT_DIVIDE_BY_ZERO: PUTS(fd, "int divide by zero"); break; |
| 390 | case EXCEPTION_INT_OVERFLOW: PUTS(fd, "integer overflow"); break; |
| 391 | case EXCEPTION_IN_PAGE_ERROR: PUTS(fd, "page error"); break; |
| 392 | case EXCEPTION_STACK_OVERFLOW: PUTS(fd, "stack overflow"); break; |
| 393 | default: |
Steve Dower | e6a23c8 | 2017-06-05 15:54:15 -0700 | [diff] [blame] | 394 | PUTS(fd, "code 0x"); |
| 395 | _Py_DumpHexadecimal(fd, code, 8); |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 396 | } |
| 397 | PUTS(fd, "\n\n"); |
| 398 | |
| 399 | if (code == EXCEPTION_ACCESS_VIOLATION) { |
| 400 | /* disable signal handler for SIGSEGV */ |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 401 | for (size_t i=0; i < faulthandler_nsignals; i++) { |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 402 | fault_handler_t *handler = &faulthandler_handlers[i]; |
| 403 | if (handler->signum == SIGSEGV) { |
| 404 | faulthandler_disable_fatal_handler(handler); |
| 405 | break; |
| 406 | } |
| 407 | } |
| 408 | } |
| 409 | |
| 410 | faulthandler_dump_traceback(fd, fatal_error.all_threads, |
| 411 | fatal_error.interp); |
| 412 | |
| 413 | /* call the next exception handler */ |
| 414 | return EXCEPTION_CONTINUE_SEARCH; |
| 415 | } |
| 416 | #endif |
| 417 | |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 418 | /* Install the handler for fatal signals, faulthandler_fatal_error(). */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 419 | |
doko@ubuntu.com | bc73150 | 2016-05-18 01:06:01 +0200 | [diff] [blame] | 420 | static int |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 421 | faulthandler_enable(void) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 422 | { |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 423 | if (fatal_error.enabled) { |
| 424 | return 0; |
| 425 | } |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 426 | fatal_error.enabled = 1; |
| 427 | |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 428 | for (size_t i=0; i < faulthandler_nsignals; i++) { |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 429 | fault_handler_t *handler; |
| 430 | #ifdef HAVE_SIGACTION |
| 431 | struct sigaction action; |
| 432 | #endif |
| 433 | int err; |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 434 | |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 435 | handler = &faulthandler_handlers[i]; |
| 436 | assert(!handler->enabled); |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 437 | #ifdef HAVE_SIGACTION |
| 438 | action.sa_handler = faulthandler_fatal_error; |
| 439 | sigemptyset(&action.sa_mask); |
| 440 | /* Do not prevent the signal from being received from within |
| 441 | its own signal handler */ |
| 442 | action.sa_flags = SA_NODEFER; |
| 443 | #ifdef HAVE_SIGALTSTACK |
| 444 | if (stack.ss_sp != NULL) { |
| 445 | /* Call the signal handler on an alternate signal stack |
| 446 | provided by sigaltstack() */ |
| 447 | action.sa_flags |= SA_ONSTACK; |
| 448 | } |
| 449 | #endif |
| 450 | err = sigaction(handler->signum, &action, &handler->previous); |
| 451 | #else |
| 452 | handler->previous = signal(handler->signum, |
| 453 | faulthandler_fatal_error); |
| 454 | err = (handler->previous == SIG_ERR); |
| 455 | #endif |
| 456 | if (err) { |
| 457 | PyErr_SetFromErrno(PyExc_RuntimeError); |
| 458 | return -1; |
| 459 | } |
| 460 | |
| 461 | handler->enabled = 1; |
| 462 | } |
| 463 | |
| 464 | #ifdef MS_WINDOWS |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 465 | assert(fatal_error.exc_handler == NULL); |
| 466 | fatal_error.exc_handler = AddVectoredExceptionHandler(1, faulthandler_exc_handler); |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 467 | #endif |
| 468 | return 0; |
| 469 | } |
| 470 | |
| 471 | static PyObject* |
| 472 | faulthandler_py_enable(PyObject *self, PyObject *args, PyObject *kwargs) |
| 473 | { |
| 474 | static char *kwlist[] = {"file", "all_threads", NULL}; |
| 475 | PyObject *file = NULL; |
| 476 | int all_threads = 1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 477 | int fd; |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 478 | PyThreadState *tstate; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 479 | |
| 480 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, |
| 481 | "|Oi:enable", kwlist, &file, &all_threads)) |
| 482 | return NULL; |
| 483 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 484 | fd = faulthandler_get_fileno(&file); |
| 485 | if (fd < 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 486 | return NULL; |
| 487 | |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 488 | tstate = get_thread_state(); |
| 489 | if (tstate == NULL) |
| 490 | return NULL; |
| 491 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 492 | Py_XINCREF(file); |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 493 | Py_XSETREF(fatal_error.file, file); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 494 | fatal_error.fd = fd; |
| 495 | fatal_error.all_threads = all_threads; |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 496 | fatal_error.interp = tstate->interp; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 497 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 498 | if (faulthandler_enable() < 0) { |
| 499 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 500 | } |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 501 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 502 | Py_RETURN_NONE; |
| 503 | } |
| 504 | |
| 505 | static void |
| 506 | faulthandler_disable(void) |
| 507 | { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 508 | if (fatal_error.enabled) { |
| 509 | fatal_error.enabled = 0; |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 510 | for (size_t i=0; i < faulthandler_nsignals; i++) { |
| 511 | fault_handler_t *handler; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 512 | handler = &faulthandler_handlers[i]; |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 513 | faulthandler_disable_fatal_handler(handler); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 514 | } |
| 515 | } |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 516 | #ifdef MS_WINDOWS |
| 517 | if (fatal_error.exc_handler != NULL) { |
| 518 | RemoveVectoredExceptionHandler(fatal_error.exc_handler); |
| 519 | fatal_error.exc_handler = NULL; |
| 520 | } |
| 521 | #endif |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 522 | Py_CLEAR(fatal_error.file); |
| 523 | } |
| 524 | |
| 525 | static PyObject* |
| 526 | faulthandler_disable_py(PyObject *self) |
| 527 | { |
| 528 | if (!fatal_error.enabled) { |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 529 | Py_RETURN_FALSE; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 530 | } |
| 531 | faulthandler_disable(); |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 532 | Py_RETURN_TRUE; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 533 | } |
| 534 | |
| 535 | static PyObject* |
| 536 | faulthandler_is_enabled(PyObject *self) |
| 537 | { |
| 538 | return PyBool_FromLong(fatal_error.enabled); |
| 539 | } |
| 540 | |
| 541 | #ifdef FAULTHANDLER_LATER |
| 542 | |
| 543 | static void |
| 544 | faulthandler_thread(void *unused) |
| 545 | { |
| 546 | PyLockStatus st; |
| 547 | const char* errmsg; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 548 | int ok; |
Victor Stinner | cf2a807 | 2011-04-19 23:30:57 +0200 | [diff] [blame] | 549 | #if defined(HAVE_PTHREAD_SIGMASK) && !defined(HAVE_BROKEN_PTHREAD_SIGMASK) |
Victor Stinner | da9edae | 2011-04-04 11:05:21 +0200 | [diff] [blame] | 550 | sigset_t set; |
| 551 | |
| 552 | /* we don't want to receive any signal */ |
| 553 | sigfillset(&set); |
Victor Stinner | da9edae | 2011-04-04 11:05:21 +0200 | [diff] [blame] | 554 | pthread_sigmask(SIG_SETMASK, &set, NULL); |
Victor Stinner | da9edae | 2011-04-04 11:05:21 +0200 | [diff] [blame] | 555 | #endif |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 556 | |
| 557 | do { |
| 558 | st = PyThread_acquire_lock_timed(thread.cancel_event, |
Victor Stinner | 9418932 | 2011-04-08 13:00:31 +0200 | [diff] [blame] | 559 | thread.timeout_us, 0); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 560 | if (st == PY_LOCK_ACQUIRED) { |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 561 | PyThread_release_lock(thread.cancel_event); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 562 | break; |
| 563 | } |
| 564 | /* Timeout => dump traceback */ |
| 565 | assert(st == PY_LOCK_FAILURE); |
| 566 | |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 567 | _Py_write_noraise(thread.fd, thread.header, (int)thread.header_len); |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 568 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 569 | errmsg = _Py_DumpTracebackThreads(thread.fd, thread.interp, NULL); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 570 | ok = (errmsg == NULL); |
| 571 | |
| 572 | if (thread.exit) |
| 573 | _exit(1); |
| 574 | } while (ok && thread.repeat); |
| 575 | |
| 576 | /* The only way out */ |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 577 | PyThread_release_lock(thread.running); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 578 | } |
| 579 | |
| 580 | static void |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 581 | cancel_dump_traceback_later(void) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 582 | { |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 583 | /* Notify cancellation */ |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 584 | PyThread_release_lock(thread.cancel_event); |
| 585 | |
Victor Stinner | a4d4f1b | 2011-04-01 03:00:05 +0200 | [diff] [blame] | 586 | /* Wait for thread to join */ |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 587 | PyThread_acquire_lock(thread.running, 1); |
| 588 | PyThread_release_lock(thread.running); |
| 589 | |
| 590 | /* The main thread should always hold the cancel_event lock */ |
| 591 | PyThread_acquire_lock(thread.cancel_event, 1); |
| 592 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 593 | Py_CLEAR(thread.file); |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 594 | if (thread.header) { |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 595 | PyMem_Free(thread.header); |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 596 | thread.header = NULL; |
| 597 | } |
| 598 | } |
| 599 | |
| 600 | static char* |
| 601 | format_timeout(double timeout) |
| 602 | { |
| 603 | unsigned long us, sec, min, hour; |
| 604 | double intpart, fracpart; |
| 605 | char buffer[100]; |
| 606 | |
| 607 | fracpart = modf(timeout, &intpart); |
| 608 | sec = (unsigned long)intpart; |
| 609 | us = (unsigned long)(fracpart * 1e6); |
| 610 | min = sec / 60; |
| 611 | sec %= 60; |
| 612 | hour = min / 60; |
| 613 | min %= 60; |
| 614 | |
| 615 | if (us != 0) |
| 616 | PyOS_snprintf(buffer, sizeof(buffer), |
| 617 | "Timeout (%lu:%02lu:%02lu.%06lu)!\n", |
| 618 | hour, min, sec, us); |
| 619 | else |
| 620 | PyOS_snprintf(buffer, sizeof(buffer), |
| 621 | "Timeout (%lu:%02lu:%02lu)!\n", |
| 622 | hour, min, sec); |
| 623 | |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 624 | return _PyMem_Strdup(buffer); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 625 | } |
| 626 | |
| 627 | static PyObject* |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 628 | faulthandler_dump_traceback_later(PyObject *self, |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 629 | PyObject *args, PyObject *kwargs) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 630 | { |
| 631 | static char *kwlist[] = {"timeout", "repeat", "file", "exit", NULL}; |
| 632 | double timeout; |
Victor Stinner | 9418932 | 2011-04-08 13:00:31 +0200 | [diff] [blame] | 633 | PY_TIMEOUT_T timeout_us; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 634 | int repeat = 0; |
| 635 | PyObject *file = NULL; |
| 636 | int fd; |
| 637 | int exit = 0; |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 638 | PyThreadState *tstate; |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 639 | char *header; |
| 640 | size_t header_len; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 641 | |
| 642 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 643 | "d|iOi:dump_traceback_later", kwlist, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 644 | &timeout, &repeat, &file, &exit)) |
| 645 | return NULL; |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 646 | if ((timeout * 1e6) >= (double) PY_TIMEOUT_MAX) { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 647 | PyErr_SetString(PyExc_OverflowError, "timeout value is too large"); |
| 648 | return NULL; |
| 649 | } |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 650 | timeout_us = (PY_TIMEOUT_T)(timeout * 1e6); |
Victor Stinner | 9418932 | 2011-04-08 13:00:31 +0200 | [diff] [blame] | 651 | if (timeout_us <= 0) { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 652 | PyErr_SetString(PyExc_ValueError, "timeout must be greater than 0"); |
| 653 | return NULL; |
| 654 | } |
| 655 | |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 656 | tstate = get_thread_state(); |
| 657 | if (tstate == NULL) |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 658 | return NULL; |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 659 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 660 | fd = faulthandler_get_fileno(&file); |
| 661 | if (fd < 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 662 | return NULL; |
| 663 | |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 664 | /* format the timeout */ |
| 665 | header = format_timeout(timeout); |
| 666 | if (header == NULL) |
| 667 | return PyErr_NoMemory(); |
| 668 | header_len = strlen(header); |
| 669 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 670 | /* Cancel previous thread, if running */ |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 671 | cancel_dump_traceback_later(); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 672 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 673 | Py_XINCREF(file); |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 674 | Py_XSETREF(thread.file, file); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 675 | thread.fd = fd; |
Victor Stinner | 9418932 | 2011-04-08 13:00:31 +0200 | [diff] [blame] | 676 | thread.timeout_us = timeout_us; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 677 | thread.repeat = repeat; |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 678 | thread.interp = tstate->interp; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 679 | thread.exit = exit; |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 680 | thread.header = header; |
| 681 | thread.header_len = header_len; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 682 | |
| 683 | /* Arm these locks to serve as events when released */ |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 684 | PyThread_acquire_lock(thread.running, 1); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 685 | |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 686 | if (PyThread_start_new_thread(faulthandler_thread, NULL) == PYTHREAD_INVALID_THREAD_ID) { |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 687 | PyThread_release_lock(thread.running); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 688 | Py_CLEAR(thread.file); |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 689 | PyMem_Free(header); |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 690 | thread.header = NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 691 | PyErr_SetString(PyExc_RuntimeError, |
| 692 | "unable to start watchdog thread"); |
| 693 | return NULL; |
| 694 | } |
| 695 | |
| 696 | Py_RETURN_NONE; |
| 697 | } |
| 698 | |
| 699 | static PyObject* |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 700 | faulthandler_cancel_dump_traceback_later_py(PyObject *self) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 701 | { |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 702 | cancel_dump_traceback_later(); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 703 | Py_RETURN_NONE; |
| 704 | } |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 705 | #endif /* FAULTHANDLER_LATER */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 706 | |
| 707 | #ifdef FAULTHANDLER_USER |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 708 | static int |
| 709 | faulthandler_register(int signum, int chain, _Py_sighandler_t *p_previous) |
| 710 | { |
| 711 | #ifdef HAVE_SIGACTION |
| 712 | struct sigaction action; |
| 713 | action.sa_handler = faulthandler_user; |
| 714 | sigemptyset(&action.sa_mask); |
| 715 | /* if the signal is received while the kernel is executing a system |
| 716 | call, try to restart the system call instead of interrupting it and |
| 717 | return EINTR. */ |
| 718 | action.sa_flags = SA_RESTART; |
| 719 | if (chain) { |
| 720 | /* do not prevent the signal from being received from within its |
| 721 | own signal handler */ |
| 722 | action.sa_flags = SA_NODEFER; |
| 723 | } |
| 724 | #ifdef HAVE_SIGALTSTACK |
| 725 | if (stack.ss_sp != NULL) { |
| 726 | /* Call the signal handler on an alternate signal stack |
| 727 | provided by sigaltstack() */ |
| 728 | action.sa_flags |= SA_ONSTACK; |
| 729 | } |
| 730 | #endif |
| 731 | return sigaction(signum, &action, p_previous); |
| 732 | #else |
| 733 | _Py_sighandler_t previous; |
| 734 | previous = signal(signum, faulthandler_user); |
| 735 | if (p_previous != NULL) |
| 736 | *p_previous = previous; |
| 737 | return (previous == SIG_ERR); |
| 738 | #endif |
| 739 | } |
| 740 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 741 | /* Handler of user signals (e.g. SIGUSR1). |
| 742 | |
| 743 | Dump the traceback of the current thread, or of all threads if |
| 744 | thread.all_threads is true. |
| 745 | |
| 746 | This function is signal safe and should only call signal safe functions. */ |
| 747 | |
| 748 | static void |
| 749 | faulthandler_user(int signum) |
| 750 | { |
| 751 | user_signal_t *user; |
Victor Stinner | c925617 | 2011-05-07 12:20:11 +0200 | [diff] [blame] | 752 | int save_errno = errno; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 753 | |
| 754 | user = &user_signals[signum]; |
| 755 | if (!user->enabled) |
| 756 | return; |
| 757 | |
Victor Stinner | c7489a5 | 2015-04-01 18:48:58 +0200 | [diff] [blame] | 758 | faulthandler_dump_traceback(user->fd, user->all_threads, user->interp); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 759 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 760 | #ifdef HAVE_SIGACTION |
| 761 | if (user->chain) { |
| 762 | (void)sigaction(signum, &user->previous, NULL); |
Victor Stinner | 3cc635d | 2012-08-09 02:43:41 +0200 | [diff] [blame] | 763 | errno = save_errno; |
| 764 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 765 | /* call the previous signal handler */ |
| 766 | raise(signum); |
Victor Stinner | 3cc635d | 2012-08-09 02:43:41 +0200 | [diff] [blame] | 767 | |
| 768 | save_errno = errno; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 769 | (void)faulthandler_register(signum, user->chain, NULL); |
Victor Stinner | 3cc635d | 2012-08-09 02:43:41 +0200 | [diff] [blame] | 770 | errno = save_errno; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 771 | } |
| 772 | #else |
| 773 | if (user->chain) { |
Victor Stinner | 3cc635d | 2012-08-09 02:43:41 +0200 | [diff] [blame] | 774 | errno = save_errno; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 775 | /* call the previous signal handler */ |
| 776 | user->previous(signum); |
| 777 | } |
| 778 | #endif |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 779 | } |
| 780 | |
| 781 | static int |
| 782 | check_signum(int signum) |
| 783 | { |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 784 | for (size_t i=0; i < faulthandler_nsignals; i++) { |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 785 | if (faulthandler_handlers[i].signum == signum) { |
| 786 | PyErr_Format(PyExc_RuntimeError, |
| 787 | "signal %i cannot be registered, " |
| 788 | "use enable() instead", |
| 789 | signum); |
| 790 | return 0; |
| 791 | } |
| 792 | } |
| 793 | if (signum < 1 || NSIG <= signum) { |
| 794 | PyErr_SetString(PyExc_ValueError, "signal number out of range"); |
| 795 | return 0; |
| 796 | } |
| 797 | return 1; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 798 | } |
| 799 | |
| 800 | static PyObject* |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 801 | faulthandler_register_py(PyObject *self, |
| 802 | PyObject *args, PyObject *kwargs) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 803 | { |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 804 | static char *kwlist[] = {"signum", "file", "all_threads", "chain", NULL}; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 805 | int signum; |
| 806 | PyObject *file = NULL; |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 807 | int all_threads = 1; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 808 | int chain = 0; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 809 | int fd; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 810 | user_signal_t *user; |
| 811 | _Py_sighandler_t previous; |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 812 | PyThreadState *tstate; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 813 | int err; |
| 814 | |
| 815 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 816 | "i|Oii:register", kwlist, |
| 817 | &signum, &file, &all_threads, &chain)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 818 | return NULL; |
| 819 | |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 820 | if (!check_signum(signum)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 821 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 822 | |
Victor Stinner | a4de6d8 | 2011-04-09 00:47:23 +0200 | [diff] [blame] | 823 | tstate = get_thread_state(); |
| 824 | if (tstate == NULL) |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 825 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 826 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 827 | fd = faulthandler_get_fileno(&file); |
| 828 | if (fd < 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 829 | return NULL; |
| 830 | |
| 831 | if (user_signals == NULL) { |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 832 | user_signals = PyMem_Malloc(NSIG * sizeof(user_signal_t)); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 833 | if (user_signals == NULL) |
| 834 | return PyErr_NoMemory(); |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 835 | memset(user_signals, 0, NSIG * sizeof(user_signal_t)); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 836 | } |
| 837 | user = &user_signals[signum]; |
| 838 | |
| 839 | if (!user->enabled) { |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 840 | err = faulthandler_register(signum, chain, &previous); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 841 | if (err) { |
| 842 | PyErr_SetFromErrno(PyExc_OSError); |
| 843 | return NULL; |
| 844 | } |
Victor Stinner | 8d37954 | 2013-07-02 00:14:56 +0200 | [diff] [blame] | 845 | |
| 846 | user->previous = previous; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 847 | } |
| 848 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 849 | Py_XINCREF(file); |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 850 | Py_XSETREF(user->file, file); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 851 | user->fd = fd; |
| 852 | user->all_threads = all_threads; |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 853 | user->chain = chain; |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 854 | user->interp = tstate->interp; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 855 | user->enabled = 1; |
| 856 | |
| 857 | Py_RETURN_NONE; |
| 858 | } |
| 859 | |
| 860 | static int |
| 861 | faulthandler_unregister(user_signal_t *user, int signum) |
| 862 | { |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 863 | if (!user->enabled) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 864 | return 0; |
| 865 | user->enabled = 0; |
| 866 | #ifdef HAVE_SIGACTION |
| 867 | (void)sigaction(signum, &user->previous, NULL); |
| 868 | #else |
| 869 | (void)signal(signum, user->previous); |
| 870 | #endif |
| 871 | Py_CLEAR(user->file); |
| 872 | user->fd = -1; |
| 873 | return 1; |
| 874 | } |
| 875 | |
| 876 | static PyObject* |
| 877 | faulthandler_unregister_py(PyObject *self, PyObject *args) |
| 878 | { |
| 879 | int signum; |
| 880 | user_signal_t *user; |
| 881 | int change; |
| 882 | |
| 883 | if (!PyArg_ParseTuple(args, "i:unregister", &signum)) |
| 884 | return NULL; |
| 885 | |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 886 | if (!check_signum(signum)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 887 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 888 | |
Victor Stinner | cfa7123 | 2011-04-08 12:48:15 +0200 | [diff] [blame] | 889 | if (user_signals == NULL) |
| 890 | Py_RETURN_FALSE; |
| 891 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 892 | user = &user_signals[signum]; |
| 893 | change = faulthandler_unregister(user, signum); |
| 894 | return PyBool_FromLong(change); |
| 895 | } |
| 896 | #endif /* FAULTHANDLER_USER */ |
| 897 | |
| 898 | |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 899 | static void |
| 900 | faulthandler_suppress_crash_report(void) |
| 901 | { |
| 902 | #ifdef MS_WINDOWS |
| 903 | UINT mode; |
| 904 | |
| 905 | /* Configure Windows to not display the Windows Error Reporting dialog */ |
| 906 | mode = SetErrorMode(SEM_NOGPFAULTERRORBOX); |
| 907 | SetErrorMode(mode | SEM_NOGPFAULTERRORBOX); |
| 908 | #endif |
| 909 | |
| 910 | #ifdef HAVE_SYS_RESOURCE_H |
| 911 | struct rlimit rl; |
| 912 | |
| 913 | /* Disable creation of core dump */ |
| 914 | if (getrlimit(RLIMIT_CORE, &rl) != 0) { |
| 915 | rl.rlim_cur = 0; |
| 916 | setrlimit(RLIMIT_CORE, &rl); |
| 917 | } |
| 918 | #endif |
| 919 | |
| 920 | #ifdef _MSC_VER |
| 921 | /* Visual Studio: configure abort() to not display an error message nor |
| 922 | open a popup asking to report the fault. */ |
| 923 | _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT); |
| 924 | #endif |
| 925 | } |
| 926 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 927 | static PyObject * |
| 928 | faulthandler_read_null(PyObject *self, PyObject *args) |
| 929 | { |
Victor Stinner | a247720 | 2012-01-30 00:07:43 +0100 | [diff] [blame] | 930 | volatile int *x; |
| 931 | volatile int y; |
Victor Stinner | a247720 | 2012-01-30 00:07:43 +0100 | [diff] [blame] | 932 | |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 933 | faulthandler_suppress_crash_report(); |
Victor Stinner | a247720 | 2012-01-30 00:07:43 +0100 | [diff] [blame] | 934 | x = NULL; |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 935 | y = *x; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 936 | return PyLong_FromLong(y); |
| 937 | |
| 938 | } |
| 939 | |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 940 | static void |
| 941 | faulthandler_raise_sigsegv(void) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 942 | { |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 943 | faulthandler_suppress_crash_report(); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 944 | #if defined(MS_WINDOWS) |
Victor Stinner | bc6a4db | 2011-04-01 12:08:57 +0200 | [diff] [blame] | 945 | /* For SIGSEGV, faulthandler_fatal_error() restores the previous signal |
| 946 | handler and then gives back the execution flow to the program (without |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 947 | explicitly calling the previous error handler). In a normal case, the |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 948 | SIGSEGV was raised by the kernel because of a fault, and so if the |
| 949 | program retries to execute the same instruction, the fault will be |
| 950 | raised again. |
| 951 | |
| 952 | Here the fault is simulated by a fake SIGSEGV signal raised by the |
| 953 | application. We have to raise SIGSEGV at lease twice: once for |
| 954 | faulthandler_fatal_error(), and one more time for the previous signal |
| 955 | handler. */ |
| 956 | while(1) |
| 957 | raise(SIGSEGV); |
| 958 | #else |
| 959 | raise(SIGSEGV); |
| 960 | #endif |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 961 | } |
| 962 | |
| 963 | static PyObject * |
| 964 | faulthandler_sigsegv(PyObject *self, PyObject *args) |
| 965 | { |
| 966 | int release_gil = 0; |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 967 | if (!PyArg_ParseTuple(args, "|i:_sigsegv", &release_gil)) |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 968 | return NULL; |
| 969 | |
| 970 | if (release_gil) { |
| 971 | Py_BEGIN_ALLOW_THREADS |
| 972 | faulthandler_raise_sigsegv(); |
| 973 | Py_END_ALLOW_THREADS |
| 974 | } else { |
| 975 | faulthandler_raise_sigsegv(); |
| 976 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 977 | Py_RETURN_NONE; |
| 978 | } |
| 979 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 980 | #ifdef WITH_THREAD |
| 981 | static void |
| 982 | faulthandler_fatal_error_thread(void *plock) |
| 983 | { |
Victor Stinner | 9a2329f | 2016-12-05 17:56:36 +0100 | [diff] [blame] | 984 | #ifndef __clang__ |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 985 | PyThread_type_lock *lock = (PyThread_type_lock *)plock; |
Victor Stinner | 9a2329f | 2016-12-05 17:56:36 +0100 | [diff] [blame] | 986 | #endif |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 987 | |
| 988 | Py_FatalError("in new thread"); |
| 989 | |
Victor Stinner | 9a2329f | 2016-12-05 17:56:36 +0100 | [diff] [blame] | 990 | #ifndef __clang__ |
| 991 | /* Issue #28152: Py_FatalError() is declared with |
| 992 | __attribute__((__noreturn__)). GCC emits a warning without |
| 993 | "PyThread_release_lock()" (compiler bug?), but Clang is smarter and |
| 994 | emits a warning on the return. */ |
| 995 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 996 | /* notify the caller that we are done */ |
| 997 | PyThread_release_lock(lock); |
Victor Stinner | 9a2329f | 2016-12-05 17:56:36 +0100 | [diff] [blame] | 998 | #endif |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 999 | } |
| 1000 | |
| 1001 | static PyObject * |
| 1002 | faulthandler_fatal_error_c_thread(PyObject *self, PyObject *args) |
| 1003 | { |
| 1004 | long thread; |
| 1005 | PyThread_type_lock lock; |
| 1006 | |
| 1007 | faulthandler_suppress_crash_report(); |
| 1008 | |
| 1009 | lock = PyThread_allocate_lock(); |
| 1010 | if (lock == NULL) |
| 1011 | return PyErr_NoMemory(); |
| 1012 | |
| 1013 | PyThread_acquire_lock(lock, WAIT_LOCK); |
| 1014 | |
| 1015 | thread = PyThread_start_new_thread(faulthandler_fatal_error_thread, lock); |
| 1016 | if (thread == -1) { |
| 1017 | PyThread_free_lock(lock); |
| 1018 | PyErr_SetString(PyExc_RuntimeError, "unable to start the thread"); |
| 1019 | return NULL; |
| 1020 | } |
| 1021 | |
| 1022 | /* wait until the thread completes: it will never occur, since Py_FatalError() |
| 1023 | exits the process immedialty. */ |
| 1024 | PyThread_acquire_lock(lock, WAIT_LOCK); |
| 1025 | PyThread_release_lock(lock); |
| 1026 | PyThread_free_lock(lock); |
| 1027 | |
| 1028 | Py_RETURN_NONE; |
| 1029 | } |
| 1030 | #endif |
| 1031 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1032 | static PyObject * |
| 1033 | faulthandler_sigfpe(PyObject *self, PyObject *args) |
| 1034 | { |
| 1035 | /* Do an integer division by zero: raise a SIGFPE on Intel CPU, but not on |
| 1036 | PowerPC. Use volatile to disable compile-time optimizations. */ |
| 1037 | volatile int x = 1, y = 0, z; |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 1038 | faulthandler_suppress_crash_report(); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1039 | z = x / y; |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 1040 | /* If the division by zero didn't raise a SIGFPE (e.g. on PowerPC), |
| 1041 | raise it manually. */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1042 | raise(SIGFPE); |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 1043 | /* This line is never reached, but we pretend to make something with z |
| 1044 | to silence a compiler warning. */ |
Victor Stinner | e0c9a75 | 2011-05-09 14:44:26 +0200 | [diff] [blame] | 1045 | return PyLong_FromLong(z); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1046 | } |
| 1047 | |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 1048 | static PyObject * |
| 1049 | faulthandler_sigabrt(PyObject *self, PyObject *args) |
| 1050 | { |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 1051 | faulthandler_suppress_crash_report(); |
Victor Stinner | 00bc6cc | 2011-05-10 01:30:03 +0200 | [diff] [blame] | 1052 | abort(); |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 1053 | Py_RETURN_NONE; |
| 1054 | } |
| 1055 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1056 | static PyObject * |
| 1057 | faulthandler_fatal_error_py(PyObject *self, PyObject *args) |
| 1058 | { |
| 1059 | char *message; |
Victor Stinner | 57003f8 | 2016-03-15 17:23:35 +0100 | [diff] [blame] | 1060 | int release_gil = 0; |
| 1061 | if (!PyArg_ParseTuple(args, "y|i:fatal_error", &message, &release_gil)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1062 | return NULL; |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 1063 | faulthandler_suppress_crash_report(); |
Victor Stinner | 57003f8 | 2016-03-15 17:23:35 +0100 | [diff] [blame] | 1064 | if (release_gil) { |
| 1065 | Py_BEGIN_ALLOW_THREADS |
| 1066 | Py_FatalError(message); |
| 1067 | Py_END_ALLOW_THREADS |
| 1068 | } |
| 1069 | else { |
| 1070 | Py_FatalError(message); |
| 1071 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1072 | Py_RETURN_NONE; |
| 1073 | } |
| 1074 | |
| 1075 | #if defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION) |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1076 | #define FAULTHANDLER_STACK_OVERFLOW |
| 1077 | |
Victor Stinner | 19276f1 | 2015-03-23 21:20:27 +0100 | [diff] [blame] | 1078 | #ifdef __INTEL_COMPILER |
| 1079 | /* Issue #23654: Turn off ICC's tail call optimization for the |
| 1080 | * stack_overflow generator. ICC turns the recursive tail call into |
| 1081 | * a loop. */ |
| 1082 | # pragma intel optimization_level 0 |
| 1083 | #endif |
| 1084 | static |
Benjamin Peterson | ca47063 | 2016-09-06 13:47:26 -0700 | [diff] [blame] | 1085 | uintptr_t |
| 1086 | stack_overflow(uintptr_t min_sp, uintptr_t max_sp, size_t *depth) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1087 | { |
| 1088 | /* allocate 4096 bytes on the stack at each call */ |
| 1089 | unsigned char buffer[4096]; |
Benjamin Peterson | ca47063 | 2016-09-06 13:47:26 -0700 | [diff] [blame] | 1090 | uintptr_t sp = (uintptr_t)&buffer; |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1091 | *depth += 1; |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 1092 | if (sp < min_sp || max_sp < sp) |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1093 | return sp; |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 1094 | buffer[0] = 1; |
| 1095 | buffer[4095] = 0; |
| 1096 | return stack_overflow(min_sp, max_sp, depth); |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1097 | } |
| 1098 | |
| 1099 | static PyObject * |
| 1100 | faulthandler_stack_overflow(PyObject *self) |
| 1101 | { |
| 1102 | size_t depth, size; |
Benjamin Peterson | ca47063 | 2016-09-06 13:47:26 -0700 | [diff] [blame] | 1103 | uintptr_t sp = (uintptr_t)&depth; |
| 1104 | uintptr_t stop; |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1105 | |
Victor Stinner | 7a39912 | 2014-09-30 13:40:12 +0200 | [diff] [blame] | 1106 | faulthandler_suppress_crash_report(); |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1107 | depth = 0; |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 1108 | stop = stack_overflow(sp - STACK_OVERFLOW_MAX_SIZE, |
| 1109 | sp + STACK_OVERFLOW_MAX_SIZE, |
| 1110 | &depth); |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 1111 | if (sp < stop) |
| 1112 | size = stop - sp; |
| 1113 | else |
| 1114 | size = sp - stop; |
| 1115 | PyErr_Format(PyExc_RuntimeError, |
| 1116 | "unable to raise a stack overflow (allocated %zu bytes " |
| 1117 | "on the stack, %zu recursive calls)", |
| 1118 | size, depth); |
| 1119 | return NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1120 | } |
Victor Stinner | 928ad28 | 2016-03-23 15:19:12 +0100 | [diff] [blame] | 1121 | #endif /* defined(HAVE_SIGALTSTACK) && defined(HAVE_SIGACTION) */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1122 | |
| 1123 | |
| 1124 | static int |
| 1125 | faulthandler_traverse(PyObject *module, visitproc visit, void *arg) |
| 1126 | { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1127 | #ifdef FAULTHANDLER_LATER |
| 1128 | Py_VISIT(thread.file); |
| 1129 | #endif |
| 1130 | #ifdef FAULTHANDLER_USER |
| 1131 | if (user_signals != NULL) { |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 1132 | for (size_t signum=0; signum < NSIG; signum++) |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 1133 | Py_VISIT(user_signals[signum].file); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1134 | } |
| 1135 | #endif |
| 1136 | Py_VISIT(fatal_error.file); |
| 1137 | return 0; |
| 1138 | } |
| 1139 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1140 | #ifdef MS_WINDOWS |
| 1141 | static PyObject * |
| 1142 | faulthandler_raise_exception(PyObject *self, PyObject *args) |
| 1143 | { |
| 1144 | unsigned int code, flags = 0; |
| 1145 | if (!PyArg_ParseTuple(args, "I|I:_raise_exception", &code, &flags)) |
| 1146 | return NULL; |
| 1147 | faulthandler_suppress_crash_report(); |
| 1148 | RaiseException(code, flags, 0, NULL); |
| 1149 | Py_RETURN_NONE; |
| 1150 | } |
| 1151 | #endif |
| 1152 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1153 | PyDoc_STRVAR(module_doc, |
| 1154 | "faulthandler module."); |
| 1155 | |
| 1156 | static PyMethodDef module_methods[] = { |
| 1157 | {"enable", |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1158 | (PyCFunction)faulthandler_py_enable, METH_VARARGS|METH_KEYWORDS, |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 1159 | PyDoc_STR("enable(file=sys.stderr, all_threads=True): " |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1160 | "enable the fault handler")}, |
| 1161 | {"disable", (PyCFunction)faulthandler_disable_py, METH_NOARGS, |
| 1162 | PyDoc_STR("disable(): disable the fault handler")}, |
| 1163 | {"is_enabled", (PyCFunction)faulthandler_is_enabled, METH_NOARGS, |
| 1164 | PyDoc_STR("is_enabled()->bool: check if the handler is enabled")}, |
| 1165 | {"dump_traceback", |
| 1166 | (PyCFunction)faulthandler_dump_traceback_py, METH_VARARGS|METH_KEYWORDS, |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 1167 | PyDoc_STR("dump_traceback(file=sys.stderr, all_threads=True): " |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1168 | "dump the traceback of the current thread, or of all threads " |
| 1169 | "if all_threads is True, into file")}, |
| 1170 | #ifdef FAULTHANDLER_LATER |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 1171 | {"dump_traceback_later", |
| 1172 | (PyCFunction)faulthandler_dump_traceback_later, METH_VARARGS|METH_KEYWORDS, |
| 1173 | PyDoc_STR("dump_traceback_later(timeout, repeat=False, file=sys.stderrn, exit=False):\n" |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1174 | "dump the traceback of all threads in timeout seconds,\n" |
Victor Stinner | 9699440 | 2011-04-07 11:37:19 +0200 | [diff] [blame] | 1175 | "or each timeout seconds if repeat is True. If exit is True, " |
| 1176 | "call _exit(1) which is not safe.")}, |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 1177 | {"cancel_dump_traceback_later", |
| 1178 | (PyCFunction)faulthandler_cancel_dump_traceback_later_py, METH_NOARGS, |
| 1179 | PyDoc_STR("cancel_dump_traceback_later():\ncancel the previous call " |
| 1180 | "to dump_traceback_later().")}, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1181 | #endif |
| 1182 | |
| 1183 | #ifdef FAULTHANDLER_USER |
| 1184 | {"register", |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 1185 | (PyCFunction)faulthandler_register_py, METH_VARARGS|METH_KEYWORDS, |
| 1186 | PyDoc_STR("register(signum, file=sys.stderr, all_threads=True, chain=False): " |
Serhiy Storchaka | 6a7b3a7 | 2016-04-17 08:32:47 +0300 | [diff] [blame] | 1187 | "register a handler for the signal 'signum': dump the " |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1188 | "traceback of the current thread, or of all threads if " |
| 1189 | "all_threads is True, into file")}, |
| 1190 | {"unregister", |
| 1191 | faulthandler_unregister_py, METH_VARARGS|METH_KEYWORDS, |
| 1192 | PyDoc_STR("unregister(signum): unregister the handler of the signal " |
| 1193 | "'signum' registered by register()")}, |
| 1194 | #endif |
| 1195 | |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 1196 | {"_read_null", faulthandler_read_null, METH_NOARGS, |
| 1197 | PyDoc_STR("_read_null(): read from NULL, raise " |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1198 | "a SIGSEGV or SIGBUS signal depending on the platform")}, |
| 1199 | {"_sigsegv", faulthandler_sigsegv, METH_VARARGS, |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 1200 | PyDoc_STR("_sigsegv(release_gil=False): raise a SIGSEGV signal")}, |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 1201 | #ifdef WITH_THREAD |
| 1202 | {"_fatal_error_c_thread", faulthandler_fatal_error_c_thread, METH_NOARGS, |
| 1203 | PyDoc_STR("fatal_error_c_thread(): " |
| 1204 | "call Py_FatalError() in a new C thread.")}, |
| 1205 | #endif |
Victor Stinner | 9db521c | 2014-09-30 13:49:09 +0200 | [diff] [blame] | 1206 | {"_sigabrt", faulthandler_sigabrt, METH_NOARGS, |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 1207 | PyDoc_STR("_sigabrt(): raise a SIGABRT signal")}, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1208 | {"_sigfpe", (PyCFunction)faulthandler_sigfpe, METH_NOARGS, |
| 1209 | PyDoc_STR("_sigfpe(): raise a SIGFPE signal")}, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1210 | {"_fatal_error", faulthandler_fatal_error_py, METH_VARARGS, |
| 1211 | PyDoc_STR("_fatal_error(message): call Py_FatalError(message)")}, |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1212 | #ifdef FAULTHANDLER_STACK_OVERFLOW |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1213 | {"_stack_overflow", (PyCFunction)faulthandler_stack_overflow, METH_NOARGS, |
| 1214 | PyDoc_STR("_stack_overflow(): recursive call to raise a stack overflow")}, |
| 1215 | #endif |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1216 | #ifdef MS_WINDOWS |
| 1217 | {"_raise_exception", faulthandler_raise_exception, METH_VARARGS, |
| 1218 | PyDoc_STR("raise_exception(code, flags=0): Call RaiseException(code, flags).")}, |
| 1219 | #endif |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 1220 | {NULL, NULL} /* sentinel */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1221 | }; |
| 1222 | |
| 1223 | static struct PyModuleDef module_def = { |
| 1224 | PyModuleDef_HEAD_INIT, |
| 1225 | "faulthandler", |
| 1226 | module_doc, |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 1227 | 0, /* non-negative size to be able to unload the module */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1228 | module_methods, |
| 1229 | NULL, |
| 1230 | faulthandler_traverse, |
| 1231 | NULL, |
| 1232 | NULL |
| 1233 | }; |
| 1234 | |
| 1235 | PyMODINIT_FUNC |
| 1236 | PyInit_faulthandler(void) |
| 1237 | { |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 1238 | PyObject *m = PyModule_Create(&module_def); |
| 1239 | if (m == NULL) |
| 1240 | return NULL; |
| 1241 | |
| 1242 | /* Add constants for unit tests */ |
| 1243 | #ifdef MS_WINDOWS |
| 1244 | /* RaiseException() codes (prefixed by an underscore) */ |
| 1245 | if (PyModule_AddIntConstant(m, "_EXCEPTION_ACCESS_VIOLATION", |
| 1246 | EXCEPTION_ACCESS_VIOLATION)) |
| 1247 | return NULL; |
| 1248 | if (PyModule_AddIntConstant(m, "_EXCEPTION_INT_DIVIDE_BY_ZERO", |
| 1249 | EXCEPTION_INT_DIVIDE_BY_ZERO)) |
| 1250 | return NULL; |
| 1251 | if (PyModule_AddIntConstant(m, "_EXCEPTION_STACK_OVERFLOW", |
| 1252 | EXCEPTION_STACK_OVERFLOW)) |
| 1253 | return NULL; |
| 1254 | |
| 1255 | /* RaiseException() flags (prefixed by an underscore) */ |
| 1256 | if (PyModule_AddIntConstant(m, "_EXCEPTION_NONCONTINUABLE", |
| 1257 | EXCEPTION_NONCONTINUABLE)) |
| 1258 | return NULL; |
| 1259 | if (PyModule_AddIntConstant(m, "_EXCEPTION_NONCONTINUABLE_EXCEPTION", |
| 1260 | EXCEPTION_NONCONTINUABLE_EXCEPTION)) |
| 1261 | return NULL; |
| 1262 | #endif |
| 1263 | |
| 1264 | return m; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1265 | } |
| 1266 | |
Victor Stinner | 410dd7d | 2011-05-11 20:56:08 +0200 | [diff] [blame] | 1267 | /* Call faulthandler.enable() if the PYTHONFAULTHANDLER environment variable |
| 1268 | is defined, or if sys._xoptions has a 'faulthandler' key. */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1269 | |
| 1270 | static int |
| 1271 | faulthandler_env_options(void) |
| 1272 | { |
| 1273 | PyObject *xoptions, *key, *module, *res; |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 1274 | char *p; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1275 | |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 1276 | if (!((p = Py_GETENV("PYTHONFAULTHANDLER")) && *p != '\0')) { |
| 1277 | /* PYTHONFAULTHANDLER environment variable is missing |
| 1278 | or an empty string */ |
Victor Stinner | 25095b2 | 2011-05-26 13:47:08 +0200 | [diff] [blame] | 1279 | int has_key; |
| 1280 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1281 | xoptions = PySys_GetXOptions(); |
| 1282 | if (xoptions == NULL) |
| 1283 | return -1; |
| 1284 | |
| 1285 | key = PyUnicode_FromString("faulthandler"); |
| 1286 | if (key == NULL) |
| 1287 | return -1; |
| 1288 | |
Victor Stinner | 25095b2 | 2011-05-26 13:47:08 +0200 | [diff] [blame] | 1289 | has_key = PyDict_Contains(xoptions, key); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1290 | Py_DECREF(key); |
Serhiy Storchaka | fa494fd | 2015-05-30 17:45:22 +0300 | [diff] [blame] | 1291 | if (has_key <= 0) |
| 1292 | return has_key; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1293 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1294 | |
| 1295 | module = PyImport_ImportModule("faulthandler"); |
| 1296 | if (module == NULL) { |
| 1297 | return -1; |
| 1298 | } |
Victor Stinner | 3466bde | 2016-09-05 18:16:01 -0700 | [diff] [blame] | 1299 | res = _PyObject_CallMethodId(module, &PyId_enable, NULL); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1300 | Py_DECREF(module); |
| 1301 | if (res == NULL) |
| 1302 | return -1; |
| 1303 | Py_DECREF(res); |
| 1304 | return 0; |
| 1305 | } |
| 1306 | |
| 1307 | int _PyFaulthandler_Init(void) |
| 1308 | { |
| 1309 | #ifdef HAVE_SIGALTSTACK |
| 1310 | int err; |
| 1311 | |
| 1312 | /* Try to allocate an alternate stack for faulthandler() signal handler to |
| 1313 | * be able to allocate memory on the stack, even on a stack overflow. If it |
| 1314 | * fails, ignore the error. */ |
| 1315 | stack.ss_flags = 0; |
| 1316 | stack.ss_size = SIGSTKSZ; |
| 1317 | stack.ss_sp = PyMem_Malloc(stack.ss_size); |
| 1318 | if (stack.ss_sp != NULL) { |
Christophe Zeitouny | 20fbf8a | 2017-03-23 10:14:29 -0700 | [diff] [blame] | 1319 | err = sigaltstack(&stack, &old_stack); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1320 | if (err) { |
| 1321 | PyMem_Free(stack.ss_sp); |
| 1322 | stack.ss_sp = NULL; |
| 1323 | } |
| 1324 | } |
| 1325 | #endif |
| 1326 | #ifdef FAULTHANDLER_LATER |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1327 | thread.file = NULL; |
| 1328 | thread.cancel_event = PyThread_allocate_lock(); |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 1329 | thread.running = PyThread_allocate_lock(); |
| 1330 | if (!thread.cancel_event || !thread.running) { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1331 | PyErr_SetString(PyExc_RuntimeError, |
| 1332 | "could not allocate locks for faulthandler"); |
| 1333 | return -1; |
| 1334 | } |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 1335 | PyThread_acquire_lock(thread.cancel_event, 1); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1336 | #endif |
| 1337 | |
| 1338 | return faulthandler_env_options(); |
| 1339 | } |
| 1340 | |
| 1341 | void _PyFaulthandler_Fini(void) |
| 1342 | { |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1343 | #ifdef FAULTHANDLER_LATER |
| 1344 | /* later */ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1345 | if (thread.cancel_event) { |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 1346 | cancel_dump_traceback_later(); |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 1347 | PyThread_release_lock(thread.cancel_event); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1348 | PyThread_free_lock(thread.cancel_event); |
| 1349 | thread.cancel_event = NULL; |
| 1350 | } |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 1351 | if (thread.running) { |
| 1352 | PyThread_free_lock(thread.running); |
| 1353 | thread.running = NULL; |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1354 | } |
| 1355 | #endif |
| 1356 | |
| 1357 | #ifdef FAULTHANDLER_USER |
| 1358 | /* user */ |
| 1359 | if (user_signals != NULL) { |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 1360 | for (size_t signum=0; signum < NSIG; signum++) { |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 1361 | faulthandler_unregister(&user_signals[signum], signum); |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 1362 | } |
Victor Stinner | 49fc8ec | 2013-07-07 23:30:24 +0200 | [diff] [blame] | 1363 | PyMem_Free(user_signals); |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1364 | user_signals = NULL; |
| 1365 | } |
| 1366 | #endif |
| 1367 | |
| 1368 | /* fatal */ |
| 1369 | faulthandler_disable(); |
| 1370 | #ifdef HAVE_SIGALTSTACK |
| 1371 | if (stack.ss_sp != NULL) { |
Christophe Zeitouny | 20fbf8a | 2017-03-23 10:14:29 -0700 | [diff] [blame] | 1372 | /* Fetch the current alt stack */ |
| 1373 | stack_t current_stack; |
| 1374 | if (sigaltstack(NULL, ¤t_stack) == 0) { |
| 1375 | if (current_stack.ss_sp == stack.ss_sp) { |
| 1376 | /* The current alt stack is the one that we installed. |
| 1377 | It is safe to restore the old stack that we found when |
| 1378 | we installed ours */ |
| 1379 | sigaltstack(&old_stack, NULL); |
| 1380 | } else { |
| 1381 | /* Someone switched to a different alt stack and didn't |
| 1382 | restore ours when they were done (if they're done). |
| 1383 | There's not much we can do in this unlikely case */ |
| 1384 | } |
| 1385 | } |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1386 | PyMem_Free(stack.ss_sp); |
| 1387 | stack.ss_sp = NULL; |
| 1388 | } |
| 1389 | #endif |
| 1390 | } |