1 # Copyright (C) 2008-2020 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file is part of the GDB testsuite. It tests the mechanism
17 # exposing values to Python.
19 load_lib gdb-python.exp
21 standard_testfile python.c python-1.c
23 if {[build_executable $testfile.exp $testfile \
24 [list $srcfile $srcfile2] debug] == -1} {
28 # Start with a fresh gdb.
31 gdb_reinitialize_dir $srcdir/$subdir
33 set remote_source2_py [gdb_remote_download host \
34 ${srcdir}/${subdir}/source2.py]
36 # Do this instead of the skip_python_check.
37 # We want to do some tests when Python is not present.
38 gdb_test_multiple "python print (23)" "verify python support" {
39 -re "not supported.*$gdb_prompt $" {
40 unsupported "python support is disabled"
42 # If Python is not supported, verify that sourcing a python script
44 gdb_test "source $remote_source2_py" \
45 "Error in sourced command file:.*" \
46 "source source2.py when python disabled"
48 # Verify multi-line python commands cause an error.
49 gdb_test_multiline "multi-line python command" \
52 "end" "not supported.*"
56 -re "$gdb_prompt $" {}
59 gdb_test_multiline "multi-line python command" \
64 # Spawn interactive Python help from a multi-line command, thus, after
67 with_test_prefix "python interactive help" {
68 set test "python; help(); end"
69 gdb_test_multiple "python\nhelp()\nend" $test {
70 -re ".*help utility.*help> $" {
73 # The "quit" must be seen on the output. A buggy GDB
74 # would not display it.
75 gdb_test "quit" "^quit.*leaving help.*" "quit help"
80 gdb_test_multiline "show python command" \
81 "define zzq" "Type commands for definition of .* just \"end\"\\.*" \
86 "show user zzq" "User command \"zzq\":.* python.*print \\(23\\).* end"
88 gdb_test_multiline "indented multi-line python command" \
91 " print ('hello, world!')" "" \
95 gdb_test "source $remote_source2_py" "yes" "source source2.py"
97 gdb_test "source -s source2.py" "yes"
99 set remote_source2_symlink_notpy \
100 [gdb_remote_download host ${srcdir}/${subdir}/source2.py \
101 [standard_output_file "source2-symlink.notpy"]]
102 set remote_source2_symlink_py [standard_output_file "source2-symlink.py"]
103 remote_file host delete $remote_source2_symlink_py
104 set status [remote_exec host "ln -sf $remote_source2_symlink_notpy $remote_source2_symlink_py"]
105 set test "source -s source2-symlink.py"
106 if {[lindex $status 0] == 0} {
107 gdb_test "source -s $remote_source2_symlink_py" "yes" $test
109 unsupported "$test (host does not support symbolic links)"
112 gdb_test "python print (gdb.current_objfile())" "None"
113 gdb_test "python print (gdb.objfiles())" "\\\[\\\]"
115 # Test http://bugs.python.org/issue4434 workaround in configure.ac
116 gdb_test "python import itertools; print ('IMPOR'+'TED')" "IMPORTED" "pythonX.Y/lib-dynload/*.so"
119 "python x = gdb.execute('printf \"%d\", 23', to_string = True)"
120 gdb_test "python print (x)" "23"
122 gdb_test "python gdb.execute('echo 2\\necho 3\\\\n\\n')" "23" \
124 gdb_test " " "23" "gdb.execute does not affect repeat history"
127 gdb_test_multiline "post event insertion" \
130 "class Foo(object):" "" \
131 " def __call__(self):" "" \
132 " global someVal" "" \
134 "gdb.post_event(Foo())" "" \
137 gdb_test "python print (someVal)" "1" "test post event execution"
138 gdb_test "python gdb.post_event(str(1))" "RuntimeError: Posted event is not callable.*" \
139 "test non callable class"
141 send_gdb "python gdb.post_event(lambda: invalid())\n"
143 -re "name 'invalid' is not defined" {
144 pass "test post_event error on receipt"
147 fail "test post_event error on receipt"
151 # Test (no) pagination of the executed command.
152 gdb_test "show height" {Number of lines gdb thinks are in a page is unlimited\.}
154 gdb_test_no_output "set height $lines"
156 set test "verify pagination beforehand"
157 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
161 -re " for more, q to quit" {
164 -re ", c to continue without paging--$" {
168 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination beforehand: q"
170 gdb_test "python if gdb.execute('python print (\"\\\\n\" * $lines)', to_string=True) == \"\\n\" * [expr $lines + 1]: print (\"yes\")" "yes" "gdb.execute does not page"
172 set test "verify pagination afterwards"
173 gdb_test_multiple "python print (\"\\n\" * $lines)" $test {
177 -re " for more, q to quit" {
180 -re ", c to continue without paging--$" {
184 gdb_test "q" "Quit.*Error while executing Python.*" "verify pagination afterwards: q"
186 gdb_test_no_output "set height 0"
188 gdb_test_no_output "python a = gdb.execute('help', to_string=True)" "collect help from uiout"
190 gdb_test "python print (a)" ".*aliases -- User-defined aliases of other commands.*" "verify help to uiout"
192 # Test PR 12212, using InfThread.selected_thread() when no inferior is
194 gdb_py_test_silent_cmd "python nothread = gdb.selected_thread()" "Attempt to aquire thread with no inferior" 1
195 gdb_test "python print (nothread == None)" "True" "ensure that no threads are returned"
197 gdb_test_multiline "register atexit function" \
200 "def printit(arg):" "" \
202 "atexit.register(printit, 'good bye world')" "" \
207 -re "good bye world" {
208 pass "atexit handling"
211 fail "atexit handling"
215 # Start with a fresh gdb.
216 clean_restart ${testfile}
218 # The following tests require execution.
220 if ![runto_main] then {
221 fail "can't run to main"
225 set lineno [gdb_get_line_number "Break to end."]
228 # Test gdb.decode_line.
229 gdb_test "python gdb.decode_line(\"main.c:43\")" \
230 "gdb.error: No source file named main.c.*" "test decode_line no source named main"
232 with_test_prefix "test decode_line current location" {
233 gdb_py_test_silent_cmd "python symtab = gdb.decode_line()" "decode current line" 1
234 gdb_test "python print (len(symtab))" "2" "length of result"
235 gdb_test "python print (symtab\[0\])" "None" "no unparsed text"
236 gdb_test "python print (len(symtab\[1\]))" "1" "length of result locations"
239 # Test that decode_line with an empty string argument does not crash.
240 gdb_py_test_silent_cmd "python symtab2 = gdb.decode_line('')" \
241 "test decode_line with empty string" 1
243 if { [is_remote host] } {
244 set python_c [string_to_regexp "python.c"]
246 set python_c [string_to_regexp "gdb.python/python.c"]
248 with_test_prefix "test decode_line" {
249 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "current location filename"
250 gdb_test "python print (symtab\[1\]\[0\].line)" "$lineno" "current location line number"
252 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"python.c:26 if foo\")" "python.c:26 decode" 1
253 gdb_test "python print (len(symtab))" "2" "python.c:26 length 2"
254 gdb_test "python print (symtab\[0\])" "if foo" "expression parse"
255 gdb_test "python print (len(symtab\[1\]))" "1" "python.c:26 length 1"
256 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "python.c:26 filename"
257 gdb_test "python print (symtab\[1\]\[0\].line)" "26" "python.c:26 line number"
259 gdb_test "python gdb.decode_line(\"randomfunc\")" \
260 "gdb.error: Function \"randomfunc\" not defined.*" "randomfunc"
261 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"func1\")" "func1()" 1
262 gdb_test "python print (len(symtab))" "2" "func1 length 2"
263 gdb_test "python print (len(symtab\[1\]))" "1" "func1 length 1"
266 if { [is_remote host] } {
267 set python_1_c [string_to_regexp "python-1.c"]
269 set python_1_c [string_to_regexp "gdb.python/python-1.c"]
271 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_1_c}" "test decode_line func1 filename"
273 # Set a default value for func1_lineno in case we fail to fetch the line number
275 set func1_lineno "noline"
277 # Fetch the line GDB thinks func1 starts at. This may change depending
278 # on the architecture and on how GDB handles the prologue of the function.
279 gdb_test_multiple "info line func1" "info line func1" {
280 -re "Line ($decimal) of .* starts at address $hex <func1> and ends at $hex <func1\\+$decimal>\.\[\r\n\]+$gdb_prompt $" {
281 # Fetch the line number.
282 set func1_lineno $expect_out(1,string)
286 gdb_test "python print (symtab\[1\]\[0\].line)" "$func1_lineno" "test decode_line func1 line number"
287 gdb_py_test_silent_cmd {python symtab = gdb.decode_line ("func1,func2")} \
288 "test decode_line func1,func2" 1
289 gdb_test {python print (symtab[0])} ",func2" "stop at comma in linespec"
291 with_test_prefix "test decode_line" {
292 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"*0\")" "*0" 1
293 gdb_test "python print (len(symtab))" "2" "*0 result length"
294 gdb_test "python print (symtab\[0\])" "None" "*0 unparsed"
295 gdb_test "python print (len(symtab\[1\]))" "1" "*0 locations length"
296 gdb_test "python print (symtab\[1\]\[0\].symtab)" "None" "*0 filename"
297 gdb_test "python print (symtab\[1\]\[0\].pc)" "0" "*0 pc"
301 gdb_test "python print (sys.stderr)" ".*gdb._GdbOutputErrorFile (instance|object) at.*" "test stderr location"
302 gdb_test "python print (sys.stdout)" ".*gdb._GdbOutputFile (instance|object) at.*" "test stdout location"
303 gdb_test "python gdb.write(\"Foo\\n\")" "Foo" "test default write"
304 gdb_test "python gdb.write(\"Error stream\\n\", stream=gdb.STDERR)" "Error stream" "test stderr write"
305 gdb_test "python gdb.write(\"Normal stream\\n\", stream=gdb.STDOUT)" "Normal stream" "test stdout write"
307 if ![gdb_debug_enabled] {
308 gdb_test "python gdb.write(\"Log stream\\n\", stream=gdb.STDLOG)" "Log stream" "test stdlog write"
311 # Turn on full stack printing for subsequent tests.
312 gdb_py_test_silent_cmd "set python print-stack full" \
313 "Set print-stack full for prompt tests" 1
315 # Test prompt substituion
317 gdb_test_multiline "prompt substitution" \
319 "someCounter = 0" "" \
320 "def prompt(current):" "" \
321 " global someCounter" "" \
322 " if (current == \"testfake \"):" "" \
324 " someCounter = someCounter + 1" "" \
325 " return \"py prompt \" + str (someCounter) + \" \"" "" \
328 gdb_test_multiline "prompt substitution readline" \
331 "def program_prompt(current):" "" \
332 " global pCounter" "" \
333 " if (current == \">\"):" "" \
334 " pCounter = pCounter + 1" "" \
335 " return \"python line \" + str (pCounter) + \": \"" "" \
339 set newprompt "py prompt 1"
340 set newprompt2 "py prompt 2"
341 set testfake "testfake"
343 gdb_test_multiple "python gdb.prompt_hook = prompt" "set the hook = prompt" {
344 -re "\[\r\n\]$newprompt $" {
349 gdb_test_multiple "set prompt testfake " "set testfake prompt in GDB" {
350 -re "\[\r\n\]$testfake $" {
355 gdb_test_multiple "show prompt" "show testfake prompt" {
356 -re "Gdb's prompt is \"$testfake \"..* $" {
361 gdb_test_multiple "set prompt blah " "set blah in GDB" {
362 -re "\[\r\n\]$newprompt2 $" {
367 gdb_test_multiple "python gdb.prompt_hook = None" "delete hook" {
368 -re "\[\r\n\]$newprompt2 $" {
373 gdb_test_multiple "set prompt $gdb_prompt " "set default prompt" {
374 -re "\[\r\n\]$gdb_prompt $" {
380 gdb_test_multiple "pwd" "pwd" {
381 -re "Working directory (.*)\\.\[\r\n\]+$gdb_prompt $" {
382 set working_dir $expect_out(1,string)
386 gdb_test_multiple "python gdb.prompt_hook = program_prompt" "set the programming hook" {
387 -re "\[\r\n\]$gdb_prompt $" {
392 gdb_test_multiple "python" "test we ignore substitution for seconday prompts" {
398 gdb_test_multiple "end" "end programming" {
399 -re "\[\r\n\]$gdb_prompt $" {
404 gdb_test_multiline "prompt substitution readline import" \
406 "import gdb.command.prompt" "" \
409 gdb_test_multiple "set extended-prompt one two three " \
410 "set basic extended prompt" {
411 -re "\[\r\n\]one two three $" {
416 gdb_test_multiple "set extended-prompt \\w " \
417 "set extended prompt working directory" {
418 -re "\[\r\n\][string_to_regexp $working_dir] $" {
423 gdb_test_multiple "set extended-prompt some param \\p{python print-stack} " \
424 "set extended prompt parameter" {
425 -re "\[\r\n\]some param full $" {
430 # Start with a fresh gdb.
431 clean_restart ${testfile}
433 # The following tests require execution.
435 if ![runto_main] then {
436 fail "can't run to main"
440 # print-stack settings
441 gdb_test "show python print-stack" \
442 "The mode of Python stack printing on error is \"message\".*" \
443 "Test print-stack show setting. Default is message."
444 gdb_py_test_silent_cmd "set python print-stack full" \
445 "Test print-stack set setting to full" 1
446 gdb_test "show python print-stack" \
447 "The mode of Python stack printing on error is \"full\".*" \
448 "Test print-stack show setting to full"
449 gdb_py_test_silent_cmd "set python print-stack none" \
450 "Test print-stack set setting to none" 1
451 gdb_test "show python print-stack" \
452 "The mode of Python stack printing on error is \"none\".*" \
453 "test print-stack show setting to none"
455 gdb_py_test_silent_cmd "set python print-stack message" \
456 "Test print-stack set setting to message" 1
458 gdb_test_multiline "prompt substitution readline error_prompt" \
461 "def error_prompt(current):" "" \
462 " raise RuntimeError(\"Python exception called\")" "" \
465 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook error_prompt" {
466 -re "Python Exception (exceptions.RuntimeError|<(type 'exceptions.|class ')RuntimeError'>) Python exception called.*$gdb_prompt $" {
471 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
472 "set the hook to default 1" 1
474 gdb_py_test_silent_cmd "set python print-stack full" \
475 "set print-stack full for prompt error test" 1
477 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook error_prompt traceback" {
478 -re "Traceback.*File.*line.*RuntimeError.*Python exception called.*$gdb_prompt $" {
483 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
484 "set the hook to default 2" 1
486 # Start with a fresh gdb.
487 clean_restart ${testfile}
489 # The following tests require execution.
491 if ![runto_main] then {
492 fail "can't run to main"
496 runto [gdb_get_line_number "Break at func2 call site."]
498 gdb_py_test_silent_cmd "python line = gdb.selected_frame().find_sal().line" "Get line number of func2 call site" 1
499 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line == line)" "True" "test find_pc_line at func2 call site"
501 gdb_py_test_silent_cmd "step" "Step into func2" 1
502 gdb_py_test_silent_cmd "up" "Step out of func2" 1
504 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line > line)" "True" "test find_pc_line with resume address"
506 gdb_test_no_output "set variable \$cvar1 = 23" "set convenience variable"
507 gdb_test "python print(gdb.convenience_variable('cvar1'))" "23"
508 gdb_test "python print(gdb.convenience_variable('cvar2'))" "None"
509 gdb_test_no_output "python gdb.set_convenience_variable('cvar1', 89)" \
510 "change convenience variable from python"
511 gdb_test "python print(gdb.convenience_variable('cvar1'))" "89" \
512 "print new value of convenience variable from python"
513 gdb_test "print \$cvar1" " = 89" \
514 "print new value of convenience variable from CLI"
515 gdb_test_no_output "python gdb.set_convenience_variable('cvar3', -5)" \
516 "make convenience variable from python"
517 gdb_test "python print(gdb.convenience_variable('cvar3'))" "-5" \
518 "print value of new convenience variable from python"
519 gdb_test_no_output "python gdb.set_convenience_variable('cvar3', None)" \
520 "reset convenience variable from python"
521 gdb_test "python print(gdb.convenience_variable('cvar3'))" "None" \
522 "print reset convenience variable from python"
523 gdb_test "print \$cvar3" "= void" \
524 "print reset convenience variable from CLI"
526 # Test PR 23669, the following would invoke the "commands" command instead of
528 gdb_test "python gdb.execute(\"show commands\")" "$decimal print \\\$cvar3.*"
530 # Test that the from_tty argument to gdb.execute is effective. If
531 # False, the user is not prompted for decisions such as restarting the
532 # program, and "yes" is assumed. If True, the user is prompted.
533 gdb_test "python gdb.execute('starti', from_tty=False)" \
534 "Program stopped.*" \
535 "starti via gdb.execute, not from tty"
536 gdb_test_multiple "python gdb.execute('starti', from_tty=True)" \
537 "starti via gdb.execute, from tty" {
538 -re {The program being debugged has been started already\.\r\nStart it from the beginning\? \(y or n\) $} {
539 gdb_test "y" "Starting program:.*" "starti via interactive input"