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_py_test_multiple "multi-line python command" \
52 "end" "not supported.*"
56 -re "$gdb_prompt $" {}
59 gdb_py_test_multiple "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_py_test_multiple "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_py_test_multiple "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_py_test_multiple "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_py_test_multiple "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 gdb_py_test_silent_cmd "python symtab = gdb.decode_line()" "test decode_line current location" 1
233 gdb_test "python print (len(symtab))" "2" "test decode_line current location"
234 gdb_test "python print (symtab\[0\])" "None" "test decode_line expression parse"
235 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line current location"
237 # Test that decode_line with an empty string argument does not crash.
238 gdb_py_test_silent_cmd "python symtab2 = gdb.decode_line('')" \
239 "test decode_line with empty string" 1
241 if { [is_remote host] } {
242 set python_c [string_to_regexp "python.c"]
244 set python_c [string_to_regexp "gdb.python/python.c"]
246 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line current location filename"
247 gdb_test "python print (symtab\[1\]\[0\].line)" "$lineno" "test decode_line current location line number"
249 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"python.c:26 if foo\")" "test decode_line python.c:26" 1
250 gdb_test "python print (len(symtab))" "2" "test decode_line python.c:26 length"
251 gdb_test "python print (symtab\[0\])" "if foo" "test decode_line expression parse"
252 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line python.c:26 length"
253 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_c}" "test decode_line python.c:26 filename"
254 gdb_test "python print (symtab\[1\]\[0\].line)" "26" "test decode_line python.c:26 line number"
256 gdb_test "python gdb.decode_line(\"randomfunc\")" \
257 "gdb.error: Function \"randomfunc\" not defined.*" "test decode_line randomfunc"
258 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"func1\")" "test decode_line func1()" 1
259 gdb_test "python print (len(symtab))" "2" "test decode_line func1 length"
260 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line func1 length"
262 if { [is_remote host] } {
263 set python_1_c [string_to_regexp "python-1.c"]
265 set python_1_c [string_to_regexp "gdb.python/python-1.c"]
267 gdb_test "python print (symtab\[1\]\[0\].symtab)" ".*${python_1_c}" "test decode_line func1 filename"
269 # Set a default value for func1_lineno in case we fail to fetch the line number
271 set func1_lineno "noline"
273 # Fetch the line GDB thinks func1 starts at. This may change depending
274 # on the architecture and on how GDB handles the prologue of the function.
275 gdb_test_multiple "info line func1" "info line func1" {
276 -re "Line ($decimal) of .* starts at address $hex <func1> and ends at $hex <func1\\+$decimal>\.\[\r\n\]+$gdb_prompt $" {
277 # Fetch the line number.
278 set func1_lineno $expect_out(1,string)
282 gdb_test "python print (symtab\[1\]\[0\].line)" "$func1_lineno" "test decode_line func1 line number"
283 gdb_py_test_silent_cmd {python symtab = gdb.decode_line ("func1,func2")} \
284 "test decode_line func1,func2" 1
285 gdb_test {python print (symtab[0])} ",func2" "stop at comma in linespec"
287 gdb_py_test_silent_cmd "python symtab = gdb.decode_line(\"*0\")" "Test decode_line *0" 1
288 gdb_test "python print (len(symtab))" "2" "test decode_line *0 result length"
289 gdb_test "python print (symtab\[0\])" "None" "test decode_line *0 unparsed"
290 gdb_test "python print (len(symtab\[1\]))" "1" "test decode_line *0 locations length"
291 gdb_test "python print (symtab\[1\]\[0\].symtab)" "None" "test decode_line *0 filename"
292 gdb_test "python print (symtab\[1\]\[0\].pc)" "0" "test decode_line *0 pc"
295 gdb_test "python print (sys.stderr)" ".*gdb._GdbOutputErrorFile (instance|object) at.*" "test stderr location"
296 gdb_test "python print (sys.stdout)" ".*gdb._GdbOutputFile (instance|object) at.*" "test stdout location"
297 gdb_test "python gdb.write(\"Foo\\n\")" "Foo" "test default write"
298 gdb_test "python gdb.write(\"Error stream\\n\", stream=gdb.STDERR)" "Error stream" "test stderr write"
299 gdb_test "python gdb.write(\"Normal stream\\n\", stream=gdb.STDOUT)" "Normal stream" "test stdout write"
301 if ![gdb_debug_enabled] {
302 gdb_test "python gdb.write(\"Log stream\\n\", stream=gdb.STDLOG)" "Log stream" "test stdlog write"
305 # Turn on full stack printing for subsequent tests.
306 gdb_py_test_silent_cmd "set python print-stack full" \
307 "Set print-stack full for prompt tests" 1
309 # Test prompt substituion
311 gdb_py_test_multiple "prompt substitution" \
313 "someCounter = 0" "" \
314 "def prompt(current):" "" \
315 " global someCounter" "" \
316 " if (current == \"testfake \"):" "" \
318 " someCounter = someCounter + 1" "" \
319 " return \"py prompt \" + str (someCounter) + \" \"" "" \
322 gdb_py_test_multiple "prompt substitution readline" \
325 "def program_prompt(current):" "" \
326 " global pCounter" "" \
327 " if (current == \">\"):" "" \
328 " pCounter = pCounter + 1" "" \
329 " return \"python line \" + str (pCounter) + \": \"" "" \
333 set newprompt "py prompt 1"
334 set newprompt2 "py prompt 2"
335 set testfake "testfake"
337 gdb_test_multiple "python gdb.prompt_hook = prompt" "set the hook" {
338 -re "\[\r\n\]$newprompt $" {
343 gdb_test_multiple "set prompt testfake " "set testfake prompt in GDB" {
344 -re "\[\r\n\]$testfake $" {
345 pass "set prompt testfake"
349 gdb_test_multiple "show prompt" "show testfake prompt" {
350 -re "Gdb's prompt is \"$testfake \"..* $" {
351 pass "show prompt shows guarded prompt"
355 gdb_test_multiple "set prompt blah " "set blah in GDB" {
356 -re "\[\r\n\]$newprompt2 $" {
357 pass "set prompt blah overriden"
361 gdb_test_multiple "python gdb.prompt_hook = None" "delete hook" {
362 -re "\[\r\n\]$newprompt2 $" {
363 pass "delete old hook"
367 gdb_test_multiple "set prompt $gdb_prompt " "set default prompt" {
368 -re "\[\r\n\]$gdb_prompt $" {
369 pass "set default prompt"
374 gdb_test_multiple "pwd" "pwd" {
375 -re "Working directory (.*)\\.\[\r\n\]+$gdb_prompt $" {
376 set working_dir $expect_out(1,string)
380 gdb_test_multiple "python gdb.prompt_hook = program_prompt" "set the hook" {
381 -re "\[\r\n\]$gdb_prompt $" {
382 pass "set programming hook"
386 gdb_test_multiple "python" "test we ignore substituion for seconday prompts" {
388 pass "readline secondary are not substituted"
392 gdb_test_multiple "end" "end programming" {
393 -re "\[\r\n\]$gdb_prompt $" {
394 pass "end programming"
398 gdb_py_test_multiple "prompt substitution readline" \
400 "import gdb.command.prompt" "" \
403 gdb_test_multiple "set extended-prompt one two three " \
404 "set basic extended prompt" {
405 -re "\[\r\n\]one two three $" {
406 pass "set basic extended prompt"
410 gdb_test_multiple "set extended-prompt \\w " \
411 "set extended prompt working directory" {
412 -re "\[\r\n\][string_to_regexp $working_dir] $" {
413 pass "set extended prompt working directory"
417 gdb_test_multiple "set extended-prompt some param \\p{python print-stack} " \
418 "set extended prompt parameter" {
419 -re "\[\r\n\]some param full $" {
420 pass "set extended prompt parameter"
424 # Start with a fresh gdb.
425 clean_restart ${testfile}
427 # The following tests require execution.
429 if ![runto_main] then {
430 fail "can't run to main"
434 # print-stack settings
435 gdb_test "show python print-stack" \
436 "The mode of Python stack printing on error is \"message\".*" \
437 "Test print-stack show setting. Default is message."
438 gdb_py_test_silent_cmd "set python print-stack full" \
439 "Test print-stack set setting to full" 1
440 gdb_test "show python print-stack" \
441 "The mode of Python stack printing on error is \"full\".*" \
442 "Test print-stack show setting to full"
443 gdb_py_test_silent_cmd "set python print-stack none" \
444 "Test print-stack set setting to none" 1
445 gdb_test "show python print-stack" \
446 "The mode of Python stack printing on error is \"none\".*" \
447 "test print-stack show setting to none"
449 gdb_py_test_silent_cmd "set python print-stack message" \
450 "Test print-stack set setting to message" 1
452 gdb_py_test_multiple "prompt substitution readline" \
455 "def error_prompt(current):" "" \
456 " raise RuntimeError(\"Python exception called\")" "" \
459 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
460 -re "Python Exception (exceptions.RuntimeError|<(type 'exceptions.|class ')RuntimeError'>) Python exception called.*$gdb_prompt $" {
465 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
466 "set the hook to default" 1
468 gdb_py_test_silent_cmd "set python print-stack full" \
469 "set print-stack full for prompt error test" 1
471 gdb_test_multiple "python gdb.prompt_hook = error_prompt" "set the hook" {
472 -re "Traceback.*File.*line.*RuntimeError.*Python exception called.*$gdb_prompt $" {
477 gdb_py_test_silent_cmd "python gdb.prompt_hook = None" \
478 "set the hook to default" 1
480 # Start with a fresh gdb.
481 clean_restart ${testfile}
483 # The following tests require execution.
485 if ![runto_main] then {
486 fail "can't run to main"
490 runto [gdb_get_line_number "Break at func2 call site."]
492 gdb_py_test_silent_cmd "python line = gdb.selected_frame().find_sal().line" "Get line number of func2 call site" 1
493 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line == line)" "True" "test find_pc_line at func2 call site"
495 gdb_py_test_silent_cmd "step" "Step into func2" 1
496 gdb_py_test_silent_cmd "up" "Step out of func2" 1
498 gdb_test "python print (gdb.find_pc_line(gdb.selected_frame().pc()).line > line)" "True" "test find_pc_line with resume address"
500 gdb_test_no_output "set variable \$cvar1 = 23" "set convenience variable"
501 gdb_test "python print(gdb.convenience_variable('cvar1'))" "23"
502 gdb_test "python print(gdb.convenience_variable('cvar2'))" "None"
503 gdb_test_no_output "python gdb.set_convenience_variable('cvar1', 89)" \
504 "change convenience variable from python"
505 gdb_test "python print(gdb.convenience_variable('cvar1'))" "89" \
506 "print new value of convenience variable from python"
507 gdb_test "print \$cvar1" " = 89" \
508 "print new value of convenience variable from CLI"
509 gdb_test_no_output "python gdb.set_convenience_variable('cvar3', -5)" \
510 "make convenience variable from python"
511 gdb_test "python print(gdb.convenience_variable('cvar3'))" "-5" \
512 "print value of new convenience variable from python"
513 gdb_test_no_output "python gdb.set_convenience_variable('cvar3', None)" \
514 "reset convenience variable from python"
515 gdb_test "python print(gdb.convenience_variable('cvar3'))" "None" \
516 "print reset convenience variable from python"
517 gdb_test "print \$cvar3" "= void" \
518 "print reset convenience variable from CLI"
520 # Test PR 23669, the following would invoke the "commands" command instead of
522 gdb_test "python gdb.execute(\"show commands\")" "$decimal print \\\$cvar3.*"