1 # Common functions and variables for testing the Python pretty printers.
3 # Copyright (C) 2016-2019 Free Software Foundation, Inc.
4 # This file is part of the GNU C Library.
6 # The GNU C Library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
11 # The GNU C Library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with the GNU C Library; if not, see
18 # <https://www.gnu.org/licenses/>.
20 """These tests require PExpect 4.0 or newer.
23 PASS, FAIL, UNSUPPORTED (int): Test exit codes, as per evaluate-test.sh.
28 from test_printers_exceptions
import *
35 gdb_options
= '-q -nx'
36 gdb_invocation
= '{0} {1}'.format(gdb_bin
, gdb_options
)
37 pexpect_min_version
= 4
38 gdb_min_version
= (7, 8)
44 print('PExpect 4.0 or newer must be installed to test the pretty printers.')
47 pexpect_version
= pexpect
.__version
__.split('.')[0]
49 if int(pexpect_version
) < pexpect_min_version
:
50 print('PExpect 4.0 or newer must be installed to test the pretty printers.')
53 if not pexpect
.which(gdb_bin
):
54 print('gdb 7.8 or newer must be installed to test the pretty printers.')
58 TIMEOUTFACTOR
= os
.environ
.get('TIMEOUTFACTOR')
61 timeout
= int(TIMEOUTFACTOR
)
63 # Otherwise GDB is run in interactive mode and readline may send escape
64 # sequences confusing output for pexpect.
65 os
.environ
["TERM"]="dumb"
68 # Check the gdb version.
69 version_cmd
= '{0} --version'.format(gdb_invocation
, timeout
=timeout
)
70 gdb_version_out
= pexpect
.run(version_cmd
, encoding
=encoding
)
72 # The gdb version string is "GNU gdb <PKGVERSION><version>", where
73 # PKGVERSION can be any text. We assume that there'll always be a space
74 # between PKGVERSION and the version number for the sake of the regexp.
75 version_match
= re
.search(r
'GNU gdb .* ([1-9]+)\.([0-9]+)', gdb_version_out
)
78 print('The gdb version string (gdb -v) is incorrectly formatted.')
81 gdb_version
= (int(version_match
.group(1)), int(version_match
.group(2)))
83 if gdb_version
< gdb_min_version
:
84 print('gdb 7.8 or newer must be installed to test the pretty printers.')
87 # Check if gdb supports Python.
88 gdb_python_cmd
= '{0} -ex "python import os" -batch'.format(gdb_invocation
,
90 gdb_python_error
= pexpect
.run(gdb_python_cmd
, encoding
=encoding
)
93 print('gdb must have python support to test the pretty printers.')
94 print('gdb output: {!r}'.format(gdb_python_error
))
97 # If everything's ok, spawn the gdb process we'll use for testing.
98 gdb
= pexpect
.spawn(gdb_invocation
, echo
=False, timeout
=timeout
,
100 gdb_prompt
= u
'\(gdb\)'
101 gdb
.expect(gdb_prompt
)
103 except pexpect
.ExceptionPexpect
as exception
:
104 print('Error: {0}'.format(exception
))
107 def test(command
, pattern
=None):
108 """Sends 'command' to gdb and expects the given 'pattern'.
110 If 'pattern' is None, simply consumes everything up to and including
114 command (string): The command we'll send to gdb.
115 pattern (raw string): A pattern the gdb output should match.
118 string: The string that matched 'pattern', or an empty string if
124 gdb
.sendline(command
)
127 # PExpect does a non-greedy match for '+' and '*'. Since it can't look
128 # ahead on the gdb output stream, if 'pattern' ends with a '+' or a '*'
129 # we may end up matching only part of the required output.
130 # To avoid this, we'll consume 'pattern' and anything that follows it
131 # up to and including the gdb prompt, then extract 'pattern' later.
132 index
= gdb
.expect([u
'{0}.+{1}'.format(pattern
, gdb_prompt
),
136 # gdb.after now contains the whole match. Extract the text that
138 match
= re
.match(pattern
, gdb
.after
, re
.DOTALL
).group()
140 # We got a timeout exception. Print information on what caused it
142 error
= ('Response does not match the expected pattern.\n'
144 'Expected pattern: {1}\n'
145 'Response: {2}'.format(command
, pattern
, gdb
.before
))
147 raise pexpect
.TIMEOUT(error
)
149 # Consume just the the gdb prompt.
150 gdb
.expect(gdb_prompt
)
154 def init_test(test_bin
, printer_files
, printer_names
):
155 """Loads the test binary file and the required pretty printers to gdb.
158 test_bin (string): The name of the test binary file.
159 pretty_printers (list of strings): A list with the names of the pretty
163 # Load all the pretty printer files. We're assuming these are safe.
164 for printer_file
in printer_files
:
165 test('source {0}'.format(printer_file
))
167 # Disable all the pretty printers.
168 test('disable pretty-printer', r
'0 of [0-9]+ printers enabled')
170 # Enable only the required printers.
171 for printer
in printer_names
:
172 test('enable pretty-printer {0}'.format(printer
),
173 r
'[1-9][0-9]* of [1-9]+ printers enabled')
175 # Finally, load the test binary.
176 test('file {0}'.format(test_bin
))
178 # Disable lock elision.
179 test('set environment GLIBC_TUNABLES glibc.elision.enable=0')
182 """Executes a gdb 'start' command, which takes us to main."""
184 test('start', r
'main')
186 def get_line_number(file_name
, string
):
187 """Returns the number of the line in which 'string' appears within a file.
190 file_name (string): The name of the file we'll search through.
191 string (string): The string we'll look for.
194 int: The number of the line in which 'string' appears, starting from 1.
198 with
open(file_name
) as src_file
:
199 for i
, line
in enumerate(src_file
):
205 raise NoLineError(file_name
, string
)
209 def break_at(file_name
, string
, temporary
=True, thread
=None):
210 """Places a breakpoint on the first line in 'file_name' containing 'string'.
212 'string' is usually a comment like "Stop here". Notice this may fail unless
213 the comment is placed inline next to actual code, e.g.:
222 some_func(); /* Stop here */
227 If 'thread' isn't None, the breakpoint will be set for all the threads.
228 Otherwise, it'll be set only for 'thread'.
231 file_name (string): The name of the file we'll place the breakpoint in.
232 string (string): A string we'll look for inside the file.
233 We'll place a breakpoint on the line which contains it.
234 temporary (bool): Whether the breakpoint should be automatically deleted
236 thread (int): The number of the thread we'll place the breakpoint for,
237 as seen by gdb. If specified, it should be greater than zero.
243 thread_str
= 'thread {0}'.format(thread
)
247 break_type
= 'Temporary breakpoint'
250 break_type
= 'Breakpoint'
252 line_number
= str(get_line_number(file_name
, string
))
254 test('{0} {1}:{2} {3}'.format(command
, file_name
, line_number
, thread_str
),
255 r
'{0} [0-9]+ at 0x[a-f0-9]+: file {1}, line {2}\.'.format(break_type
,
259 def continue_cmd(thread
=None):
260 """Executes a gdb 'continue' command.
262 If 'thread' isn't None, the command will be applied to all the threads.
263 Otherwise, it'll be applied only to 'thread'.
266 thread (int): The number of the thread we'll apply the command to,
267 as seen by gdb. If specified, it should be greater than zero.
273 command
= 'thread apply {0} continue'.format(thread
)
277 def next_cmd(count
=1, thread
=None):
278 """Executes a gdb 'next' command.
280 If 'thread' isn't None, the command will be applied to all the threads.
281 Otherwise, it'll be applied only to 'thread'.
284 count (int): The 'count' argument of the 'next' command.
285 thread (int): The number of the thread we'll apply the command to,
286 as seen by gdb. If specified, it should be greater than zero.
292 command
= 'thread apply {0} next'
294 test('{0} {1}'.format(command
, count
))
296 def select_thread(thread
):
297 """Selects the thread indicated by 'thread'.
300 thread (int): The number of the thread we'll switch to, as seen by gdb.
301 This should be greater than zero.
305 test('thread {0}'.format(thread
))
307 def get_current_thread_lwpid():
308 """Gets the current thread's Lightweight Process ID.
311 string: The current thread's LWP ID.
314 # It's easier to get the LWP ID through the Python API than the gdb CLI.
315 command
= 'python print(gdb.selected_thread().ptid[1])'
317 return test(command
, r
'[0-9]+')
319 def set_scheduler_locking(mode
):
320 """Executes the gdb 'set scheduler-locking' command.
323 mode (bool): Whether the scheduler locking mode should be 'on'.
330 test('set scheduler-locking {0}'.format(modes
[mode
]))
332 def test_printer(var
, to_string
, children
=None, is_ptr
=True):
333 """ Tests the output of a pretty printer.
335 For a variable called 'var', this tests whether its associated printer
336 outputs the expected 'to_string' and children (if any).
339 var (string): The name of the variable we'll print.
340 to_string (raw string): The expected output of the printer's 'to_string'
342 children (map {raw string->raw string}): A map with the expected output
343 of the printer's children' method.
344 is_ptr (bool): Whether 'var' is a pointer, and thus should be
349 var
= '*{0}'.format(var
)
351 test('print {0}'.format(var
), to_string
)
354 for name
, value
in children
.items():
355 # Children are shown as 'name = value'.
356 test('print {0}'.format(var
), r
'{0} = {1}'.format(name
, value
))
358 def check_debug_symbol(symbol
):
359 """ Tests whether a given debugging symbol exists.
361 If the symbol doesn't exist, raises a DebugError.
364 symbol (string): The symbol we're going to check for.
368 test('ptype {0}'.format(symbol
), r
'type = {0}'.format(symbol
))
370 except pexpect
.TIMEOUT
:
371 # The symbol doesn't exist.
372 raise DebugError(symbol
)