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

   1 # Copyright (C) 2009-2022 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 "failed to compile in $lang mode"
  33       return -1
  34   }
  35
  36   return 0
  37 }
  38
  39 # Restart GDB.
  40 proc restart_gdb {exefile} {
  41   global srcdir subdir srcfile testfile hex
  42
  43   gdb_exit
  44   gdb_start
  45   gdb_reinitialize_dir $srcdir/$subdir
  46   gdb_load ${exefile}
  47
  48   if ![runto_main ] then {
  49       perror "couldn't run to breakpoint"
  50       return
  51   }
  52 }
  53
  54 # Set breakpoint and run to that breakpoint.
  55 proc runto_bp {bp} {
  56   gdb_breakpoint [gdb_get_line_number $bp]
  57   gdb_continue_to_breakpoint $bp
  58 }
  59
  60 proc test_fields {lang} {
  61   with_test_prefix "test_fields" {
  62     global gdb_prompt
  63
  64     # .fields() of a typedef should still return the underlying field list
  65     gdb_test "python print (len(gdb.parse_and_eval('ts').type.fields()))" "2" \
  66         "$lang typedef field list"
  67
  68     if {$lang == "c++"} {
  69       # Test usage with a class
  70       gdb_py_test_silent_cmd "print (c)" "print value (c)" 1
  71       gdb_py_test_silent_cmd "python c = gdb.history (0)" "get value (c) from history" 1
  72       gdb_py_test_silent_cmd "python fields = c.type.fields()" "get fields from c.type" 1
  73       gdb_test "python print (len(fields))" "2" "check number of fields (c)"
  74       gdb_test "python print (fields\[0\].name)" "c" "check class field c name"
  75       gdb_test "python print (fields\[1\].name)" "d" "check class field d name"
  76
  77       gdb_test "python print (c.type == gdb.parse_and_eval('d').type)" "False"
  78       gdb_test "python print (c.type == gdb.parse_and_eval('d').type.fields()\[0\].type)" \
  79           "True"
  80
  81       # Test fields of a method (its parameters)
  82       gdb_test "python print (len (gdb.parse_and_eval ('C::a_method').type.fields ()))" "3"
  83       gdb_test "python print (gdb.parse_and_eval ('C::a_method').type.fields ()\[0\].type)" "C \\* const"
  84       gdb_test "python print (gdb.parse_and_eval ('C::a_method').type.fields ()\[1\].type)" "int"
  85       gdb_test "python print (gdb.parse_and_eval ('C::a_method').type.fields ()\[2\].type)" "char"
  86       gdb_test "python print (gdb.parse_and_eval ('c')\['a_method'\].type.fields ()\[0\].type)" "C \\* const"
  87
  88       gdb_test "python print (len (gdb.parse_and_eval ('C::a_const_method').type.fields ()))" "3"
  89       gdb_test "python print (gdb.parse_and_eval ('C::a_const_method').type.fields ()\[0\].type)" "const C \\* const"
  90       gdb_test "python print (gdb.parse_and_eval ('C::a_const_method').type.fields ()\[1\].type)" "int"
  91       gdb_test "python print (gdb.parse_and_eval ('C::a_const_method').type.fields ()\[2\].type)" "char"
  92       gdb_test "python print (gdb.parse_and_eval ('c')\['a_const_method'\].type.fields ()\[0\].type)" "const C \\* const"
  93
  94       gdb_test "python print (len (gdb.parse_and_eval ('C::a_static_method').type.fields ()))" "2"
  95       gdb_test "python print (gdb.parse_and_eval ('C::a_static_method').type.fields ()\[0\].type)" "int"
  96       gdb_test "python print (gdb.parse_and_eval ('C::a_static_method').type.fields ()\[1\].type)" "char"
  97       gdb_test "python print (gdb.parse_and_eval ('c')\['a_static_method'\].type.fields ()\[0\].type)" "int"
  98     }
  99
 100     # Test normal fields usage in structs.
 101     gdb_py_test_silent_cmd "print (st)" "print value (st)" 1
 102     gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value (st) from history" 1
 103     gdb_py_test_silent_cmd "python fields = st.type.fields()" "get fields from st.type" 1
 104     gdb_test "python print (st.type.objfile.filename == gdb.current_progspace ().filename)" "True" \
 105       "check type.objfile"
 106     gdb_test "python print (len(fields))" "2" "check number of fields (st)"
 107     gdb_test "python print (fields\[0\].name)" "a" "check structure field a name"
 108     gdb_test "python print (fields\[1\].name)" "b" "check structure field b name"
 109
 110     # Test that unamed fields have 'None' for name.
 111     gdb_py_test_silent_cmd "python ss = gdb.parse_and_eval('ss')" "init ss" 1
 112     gdb_py_test_silent_cmd "python ss_fields = ss.type.fields()" \
 113       "get fields from ss.type" 1
 114     gdb_test "python print(len(ss_fields))" "2" "check length of ss_fields"
 115     gdb_test "python print(ss_fields\[0\].name is None)" "True" \
 116       "Check ss_fields\[0\].name"
 117     gdb_test "python print(ss_fields\[1\].name is None)" "True" \
 118       "Check ss_fields\[1\].name"
 119     # Regression test for
 120     # http://sourceware.org/bugzilla/show_bug.cgi?id=12070.
 121     gdb_test "python print ('type' in dir(fields\[0\]))" "True" \
 122       "Check that dir includes name"
 123
 124     # Test Python mapping behavior of gdb.Type for structs/classes
 125     gdb_test "python print (len(st.type))" "2" "check number of fields (st.type)"
 126     gdb_test "python print (st.type\['a'\].name)" "a" "check fields lookup by name"
 127     gdb_test "python print (\[v.bitpos for v in st.type.itervalues()\])" {\[0L?, 32L?\]} "Check fields iteration over values"
 128     gdb_test "python print (\[(n, v.bitpos) for (n, v) in st.type.items()\])" {\[\('a', 0L?\), \('b', 32L?\)\]} "Check fields items list"
 129     gdb_test "python print ('a' in st.type)" "True" "check field name exists test"
 130     gdb_test "python print ('nosuch' in st.type)" "False" "check field name nonexists test"
 131     gdb_test "python print (not not st.type)" "True" "check conversion to bool"
 132
 133     # Test rejection of mapping operations on scalar types
 134     gdb_test "python print (len (st.type\['a'\].type))" "TypeError: Type is not a structure, union, enum, or function type.*"
 135     gdb_test "python print (st.type\['a'\].type.has_key ('x'))" "TypeError: Type is not a structure, union, enum, or function type.*"
 136     gdb_test "python print (st.type\['a'\].type\['x'\])" "TypeError: Type is not a structure, union, enum, or function type.*"
 137     gdb_test "python print (st.type\['a'\].type.keys ())" "TypeError: Type is not a structure, union, enum, or function type.*"
 138
 139     # Test conversion to bool on scalar types
 140     gdb_test "python print (not not st.type\['a'\].type)" "True"
 141
 142     # Test regression PR python/10805
 143     gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 144     gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 145     gdb_test "python fields = ar.type.fields()"
 146     gdb_test "python print (len(fields))" "1" "check the number of fields"
 147     gdb_test "python print (fields\[0\].type)" "<range type>" "check array field type"
 148
 149     # Test gdb.Type.array.
 150     gdb_test "python print (ar\[0\].cast(ar\[0\].type.array(1)))" \
 151         ".1, 2." "cast to array with one argument"
 152     gdb_test "python print (ar\[0\].cast(ar\[0\].type.array(0, 1)))" \
 153         ".1, 2." "cast to array with two arguments"
 154
 155     gdb_test "python print (ar\[0\].type == ar\[0\].type)" "True"
 156
 157     # Test gdb.Type.vector.
 158     # Note: vectors cast differently than arrays.  Here ar[0] is replicated
 159     # for the size of the vector.
 160     gdb_py_test_silent_cmd "print (vec_data_1)" "print value (vec_data_1)" 1
 161     gdb_py_test_silent_cmd "python vec_data_1 = gdb.history (0)" "get value (vec_data_1) from history" 1
 162
 163     gdb_py_test_silent_cmd "print (vec_data_2)" "print value (vec_data_2)" 1
 164     gdb_py_test_silent_cmd "python vec_data_2 = gdb.history (0)" "get value (vec_data_2) from history" 1
 165
 166     gdb_py_test_silent_cmd "python vec1 = vec_data_1.cast(ar\[0\].type.vector(1))" "set vec1" 1
 167     gdb_test "python print (vec1)" ".1, 1." "cast to vector with one argument"
 168     gdb_py_test_silent_cmd "python vec2 = vec_data_1.cast(ar\[0\].type.vector(0, 1))" "set vec2" 1
 169     gdb_test "python print (vec2)" ".1, 1." "cast to vector with two arguments"
 170     gdb_test "python print (vec1 == vec2)" "True"
 171     gdb_py_test_silent_cmd "python vec3 = vec_data_2.cast(ar\[0\].type.vector(1))" "set vec3" 1
 172     gdb_test "python print (vec1 == vec3)" "False"
 173
 174     # Test fields of a function (its parameters)
 175     gdb_test "python print (len (gdb.parse_and_eval ('a_function').type.fields ()))" "2"
 176     gdb_test "python print (gdb.parse_and_eval ('a_function').type.fields ()\[0\].type)" "int"
 177     gdb_test "python print (gdb.parse_and_eval ('a_function').type.fields ()\[1\].type)" "char"
 178
 179     # Test calling `fields` on a non-aggregate type.
 180     gdb_test "python gdb.lookup_type('int').fields()" "TypeError: Type is not a structure, union, enum, or function type.*"
 181   }
 182 }
 183
 184 proc test_enums {} {
 185   with_test_prefix "test_enum" {
 186     gdb_py_test_silent_cmd "print (e)" "print value (e)" 1
 187     gdb_py_test_silent_cmd "python (e) = gdb.history (0)" "get value (e) from history" 1
 188     gdb_py_test_silent_cmd "python fields = e.type.fields()" "extract type fields from e" 1
 189     gdb_test "python print (len(fields))" "3" "check the number of enum fields"
 190     gdb_test "python print (fields\[0\].name)" "v1" "check enum field\[0\] name"
 191     gdb_test "python print (fields\[1\].name)" "v2" "check enum field\[1\]name"
 192
 193     # Ditto but by mapping operations
 194     gdb_test "python print (len(e.type))" "3" "check the number of type fields"
 195     gdb_test "python print (e.type\['v1'\].name)" "v1" "check enum field lookup by name (v1)"
 196     gdb_test "python print (e.type\['v3'\].name)" "v3" "check enum field lookup by name (v3)"
 197     gdb_test "python print (\[v.enumval for v in e.type.itervalues()\])" {\[0L?, 1L?, 2L?\]} "Check num fields iteration over values"
 198     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"
 199   }
 200 }
 201
 202 proc test_base_class {} {
 203   with_test_prefix "test_base_class" {
 204     gdb_py_test_silent_cmd "print (d)" "print value (d)" 1
 205     gdb_py_test_silent_cmd "python d = gdb.history (0)" "get value (d) from history" 1
 206     gdb_py_test_silent_cmd "python fields = d.type.fields()" "extract type fields from d" 1
 207     gdb_test "python print (len(fields))" "3" "check the number of fields"
 208     gdb_test "python print (fields\[0\].is_base_class)" "True" "check base class (fields\[0\])"
 209     gdb_test "python print (fields\[1\].is_base_class)" "False" "check base class (fields\[1\])"
 210   }
 211 }
 212
 213 proc test_range {} {
 214   with_test_prefix "test_range" {
 215     with_test_prefix "on ranged value" {
 216       # Test a valid range request.
 217       gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 218       gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 219       gdb_test "python print (len(ar.type.range()))" "2" "check correct tuple length"
 220       gdb_test "python print (ar.type.range()\[0\])" "0" "check range low bound"
 221       gdb_test "python print (ar.type.range()\[1\])" "1" "check range high bound"
 222     }
 223
 224     with_test_prefix "on ranged type" {
 225       # Test a range request on a ranged type.
 226       gdb_py_test_silent_cmd "print (ar)" "print value (ar)" 1
 227       gdb_py_test_silent_cmd "python ar = gdb.history (0)" "get value (ar) from history" 1
 228       gdb_py_test_silent_cmd "python fields = ar.type.fields()" "get fields" 1
 229       gdb_test "python print (fields\[0\].type.range()\[0\])" "0" "check range low bound"
 230       gdb_test "python print (fields\[0\].type.range()\[1\])" "1" "check range high bound"
 231     }
 232
 233     with_test_prefix "on unranged value" {
 234       # Test where a range does not exist.
 235       gdb_py_test_silent_cmd "print (st)" "print value (st)" 1
 236       gdb_py_test_silent_cmd "python st = gdb.history (0)" "get value (st) from history" 1
 237       gdb_test "python print (st.type.range())" "RuntimeError: This type does not have a range.*" "check range for non ranged type."
 238     }
 239   }
 240 }
 241
 242 # Some tests of template arguments.
 243 proc test_template {} {
 244     gdb_py_test_silent_cmd \
 245         "python ttype = gdb.parse_and_eval('temvar').type" \
 246         "get type of temvar" \
 247         1
 248
 249     gdb_test "python print (ttype.template_argument(0))" "D"
 250     gdb_test "python print (isinstance(ttype.template_argument(0), gdb.Type))" \
 251         "True"
 252
 253     # The next two tests require a GCC that emits DW_TAG_template_*.
 254     # GCC 4.4 does not emit it, 4.5 and 6 do emit it.
 255     set have_older_gcc 0
 256     if {[test_compiler_info {gcc-[0-3]-*}]
 257         || [test_compiler_info {gcc-4-[0-4]-*}]} {
 258         set have_older_gcc 1
 259     }
 260     if $have_older_gcc { setup_xfail *-*-* }
 261     gdb_test "python print (ttype.template_argument(1))" "23"
 262     if $have_older_gcc { setup_xfail *-*-* }
 263     gdb_test "python print (isinstance(ttype.template_argument(1), gdb.Value))" \
 264         "True"
 265
 266     if {[test_compiler_info {gcc-[0-3]-*}]
 267         || [test_compiler_info {gcc-4-[0-5]-*}]} {
 268         setup_xfail "gcc/46955" *-*-*
 269     }
 270     gdb_test "python print (ttype.template_argument(2))" "&C::c"
 271 }
 272
 273 # Check the is_signed property of some types.
 274 proc test_is_signed {lang} {
 275     if {$lang == "c++"} {
 276         gdb_test "python print(gdb.parse_and_eval ('c').type.is_signed)"  \
 277         "ValueError: Type must be a scalar type.*"
 278         gdb_test "python print(gdb.parse_and_eval ('&c').type.is_signed == False)" "True"
 279     }
 280
 281     gdb_test "python print(gdb.parse_and_eval('global_unsigned_char').type.is_signed == False)" "True"
 282     gdb_test "python print(gdb.parse_and_eval('global_char').type.is_signed)" "True|False"
 283     gdb_test "python print(gdb.parse_and_eval('global_signed_char').type.is_signed == True)" "True"
 284
 285     gdb_test "python print(gdb.parse_and_eval ('ss.x').type.is_signed == True)" "True"
 286     gdb_test "python print(gdb.parse_and_eval ('ss').type.is_signed)" \
 287         "ValueError: Type must be a scalar type.*"
 288     gdb_test "python print(gdb.parse_and_eval ('uu').type.is_signed)"  \
 289         "ValueError: Type must be a scalar type.*"
 290     gdb_test "python print(gdb.parse_and_eval ('uu.i').type.is_signed == True)" "True"
 291     gdb_test "python print(gdb.parse_and_eval ('uu.f').type.is_signed == True)" "True"
 292     gdb_test "python print(gdb.parse_and_eval ('uu.a').type.is_signed)"  \
 293         "ValueError: Type must be a scalar type.*"
 294
 295     gdb_test "python print(gdb.parse_and_eval ('&ss.x').type.is_signed == False)" "True"
 296     gdb_test "python print(gdb.parse_and_eval ('&uu').type.is_signed == False)" "True"
 297 }
 298
 299 # Compare the types of different symbols from the inferior, we're
 300 # checking that the types of different sybols of the same declared
 301 # type, are equal (in Python).
 302 proc test_type_equality {} {
 303
 304     foreach_with_prefix type { char int } {
 305         gdb_test_no_output "python v1 = gdb.parse_and_eval('global_unsigned_${type}')"
 306         gdb_test_no_output "python v2 = gdb.parse_and_eval('global_${type}')"
 307         gdb_test_no_output "python v3 = gdb.parse_and_eval('global_signed_${type}')"
 308
 309         gdb_test_no_output "python t1 = v1.type"
 310         gdb_test_no_output "python t2 = v2.type"
 311         gdb_test_no_output "python t3 = v3.type"
 312
 313         if { $type == "char" } {
 314             # In C/C++ there's an interesting property of 'char' based types;
 315             # 'signed char', 'unsigned char', and 'char' are all distinct
 316             # types.  Weird, right?  Here we check that this property is
 317             # visible to Python code.
 318             gdb_test "python print(t1 != t2)" "True"
 319             gdb_test "python print(t1 != t3)" "True"
 320             gdb_test "python print(t2 != t3)" "True"
 321         } else {
 322             # For 'int' type, when neither signed or unsigned is given
 323             # we expect the type to be signed by default.
 324             gdb_test "python print(t1 != t2)" "True"
 325             gdb_test "python print(t1 != t3)" "True"
 326             gdb_test "python print(t2 == t3)" "True"
 327         }
 328     }
 329 }
 330
 331 # Test the gdb.Type.is_scalar property.
 332 proc test_is_scalar { lang } {
 333     if {$lang == "c++"} {
 334         gdb_test "python print(gdb.parse_and_eval ('c').type.is_scalar)" "False"
 335         gdb_test "python print(gdb.parse_and_eval ('&c').type.is_scalar)" "True"
 336     }
 337
 338     foreach type { char int } {
 339         gdb_test "python print(gdb.parse_and_eval('global_unsigned_${type}').type.is_scalar)" "True"
 340         gdb_test "python print(gdb.parse_and_eval('global_${type}').type.is_scalar)" "True"
 341         gdb_test "python print(gdb.parse_and_eval('global_signed_${type}').type.is_scalar)" "True"
 342     }
 343
 344     gdb_test "python print(gdb.parse_and_eval ('ss.x').type.is_scalar)" "True"
 345     gdb_test "python print(gdb.parse_and_eval ('ss').type.is_scalar)" "False"
 346     gdb_test "python print(gdb.parse_and_eval ('uu').type.is_scalar)" "False"
 347
 348     gdb_test "python print(gdb.parse_and_eval ('uu.i').type.is_scalar)" "True"
 349     gdb_test "python print(gdb.parse_and_eval ('uu.f').type.is_scalar)" "True"
 350     gdb_test "python print(gdb.parse_and_eval ('uu.a').type.is_scalar)"  "False"
 351     gdb_test "python print(gdb.parse_and_eval ('&ss.x').type.is_scalar)" "True"
 352 }
 353
 354 # Perform C Tests.
 355 if { [build_inferior "${binfile}" "c"] == 0 } {
 356   restart_gdb "${binfile}"
 357
 358   # Skip all tests if Python scripting is not enabled.
 359   if { [skip_python_tests] } { continue }
 360
 361   gdb_test "python print (gdb.lookup_type ('char').objfile)" "None"
 362
 363   gdb_test "python print(gdb.lookup_type('char').array(1, 0))" \
 364       "char \\\[0\\\]"
 365
 366   gdb_test "python print(gdb.lookup_type('char').array(1, -1))" \
 367       "Array length must not be negative.*"
 368
 369   gdb_test "python print(gdb.lookup_type('int').optimized_out())" \
 370       "<optimized out>"
 371
 372   set sint [get_sizeof int 0]
 373   gdb_test "python print(gdb.parse_and_eval('aligncheck').type.alignof)" \
 374       $sint
 375
 376   with_test_prefix "lang_c" {
 377       runto_bp "break to inspect struct and array."
 378       test_fields "c"
 379       test_enums
 380       test_is_scalar "c"
 381       test_is_signed "c"
 382       test_type_equality
 383   }
 384 }
 385
 386 # Perform C++ Tests.
 387 if { [build_inferior "${binfile}-cxx" "c++"] == 0 } {
 388   restart_gdb "${binfile}-cxx"
 389   with_test_prefix "lang_cpp" {
 390       runto_bp "break to inspect struct and array."
 391       test_fields "c++"
 392       test_base_class
 393       test_range
 394       test_template
 395       test_enums
 396       test_is_scalar "c++"
 397       test_is_signed "c++"
 398       test_type_equality
 399   }
 400 }