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