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

   1 # Copyright (C) 2009-2015 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 # of exposing types to Python.
  18
  19 load_lib gdb-python.exp
  20
  21 standard_testfile
  22
  23 if [get_compiler_info c++] {
  24     return -1
  25 }
  26
  27 # Build inferior to language specification.
  28 proc build_inferior {exefile lang} {
  29   global srcdir subdir srcfile testfile hex
  30
  31   if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${exefile}" executable "debug $lang"] != "" } {
  32       untested "Couldn't compile ${srcfile} in $lang mode"
  33       return -1
  34   }
  35 }
  36
  37 # Restart GDB.
  38 proc restart_gdb {exefile} {
  39   global srcdir subdir srcfile testfile hex
  40
  41   gdb_exit
  42   gdb_start
  43   gdb_reinitialize_dir $srcdir/$subdir
  44   gdb_load ${exefile}
  45
  46   if ![runto_main ] then {
  47       perror "couldn't run to breakpoint"
  48       return
  49   }
  50 }
  51
  52 # Set breakpoint and run to that breakpoint.
  53 proc runto_bp {bp} {
  54   gdb_breakpoint [gdb_get_line_number $bp]
  55   gdb_continue_to_breakpoint $bp
  56 }
  57
  58 proc test_fields {lang} {
  59   with_test_prefix "test_fields" {
  60     global gdb_prompt
  61
  62     # .fields() of a typedef should still return the underlying field list
  63     gdb_test "python print (len(gdb.parse_and_eval('ts').type.fields()))" "2" \
  64         "$lang typedef field list"
  65
  66     if {$lang == "c++"} {
  67       # Test usage with a class
  68       gdb_py_test_silent_cmd "print (c)" "print value (c)" 1
  69       gdb_py_test_silent_cmd "python c = gdb.history (0)" "get value (c) from history" 1
  70       gdb_py_test_silent_cmd "python fields = c.type.fields()" "get fields from c.type" 1
  71       gdb_test "python print (len(fields))" "2" "Check number of fields (c)"
  72       gdb_test "python print (fields\[0\].name)" "c" "Check class field c name"
  73       gdb_test "python print (fields\[1\].name)" "d" "Check class field d name"
  74
  75       gdb_test "python print (c.type == gdb.parse_and_eval('d').type)" "False"
  76       gdb_test "python print (c.type == gdb.parse_and_eval('d').type.fields()\[0\].type)" \
  77           "True"
  78     }
  79
  80     # Test normal fields usage in structs.
  81     gdb_py_test_silent_cmd "print (st)" "print value (st)" 1
  82     gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value (st) from history" 1
  83     gdb_py_test_silent_cmd "python fields = st.type.fields()" "get fields from st.type" 1
  84     gdb_test "python print (len(fields))" "2" "Check number of fields (st)"
  85     gdb_test "python print (fields\[0\].name)" "a" "Check structure field a name"
  86     gdb_test "python print (fields\[1\].name)" "b" "Check structure field b name"
  87
  88     # Test that unamed fields have 'None' for name.
  89     gdb_py_test_silent_cmd "python ss = gdb.parse_and_eval('ss')" "init ss" 1
  90     gdb_py_test_silent_cmd "python ss_fields = ss.type.fields()" \
  91       "get fields from ss.type" 1
  92     gdb_test "python print(len(ss_fields))" "2" "Check length of ss_fields"
  93     gdb_test "python print(ss_fields\[0\].name is None)" "True" \
  94       "Check ss_fields\[0\].name"
  95     gdb_test "python print(ss_fields\[1\].name is None)" "True" \
  96       "Check ss_fields\[1\].name"
  97     # Regression test for
  98     # http://sourceware.org/bugzilla/show_bug.cgi?id=12070.
  99     gdb_test "python print ('type' in dir(fields\[0\]))" "True" \
 100       "Check that dir includes name"
 101
 102     # Test Python mapping behavior of gdb.Type for structs/classes
 103     gdb_test "python print (len(st.type))" "2" "Check number of fields (st.type)"
 104     gdb_test "python print (st.type\['a'\].name)" "a" "Check fields lookup by name"
 105     gdb_test "python print (\[v.bitpos for v in st.type.itervalues()\])" {\[0L?, 32L?\]} "Check fields iteration over values"
 106     gdb_test "python print (\[(n, v.bitpos) for (n, v) in st.type.items()\])" {\[\('a', 0L?\), \('b', 32L?\)\]} "Check fields items list"
 107     gdb_test "python print ('a' in st.type)" "True" "Check field name exists test"
 108     gdb_test "python print ('nosuch' in st.type)" "False" "Check field name nonexists test"
 109     gdb_test "python print (not not st.type)" "True" "Check conversion to bool"
 110
 111     # Test rejection of mapping operations on scalar types
 112     gdb_test "python print (len (st.type\['a'\].type))" "TypeError: Type is not a structure, union, or enum type.*"
 113     gdb_test "python print (st.type\['a'\].type.has_key ('x'))" "TypeError: Type is not a structure, union, or enum type.*"
 114     gdb_test "python print (st.type\['a'\].type.keys ())" "TypeError: Type is not a structure, union, or enum type.*"
 115     gdb_test "python print (st.type\['a'\].type\['x'\])" "TypeError: Type is not a structure, union, or enum type.*"
 116
 117     # Test conversion to bool on scalar types
 118     gdb_test "python print (not not st.type\['a'\].type)" "True"
 119
 120     # Test regression PR python/10805
 121     gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 122     gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 123     gdb_test "python fields = ar.type.fields()"
 124     gdb_test "python print (len(fields))" "1" "Check the number of fields"
 125     gdb_test "python print (fields\[0\].type)" "<range type>" "Check array field type"
 126
 127     # Test gdb.Type.array.
 128     gdb_test "python print (ar\[0\].cast(ar\[0\].type.array(1)))" \
 129         ".1, 2." "cast to array with one argument"
 130     gdb_test "python print (ar\[0\].cast(ar\[0\].type.array(0, 1)))" \
 131         ".1, 2." "cast to array with two arguments"
 132
 133     gdb_test "python print (ar\[0\].type == ar\[0\].type)" "True"
 134
 135     # Test gdb.Type.vector.
 136     # Note: vectors cast differently than arrays.  Here ar[0] is replicated
 137     # for the size of the vector.
 138     gdb_py_test_silent_cmd "print (vec_data_1)" "print value (vec_data_1)" 1
 139     gdb_py_test_silent_cmd "python vec_data_1 = gdb.history (0)" "get value (vec_data_1) from history" 1
 140
 141     gdb_py_test_silent_cmd "print (vec_data_2)" "print value (vec_data_2)" 1
 142     gdb_py_test_silent_cmd "python vec_data_2 = gdb.history (0)" "get value (vec_data_2) from history" 1
 143
 144     gdb_py_test_silent_cmd "python vec1 = vec_data_1.cast(ar\[0\].type.vector(1))" "set vec1" 1
 145     gdb_test "python print (vec1)" ".1, 1." "cast to vector with one argument"
 146     gdb_py_test_silent_cmd "python vec2 = vec_data_1.cast(ar\[0\].type.vector(0, 1))" "set vec2" 1
 147     gdb_test "python print (vec2)" ".1, 1." "cast to vector with two arguments"
 148     gdb_test "python print (vec1 == vec2)" "True"
 149     gdb_py_test_silent_cmd "python vec3 = vec_data_2.cast(ar\[0\].type.vector(1))" "set vec3" 1
 150     gdb_test "python print (vec1 == vec3)" "False"
 151   }
 152 }
 153
 154 proc test_enums {} {
 155   with_test_prefix "test_enum" {
 156     gdb_py_test_silent_cmd "print (e)" "print value (e)" 1
 157     gdb_py_test_silent_cmd "python (e) = gdb.history (0)" "get value (e) from history" 1
 158     gdb_py_test_silent_cmd "python fields = e.type.fields()" "extract type fields from e" 1
 159     gdb_test "python print (len(fields))" "3" "Check the number of enum fields"
 160     gdb_test "python print (fields\[0\].name)" "v1" "Check enum field\[0\] name"
 161     gdb_test "python print (fields\[1\].name)" "v2" "Check enum field\[1\]name"
 162
 163     # Ditto but by mapping operations
 164     gdb_test "python print (len(e.type))" "3" "Check the number of type fields"
 165     gdb_test "python print (e.type\['v1'\].name)" "v1" "Check enum field lookup by name (v1)"
 166     gdb_test "python print (e.type\['v3'\].name)" "v3" "Check enum field lookup by name (v3)"
 167     gdb_test "python print (\[v.enumval for v in e.type.itervalues()\])" {\[0L?, 1L?, 2L?\]} "Check num fields iteration over values"
 168     gdb_test "python print (\[(n, v.enumval) for (n, v) in e.type.items()\])" {\[\('v1', 0L?\), \('v2', 1L?\), \('v3', 2L?\)\]} "Check enum fields items list"
 169   }
 170 }
 171
 172 proc test_base_class {} {
 173   with_test_prefix "test_base_class" {
 174     gdb_py_test_silent_cmd "print (d)" "print value (d)" 1
 175     gdb_py_test_silent_cmd "python d = gdb.history (0)" "get value (d) from history" 1
 176     gdb_py_test_silent_cmd "python fields = d.type.fields()" "extract type fields from d" 1
 177     gdb_test "python print (len(fields))" "3" "Check the number of fields"
 178     gdb_test "python print (fields\[0\].is_base_class)" "True" "Check base class (fields\[0\])"
 179     gdb_test "python print (fields\[1\].is_base_class)" "False" "Check base class (fields\[1\])"
 180   }
 181 }
 182
 183 proc test_range {} {
 184   with_test_prefix "test_range" {
 185     with_test_prefix "on ranged value" {
 186       # Test a valid range request.
 187       gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 188       gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 189       gdb_test "python print (len(ar.type.range()))" "2" "Check correct tuple length"
 190       gdb_test "python print (ar.type.range()\[0\])" "0" "Check range low bound"
 191       gdb_test "python print (ar.type.range()\[1\])" "1" "Check range high bound"
 192     }
 193
 194     with_test_prefix "on ranged type" {
 195       # Test a range request on a ranged type.
 196       gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 197       gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 198       gdb_py_test_silent_cmd "python fields = ar.type.fields()" "get fields" 1
 199       gdb_test "python print (fields\[0\].type.range()\[0\])" "0" "Check range low bound"
 200       gdb_test "python print (fields\[0\].type.range()\[1\])" "1" "Check range high bound"
 201     }
 202
 203     with_test_prefix "on unranged value" {
 204       # Test where a range does not exist.
 205       gdb_py_test_silent_cmd "print (st)" "print value (st)" 1
 206       gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value (st) from history" 1
 207       gdb_test "python print (st.type.range())" "RuntimeError: This type does not have a range.*" "Check range for non ranged type."
 208     }
 209   }
 210 }
 211
 212 # Some tests of template arguments.
 213 proc test_template {} {
 214     gdb_py_test_silent_cmd \
 215         "python ttype = gdb.parse_and_eval('temvar').type" \
 216         "get type of temvar" \
 217         1
 218
 219     gdb_test "python print (ttype.template_argument(0))" "D"
 220     gdb_test "python print (isinstance(ttype.template_argument(0), gdb.Type))" \
 221         "True"
 222
 223     # The next two tests require a GCC that emits DW_TAG_template_*.
 224     # GCC 4.4 does not emit it, 4.5 and 6 do emit it.
 225     set have_older_gcc 0
 226     if {[test_compiler_info {gcc-[0-3]-*}]
 227         || [test_compiler_info {gcc-4-[0-4]-*}]} {
 228         set have_older_gcc 1
 229     }
 230     if $have_older_gcc { setup_xfail *-*-* }
 231     gdb_test "python print (ttype.template_argument(1))" "23"
 232     if $have_older_gcc { setup_xfail *-*-* }
 233     gdb_test "python print (isinstance(ttype.template_argument(1), gdb.Value))" \
 234         "True"
 235
 236     if {[test_compiler_info {gcc-[0-3]-*}]
 237         || [test_compiler_info {gcc-4-[0-5]-*}]} {
 238         setup_xfail "gcc/46955" *-*-*
 239     }
 240     gdb_test "python print (ttype.template_argument(2))" "&C::c"
 241 }
 242
 243 # Perform C Tests.
 244 build_inferior "${binfile}" "c"
 245 restart_gdb "${binfile}"
 246
 247 # Skip all tests if Python scripting is not enabled.
 248 if { [skip_python_tests] } { continue }
 249
 250 gdb_test "python print(gdb.lookup_type('char').array(1, 0))" \
 251     "char \\\[0\\\]"
 252
 253 gdb_test "python print(gdb.lookup_type('char').array(1, -1))" \
 254     "Array length must not be negative.*"
 255
 256 gdb_test "python print(gdb.lookup_type('int').optimized_out())" \
 257     "<optimized out>"
 258
 259 with_test_prefix "lang_c" {
 260     runto_bp "break to inspect struct and array."
 261     test_fields "c"
 262     test_enums
 263 }
 264
 265 # Perform C++ Tests.
 266 build_inferior "${binfile}-cxx" "c++"
 267 restart_gdb "${binfile}-cxx"
 268 with_test_prefix "lang_cpp" {
 269     runto_bp "break to inspect struct and array."
 270     test_fields "c++"
 271     test_base_class
 272     test_range
 273     test_template
 274     test_enums
 275 }