gdb/testsuite/gdb.guile/scm-value.exp

   1 # Copyright (C) 2008-2014 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.
  17 # It tests the mechanism exposing values to Guile.
  18
  19 load_lib gdb-guile.exp
  20
  21 standard_testfile
  22
  23 # Build inferior to language specification.
  24 # LANG is one of "c" or "c++".
  25 proc build_inferior {exefile lang} {
  26     global srcdir subdir srcfile testfile hex
  27
  28     # Use different names for .o files based on the language.
  29     # For Fission, the debug info goes in foo.dwo and we don't want,
  30     # for example, a C++ compile to clobber the dwo of a C compile.
  31     # ref: http://gcc.gnu.org/wiki/DebugFission
  32     switch ${lang} {
  33         "c" { set filename ${testfile}.o }
  34         "c++" { set filename ${testfile}-cxx.o }
  35     }
  36     set objfile [standard_output_file $filename]
  37
  38     if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${objfile}" object "debug $lang"] != ""
  39          || [gdb_compile "${objfile}" "${exefile}" executable "debug $lang"] != "" } {
  40         untested "Couldn't compile ${srcfile} in $lang mode"
  41         return -1
  42     }
  43     return 0
  44 }
  45
  46 proc test_value_in_inferior {} {
  47     global gdb_prompt
  48     global testfile
  49
  50     gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
  51
  52     gdb_continue_to_breakpoint "break to inspect struct and union"
  53
  54     # Just get inferior variable s in the value history, available to guile.
  55     gdb_test "print s" "= {a = 3, b = 5}" ""
  56
  57     gdb_scm_test_silent_cmd "gu (define s (history-ref 0))" "set s"
  58
  59     gdb_test "gu (print (value-field s \"a\"))" \
  60         "= 3" "access element inside struct using string name"
  61
  62     # Test dereferencing the argv pointer.
  63
  64     # Just get inferior variable argv the value history, available to guile.
  65     gdb_test "print argv" "= \\(char \\*\\*\\) 0x.*" ""
  66
  67     gdb_scm_test_silent_cmd "gu (define argv (history-ref 0))" \
  68         "set argv"
  69     gdb_scm_test_silent_cmd "gu (define arg0 (value-dereference argv))" \
  70         "set arg0"
  71
  72     # Check that the dereferenced value is sane.
  73     if { ! [target_info exists noargs] } {
  74         gdb_test "gu (print arg0)" \
  75             "0x.*$testfile\"" "verify dereferenced value"
  76     }
  77
  78     # Smoke-test value-optimized-out?.
  79     gdb_test "gu (print (value-optimized-out? arg0))" \
  80         "= #f" "Test value-optimized-out?"
  81
  82     # Test address attribute.
  83     gdb_test "gu (print (value-address arg0))" \
  84         "= 0x\[\[:xdigit:\]\]+" "Test address attribute"
  85     # Test address attribute is #f in a non-addressable value.
  86     gdb_test "gu (print (value-address (make-value 42)))" \
  87         "= #f" "Test address attribute in non-addressable value"
  88
  89     # Test displaying a variable that is temporarily at a bad address.
  90     # But if we can examine what's at memory address 0, then we'll also be
  91     # able to display it without error.  Don't run the test in that case.
  92     set can_read_0 0
  93     gdb_test_multiple "x 0" "memory at address 0" {
  94         -re "0x0:\[ \t\]*Cannot access memory at address 0x0\r\n$gdb_prompt $" { }
  95         -re "0x0:\[ \t\]*Error accessing memory address 0x0\r\n$gdb_prompt $" { }
  96         -re "\r\n$gdb_prompt $" {
  97             set can_read_0 1
  98         }
  99     }
 100
 101     # Test memory error.
 102     set test "parse_and_eval with memory error"
 103     if {$can_read_0} {
 104         untested $test
 105     } else {
 106         gdb_test "gu (print (parse-and-eval \"*(int*)0\"))" \
 107             "ERROR: Cannot access memory at address 0x0.*" $test
 108     }
 109
 110     # Test Guile lazy value handling
 111     set test "memory error and lazy values"
 112     if {$can_read_0} {
 113         untested $test
 114     } else {
 115         gdb_test_no_output "gu (define inval (parse-and-eval \"*(int*)0\"))"
 116         gdb_test "gu (print (value-lazy? inval))" \
 117             "#t"
 118         gdb_test "gu (define inval2 (value-add inval 1))" \
 119             "ERROR: Cannot access memory at address 0x0.*" $test
 120         gdb_test "gu (value-fetch-lazy! inval))" \
 121             "ERROR: Cannot access memory at address 0x0.*" $test
 122     }
 123     gdb_test_no_output "gu (define argc-lazy (parse-and-eval \"argc\"))"
 124     gdb_test_no_output "gu (define argc-notlazy (parse-and-eval \"argc\"))"
 125     gdb_test_no_output "gu (value-fetch-lazy! argc-notlazy)"
 126     gdb_test "gu (print (value-lazy? argc-lazy))" "= #t"
 127     gdb_test "gu (print (value-lazy? argc-notlazy))" "= #f"
 128     gdb_test "print argc" "= 1" "sanity check argc"
 129     gdb_test "gu (print (value-lazy? argc-lazy))" "= #t"
 130     gdb_test_no_output "set argc=2"
 131     gdb_test "gu (print argc-notlazy)" "= 1"
 132     gdb_test "gu (print argc-lazy)" "= 2"
 133     gdb_test "gu (print (value-lazy? argc-lazy))" "= #f"
 134
 135     # Test string fetches, both partial and whole.
 136     gdb_test "print st" "\"divide et impera\""
 137     gdb_scm_test_silent_cmd "gu (define st (history-ref 0))" \
 138         "inf: get st value from history"
 139     gdb_test "gu (print (value->string st))" \
 140         "= divide et impera"  "Test string with no length"
 141     gdb_test "gu (print (value->string st #:length -1))" \
 142         "= divide et impera" "Test string (length = -1) is all of the string"
 143     gdb_test "gu (print (value->string st #:length 6))" \
 144         "= divide"
 145     gdb_test "gu (print (string-append \"---\" (value->string st #:length 0) \"---\"))" \
 146         "= ------" "Test string (length = 0) is empty"
 147     gdb_test "gu (print (string-length (value->string st #:length 0)))" \
 148         "= 0" "Test length is 0"
 149
 150     # Fetch a string that has embedded nulls.
 151     gdb_test "print nullst" "\"divide\\\\000et\\\\000impera\".*"
 152     gdb_scm_test_silent_cmd "gu (define nullst (history-ref 0))" \
 153         "inf: get nullst value from history"
 154     gdb_test "gu (print (value->string nullst))" \
 155         "divide" "Test string to first null"
 156     gdb_scm_test_silent_cmd "gu (set! nullst (value->string nullst #:length 9))" \
 157         "get string beyond null"
 158     gdb_test "gu (print nullst)" \
 159         "= divide\\\\000et"
 160 }
 161
 162 proc test_strings {} {
 163     gdb_test "gu (make-value \"test\")" "#<gdb:value \"test\">" "make string"
 164
 165     # Test string conversion errors.
 166     set save_charset [get_target_charset]
 167     gdb_test_no_output "set target-charset UTF-8"
 168
 169     gdb_test_no_output "gu (set-port-conversion-strategy! #f 'error)"
 170     gdb_test "gu (print (value->string (make-value (string #\\x1234)) #:encoding \"ASCII\"))" \
 171         "ERROR.*decoding-error.*" \
 172         "value->string with default #:errors = 'error"
 173
 174     # There is no 'escape strategy for C->SCM string conversions, but it's
 175     # still a legitimate value for %default-port-conversion-strategy.
 176     # GDB handles this by, umm, substituting 'substitute.
 177     # Use this case to also handle "#:errors #f" which explicitly says
 178     # "use %default-port-conversion-strategy".
 179     gdb_test_no_output "gu (set-port-conversion-strategy! #f 'escape)"
 180     gdb_test "gu (print (value->string (make-value (string #\\x1234)) #:encoding \"ASCII\" #:errors #f))" \
 181         "= \[?\]{3}" "value->string with default #:errors = 'escape"
 182
 183     # This is last in the default conversion tests so that
 184     # %default-port-conversion-strategy ends up with the default value.
 185     gdb_test_no_output "gu (set-port-conversion-strategy! #f 'substitute)"
 186     gdb_test "gu (print (value->string (make-value (string #\\x1234)) #:encoding \"ASCII\"))" \
 187         "= \[?\]{3}" "value->string with default #:errors = 'substitute"
 188
 189     gdb_test "gu (print (value->string (make-value (string #\\x1234)) #:encoding \"ASCII\" #:errors 'error))" \
 190         "ERROR.*decoding-error.*" "value->string #:errors 'error"
 191     gdb_test "gu (print (value->string (make-value (string #\\x1234)) #:encoding \"ASCII\" #:errors 'substitute))" \
 192         "= \[?\]{3}" "value->string #:errors 'substitute"
 193     gdb_test "gu (print (value->string (make-value \"abc\") #:errors \"foo\"))" \
 194         "ERROR.*invalid error kind.*" "bad value for #:errors"
 195
 196     gdb_test_no_output "set target-charset $save_charset" \
 197         "restore target-charset"
 198 }
 199
 200 proc test_lazy_strings {} {
 201     global hex
 202
 203     gdb_test "print sptr" "\"pointer\""
 204     gdb_scm_test_silent_cmd "gu (define sptr (history-ref 0))" \
 205         "lazy strings: get sptr value from history"
 206
 207     gdb_scm_test_silent_cmd "gu (define lstr (value->lazy-string sptr))" \
 208         "Aquire lazy string"
 209     gdb_test "gu (print (lazy-string-type lstr))" \
 210         "= const char \*." "Test lazy-string type name equality"
 211     gdb_test "gu (print (value-type sptr))" \
 212         "= const char \*." "Test string type name equality"
 213     gdb_test "print sn" "0x0"
 214     gdb_scm_test_silent_cmd "gu (define snptr (history-ref 0))" \
 215         "lazy strings: get snptr value from history"
 216     gdb_test "gu (define snstr (value->lazy-string snptr #:length 5))" \
 217         ".*cannot create a lazy string with address.*" "Test lazy string"
 218     gdb_scm_test_silent_cmd "gu (define snstr (value->lazy-string snptr #:length 0))" \
 219         "Successfully create a lazy string"
 220     gdb_test "gu (print (lazy-string-length snstr))" \
 221         "= 0" "Test lazy string length"
 222     gdb_test "gu (print (lazy-string-address snstr))" \
 223         "= 0" "Test lazy string address"
 224 }
 225
 226 proc test_inferior_function_call {} {
 227     global gdb_prompt hex decimal
 228
 229     # Correct inferior call without arguments.
 230     gdb_test "p/x fp1" "= $hex.*"
 231     gdb_scm_test_silent_cmd "gu (define fp1 (history-ref 0))" \
 232         "get fp1 value from history"
 233     gdb_scm_test_silent_cmd "gu (set! fp1 (value-dereference fp1))" \
 234         "dereference fp1"
 235     gdb_test "gu (print (value-call fp1 '()))" \
 236         "= void"
 237
 238     # Correct inferior call with arguments.
 239     gdb_test "p/x fp2" "= $hex.*"
 240     gdb_scm_test_silent_cmd "gu (define fp2 (history-ref 0))" \
 241         "get fp2 value from history"
 242     gdb_scm_test_silent_cmd "gu (set! fp2 (value-dereference fp2))" \
 243         "dereference fp2"
 244     gdb_test "gu (print (value-call fp2 (list 10 20)))" \
 245         "= 30"
 246
 247     # Incorrect to call an int value.
 248     gdb_test "p i" "= $decimal.*"
 249     gdb_scm_test_silent_cmd "gu (define i (history-ref 0))" \
 250         "inf call: get i value from history"
 251     gdb_test "gu (print (value-call i '()))" \
 252         "ERROR: .*: Wrong type argument in position 1 \\(expecting function \\(value of TYPE_CODE_FUNC\\)\\): .*"
 253
 254     # Incorrect number of arguments.
 255     gdb_test "p/x fp2" "= $hex.*"
 256     gdb_scm_test_silent_cmd "gu (define fp3 (history-ref 0))" \
 257         "get fp3 value from history"
 258     gdb_scm_test_silent_cmd "gu (set! fp3 (value-dereference fp3))" \
 259         "dereference fp3"
 260     gdb_test "gu (print (value-call fp3 (list 10)))" \
 261         "ERROR: Too few arguments in function call.*"
 262 }
 263
 264 proc test_value_after_death {} {
 265     # Construct a type while the inferior is still running.
 266     gdb_scm_test_silent_cmd "gu (define ptrtype (lookup-type \"PTR\"))" \
 267         "create PTR type"
 268
 269     # Kill the inferior and remove the symbols.
 270     gdb_test "kill" "" "kill the inferior" \
 271         "Kill the program being debugged. .y or n. $" \
 272         "y"
 273     gdb_test "file" "" "Discard the symbols" \
 274         "Discard symbol table from.*y or n. $" \
 275         "y"
 276
 277     # Now create a value using that type.  Relies on arg0, created by
 278     # test_value_in_inferior.
 279     gdb_scm_test_silent_cmd "gu (define castval (value-cast arg0 (type-pointer ptrtype)))" \
 280         "cast arg0 to PTR"
 281
 282     # Make sure the type is deleted.
 283     gdb_scm_test_silent_cmd "gu (set! ptrtype #f)" \
 284         "delete PTR type"
 285
 286     # Now see if the value's type is still valid.
 287     gdb_test "gu (print (value-type castval))" \
 288         "= PTR ." "print value's type"
 289 }
 290
 291 # Regression test for invalid subscript operations.  The bug was that
 292 # the type of the value was not being checked before allowing a
 293 # subscript operation to proceed.
 294
 295 proc test_subscript_regression {exefile lang} {
 296     # Start with a fresh gdb.
 297     clean_restart ${exefile}
 298
 299     if ![gdb_guile_runto_main ] {
 300         fail "Can't run to main"
 301         return
 302     }
 303
 304     if {$lang == "c++"} {
 305         gdb_breakpoint [gdb_get_line_number "break to inspect pointer by reference"]
 306         gdb_continue_to_breakpoint "break to inspect pointer by reference"
 307
 308         gdb_scm_test_silent_cmd "print rptr_int" \
 309             "Obtain address"
 310         gdb_scm_test_silent_cmd "gu (define rptr (history-ref 0))" \
 311             "set rptr"
 312         gdb_test "gu (print (value-subscript rptr 0))" \
 313             "= 2" "Check pointer passed as reference"
 314
 315         # Just the most basic test of dynamic_cast -- it is checked in
 316         # the C++ tests.
 317         gdb_test "gu (print (value->bool (value-dynamic-cast (parse-and-eval \"base\") (type-pointer (lookup-type \"Derived\")))))" \
 318             "= #t"
 319
 320         # Likewise.
 321         gdb_test "gu (print (value-dynamic-type (parse-and-eval \"base\")))" \
 322             "= Derived \[*\]"
 323         # A static type case.
 324         gdb_test "gu (print (value-dynamic-type (parse-and-eval \"5\")))" \
 325             "= int"
 326     }
 327
 328     gdb_breakpoint [gdb_get_line_number "break to inspect struct and union"]
 329     gdb_continue_to_breakpoint "break to inspect struct and union"
 330
 331     gdb_scm_test_silent_cmd "gu (define intv (make-value 1))" \
 332         "Create int value for subscript test"
 333     gdb_scm_test_silent_cmd "gu (define stringv (make-value \"foo\"))" \
 334         "Create string value for subscript test"
 335
 336     # Try to access an int with a subscript.  This should fail.
 337     gdb_test "gu (print intv)" \
 338         "= 1" "Baseline print of an int Guile value"
 339     gdb_test "gu (print (value-subscript intv 0))" \
 340         "ERROR: Cannot subscript requested type.*" \
 341         "Attempt to access an integer with a subscript"
 342
 343     # Try to access a string with a subscript.  This should pass.
 344     gdb_test "gu (print stringv)" \
 345         "= \"foo\"" "Baseline print of a string Guile value"
 346     gdb_test "gu (print (value-subscript stringv 0))" \
 347         "= 102 'f'" "Attempt to access a string with a subscript"
 348
 349     # Try to access an int array via a pointer with a subscript.
 350     # This should pass.
 351     gdb_scm_test_silent_cmd "print p" "Build pointer to array"
 352     gdb_scm_test_silent_cmd "gu (define pointer (history-ref 0))" "set pointer"
 353     gdb_test "gu (print (value-subscript pointer 0))" \
 354         "= 1" "Access array via pointer with int subscript"
 355     gdb_test "gu (print (value-subscript pointer intv))" \
 356         "= 2" "Access array via pointer with value subscript"
 357
 358     # Try to access a single dimension array with a subscript to the
 359     # result.  This should fail.
 360     gdb_test "gu (print (value-subscript (value-subscript pointer intv) 0))" \
 361         "ERROR: Cannot subscript requested type.*" \
 362         "Attempt to access an integer with a subscript 2"
 363
 364     # Lastly, test subscript access to an array with multiple
 365     # dimensions.  This should pass.
 366     gdb_scm_test_silent_cmd "print {\"fu \",\"foo\",\"bar\"}" "Build array"
 367     gdb_scm_test_silent_cmd "gu (define marray (history-ref 0))" ""
 368     gdb_test "gu (print (value-subscript (value-subscript marray 1) 2))" \
 369         "o." "Test multiple subscript"
 370 }
 371
 372 # A few tests of gdb:parse-and-eval.
 373
 374 proc test_parse_and_eval {} {
 375     gdb_test "gu (print (parse-and-eval \"23\"))" \
 376         "= 23" "parse-and-eval constant test"
 377     gdb_test "gu (print (parse-and-eval \"5 + 7\"))" \
 378         "= 12" "parse-and-eval simple expression test"
 379     gdb_test "gu (raw-print (parse-and-eval \"5 + 7\"))" \
 380         "#<gdb:value 12>" "parse-and-eval type test"
 381 }
 382
 383 # Test that values are hashable.
 384 # N.B.: While smobs are hashable, the hash is really non-existent,
 385 # they all get hashed to the same value.  Guile may provide a hash function
 386 # for smobs in a future release.  In the meantime one should use a custom
 387 # hash table that uses gdb:hash-gsmob.
 388
 389 proc test_value_hash {} {
 390     gdb_test_multiline "Simple Guile value dictionary" \
 391         "guile" "" \
 392         "(define one (make-value 1))" "" \
 393         "(define two (make-value 2))" "" \
 394         "(define three (make-value 3))" "" \
 395         "(define vdict (make-hash-table 5))" "" \
 396         "(hash-set! vdict one \"one str\")" "" \
 397         "(hash-set! vdict two \"two str\")" "" \
 398         "(hash-set! vdict three \"three str\")" "" \
 399         "end"
 400     gdb_test "gu (print (hash-ref vdict one))" \
 401         "one str" "Test dictionary hash 1"
 402     gdb_test "gu (print (hash-ref vdict two))" \
 403         "two str" "Test dictionary hash 2"
 404     gdb_test "gu (print (hash-ref vdict three))" \
 405         "three str" "Test dictionary hash 3"
 406 }
 407
 408 # Build C version of executable.  C++ is built later.
 409 if { [build_inferior "${binfile}" "c"] < 0 } {
 410     return
 411 }
 412
 413 # Start with a fresh gdb.
 414 clean_restart ${binfile}
 415
 416 # Skip all tests if Guile scripting is not enabled.
 417 if { [skip_guile_tests] } { continue }
 418
 419 gdb_install_guile_utils
 420 gdb_install_guile_module
 421
 422 test_parse_and_eval
 423 test_value_hash
 424
 425 # The following tests require execution.
 426
 427 if ![gdb_guile_runto_main] {
 428     fail "Can't run to main"
 429     return
 430 }
 431
 432 test_value_in_inferior
 433 test_inferior_function_call
 434 test_strings
 435 test_lazy_strings
 436 test_value_after_death
 437
 438 # Test either C or C++ values.
 439
 440 test_subscript_regression "${binfile}" "c"
 441
 442 if ![skip_cplus_tests] {
 443     if { [build_inferior "${binfile}-cxx" "c++"] < 0 } {
 444         return
 445     }
 446     with_test_prefix "c++" {
 447         test_subscript_regression "${binfile}-cxx" "c++"
 448     }
 449 }