Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 1 | from contextlib import contextmanager |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 2 | import datetime |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 3 | import faulthandler |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 4 | import os |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 5 | import signal |
| 6 | import subprocess |
| 7 | import sys |
Gregory P. Smith | b474e67 | 2018-12-30 17:05:36 -0800 | [diff] [blame] | 8 | import sysconfig |
Berker Peksag | ce64391 | 2015-05-06 06:33:17 +0300 | [diff] [blame] | 9 | from test import support |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 10 | from test.support import script_helper, is_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 11 | import tempfile |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 12 | import threading |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 13 | import unittest |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 14 | from textwrap import dedent |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 15 | |
Victor Stinner | ff4cd88 | 2011-04-07 11:50:25 +0200 | [diff] [blame] | 16 | try: |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 17 | import _testcapi |
| 18 | except ImportError: |
| 19 | _testcapi = None |
Victor Stinner | ff4cd88 | 2011-04-07 11:50:25 +0200 | [diff] [blame] | 20 | |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 21 | TIMEOUT = 0.5 |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 22 | MS_WINDOWS = (os.name == 'nt') |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 23 | _cflags = sysconfig.get_config_var('CFLAGS') or '' |
| 24 | _config_args = sysconfig.get_config_var('CONFIG_ARGS') or '' |
| 25 | UB_SANITIZER = ( |
Gregory P. Smith | d6f45b2 | 2018-12-30 20:15:41 -0800 | [diff] [blame] | 26 | '-fsanitize=undefined' in _cflags or |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 27 | '--with-undefined-behavior-sanitizer' in _config_args |
Gregory P. Smith | b474e67 | 2018-12-30 17:05:36 -0800 | [diff] [blame] | 28 | ) |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 29 | MEMORY_SANITIZER = ( |
Gregory P. Smith | d6f45b2 | 2018-12-30 20:15:41 -0800 | [diff] [blame] | 30 | '-fsanitize=memory' in _cflags or |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 31 | '--with-memory-sanitizer' in _config_args |
| 32 | ) |
| 33 | |
Victor Stinner | 44378d4 | 2011-04-01 15:37:12 +0200 | [diff] [blame] | 34 | |
Victor Stinner | 301f3f0 | 2011-06-01 13:49:12 +0200 | [diff] [blame] | 35 | def expected_traceback(lineno1, lineno2, header, min_count=1): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 36 | regex = header |
Victor Stinner | 7ad24e9 | 2011-03-31 22:35:49 +0200 | [diff] [blame] | 37 | regex += ' File "<string>", line %s in func\n' % lineno1 |
| 38 | regex += ' File "<string>", line %s in <module>' % lineno2 |
Victor Stinner | 301f3f0 | 2011-06-01 13:49:12 +0200 | [diff] [blame] | 39 | if 1 < min_count: |
| 40 | return '^' + (regex + '\n') * (min_count - 1) + regex |
| 41 | else: |
| 42 | return '^' + regex + '$' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 43 | |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 44 | def skip_segfault_on_android(test): |
| 45 | # Issue #32138: Raising SIGSEGV on Android may not cause a crash. |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 46 | return unittest.skipIf(is_android, |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 47 | 'raising SIGSEGV on Android is unreliable')(test) |
| 48 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 49 | @contextmanager |
| 50 | def temporary_filename(): |
| 51 | filename = tempfile.mktemp() |
| 52 | try: |
| 53 | yield filename |
| 54 | finally: |
| 55 | support.unlink(filename) |
| 56 | |
| 57 | class FaultHandlerTests(unittest.TestCase): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 58 | def get_output(self, code, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 59 | """ |
| 60 | Run the specified code in Python (in a new child process) and read the |
| 61 | output from the standard error or from a file (if filename is set). |
| 62 | Return the output lines as a list. |
| 63 | |
| 64 | Strip the reference count from the standard error for Python debug |
| 65 | build, and replace "Current thread 0x00007f8d8fbd9700" by "Current |
| 66 | thread XXX". |
| 67 | """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 68 | code = dedent(code).strip() |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 69 | pass_fds = [] |
| 70 | if fd is not None: |
| 71 | pass_fds.append(fd) |
Antoine Pitrou | 77e904e | 2013-10-08 23:04:32 +0200 | [diff] [blame] | 72 | with support.SuppressCrashReport(): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 73 | process = script_helper.spawn_python('-c', code, pass_fds=pass_fds) |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 74 | with process: |
| 75 | stdout, stderr = process.communicate() |
| 76 | exitcode = process.wait() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 77 | output = support.strip_python_stderr(stdout) |
| 78 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 79 | if filename: |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 80 | self.assertEqual(output, '') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 81 | with open(filename, "rb") as fp: |
| 82 | output = fp.read() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 83 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 84 | elif fd is not None: |
| 85 | self.assertEqual(output, '') |
| 86 | os.lseek(fd, os.SEEK_SET, 0) |
| 87 | with open(fd, "rb", closefd=False) as fp: |
| 88 | output = fp.read() |
| 89 | output = output.decode('ascii', 'backslashreplace') |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 90 | return output.splitlines(), exitcode |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 91 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 92 | def check_error(self, code, line_number, fatal_error, *, |
| 93 | filename=None, all_threads=True, other_regex=None, |
| 94 | fd=None, know_current_thread=True): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 95 | """ |
| 96 | Check that the fault handler for fatal errors is enabled and check the |
| 97 | traceback from the child process output. |
| 98 | |
| 99 | Raise an error if the output doesn't match the expected format. |
| 100 | """ |
| 101 | if all_threads: |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 102 | if know_current_thread: |
| 103 | header = 'Current thread 0x[0-9a-f]+' |
| 104 | else: |
| 105 | header = 'Thread 0x[0-9a-f]+' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 106 | else: |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 107 | header = 'Stack' |
R David Murray | 44b548d | 2016-09-08 13:59:53 -0400 | [diff] [blame] | 108 | regex = r""" |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 109 | (?m)^{fatal_error} |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 110 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 111 | {header} \(most recent call first\): |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 112 | File "<string>", line {lineno} in <module> |
| 113 | """ |
| 114 | regex = dedent(regex.format( |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 115 | lineno=line_number, |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 116 | fatal_error=fatal_error, |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 117 | header=header)).strip() |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 118 | if other_regex: |
| 119 | regex += '|' + other_regex |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 120 | output, exitcode = self.get_output(code, filename=filename, fd=fd) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 121 | output = '\n'.join(output) |
| 122 | self.assertRegex(output, regex) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 123 | self.assertNotEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 124 | |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 125 | def check_fatal_error(self, code, line_number, name_regex, **kw): |
| 126 | fatal_error = 'Fatal Python error: %s' % name_regex |
| 127 | self.check_error(code, line_number, fatal_error, **kw) |
| 128 | |
| 129 | def check_windows_exception(self, code, line_number, name_regex, **kw): |
Victor Stinner | 412a5e7 | 2016-03-23 14:44:14 +0100 | [diff] [blame] | 130 | fatal_error = 'Windows fatal exception: %s' % name_regex |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 131 | self.check_error(code, line_number, fatal_error, **kw) |
| 132 | |
Victor Stinner | 330426c | 2013-07-03 22:29:42 +0200 | [diff] [blame] | 133 | @unittest.skipIf(sys.platform.startswith('aix'), |
| 134 | "the first page of memory is a mapped read-only on AIX") |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 135 | def test_read_null(self): |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 136 | if not MS_WINDOWS: |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 137 | self.check_fatal_error(""" |
| 138 | import faulthandler |
| 139 | faulthandler.enable() |
| 140 | faulthandler._read_null() |
| 141 | """, |
| 142 | 3, |
| 143 | # Issue #12700: Read NULL raises SIGILL on Mac OS X Lion |
| 144 | '(?:Segmentation fault' |
| 145 | '|Bus error' |
| 146 | '|Illegal instruction)') |
| 147 | else: |
| 148 | self.check_windows_exception(""" |
| 149 | import faulthandler |
| 150 | faulthandler.enable() |
| 151 | faulthandler._read_null() |
| 152 | """, |
| 153 | 3, |
| 154 | 'access violation') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 155 | |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 156 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 157 | def test_sigsegv(self): |
| 158 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 159 | import faulthandler |
| 160 | faulthandler.enable() |
| 161 | faulthandler._sigsegv() |
| 162 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 163 | 3, |
| 164 | 'Segmentation fault') |
| 165 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 166 | def test_fatal_error_c_thread(self): |
| 167 | self.check_fatal_error(""" |
| 168 | import faulthandler |
| 169 | faulthandler.enable() |
| 170 | faulthandler._fatal_error_c_thread() |
| 171 | """, |
| 172 | 3, |
| 173 | 'in new thread', |
| 174 | know_current_thread=False) |
| 175 | |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 176 | def test_sigabrt(self): |
| 177 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 178 | import faulthandler |
| 179 | faulthandler.enable() |
| 180 | faulthandler._sigabrt() |
| 181 | """, |
Victor Stinner | d727e23 | 2011-04-01 12:13:55 +0200 | [diff] [blame] | 182 | 3, |
| 183 | 'Aborted') |
| 184 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 185 | @unittest.skipIf(sys.platform == 'win32', |
| 186 | "SIGFPE cannot be caught on Windows") |
| 187 | def test_sigfpe(self): |
| 188 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 189 | import faulthandler |
| 190 | faulthandler.enable() |
| 191 | faulthandler._sigfpe() |
| 192 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 193 | 3, |
| 194 | 'Floating point exception') |
| 195 | |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 196 | @unittest.skipIf(_testcapi is None, 'need _testcapi') |
| 197 | @unittest.skipUnless(hasattr(signal, 'SIGBUS'), 'need signal.SIGBUS') |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 198 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 199 | def test_sigbus(self): |
| 200 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 201 | import faulthandler |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 202 | import signal |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 203 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 204 | faulthandler.enable() |
Vladimir Matveev | c24c6c2 | 2019-01-08 01:58:25 -0800 | [diff] [blame] | 205 | signal.raise_signal(signal.SIGBUS) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 206 | """, |
Vladimir Matveev | c24c6c2 | 2019-01-08 01:58:25 -0800 | [diff] [blame] | 207 | 5, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 208 | 'Bus error') |
| 209 | |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 210 | @unittest.skipIf(_testcapi is None, 'need _testcapi') |
| 211 | @unittest.skipUnless(hasattr(signal, 'SIGILL'), 'need signal.SIGILL') |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 212 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 213 | def test_sigill(self): |
| 214 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 215 | import faulthandler |
Victor Stinner | 68e0808 | 2014-08-10 19:51:05 +0200 | [diff] [blame] | 216 | import signal |
Victor Stinner | 56e8c29 | 2014-07-21 12:30:22 +0200 | [diff] [blame] | 217 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 218 | faulthandler.enable() |
Vladimir Matveev | c24c6c2 | 2019-01-08 01:58:25 -0800 | [diff] [blame] | 219 | signal.raise_signal(signal.SIGILL) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 220 | """, |
Vladimir Matveev | c24c6c2 | 2019-01-08 01:58:25 -0800 | [diff] [blame] | 221 | 5, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 222 | 'Illegal instruction') |
| 223 | |
| 224 | def test_fatal_error(self): |
| 225 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 226 | import faulthandler |
| 227 | faulthandler._fatal_error(b'xyz') |
| 228 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 229 | 2, |
| 230 | 'xyz') |
| 231 | |
Victor Stinner | 57003f8 | 2016-03-15 17:23:35 +0100 | [diff] [blame] | 232 | def test_fatal_error_without_gil(self): |
| 233 | self.check_fatal_error(""" |
| 234 | import faulthandler |
| 235 | faulthandler._fatal_error(b'xyz', True) |
| 236 | """, |
| 237 | 2, |
| 238 | 'xyz') |
| 239 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 240 | @unittest.skipIf(sys.platform.startswith('openbsd'), |
Charles-François Natali | 3391e64 | 2011-09-01 23:08:21 +0200 | [diff] [blame] | 241 | "Issue #12868: sigaltstack() doesn't work on " |
| 242 | "OpenBSD if Python is compiled with pthread") |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 243 | @unittest.skipIf(not hasattr(faulthandler, '_stack_overflow'), |
| 244 | 'need faulthandler._stack_overflow()') |
| 245 | def test_stack_overflow(self): |
| 246 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 247 | import faulthandler |
| 248 | faulthandler.enable() |
| 249 | faulthandler._stack_overflow() |
| 250 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 251 | 3, |
Victor Stinner | f048075 | 2011-03-31 11:34:08 +0200 | [diff] [blame] | 252 | '(?:Segmentation fault|Bus error)', |
| 253 | other_regex='unable to raise a stack overflow') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 254 | |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 255 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 256 | def test_gil_released(self): |
| 257 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 258 | import faulthandler |
| 259 | faulthandler.enable() |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 260 | faulthandler._sigsegv(True) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 261 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 262 | 3, |
Victor Stinner | 5083828 | 2014-09-30 13:54:14 +0200 | [diff] [blame] | 263 | 'Segmentation fault') |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 264 | |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 265 | @unittest.skipIf(UB_SANITIZER or MEMORY_SANITIZER, |
Gregory P. Smith | d6f45b2 | 2018-12-30 20:15:41 -0800 | [diff] [blame] | 266 | "sanitizer builds change crashing process output.") |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 267 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 268 | def test_enable_file(self): |
| 269 | with temporary_filename() as filename: |
| 270 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 271 | import faulthandler |
| 272 | output = open({filename}, 'wb') |
| 273 | faulthandler.enable(output) |
| 274 | faulthandler._sigsegv() |
| 275 | """.format(filename=repr(filename)), |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 276 | 4, |
Victor Stinner | 5678539 | 2013-06-17 23:37:59 +0200 | [diff] [blame] | 277 | 'Segmentation fault', |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 278 | filename=filename) |
| 279 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 280 | @unittest.skipIf(sys.platform == "win32", |
| 281 | "subprocess doesn't support pass_fds on Windows") |
Gregory P. Smith | 30e0232 | 2018-12-30 18:09:26 -0800 | [diff] [blame] | 282 | @unittest.skipIf(UB_SANITIZER or MEMORY_SANITIZER, |
Gregory P. Smith | d6f45b2 | 2018-12-30 20:15:41 -0800 | [diff] [blame] | 283 | "sanitizer builds change crashing process output.") |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 284 | @skip_segfault_on_android |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 285 | def test_enable_fd(self): |
| 286 | with tempfile.TemporaryFile('wb+') as fp: |
| 287 | fd = fp.fileno() |
| 288 | self.check_fatal_error(""" |
| 289 | import faulthandler |
| 290 | import sys |
| 291 | faulthandler.enable(%s) |
| 292 | faulthandler._sigsegv() |
| 293 | """ % fd, |
| 294 | 4, |
| 295 | 'Segmentation fault', |
| 296 | fd=fd) |
| 297 | |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 298 | @skip_segfault_on_android |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 299 | def test_enable_single_thread(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 300 | self.check_fatal_error(""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 301 | import faulthandler |
| 302 | faulthandler.enable(all_threads=False) |
| 303 | faulthandler._sigsegv() |
| 304 | """, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 305 | 3, |
Victor Stinner | 5678539 | 2013-06-17 23:37:59 +0200 | [diff] [blame] | 306 | 'Segmentation fault', |
Victor Stinner | 7bba62f | 2011-05-07 12:43:00 +0200 | [diff] [blame] | 307 | all_threads=False) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 308 | |
xdegaye | ef83806 | 2017-11-29 11:43:23 +0100 | [diff] [blame] | 309 | @skip_segfault_on_android |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 310 | def test_disable(self): |
| 311 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 312 | import faulthandler |
| 313 | faulthandler.enable() |
| 314 | faulthandler.disable() |
| 315 | faulthandler._sigsegv() |
| 316 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 317 | not_expected = 'Fatal Python error' |
Antoine Pitrou | 77e904e | 2013-10-08 23:04:32 +0200 | [diff] [blame] | 318 | stderr, exitcode = self.get_output(code) |
Victor Stinner | 29001c8 | 2014-09-25 00:38:48 +0200 | [diff] [blame] | 319 | stderr = '\n'.join(stderr) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 320 | self.assertTrue(not_expected not in stderr, |
| 321 | "%r is present in %r" % (not_expected, stderr)) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 322 | self.assertNotEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 323 | |
| 324 | def test_is_enabled(self): |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 325 | orig_stderr = sys.stderr |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 326 | try: |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 327 | # regrtest may replace sys.stderr by io.StringIO object, but |
| 328 | # faulthandler.enable() requires that sys.stderr has a fileno() |
| 329 | # method |
Victor Stinner | 7248850 | 2011-06-29 23:24:31 +0200 | [diff] [blame] | 330 | sys.stderr = sys.__stderr__ |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 331 | |
| 332 | was_enabled = faulthandler.is_enabled() |
| 333 | try: |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 334 | faulthandler.enable() |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 335 | self.assertTrue(faulthandler.is_enabled()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 336 | faulthandler.disable() |
Victor Stinner | 7e32f3a | 2011-06-29 13:44:05 +0200 | [diff] [blame] | 337 | self.assertFalse(faulthandler.is_enabled()) |
| 338 | finally: |
| 339 | if was_enabled: |
| 340 | faulthandler.enable() |
| 341 | else: |
| 342 | faulthandler.disable() |
| 343 | finally: |
| 344 | sys.stderr = orig_stderr |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 345 | |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 346 | def test_disabled_by_default(self): |
| 347 | # By default, the module should be disabled |
| 348 | code = "import faulthandler; print(faulthandler.is_enabled())" |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 349 | args = (sys.executable, "-E", "-c", code) |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 350 | # don't use assert_python_ok() because it always enables faulthandler |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 351 | output = subprocess.check_output(args) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 352 | self.assertEqual(output.rstrip(), b"False") |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 353 | |
| 354 | def test_sys_xoptions(self): |
| 355 | # Test python -X faulthandler |
| 356 | code = "import faulthandler; print(faulthandler.is_enabled())" |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 357 | args = filter(None, (sys.executable, |
| 358 | "-E" if sys.flags.ignore_environment else "", |
| 359 | "-X", "faulthandler", "-c", code)) |
| 360 | env = os.environ.copy() |
| 361 | env.pop("PYTHONFAULTHANDLER", None) |
| 362 | # don't use assert_python_ok() because it always enables faulthandler |
| 363 | output = subprocess.check_output(args, env=env) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 364 | self.assertEqual(output.rstrip(), b"True") |
| 365 | |
| 366 | def test_env_var(self): |
| 367 | # empty env var |
| 368 | code = "import faulthandler; print(faulthandler.is_enabled())" |
| 369 | args = (sys.executable, "-c", code) |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 370 | env = dict(os.environ) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 371 | env['PYTHONFAULTHANDLER'] = '' |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 372 | env['PYTHONDEVMODE'] = '' |
Gregory P. Smith | fe7c5d6 | 2015-01-22 17:33:28 -0800 | [diff] [blame] | 373 | # don't use assert_python_ok() because it always enables faulthandler |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 374 | output = subprocess.check_output(args, env=env) |
| 375 | self.assertEqual(output.rstrip(), b"False") |
| 376 | |
| 377 | # non-empty env var |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 378 | env = dict(os.environ) |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 379 | env['PYTHONFAULTHANDLER'] = '1' |
Victor Stinner | 721e25c | 2017-12-12 23:15:00 +0100 | [diff] [blame] | 380 | env['PYTHONDEVMODE'] = '' |
Victor Stinner | 8898350 | 2013-09-08 11:36:23 +0200 | [diff] [blame] | 381 | output = subprocess.check_output(args, env=env) |
| 382 | self.assertEqual(output.rstrip(), b"True") |
Victor Stinner | d5698cb | 2012-07-31 02:55:49 +0200 | [diff] [blame] | 383 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 384 | def check_dump_traceback(self, *, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 385 | """ |
| 386 | Explicitly call dump_traceback() function and check its output. |
| 387 | Raise an error if the output doesn't match the expected format. |
| 388 | """ |
| 389 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 390 | import faulthandler |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 391 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 392 | filename = {filename!r} |
| 393 | fd = {fd} |
| 394 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 395 | def funcB(): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 396 | if filename: |
| 397 | with open(filename, "wb") as fp: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 398 | faulthandler.dump_traceback(fp, all_threads=False) |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 399 | elif fd is not None: |
| 400 | faulthandler.dump_traceback(fd, |
| 401 | all_threads=False) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 402 | else: |
| 403 | faulthandler.dump_traceback(all_threads=False) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 404 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 405 | def funcA(): |
| 406 | funcB() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 407 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 408 | funcA() |
| 409 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 410 | code = code.format( |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 411 | filename=filename, |
| 412 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 413 | ) |
| 414 | if filename: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 415 | lineno = 9 |
| 416 | elif fd is not None: |
Serhiy Storchaka | da8d72c | 2018-09-17 15:17:29 +0300 | [diff] [blame] | 417 | lineno = 11 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 418 | else: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 419 | lineno = 14 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 420 | expected = [ |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 421 | 'Stack (most recent call first):', |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 422 | ' File "<string>", line %s in funcB' % lineno, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 423 | ' File "<string>", line 17 in funcA', |
| 424 | ' File "<string>", line 19 in <module>' |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 425 | ] |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 426 | trace, exitcode = self.get_output(code, filename, fd) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 427 | self.assertEqual(trace, expected) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 428 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 429 | |
| 430 | def test_dump_traceback(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 431 | self.check_dump_traceback() |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 432 | |
| 433 | def test_dump_traceback_file(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 434 | with temporary_filename() as filename: |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 435 | self.check_dump_traceback(filename=filename) |
| 436 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 437 | @unittest.skipIf(sys.platform == "win32", |
| 438 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 439 | def test_dump_traceback_fd(self): |
| 440 | with tempfile.TemporaryFile('wb+') as fp: |
| 441 | self.check_dump_traceback(fd=fp.fileno()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 442 | |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 443 | def test_truncate(self): |
| 444 | maxlen = 500 |
| 445 | func_name = 'x' * (maxlen + 50) |
| 446 | truncated = 'x' * maxlen + '...' |
| 447 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 448 | import faulthandler |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 449 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 450 | def {func_name}(): |
| 451 | faulthandler.dump_traceback(all_threads=False) |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 452 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 453 | {func_name}() |
| 454 | """ |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 455 | code = code.format( |
| 456 | func_name=func_name, |
| 457 | ) |
| 458 | expected = [ |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 459 | 'Stack (most recent call first):', |
Victor Stinner | 53386d8 | 2012-08-01 19:45:34 +0200 | [diff] [blame] | 460 | ' File "<string>", line 4 in %s' % truncated, |
| 461 | ' File "<string>", line 6 in <module>' |
| 462 | ] |
| 463 | trace, exitcode = self.get_output(code) |
| 464 | self.assertEqual(trace, expected) |
| 465 | self.assertEqual(exitcode, 0) |
| 466 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 467 | def check_dump_traceback_threads(self, filename): |
| 468 | """ |
| 469 | Call explicitly dump_traceback(all_threads=True) and check the output. |
| 470 | Raise an error if the output doesn't match the expected format. |
| 471 | """ |
| 472 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 473 | import faulthandler |
| 474 | from threading import Thread, Event |
| 475 | import time |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 476 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 477 | def dump(): |
| 478 | if {filename}: |
| 479 | with open({filename}, "wb") as fp: |
| 480 | faulthandler.dump_traceback(fp, all_threads=True) |
| 481 | else: |
| 482 | faulthandler.dump_traceback(all_threads=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 483 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 484 | class Waiter(Thread): |
| 485 | # avoid blocking if the main thread raises an exception. |
| 486 | daemon = True |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 487 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 488 | def __init__(self): |
| 489 | Thread.__init__(self) |
| 490 | self.running = Event() |
| 491 | self.stop = Event() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 492 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 493 | def run(self): |
| 494 | self.running.set() |
| 495 | self.stop.wait() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 496 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 497 | waiter = Waiter() |
| 498 | waiter.start() |
| 499 | waiter.running.wait() |
| 500 | dump() |
| 501 | waiter.stop.set() |
| 502 | waiter.join() |
| 503 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 504 | code = code.format(filename=repr(filename)) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 505 | output, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 506 | output = '\n'.join(output) |
| 507 | if filename: |
| 508 | lineno = 8 |
| 509 | else: |
| 510 | lineno = 10 |
R David Murray | 44b548d | 2016-09-08 13:59:53 -0400 | [diff] [blame] | 511 | regex = r""" |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 512 | ^Thread 0x[0-9a-f]+ \(most recent call first\): |
| 513 | (?: File ".*threading.py", line [0-9]+ in [_a-z]+ |
| 514 | ){{1,3}} File "<string>", line 23 in run |
| 515 | File ".*threading.py", line [0-9]+ in _bootstrap_inner |
| 516 | File ".*threading.py", line [0-9]+ in _bootstrap |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 517 | |
Victor Stinner | 861d9ab | 2016-03-16 22:45:24 +0100 | [diff] [blame] | 518 | Current thread 0x[0-9a-f]+ \(most recent call first\): |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 519 | File "<string>", line {lineno} in dump |
| 520 | File "<string>", line 28 in <module>$ |
| 521 | """ |
| 522 | regex = dedent(regex.format(lineno=lineno)).strip() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 523 | self.assertRegex(output, regex) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 524 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 525 | |
| 526 | def test_dump_traceback_threads(self): |
| 527 | self.check_dump_traceback_threads(None) |
Victor Stinner | 1940233 | 2011-03-31 18:15:52 +0200 | [diff] [blame] | 528 | |
| 529 | def test_dump_traceback_threads_file(self): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 530 | with temporary_filename() as filename: |
| 531 | self.check_dump_traceback_threads(filename) |
| 532 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 533 | @unittest.skipIf(not hasattr(faulthandler, 'dump_traceback_later'), |
| 534 | 'need faulthandler.dump_traceback_later()') |
| 535 | def check_dump_traceback_later(self, repeat=False, cancel=False, loops=1, |
| 536 | *, filename=None, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 537 | """ |
| 538 | Check how many times the traceback is written in timeout x 2.5 seconds, |
| 539 | or timeout x 3.5 seconds if cancel is True: 1, 2 or 3 times depending |
| 540 | on repeat and cancel options. |
| 541 | |
| 542 | Raise an error if the output doesn't match the expect format. |
| 543 | """ |
Victor Stinner | c790a53 | 2011-04-08 13:39:59 +0200 | [diff] [blame] | 544 | timeout_str = str(datetime.timedelta(seconds=TIMEOUT)) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 545 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 546 | import faulthandler |
| 547 | import time |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 548 | import sys |
| 549 | |
| 550 | timeout = {timeout} |
| 551 | repeat = {repeat} |
| 552 | cancel = {cancel} |
| 553 | loops = {loops} |
| 554 | filename = {filename!r} |
| 555 | fd = {fd} |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 556 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 557 | def func(timeout, repeat, cancel, file, loops): |
| 558 | for loop in range(loops): |
| 559 | faulthandler.dump_traceback_later(timeout, repeat=repeat, file=file) |
| 560 | if cancel: |
| 561 | faulthandler.cancel_dump_traceback_later() |
| 562 | time.sleep(timeout * 5) |
| 563 | faulthandler.cancel_dump_traceback_later() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 564 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 565 | if filename: |
| 566 | file = open(filename, "wb") |
| 567 | elif fd is not None: |
| 568 | file = sys.stderr.fileno() |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 569 | else: |
| 570 | file = None |
| 571 | func(timeout, repeat, cancel, file, loops) |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 572 | if filename: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 573 | file.close() |
| 574 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 575 | code = code.format( |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 576 | timeout=TIMEOUT, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 577 | repeat=repeat, |
| 578 | cancel=cancel, |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 579 | loops=loops, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 580 | filename=filename, |
| 581 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 582 | ) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 583 | trace, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 584 | trace = '\n'.join(trace) |
| 585 | |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 586 | if not cancel: |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 587 | count = loops |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 588 | if repeat: |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 589 | count *= 2 |
Guido van Rossum | 7be5d7d | 2013-10-20 18:21:02 -0700 | [diff] [blame] | 590 | header = r'Timeout \(%s\)!\nThread 0x[0-9a-f]+ \(most recent call first\):\n' % timeout_str |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 591 | regex = expected_traceback(17, 26, header, min_count=count) |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 592 | self.assertRegex(trace, regex) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 593 | else: |
Victor Stinner | f77ccc6 | 2011-04-03 18:45:42 +0200 | [diff] [blame] | 594 | self.assertEqual(trace, '') |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 595 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 596 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 597 | def test_dump_traceback_later(self): |
| 598 | self.check_dump_traceback_later() |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 599 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 600 | def test_dump_traceback_later_repeat(self): |
| 601 | self.check_dump_traceback_later(repeat=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 602 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 603 | def test_dump_traceback_later_cancel(self): |
| 604 | self.check_dump_traceback_later(cancel=True) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 605 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 606 | def test_dump_traceback_later_file(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 607 | with temporary_filename() as filename: |
| 608 | self.check_dump_traceback_later(filename=filename) |
| 609 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 610 | @unittest.skipIf(sys.platform == "win32", |
| 611 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 612 | def test_dump_traceback_later_fd(self): |
| 613 | with tempfile.TemporaryFile('wb+') as fp: |
| 614 | self.check_dump_traceback_later(fd=fp.fileno()) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 615 | |
Georg Brandl | deb92b5 | 2012-09-22 08:58:55 +0200 | [diff] [blame] | 616 | def test_dump_traceback_later_twice(self): |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 617 | self.check_dump_traceback_later(loops=2) |
Victor Stinner | de10f40 | 2011-04-08 12:57:06 +0200 | [diff] [blame] | 618 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 619 | @unittest.skipIf(not hasattr(faulthandler, "register"), |
| 620 | "need faulthandler.register") |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 621 | def check_register(self, filename=False, all_threads=False, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 622 | unregister=False, chain=False, fd=None): |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 623 | """ |
| 624 | Register a handler displaying the traceback on a user signal. Raise the |
| 625 | signal and check the written traceback. |
| 626 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 627 | If chain is True, check that the previous signal handler is called. |
| 628 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 629 | Raise an error if the output doesn't match the expected format. |
| 630 | """ |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 631 | signum = signal.SIGUSR1 |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 632 | code = """ |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 633 | import faulthandler |
| 634 | import os |
| 635 | import signal |
| 636 | import sys |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 637 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 638 | all_threads = {all_threads} |
| 639 | signum = {signum} |
| 640 | unregister = {unregister} |
| 641 | chain = {chain} |
| 642 | filename = {filename!r} |
| 643 | fd = {fd} |
| 644 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 645 | def func(signum): |
| 646 | os.kill(os.getpid(), signum) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 647 | |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 648 | def handler(signum, frame): |
| 649 | handler.called = True |
| 650 | handler.called = False |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 651 | |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 652 | if filename: |
| 653 | file = open(filename, "wb") |
| 654 | elif fd is not None: |
| 655 | file = sys.stderr.fileno() |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 656 | else: |
| 657 | file = None |
| 658 | if chain: |
| 659 | signal.signal(signum, handler) |
| 660 | faulthandler.register(signum, file=file, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 661 | all_threads=all_threads, chain={chain}) |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 662 | if unregister: |
| 663 | faulthandler.unregister(signum) |
| 664 | func(signum) |
| 665 | if chain and not handler.called: |
| 666 | if file is not None: |
| 667 | output = file |
| 668 | else: |
| 669 | output = sys.stderr |
| 670 | print("Error: signal handler not called!", file=output) |
| 671 | exitcode = 1 |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 672 | else: |
| 673 | exitcode = 0 |
| 674 | if filename: |
Victor Stinner | 6d20168 | 2014-08-10 19:50:08 +0200 | [diff] [blame] | 675 | file.close() |
| 676 | sys.exit(exitcode) |
| 677 | """ |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 678 | code = code.format( |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 679 | all_threads=all_threads, |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 680 | signum=signum, |
| 681 | unregister=unregister, |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 682 | chain=chain, |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 683 | filename=filename, |
| 684 | fd=fd, |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 685 | ) |
Victor Stinner | 05585cb | 2011-03-31 13:29:56 +0200 | [diff] [blame] | 686 | trace, exitcode = self.get_output(code, filename) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 687 | trace = '\n'.join(trace) |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 688 | if not unregister: |
| 689 | if all_threads: |
R David Murray | 44b548d | 2016-09-08 13:59:53 -0400 | [diff] [blame] | 690 | regex = r'Current thread 0x[0-9a-f]+ \(most recent call first\):\n' |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 691 | else: |
R David Murray | 44b548d | 2016-09-08 13:59:53 -0400 | [diff] [blame] | 692 | regex = r'Stack \(most recent call first\):\n' |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 693 | regex = expected_traceback(14, 32, regex) |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 694 | self.assertRegex(trace, regex) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 695 | else: |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 696 | self.assertEqual(trace, '') |
| 697 | if unregister: |
| 698 | self.assertNotEqual(exitcode, 0) |
| 699 | else: |
| 700 | self.assertEqual(exitcode, 0) |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 701 | |
| 702 | def test_register(self): |
| 703 | self.check_register() |
| 704 | |
Victor Stinner | a01ca12 | 2011-04-01 12:56:17 +0200 | [diff] [blame] | 705 | def test_unregister(self): |
| 706 | self.check_register(unregister=True) |
| 707 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 708 | def test_register_file(self): |
| 709 | with temporary_filename() as filename: |
| 710 | self.check_register(filename=filename) |
| 711 | |
Victor Stinner | ff2a661 | 2015-03-13 11:01:30 +0100 | [diff] [blame] | 712 | @unittest.skipIf(sys.platform == "win32", |
| 713 | "subprocess doesn't support pass_fds on Windows") |
Victor Stinner | 95bb714 | 2015-03-12 15:32:03 +0100 | [diff] [blame] | 714 | def test_register_fd(self): |
| 715 | with tempfile.TemporaryFile('wb+') as fp: |
| 716 | self.check_register(fd=fp.fileno()) |
| 717 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 718 | def test_register_threads(self): |
| 719 | self.check_register(all_threads=True) |
| 720 | |
Victor Stinner | a9a9dab | 2011-07-13 23:39:53 +0200 | [diff] [blame] | 721 | def test_register_chain(self): |
| 722 | self.check_register(chain=True) |
| 723 | |
Victor Stinner | e2d6690 | 2014-05-14 17:15:50 +0200 | [diff] [blame] | 724 | @contextmanager |
| 725 | def check_stderr_none(self): |
| 726 | stderr = sys.stderr |
| 727 | try: |
| 728 | sys.stderr = None |
| 729 | with self.assertRaises(RuntimeError) as cm: |
| 730 | yield |
| 731 | self.assertEqual(str(cm.exception), "sys.stderr is None") |
| 732 | finally: |
| 733 | sys.stderr = stderr |
| 734 | |
| 735 | def test_stderr_None(self): |
Serhiy Storchaka | 6a7b3a7 | 2016-04-17 08:32:47 +0300 | [diff] [blame] | 736 | # Issue #21497: provide a helpful error if sys.stderr is None, |
Victor Stinner | e2d6690 | 2014-05-14 17:15:50 +0200 | [diff] [blame] | 737 | # instead of just an attribute error: "None has no attribute fileno". |
| 738 | with self.check_stderr_none(): |
| 739 | faulthandler.enable() |
| 740 | with self.check_stderr_none(): |
| 741 | faulthandler.dump_traceback() |
| 742 | if hasattr(faulthandler, 'dump_traceback_later'): |
| 743 | with self.check_stderr_none(): |
| 744 | faulthandler.dump_traceback_later(1e-3) |
| 745 | if hasattr(faulthandler, "register"): |
| 746 | with self.check_stderr_none(): |
| 747 | faulthandler.register(signal.SIGUSR1) |
| 748 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 749 | @unittest.skipUnless(MS_WINDOWS, 'specific to Windows') |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 750 | def test_raise_exception(self): |
| 751 | for exc, name in ( |
| 752 | ('EXCEPTION_ACCESS_VIOLATION', 'access violation'), |
| 753 | ('EXCEPTION_INT_DIVIDE_BY_ZERO', 'int divide by zero'), |
| 754 | ('EXCEPTION_STACK_OVERFLOW', 'stack overflow'), |
| 755 | ): |
Eric V. Smith | 451d0e3 | 2016-09-09 21:56:20 -0400 | [diff] [blame] | 756 | self.check_windows_exception(f""" |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 757 | import faulthandler |
| 758 | faulthandler.enable() |
| 759 | faulthandler._raise_exception(faulthandler._{exc}) |
Eric V. Smith | 451d0e3 | 2016-09-09 21:56:20 -0400 | [diff] [blame] | 760 | """, |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 761 | 3, |
| 762 | name) |
| 763 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 764 | @unittest.skipUnless(MS_WINDOWS, 'specific to Windows') |
Victor Stinner | 6e3d6b5 | 2017-10-09 09:52:32 -0700 | [diff] [blame] | 765 | def test_ignore_exception(self): |
| 766 | for exc_code in ( |
| 767 | 0xE06D7363, # MSC exception ("Emsc") |
| 768 | 0xE0434352, # COM Callable Runtime exception ("ECCR") |
| 769 | ): |
| 770 | code = f""" |
| 771 | import faulthandler |
| 772 | faulthandler.enable() |
| 773 | faulthandler._raise_exception({exc_code}) |
| 774 | """ |
| 775 | code = dedent(code) |
| 776 | output, exitcode = self.get_output(code) |
| 777 | self.assertEqual(output, []) |
| 778 | self.assertEqual(exitcode, exc_code) |
| 779 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 780 | @unittest.skipUnless(MS_WINDOWS, 'specific to Windows') |
Steve Dower | e6a23c8 | 2017-06-05 15:54:15 -0700 | [diff] [blame] | 781 | def test_raise_nonfatal_exception(self): |
| 782 | # These exceptions are not strictly errors. Letting |
| 783 | # faulthandler display the traceback when they are |
| 784 | # raised is likely to result in noise. However, they |
| 785 | # may still terminate the process if there is no |
| 786 | # handler installed for them (which there typically |
| 787 | # is, e.g. for debug messages). |
| 788 | for exc in ( |
| 789 | 0x00000000, |
| 790 | 0x34567890, |
| 791 | 0x40000000, |
| 792 | 0x40001000, |
| 793 | 0x70000000, |
| 794 | 0x7FFFFFFF, |
| 795 | ): |
| 796 | output, exitcode = self.get_output(f""" |
| 797 | import faulthandler |
| 798 | faulthandler.enable() |
| 799 | faulthandler._raise_exception(0x{exc:x}) |
| 800 | """ |
| 801 | ) |
| 802 | self.assertEqual(output, []) |
Victor Stinner | 6a1d84e | 2017-06-06 19:40:41 +0200 | [diff] [blame] | 803 | # On Windows older than 7 SP1, the actual exception code has |
| 804 | # bit 29 cleared. |
| 805 | self.assertIn(exitcode, |
| 806 | (exc, exc & ~0x10000000)) |
Steve Dower | e6a23c8 | 2017-06-05 15:54:15 -0700 | [diff] [blame] | 807 | |
Victor Stinner | 937ee9e | 2018-06-26 02:11:06 +0200 | [diff] [blame] | 808 | @unittest.skipUnless(MS_WINDOWS, 'specific to Windows') |
Victor Stinner | 46c2b81 | 2017-04-21 18:06:13 +0200 | [diff] [blame] | 809 | def test_disable_windows_exc_handler(self): |
| 810 | code = dedent(""" |
| 811 | import faulthandler |
| 812 | faulthandler.enable() |
| 813 | faulthandler.disable() |
| 814 | code = faulthandler._EXCEPTION_ACCESS_VIOLATION |
| 815 | faulthandler._raise_exception(code) |
| 816 | """) |
| 817 | output, exitcode = self.get_output(code) |
| 818 | self.assertEqual(output, []) |
| 819 | self.assertEqual(exitcode, 0xC0000005) |
Victor Stinner | 404cdc5 | 2016-03-23 10:39:17 +0100 | [diff] [blame] | 820 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 821 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 822 | if __name__ == "__main__": |
Brett Cannon | 3e9a9ae | 2013-06-12 21:25:59 -0400 | [diff] [blame] | 823 | unittest.main() |