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