1 # Copyright (C) 2008-2012 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
23 # Build inferior to language specification.
24 proc build_inferior {exefile lang} {
25 global srcdir subdir srcfile testfile hex
27 if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${exefile}" executable "debug $lang"] != "" } {
28 untested "Couldn't compile ${srcfile} in $lang mode"
33 proc test_value_creation {} {
36 gdb_py_test_silent_cmd "python i = gdb.Value (True)" "create boolean value" 1
37 gdb_py_test_silent_cmd "python i = gdb.Value (5)" "create integer value" 1
38 gdb_py_test_silent_cmd "python i = gdb.Value (5L)" "create long value" 1
39 gdb_py_test_silent_cmd "python f = gdb.Value (1.25)" "create double value" 1
40 gdb_py_test_silent_cmd "python a = gdb.Value ('string test')" "create 8-bit string value" 1
41 gdb_test "python print a" "\"string test\"" "print 8-bit string"
42 gdb_test "python print a.__class__" "<type 'gdb.Value'>" "verify type of 8-bit string"
43 gdb_py_test_silent_cmd "python a = gdb.Value (u'unicode test')" "create unicode value" 1
44 gdb_test "python print a" "\"unicode test\"" "print Unicode string"
45 gdb_test "python print a.__class__" "<type 'gdb.Value'>" "verify type of unicode string"
47 # Test address attribute is None in a non-addressable value
48 gdb_test "python print 'result =', i.address" "= None" "Test address attribute in non-addressable value"
51 proc test_value_numeric_ops {} {
54 gdb_py_test_silent_cmd "python i = gdb.Value (5)" "create first integer value" 0
55 gdb_py_test_silent_cmd "python j = gdb.Value (2)" "create second integer value" 0
56 gdb_py_test_silent_cmd "python f = gdb.Value (1.25)" "create first double value" 0
57 gdb_py_test_silent_cmd "python g = gdb.Value (2.5)" "create second double value" 0
58 gdb_test "python print 'result = ' + str(i+j)" " = 7" "add two integer values"
59 gdb_test "python print (i+j).__class__" "<type 'gdb.Value'>" "verify type of integer add result"
61 gdb_test "python print 'result = ' + str(f+g)" " = 3.75" "add two double values"
62 gdb_test "python print 'result = ' + str(i-j)" " = 3" "subtract two integer values"
63 gdb_test "python print 'result = ' + str(f-g)" " = -1.25" "subtract two double values"
64 gdb_test "python print 'result = ' + str(i*j)" " = 10" "multiply two integer values"
65 gdb_test "python print 'result = ' + str(f*g)" " = 3.125" "multiply two double values"
66 gdb_test "python print 'result = ' + str(i/j)" " = 2" "divide two integer values"
67 gdb_test "python print 'result = ' + str(f/g)" " = 0.5" "divide two double values"
68 gdb_test "python print 'result = ' + str(i%j)" " = 1" "take remainder of two integer values"
69 # Remainder of float is implemented in Python but not in GDB's value system.
71 gdb_test "python print 'result = ' + str(i**j)" " = 25" "integer value raised to the power of another integer value"
72 gdb_test "python print 'result = ' + str(g**j)" " = 6.25" "double value raised to the power of integer value"
74 gdb_test "python print 'result = ' + str(-i)" " = -5" "negated integer value"
75 gdb_test "python print 'result = ' + str(+i)" " = 5" "positive integer value"
76 gdb_test "python print 'result = ' + str(-f)" " = -1.25" "negated double value"
77 gdb_test "python print 'result = ' + str(+f)" " = 1.25" "positive double value"
78 gdb_test "python print 'result = ' + str(abs(j-i))" " = 3" "absolute of integer value"
79 gdb_test "python print 'result = ' + str(abs(f-g))" " = 1.25" "absolute of double value"
81 # Test gdb.Value mixed with Python types.
83 gdb_test "python print 'result = ' + str(i-1)" " = 4" "subtract integer value from python integer"
84 gdb_test "python print (i-1).__class__" "<type 'gdb.Value'>" "verify type of mixed integer subtraction result"
85 gdb_test "python print 'result = ' + str(f+1.5)" " = 2.75" "add double value with python float"
87 gdb_test "python print 'result = ' + str(1-i)" " = -4" "subtract python integer from integer value"
88 gdb_test "python print 'result = ' + str(1.5+f)" " = 2.75" "add python float with double value"
91 gdb_test "print evalue" " = TWO"
92 gdb_test_no_output "python evalue = gdb.history (0)"
93 gdb_test "python print int (evalue)" "2"
95 # Test pointer arithmethic
97 # First, obtain the pointers
98 gdb_test "print (void *) 2" ".*" ""
99 gdb_test_no_output "python a = gdb.history (0)" ""
100 gdb_test "print (void *) 5" ".*" ""
101 gdb_test_no_output "python b = gdb.history (0)" ""
103 gdb_test "python print 'result = ' + str(a+5)" " = 0x7( <.*>)?" "add pointer value with python integer"
104 gdb_test "python print 'result = ' + str(b-2)" " = 0x3( <.*>)?" "subtract python integer from pointer value"
105 gdb_test "python print 'result = ' + str(b-a)" " = 3" "subtract two pointer values"
107 # Test some invalid operations.
109 gdb_test_multiple "python print 'result = ' + str(i+'foo')" "catch error in python type conversion" {
110 -re "Argument to arithmetic operation not a number or boolean.*$gdb_prompt $" {pass "catch error in python type conversion"}
111 -re "result = .*$gdb_prompt $" {fail "catch error in python type conversion"}
112 -re "$gdb_prompt $" {fail "catch error in python type conversion"}
115 gdb_test_multiple "python print 'result = ' + str(i+gdb.Value('foo'))" "catch throw of GDB error" {
116 -re "Traceback.*$gdb_prompt $" {pass "catch throw of GDB error"}
117 -re "result = .*$gdb_prompt $" {fail "catch throw of GDB error"}
118 -re "$gdb_prompt $" {fail "catch throw of GDB error"}
122 proc test_value_boolean {} {
123 # First, define a useful function to test booleans.
124 gdb_py_test_multiple "define function to test booleans" \
126 "def test_bool (val):" "" \
133 gdb_test "py test_bool (gdb.Value (True))" "yay" "check evaluation of true boolean value in expression"
135 gdb_test "py test_bool (gdb.Value (False))" "nay" "check evaluation of false boolean value in expression"
137 gdb_test "py test_bool (gdb.Value (5))" "yay" "check evaluation of true integer value in expression"
139 gdb_test "py test_bool (gdb.Value (0))" "nay" "check evaluation of false integer value in expression"
141 gdb_test "py test_bool (gdb.Value (5.2))" "yay" "check evaluation of true integer value in expression"
143 gdb_test "py test_bool (gdb.Value (0.0))" "nay" "check evaluation of false integer value in expression"
146 proc test_value_compare {} {
147 gdb_test "py print gdb.Value (1) < gdb.Value (1)" "False" "less than, equal"
148 gdb_test "py print gdb.Value (1) < gdb.Value (2)" "True" "less than, less"
149 gdb_test "py print gdb.Value (2) < gdb.Value (1)" "False" "less than, greater"
150 gdb_test "py print gdb.Value (2) < None" "False" "less than, None"
152 gdb_test "py print gdb.Value (1) <= gdb.Value (1)" "True" "less or equal, equal"
153 gdb_test "py print gdb.Value (1) <= gdb.Value (2)" "True" "less or equal, less"
154 gdb_test "py print gdb.Value (2) <= gdb.Value (1)" "False" "less or equal, greater"
155 gdb_test "py print gdb.Value (2) <= None" "False" "less or equal, None"
157 gdb_test "py print gdb.Value (1) == gdb.Value (1)" "True" "equality of gdb.Values"
158 gdb_test "py print gdb.Value (1) == gdb.Value (2)" "False" "inequality of gdb.Values"
159 gdb_test "py print gdb.Value (1) == 1.0" "True" "equality of gdb.Value with Python value"
160 gdb_test "py print gdb.Value (1) == 2" "False" "inequality of gdb.Value with Python value"
161 gdb_test "py print gdb.Value (1) == None" "False" "inequality of gdb.Value with None"
163 gdb_test "py print gdb.Value (1) != gdb.Value (1)" "False" "inequality, false"
164 gdb_test "py print gdb.Value (1) != gdb.Value (2)" "True" "inequality, true"
165 gdb_test "py print gdb.Value (1) != None" "True" "inequality, None"
167 gdb_test "py print gdb.Value (1) > gdb.Value (1)" "False" "greater than, equal"
168 gdb_test "py print gdb.Value (1) > gdb.Value (2)" "False" "greater than, less"
169 gdb_test "py print gdb.Value (2) > gdb.Value (1)" "True" "greater than, greater"
170 gdb_test "py print gdb.Value (2) > None" "True" "greater than, None"
172 gdb_test "py print gdb.Value (1) >= gdb.Value (1)" "True" "greater or equal, equal"
173 gdb_test "py print gdb.Value (1) >= gdb.Value (2)" "False" "greater or equal, less"
174 gdb_test "py print gdb.Value (2) >= gdb.Value (1)" "True" "greater or equal, greater"
175 gdb_test "py print gdb.Value (2) >= None" "True" "greater or equal, None"
178 proc test_value_in_inferior {} {
182 gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
184 gdb_continue_to_breakpoint "break to inspect struct and union"
186 # Just get inferior variable s in the value history, available to python.
187 gdb_test "print s" " = {a = 3, b = 5}" ""
189 gdb_py_test_silent_cmd "python s = gdb.history (0)" "get value from history" 1
191 gdb_test "python print 'result = ' + str(s\['a'\])" " = 3" "access element inside struct using 8-bit string name"
192 gdb_test "python print 'result = ' + str(s\[u'a'\])" " = 3" "access element inside struct using unicode name"
194 # Test dereferencing the argv pointer
196 # Just get inferior variable argv the value history, available to python.
197 gdb_test "print argv" " = \\(char \\*\\*\\) 0x.*" ""
199 gdb_py_test_silent_cmd "python argv = gdb.history (0)" "" 0
200 gdb_py_test_silent_cmd "python arg0 = argv.dereference ()" "dereference value" 1
202 # Check that the dereferenced value is sane
203 if { ! [target_info exists noargs] } {
204 gdb_test "python print arg0" "0x.*$testfile\"" "verify dereferenced value"
207 # Smoke-test is_optimized_out attribute
208 gdb_test "python print 'result =', arg0.is_optimized_out" "= False" "Test is_optimized_out attribute"
210 # Test address attribute
211 gdb_test "python print 'result =', arg0.address" "= 0x\[\[:xdigit:\]\]+" "Test address attribute"
213 # Test displaying a variable that is temporarily at a bad address.
214 # But if we can examine what's at memory address 0, then we'll also be
215 # able to display it without error. Don't run the test in that case.
217 gdb_test_multiple "x 0" "memory at address 0" {
218 -re "0x0:\[ \t\]*Cannot access memory at address 0x0\r\n$gdb_prompt $" { }
219 -re "0x0:\[ \t\]*Error accessing memory address 0x0\r\n$gdb_prompt $" { }
220 -re "\r\n$gdb_prompt $" {
226 set test "parse_and_eval with memory error"
230 gdb_test "python print gdb.parse_and_eval('*(int*)0')" "gdb.MemoryError: Cannot access memory at address 0x0.*" $test
233 # Test Python lazy value handling
234 set test "memory error and lazy values"
238 gdb_test "python inval = gdb.parse_and_eval('*(int*)0')"
239 gdb_test "python print inval.is_lazy" "True"
240 gdb_test "python inval2 = inval+1" "gdb.MemoryError: Cannot access memory at address 0x0.*" $test
241 gdb_test "python inval.fetch_lazy ()" "gdb.MemoryError: Cannot access memory at address 0x0.*" $test
243 gdb_test "python argc_lazy = gdb.parse_and_eval('argc')"
244 gdb_test "python argc_notlazy = gdb.parse_and_eval('argc')"
245 gdb_test "python argc_notlazy.fetch_lazy()"
246 gdb_test "python print argc_lazy.is_lazy" "True"
247 gdb_test "python print argc_notlazy.is_lazy" "False"
248 gdb_test "print argc" " = 1" "sanity check argc"
249 gdb_test "python print argc_lazy.is_lazy" "\r\nTrue"
250 gdb_test_no_output "set argc=2"
251 gdb_test "python print argc_notlazy" "\r\n1"
252 gdb_test "python print argc_lazy" "\r\n2"
253 gdb_test "python print argc_lazy.is_lazy" "False"
255 # Test string fetches, both partial and whole.
256 gdb_test "print st" "\"divide et impera\""
257 gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value from history" 1
258 gdb_test "python print st.string ()" "divide et impera" "Test string with no length"
259 gdb_test "python print st.string (length = -1)" "divide et impera" "Test string (length = -1) is all of the string"
260 gdb_test "python print st.string (length = 6)" "divide"
261 gdb_test "python print \"---\"+st.string (length = 0)+\"---\"" "------" "Test string (length = 0) is empty"
262 gdb_test "python print len(st.string (length = 0))" "0" "Test length is 0"
265 # Fetch a string that has embedded nulls.
266 gdb_test "print nullst" "\"divide\\\\000et\\\\000impera\".*"
267 gdb_py_test_silent_cmd "python nullst = gdb.history (0)" "get value from history" 1
268 gdb_test "python print nullst.string ()" "divide" "Test string to first null"
269 # Python cannot print strings that contain the null (\0) character.
270 # For the purposes of this test, use repr()
271 gdb_py_test_silent_cmd "python nullst = nullst.string (length = 9)" "get string beyond null" 1
272 gdb_test "python print repr(nullst)" "u'divide\\\\x00et'"
275 proc test_lazy_strings {} {
279 gdb_test "print sptr" "\"pointer\""
280 gdb_py_test_silent_cmd "python sptr = gdb.history (0)" "Get value from history" 1
282 gdb_py_test_silent_cmd "python lstr = sptr.lazy_string()" "Aquire lazy string" 1
283 gdb_test "python print lstr.type" "const char \*." "Test type name equality"
284 gdb_test "python print sptr.type" "const char \*." "Test type name equality"
285 gdb_test "print sn" "0x0"
286 gdb_py_test_silent_cmd "python snptr = gdb.history (0)" "Get value from history" 1
287 gdb_test "python snstr = snptr.lazy_string(length=5)" ".*Cannot create a lazy string with address.*" "Test lazy string"
288 gdb_py_test_silent_cmd "python snstr = snptr.lazy_string(length=0)" "Succesfully create a lazy string" 1
289 gdb_test "python print snstr.length" "0" "Test lazy string length"
290 gdb_test "python print snstr.address" "0" "Test lazy string address"
294 proc test_inferior_function_call {} {
295 global gdb_prompt hex decimal
297 # Correct inferior call without arguments.
298 gdb_test "p/x fp1" " = $hex.*"
299 gdb_py_test_silent_cmd "python fp1 = gdb.history (0)" "get value from history" 1
300 gdb_test "python fp1 = fp1.dereference()" ""
301 gdb_test "python result = fp1()" ""
302 gdb_test "python print result" "void"
304 # Correct inferior call with arguments.
305 gdb_test "p/x fp2" " = $hex.*"
306 gdb_py_test_silent_cmd "python fp2 = gdb.history (0)" "get value from history" 1
307 gdb_test "python fp2 = fp2.dereference()" ""
308 gdb_test "python result2 = fp2(10,20)" ""
309 gdb_test "python print result2" "30"
311 # Incorrect to call an int value.
312 gdb_test "p i" " = $decimal.*"
313 gdb_py_test_silent_cmd "python i = gdb.history (0)" "get value from history" 1
314 gdb_test "python result3 = i()" ".*Value is not callable.*"
316 # Incorrect number of arguments.
317 gdb_test "p/x fp2" " = $hex.*"
318 gdb_py_test_silent_cmd "python fp3 = gdb.history (0)" "get value from history" 1
319 gdb_test "python fp3 = fp3.dereference()" ""
320 gdb_test "python result2 = fp3(10)" ".*Too few arguments in function call.*"
323 # A few objfile tests.
324 proc test_objfiles {} {
325 gdb_test "python\nok=False\nfor file in gdb.objfiles():\n if 'py-value' in file.filename:\n ok=True\nprint ok\nend" "True" \
326 "py-value in file.filename"
328 gdb_test "python print gdb.objfiles()\[0\].pretty_printers" "\\\[\\\]"
330 gdb_test "python gdb.objfiles()\[0\].pretty_printers = 0" \
331 "pretty_printers attribute must be a list.*Error while executing Python code."
334 proc test_value_after_death {} {
335 # Construct a type while the inferior is still running.
336 gdb_py_test_silent_cmd "python ptrtype = gdb.lookup_type('PTR')" \
339 # Kill the inferior and remove the symbols.
340 gdb_test "kill" "" "kill the inferior" \
341 "Kill the program being debugged. .y or n. $" \
343 gdb_test "file" "" "Discard the symbols" \
344 "Discard symbol table from.*y or n. $" \
347 # Now create a value using that type. Relies on arg0, created by
348 # test_value_in_inferior.
349 gdb_py_test_silent_cmd "python castval = arg0.cast(ptrtype.pointer())" \
352 # Make sure the type is deleted.
353 gdb_py_test_silent_cmd "python ptrtype = None" \
356 # Now see if the value's type is still valid.
357 gdb_test "python print castval.type" "PTR ." \
361 # Regression test for invalid subscript operations. The bug was that
362 # the type of the value was not being checked before allowing a
363 # subscript operation to proceed.
365 proc test_subscript_regression {exefile lang} {
366 # Start with a fresh gdb.
367 clean_restart ${exefile}
369 if ![runto_main ] then {
370 perror "couldn't run to breakpoint"
374 if {$lang == "c++"} {
375 gdb_breakpoint [gdb_get_line_number "break to inspect pointer by reference"]
376 gdb_continue_to_breakpoint "break to inspect pointer by reference"
378 gdb_py_test_silent_cmd "print rptr_int" \
380 gdb_py_test_silent_cmd "python rptr = gdb.history(0)" \
381 "Obtains value from GDB" 1
382 gdb_test "python print rptr\[0\]" "2" "Check pointer passed as reference"
384 # Just the most basic test of dynamic_cast -- it is checked in
386 gdb_test "python print bool(gdb.parse_and_eval('base').dynamic_cast(gdb.lookup_type('Derived').pointer()))" \
390 gdb_test "python print gdb.parse_and_eval('base').dynamic_type" \
392 # A static type case.
393 gdb_test "python print gdb.parse_and_eval('5').dynamic_type" \
397 gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
398 gdb_continue_to_breakpoint "break to inspect struct and union"
400 gdb_py_test_silent_cmd "python intv = gdb.Value(1)" \
401 "Create a value for subscript test" 1
402 gdb_py_test_silent_cmd "python stringv = gdb.Value(\"foo\")" \
403 "Create a value for subscript test" 1
405 # Try to access an int with a subscript. This should fail.
406 gdb_test "python print intv" "1" "Baseline print of a Python value"
407 gdb_test "python print intv\[0\]" "gdb.error: Cannot subscript requested type.*" \
408 "Attempt to access an integer with a subscript"
410 # Try to access a string with a subscript. This should pass.
411 gdb_test "python print stringv" "foo." "Baseline print of a Python value"
412 gdb_test "python print stringv\[0\]" "f." "Attempt to access a string with a subscript"
414 # Try to access an int array via a pointer with a subscript. This should pass.
415 gdb_py_test_silent_cmd "print p" "Build pointer to array" 1
416 gdb_py_test_silent_cmd "python pointer = gdb.history(0)" "" 1
417 gdb_test "python print pointer\[0\]" "1" "Access array via pointer with int subscript"
418 gdb_test "python print pointer\[intv\]" "2" "Access array via pointer with value subscript"
420 # Try to access a single dimension array with a subscript to the
421 # result. This should fail.
422 gdb_test "python print pointer\[intv\]\[0\]" "gdb.error: Cannot subscript requested type.*" \
423 "Attempt to access an integer with a subscript"
425 # Lastly, test subscript access to an array with multiple
426 # dimensions. This should pass.
427 gdb_py_test_silent_cmd "print {\"fu \",\"foo\",\"bar\"}" "Build array" 1
428 gdb_py_test_silent_cmd "python marray = gdb.history(0)" "" 1
429 gdb_test "python print marray\[1\]\[2\]" "o." "Test multiple subscript"
432 # A few tests of gdb.parse_and_eval.
433 proc test_parse_and_eval {} {
434 gdb_test "python print gdb.parse_and_eval ('23')" "23" \
435 "parse_and_eval constant test"
436 gdb_test "python print gdb.parse_and_eval ('5 + 7')" "12" \
437 "parse_and_eval simple expression test"
438 gdb_test "python print type(gdb.parse_and_eval ('5 + 7'))" \
439 ".type 'gdb.Value'."\
440 "parse_and_eval type test"
443 # Test that values are hashable.
444 proc test_value_hash {} {
445 gdb_py_test_multiple "Simple Python value dictionary" \
447 "one = gdb.Value(1)" "" \
448 "two = gdb.Value(2)" "" \
449 "three = gdb.Value(3)" "" \
450 "vdict = {one:\"one str\",two:\"two str\",three:\"three str\"}" "" \
452 gdb_test "python print vdict\[one\]" "one str" "Test dictionary hash"
453 gdb_test "python print vdict\[two\]" "two str" "Test dictionary hash"
454 gdb_test "python print vdict\[three\]" "three str" "Test dictionary hash"
455 gdb_test "python print one.__hash__() == hash(one)" "True" "Test inbuilt hash"
458 # Build C and C++ versions of executable
459 build_inferior "${binfile}" "c"
460 build_inferior "${binfile}-cxx" "c++"
462 # Start with a fresh gdb.
463 clean_restart ${binfile}
465 # Skip all tests if Python scripting is not enabled.
466 if { [skip_python_tests] } { continue }
469 test_value_numeric_ops
476 # The following tests require execution.
478 if ![runto_main] then {
479 fail "Can't run to main"
483 test_value_in_inferior
484 test_inferior_function_call
486 test_value_after_death
488 # Test either C or C++ values.
489 test_subscript_regression "${binfile}" "c"
490 test_subscript_regression "${binfile}-cxx" "c++"