gdb/testsuite/gdb.python/py-value.exp

   1 # Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   2
   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.
   7 #
   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.
  12 #
  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/>.
  15
  16 # This file is part of the GDB testsuite.  It tests the mechanism
  17 # exposing values to Python.
  18
  19 if $tracelevel then {
  20     strace $tracelevel
  21 }
  22
  23 load_lib gdb-python.exp
  24
  25 set testfile "py-value"
  26 set srcfile ${testfile}.c
  27 set binfile ${objdir}/${subdir}/${testfile}
  28
  29 # Build inferior to language specification.
  30 proc build_inferior {exefile lang} {
  31   global srcdir subdir srcfile testfile hex
  32
  33   if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${exefile}" executable "debug $lang"] != "" } {
  34       untested "Couldn't compile ${srcfile} in $lang mode"
  35       return -1
  36   }
  37 }
  38
  39 proc test_value_creation {} {
  40   global gdb_prompt
  41
  42   gdb_py_test_silent_cmd "python i = gdb.Value (True)" "create boolean value" 1
  43   gdb_py_test_silent_cmd "python i = gdb.Value (5)" "create integer value" 1
  44   gdb_py_test_silent_cmd "python i = gdb.Value (5L)" "create long value" 1
  45   gdb_py_test_silent_cmd "python f = gdb.Value (1.25)" "create double value" 1
  46   gdb_py_test_silent_cmd "python a = gdb.Value ('string test')" "create 8-bit string value" 1
  47   gdb_test "python print a" "\"string test\"" "print 8-bit string"
  48   gdb_test "python print a.__class__" "<type 'gdb.Value'>" "verify type of 8-bit string"
  49   gdb_py_test_silent_cmd "python a = gdb.Value (u'unicode test')" "create unicode value" 1
  50   gdb_test "python print a" "\"unicode test\"" "print Unicode string"
  51   gdb_test "python print a.__class__" "<type 'gdb.Value'>" "verify type of unicode string"
  52
  53   # Test address attribute is None in a non-addressable value
  54   gdb_test "python print 'result =', i.address" "= None" "Test address attribute in non-addressable value"
  55 }
  56
  57 proc test_value_numeric_ops {} {
  58   global gdb_prompt
  59
  60   gdb_py_test_silent_cmd "python i = gdb.Value (5)" "create first integer value" 0
  61   gdb_py_test_silent_cmd "python j = gdb.Value (2)" "create second integer value" 0
  62   gdb_py_test_silent_cmd "python f = gdb.Value (1.25)" "create first double value" 0
  63   gdb_py_test_silent_cmd "python g = gdb.Value (2.5)" "create second double value" 0
  64   gdb_test "python print 'result = ' + str(i+j)" " = 7" "add two integer values"
  65   gdb_test "python print (i+j).__class__" "<type 'gdb.Value'>" "verify type of integer add result"
  66
  67   gdb_test "python print 'result = ' + str(f+g)" " = 3.75" "add two double values"
  68   gdb_test "python print 'result = ' + str(i-j)" " = 3" "subtract two integer values"
  69   gdb_test "python print 'result = ' + str(f-g)" " = -1.25" "subtract two double values"
  70   gdb_test "python print 'result = ' + str(i*j)" " = 10" "multiply two integer values"
  71   gdb_test "python print 'result = ' + str(f*g)" " = 3.125" "multiply two double values"
  72   gdb_test "python print 'result = ' + str(i/j)" " = 2" "divide two integer values"
  73   gdb_test "python print 'result = ' + str(f/g)" " = 0.5" "divide two double values"
  74   gdb_test "python print 'result = ' + str(i%j)" " = 1" "take remainder of two integer values"
  75   # Remainder of float is implemented in Python but not in GDB's value system.
  76
  77   gdb_test "python print 'result = ' + str(i**j)" " = 25" "integer value raised to the power of another integer value"
  78   gdb_test "python print 'result = ' + str(g**j)" " = 6.25" "double value raised to the power of integer value"
  79
  80   gdb_test "python print 'result = ' + str(-i)" " = -5" "negated integer value"
  81   gdb_test "python print 'result = ' + str(+i)" " = 5" "positive integer value"
  82   gdb_test "python print 'result = ' + str(-f)" " = -1.25" "negated double value"
  83   gdb_test "python print 'result = ' + str(+f)" " = 1.25" "positive double value"
  84   gdb_test "python print 'result = ' + str(abs(j-i))" " = 3" "absolute of integer value"
  85   gdb_test "python print 'result = ' + str(abs(f-g))" " = 1.25" "absolute of double value"
  86
  87   # Test gdb.Value mixed with Python types.
  88
  89   gdb_test "python print 'result = ' + str(i-1)" " = 4" "subtract integer value from python integer"
  90   gdb_test "python print (i-1).__class__" "<type 'gdb.Value'>" "verify type of mixed integer subtraction result"
  91   gdb_test "python print 'result = ' + str(f+1.5)" " = 2.75" "add double value with python float"
  92
  93   gdb_test "python print 'result = ' + str(1-i)" " = -4" "subtract python integer from integer value"
  94   gdb_test "python print 'result = ' + str(1.5+f)" " = 2.75" "add python float with double value"
  95
  96   # Conversion test.
  97   gdb_test "print evalue" " = TWO"
  98   gdb_test_no_output "python evalue = gdb.history (0)"
  99   gdb_test "python print int (evalue)" "2"
 100
 101   # Test pointer arithmethic
 102
 103   # First, obtain the pointers
 104   gdb_test "print (void *) 2" ".*" ""
 105   gdb_test_no_output "python a = gdb.history (0)" ""
 106   gdb_test "print (void *) 5" ".*" ""
 107   gdb_test_no_output "python b = gdb.history (0)" ""
 108
 109   gdb_test "python print 'result = ' + str(a+5)" " = 0x7" "add pointer value with python integer"
 110   gdb_test "python print 'result = ' + str(b-2)" " = 0x3" "subtract python integer from pointer value"
 111   gdb_test "python print 'result = ' + str(b-a)" " = 3" "subtract two pointer values"
 112
 113   # Test some invalid operations.
 114
 115   gdb_test_multiple "python print 'result = ' + str(i+'foo')" "catch error in python type conversion" {
 116       -re "Argument to arithmetic operation not a number or boolean.*$gdb_prompt $"   {pass "catch error in python type conversion"}
 117       -re "result = .*$gdb_prompt $"                  {fail "catch error in python type conversion"}
 118       -re "$gdb_prompt $"                             {fail "catch error in python type conversion"}
 119   }
 120
 121   gdb_test_multiple "python print 'result = ' + str(i+gdb.Value('foo'))" "catch throw of GDB error" {
 122       -re "Traceback.*$gdb_prompt $"  {pass "catch throw of GDB error"}
 123       -re "result = .*$gdb_prompt $"  {fail "catch throw of GDB error"}
 124       -re "$gdb_prompt $"             {fail "catch throw of GDB error"}
 125   }
 126 }
 127
 128 proc test_value_boolean {} {
 129   # First, define a useful function to test booleans.
 130   gdb_py_test_multiple "define function to test booleans" \
 131     "python" "" \
 132     "def test_bool (val):" "" \
 133     "  if val:" "" \
 134     "    print 'yay'" "" \
 135     "  else:" "" \
 136     "    print 'nay'" "" \
 137     "end" ""
 138
 139   gdb_test "py test_bool (gdb.Value (True))" "yay" "check evaluation of true boolean value in expression"
 140
 141   gdb_test "py test_bool (gdb.Value (False))" "nay" "check evaluation of false boolean value in expression"
 142
 143   gdb_test "py test_bool (gdb.Value (5))" "yay" "check evaluation of true integer value in expression"
 144
 145   gdb_test "py test_bool (gdb.Value (0))" "nay" "check evaluation of false integer value in expression"
 146
 147   gdb_test "py test_bool (gdb.Value (5.2))" "yay" "check evaluation of true integer value in expression"
 148
 149   gdb_test "py test_bool (gdb.Value (0.0))" "nay" "check evaluation of false integer value in expression"
 150 }
 151
 152 proc test_value_compare {} {
 153   gdb_test "py print gdb.Value (1) < gdb.Value (1)" "False" "less than, equal"
 154   gdb_test "py print gdb.Value (1) < gdb.Value (2)" "True" "less than, less"
 155   gdb_test "py print gdb.Value (2) < gdb.Value (1)" "False" "less than, greater"
 156   gdb_test "py print gdb.Value (2) < None" "False" "less than, None"
 157
 158   gdb_test "py print gdb.Value (1) <= gdb.Value (1)" "True" "less or equal, equal"
 159   gdb_test "py print gdb.Value (1) <= gdb.Value (2)" "True" "less or equal, less"
 160   gdb_test "py print gdb.Value (2) <= gdb.Value (1)" "False" "less or equal, greater"
 161   gdb_test "py print gdb.Value (2) <= None" "False" "less or equal, None"
 162
 163   gdb_test "py print gdb.Value (1) == gdb.Value (1)" "True" "equality of gdb.Values"
 164   gdb_test "py print gdb.Value (1) == gdb.Value (2)" "False" "inequality of gdb.Values"
 165   gdb_test "py print gdb.Value (1) == 1.0" "True" "equality of gdb.Value with Python value"
 166   gdb_test "py print gdb.Value (1) == 2" "False" "inequality of gdb.Value with Python value"
 167   gdb_test "py print gdb.Value (1) == None" "False" "inequality of gdb.Value with None"
 168
 169   gdb_test "py print gdb.Value (1) != gdb.Value (1)" "False" "inequality, false"
 170   gdb_test "py print gdb.Value (1) != gdb.Value (2)" "True" "inequality, true"
 171   gdb_test "py print gdb.Value (1) != None" "True" "inequality, None"
 172
 173   gdb_test "py print gdb.Value (1) > gdb.Value (1)" "False" "greater than, equal"
 174   gdb_test "py print gdb.Value (1) > gdb.Value (2)" "False" "greater than, less"
 175   gdb_test "py print gdb.Value (2) > gdb.Value (1)" "True" "greater than, greater"
 176   gdb_test "py print gdb.Value (2) > None" "True" "greater than, None"
 177
 178   gdb_test "py print gdb.Value (1) >= gdb.Value (1)" "True" "greater or equal, equal"
 179   gdb_test "py print gdb.Value (1) >= gdb.Value (2)" "False" "greater or equal, less"
 180   gdb_test "py print gdb.Value (2) >= gdb.Value (1)" "True" "greater or equal, greater"
 181   gdb_test "py print gdb.Value (2) >= None" "True" "greater or equal, None"
 182 }
 183
 184 proc test_value_in_inferior {} {
 185   global gdb_prompt
 186   global testfile
 187
 188   gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
 189
 190   gdb_continue_to_breakpoint "break to inspect struct and union"
 191
 192   # Just get inferior variable s in the value history, available to python.
 193   gdb_test "print s" " = {a = 3, b = 5}" ""
 194
 195   gdb_py_test_silent_cmd "python s = gdb.history (0)" "get value from history" 1
 196
 197   gdb_test "python print 'result = ' + str(s\['a'\])" " = 3" "access element inside struct using 8-bit string name"
 198   gdb_test "python print 'result = ' + str(s\[u'a'\])" " = 3" "access element inside struct using unicode name"
 199
 200   # Test dereferencing the argv pointer
 201
 202   # Just get inferior variable argv the value history, available to python.
 203   gdb_test "print argv" " = \\(char \\*\\*\\) 0x.*" ""
 204
 205   gdb_py_test_silent_cmd "python argv = gdb.history (0)" "" 0
 206   gdb_py_test_silent_cmd "python arg0 = argv.dereference ()" "dereference value" 1
 207
 208   # Check that the dereferenced value is sane
 209   if { ! [target_info exists noargs] } {
 210     gdb_test "python print arg0" "0x.*$testfile\"" "verify dereferenced value"
 211   }
 212
 213   # Smoke-test is_optimized_out attribute
 214   gdb_test "python print 'result =', arg0.is_optimized_out" "= False" "Test is_optimized_out attribute"
 215
 216   # Test address attribute
 217   gdb_test "python print 'result =', arg0.address" "= 0x\[\[:xdigit:\]\]+" "Test address attribute"
 218
 219   # Test memory error.
 220   gdb_test "python print gdb.parse_and_eval('*(int*)0')" "gdb.MemoryError: Cannot access memory at address 0x0.*"
 221
 222   # Test string fetches,  both partial and whole.
 223   gdb_test "print st" "\"divide et impera\""
 224   gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value from history" 1
 225   gdb_test "python print st.string ()"  "divide et impera"  "Test string with no length"
 226   gdb_test "python print st.string (length = -1)" "divide et impera" "Test string (length = -1) is all of the string"
 227   gdb_test "python print st.string (length = 6)" "divide"
 228   gdb_test "python print \"---\"+st.string (length = 0)+\"---\"" "------" "Test string (length = 0) is empty"
 229   gdb_test "python print len(st.string (length = 0))" "0" "Test length is 0"
 230
 231
 232   # Fetch a string that has embedded nulls.
 233   gdb_test "print nullst" "\"divide\\\\000et\\\\000impera\".*"
 234   gdb_py_test_silent_cmd "python nullst = gdb.history (0)" "get value from history" 1
 235   gdb_test "python print nullst.string ()" "divide" "Test string to first null"
 236   # Python cannot print strings that contain the null (\0) character.
 237   # For the purposes of this test, use repr()
 238   gdb_py_test_silent_cmd "python nullst = nullst.string (length = 9)" "get string beyond null" 1
 239   gdb_test "python print repr(nullst)" "u'divide\\\\x00et'"
 240 }
 241
 242 proc test_lazy_strings {} {
 243
 244   global hex
 245
 246   gdb_test "print sptr" "\"pointer\""
 247   gdb_py_test_silent_cmd "python sptr = gdb.history (0)" "Get value from history" 1
 248
 249   gdb_py_test_silent_cmd "python lstr = sptr.lazy_string()" "Aquire lazy string" 1
 250   gdb_test "python print lstr.type" "const char \*." "Test type name equality"
 251   gdb_test "python print sptr.type" "const char \*." "Test type name equality"
 252   gdb_test "print sn" "0x0"
 253   gdb_py_test_silent_cmd "python snptr = gdb.history (0)" "Get value from history" 1
 254   gdb_test "python snstr = snptr.lazy_string(length=5)" ".*Cannot create a lazy string with address.*" "Test lazy string"
 255   gdb_py_test_silent_cmd "python snstr = snptr.lazy_string(length=0)" "Succesfully create a lazy string" 1
 256   gdb_test "python print snstr.length" "0" "Test lazy string length"
 257   gdb_test "python print snstr.address" "0" "Test lazy string address"
 258 }
 259
 260
 261 proc test_inferior_function_call {} {
 262     global gdb_prompt hex decimal
 263
 264     # Correct inferior call without arguments.
 265     gdb_test "p/x fp1" " = $hex.*"
 266     gdb_py_test_silent_cmd "python fp1 = gdb.history (0)" "get value from history" 1
 267     gdb_test "python fp1 = fp1.dereference()" ""
 268     gdb_test "python result = fp1()" ""
 269     gdb_test "python print result" "void"
 270
 271     # Correct inferior call with arguments.
 272     gdb_test "p/x fp2" " = $hex.*"
 273     gdb_py_test_silent_cmd "python fp2 = gdb.history (0)" "get value from history" 1
 274     gdb_test "python fp2 = fp2.dereference()" ""
 275     gdb_test "python result2 = fp2(10,20)" ""
 276     gdb_test "python print result2" "30"
 277
 278     # Incorrect to call an int value.
 279     gdb_test "p i" " = $decimal.*"
 280     gdb_py_test_silent_cmd "python i = gdb.history (0)" "get value from history" 1
 281     gdb_test "python result3 = i()" ".*Value is not callable.*"
 282
 283     # Incorrect number of arguments.
 284     gdb_test "p/x fp2" " = $hex.*"
 285     gdb_py_test_silent_cmd "python fp3 = gdb.history (0)" "get value from history" 1
 286     gdb_test "python fp3 = fp3.dereference()" ""
 287     gdb_test "python result2 = fp3(10)" ".*Too few arguments in function call.*"
 288 }
 289
 290 # A few objfile tests.
 291 proc test_objfiles {} {
 292     gdb_test "python\nok=False\nfor file in gdb.objfiles():\n  if 'py-value' in file.filename:\n    ok=True\nprint ok\nend" "True" \
 293              "py-value in file.filename"
 294
 295     gdb_test "python print gdb.objfiles()\[0\].pretty_printers" "\\\[\\\]"
 296
 297     gdb_test "python gdb.objfiles()\[0\].pretty_printers = 0" \
 298       "pretty_printers attribute must be a list.*Error while executing Python code."
 299 }
 300
 301 proc test_value_after_death {} {
 302   # Construct a type while the inferior is still running.
 303   gdb_py_test_silent_cmd "python ptrtype = gdb.lookup_type('PTR')" \
 304     "create PTR type" 1
 305
 306   # Kill the inferior and remove the symbols.
 307   gdb_test "kill" "" "kill the inferior" \
 308     "Kill the program being debugged. .y or n. $" \
 309     "y"
 310   gdb_test "file" "" "Discard the symbols" \
 311     "Discard symbol table from.*y or n. $" \
 312     "y"
 313
 314   # Now create a value using that type.  Relies on arg0, created by
 315   # test_value_in_inferior.
 316   gdb_py_test_silent_cmd "python castval = arg0.cast(ptrtype.pointer())" \
 317     "cast arg0 to PTR" 1
 318
 319   # Make sure the type is deleted.
 320   gdb_py_test_silent_cmd "python ptrtype = None" \
 321     "delete PTR type" 1
 322
 323   # Now see if the value's type is still valid.
 324   gdb_test "python print castval.type" "PTR ." \
 325     "print value's type"
 326 }
 327
 328 # Regression test for invalid subscript operations.  The bug was that
 329 # the type of the value was not being checked before allowing a
 330 # subscript operation to proceed.
 331
 332 proc test_subscript_regression {exefile lang} {
 333
 334  global srcdir subdir
 335
 336  # Start with a fresh gdb.
 337  gdb_exit
 338  gdb_start
 339  gdb_reinitialize_dir $srcdir/$subdir
 340  gdb_load ${exefile}
 341
 342  if ![runto_main ] then {
 343      perror "couldn't run to breakpoint"
 344      return
 345  }
 346
 347  if {$lang == "c++"} {
 348      gdb_breakpoint [gdb_get_line_number "break to inspect pointer by reference"]
 349      gdb_continue_to_breakpoint "break to inspect pointer by reference"
 350
 351      gdb_py_test_silent_cmd "print rptr_int" \
 352          "Obtain address" 1
 353      gdb_py_test_silent_cmd "python rptr = gdb.history(0)" \
 354          "Obtains value from GDB" 1
 355      gdb_test "python print rptr\[0\]" "2" "Check pointer passed as reference"
 356
 357      # Just the most basic test of dynamic_cast -- it is checked in
 358      # the C++ tests.
 359      gdb_test "python print bool(gdb.parse_and_eval('base').dynamic_cast(gdb.lookup_type('Derived').pointer()))" \
 360          True
 361
 362      # Likewise.
 363      gdb_test "python print gdb.parse_and_eval('base').dynamic_type" \
 364          "Derived \[*\]"
 365      # A static type case.
 366      gdb_test "python print gdb.parse_and_eval('5').dynamic_type" \
 367          "int"
 368  }
 369
 370  gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
 371  gdb_continue_to_breakpoint "break to inspect struct and union"
 372
 373  gdb_py_test_silent_cmd "python intv = gdb.Value(1)" \
 374      "Create a value for subscript test" 1
 375  gdb_py_test_silent_cmd "python stringv = gdb.Value(\"foo\")" \
 376      "Create a value for subscript test" 1
 377
 378  # Try to access an int with a subscript.  This should fail.
 379  gdb_test "python print intv" "1" "Baseline print of a Python value"
 380  gdb_test "python print intv\[0\]" "gdb.error: Cannot subscript requested type.*" \
 381      "Attempt to access an integer with a subscript"
 382
 383  # Try to access a string with a subscript.  This should pass.
 384  gdb_test "python print stringv" "foo." "Baseline print of a Python value"
 385  gdb_test "python print stringv\[0\]" "f." "Attempt to access a string with a subscript"
 386
 387  # Try to access an int array via a pointer with a subscript.  This should pass.
 388  gdb_py_test_silent_cmd "print p" "Build pointer to array" 1
 389  gdb_py_test_silent_cmd "python pointer = gdb.history(0)" "" 1
 390  gdb_test "python print pointer\[0\]" "1" "Access array via pointer with int subscript"
 391  gdb_test "python print pointer\[intv\]" "2" "Access array via pointer with value subscript"
 392
 393  # Try to access a single dimension array with a subscript to the
 394  # result.  This should fail.
 395  gdb_test "python print pointer\[intv\]\[0\]" "gdb.error: Cannot subscript requested type.*" \
 396      "Attempt to access an integer with a subscript"
 397
 398  # Lastly, test subscript access to an array with multiple
 399  # dimensions.  This should pass.
 400  gdb_py_test_silent_cmd "print {\"fu \",\"foo\",\"bar\"}" "Build array" 1
 401  gdb_py_test_silent_cmd "python marray = gdb.history(0)" "" 1
 402  gdb_test "python print marray\[1\]\[2\]" "o." "Test multiple subscript"
 403 }
 404
 405 # A few tests of gdb.parse_and_eval.
 406 proc test_parse_and_eval {} {
 407   gdb_test "python print gdb.parse_and_eval ('23')" "23" \
 408     "parse_and_eval constant test"
 409   gdb_test "python print gdb.parse_and_eval ('5 + 7')" "12" \
 410     "parse_and_eval simple expression test"
 411   gdb_test "python print type(gdb.parse_and_eval ('5 + 7'))" \
 412     ".type 'gdb.Value'."\
 413     "parse_and_eval type test"
 414 }
 415
 416 # Test that values are hashable.
 417 proc test_value_hash {} {
 418   gdb_py_test_multiple "Simple Python value dictionary" \
 419     "python" "" \
 420     "one = gdb.Value(1)" "" \
 421     "two = gdb.Value(2)" "" \
 422     "three = gdb.Value(3)" "" \
 423     "vdict = {one:\"one str\",two:\"two str\",three:\"three str\"}" "" \
 424     "end"
 425     gdb_test "python print vdict\[one\]" "one str" "Test dictionary hash"
 426     gdb_test "python print vdict\[two\]" "two str" "Test dictionary hash"
 427     gdb_test "python print vdict\[three\]" "three str" "Test dictionary hash"
 428     gdb_test "python print one.__hash__() == hash(one)" "True" "Test inbuilt hash"
 429 }
 430
 431 # Build C and C++ versions of executable
 432 build_inferior "${binfile}" "c"
 433 build_inferior "${binfile}-cxx" "c++"
 434
 435 # Start with a fresh gdb.
 436
 437 gdb_exit
 438 gdb_start
 439 gdb_reinitialize_dir $srcdir/$subdir
 440 gdb_load ${binfile}
 441
 442 # Skip all tests if Python scripting is not enabled.
 443 if { [skip_python_tests] } { continue }
 444
 445 test_value_creation
 446 test_value_numeric_ops
 447 test_value_boolean
 448 test_value_compare
 449 test_objfiles
 450 test_parse_and_eval
 451 test_value_hash
 452
 453 # The following tests require execution.
 454
 455 if ![runto_main] then {
 456     fail "Can't run to main"
 457     return 0
 458 }
 459
 460 test_value_in_inferior
 461 test_inferior_function_call
 462 test_lazy_strings
 463 test_value_after_death
 464
 465 # Test either C or C++ values.
 466 test_subscript_regression "${binfile}" "c"
 467 test_subscript_regression "${binfile}-cxx" "c++"