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

   1 # Copyright (C) 2010-2023 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 load_lib gdb-python.exp
  20
  21 require allow_python_tests
  22
  23 standard_testfile py-symbol.c py-symbol-2.c
  24
  25 set opts { debug additional_flags=-DUSE_TWO_FILES }
  26 if {[prepare_for_testing "failed to prepare" $testfile \
  27          [list $srcfile $srcfile2] $opts]} {
  28     return -1
  29 }
  30
  31 set readnow_p [readnow]
  32
  33 # Check that we find all static symbols before the inferior has
  34 # started, at which point some of the symtabs might not have been
  35 # expanded.
  36 gdb_test "python print (len (gdb.lookup_static_symbols ('rr')))" \
  37     "2" "print (len (gdb.lookup_static_symbols ('rr')))"
  38
  39 # Restart so we don't have expanded symtabs after the previous test.
  40 clean_restart ${binfile}
  41
  42 # Test looking up a global symbol before we runto_main as this is the
  43 # point where we don't have a current frame, and we don't want to
  44 # require one.
  45 gdb_py_test_silent_cmd "python main_func = gdb.lookup_global_symbol(\"main\")" "Lookup main" 1
  46 gdb_test "python print (repr (main_func))" "<gdb.Symbol print_name=main>" \
  47     "test main_func.__repr__"
  48 gdb_test "python print (main_func.is_function)" "True" "test main_func.is_function"
  49 gdb_test "python print (gdb.lookup_global_symbol(\"junk\"))" "None" "test lookup_global_symbol(\"junk\")"
  50
  51 gdb_test "python print (gdb.lookup_global_symbol('main').value())" "$hex .main." \
  52     "print value of main"
  53
  54 set qq_line [gdb_get_line_number "line of qq"]
  55 gdb_test "python print (gdb.lookup_global_symbol('qq').line)" "$qq_line" \
  56     "print line number of qq"
  57
  58 gdb_test "python print (gdb.lookup_global_symbol('qq').value())" "72" \
  59     "print value of qq"
  60
  61 gdb_test "python print (gdb.lookup_global_symbol('qq').needs_frame)" \
  62     "False" \
  63     "print whether qq needs a frame"
  64
  65 # Similarly, test looking up a static symbol before we runto_main.
  66 set rr_line [gdb_get_line_number "line of rr"]
  67 set rr_line_alt [gdb_get_line_number "line of other rr" py-symbol-2.c]
  68 gdb_test "python print (gdb.lookup_global_symbol ('rr') is None)" "True" \
  69     "lookup_global_symbol for static var"
  70
  71 set cmd "python print (gdb.lookup_static_symbol ('rr').line)"
  72 gdb_test_multiple $cmd "print line number of rr" {
  73     -re -wrap "$rr_line" {
  74         pass $gdb_test_name
  75     }
  76     -re -wrap "$rr_line_alt" {
  77         if { $readnow_p } {
  78             setup_kfail "symtab/25857" *-*-*
  79         }
  80         fail $gdb_test_name
  81     }
  82 }
  83
  84 set cmd "python print (gdb.lookup_static_symbol ('rr').value ())"
  85 gdb_test_multiple $cmd "print value of rr" {
  86     -re -wrap "42" {
  87         pass $gdb_test_name
  88     }
  89     -re -wrap "99" {
  90         if { $readnow_p } {
  91             setup_kfail "symtab/25857" *-*-*
  92         }
  93         fail $gdb_test_name
  94     }
  95 }
  96
  97
  98 gdb_test "python print (gdb.lookup_static_symbol ('rr').needs_frame)" \
  99     "False" \
 100     "print whether rr needs a frame"
 101
 102 gdb_test "python print (gdb.lookup_static_symbol ('nonexistent') is None)" \
 103     "True" "lookup_static_symbol for nonexistent var"
 104
 105 gdb_test "python print (gdb.lookup_static_symbol ('qq') is None)" \
 106     "True" "lookup_static_symbol for global var"
 107
 108 if {![runto_main]} {
 109     return 0
 110 }
 111
 112 global hex decimal
 113
 114 gdb_breakpoint [gdb_get_line_number "Block break here."]
 115 gdb_continue_to_breakpoint "Block break here."
 116 gdb_py_test_silent_cmd "python frame = gdb.selected_frame()" "Get Frame" 0
 117 gdb_py_test_silent_cmd "python block = frame.block()" "Get block" 0
 118
 119 # Test is_argument attribute.
 120 gdb_py_test_silent_cmd "python arg = gdb.lookup_symbol(\"arg\")" "Get variable arg" 0
 121 gdb_test "python print (arg\[0\].is_variable)" "False" "test arg.is_variable"
 122 gdb_test "python print (arg\[0\].is_constant)" "False" "test arg.is_constant"
 123 gdb_test "python print (arg\[0\].is_argument)" "True" "test arg.is_argument"
 124 gdb_test "python print (arg\[0\].is_function)" "False" "test arg.is_function"
 125
 126 # Test is_function attribute.
 127 gdb_py_test_silent_cmd "python func = block.function" "Get block function" 0
 128 gdb_test "python print (func.is_variable)" "False" "test func.is_variable"
 129 gdb_test "python print (func.is_constant)" "False" "test func.is_constant"
 130 gdb_test "python print (func.is_argument)" "False" "test func.is_argument"
 131 gdb_test "python print (func.is_function)" "True" "test func.is_function"
 132
 133 # Test attributes of func.
 134 gdb_test "python print (func.name)" "func" "test func.name"
 135 gdb_test "python print (func.print_name)" "func" "test func.print_name"
 136 gdb_test "python print (func.linkage_name)" "func" "test func.linkage_name"
 137 gdb_test "python print (func.addr_class == gdb.SYMBOL_LOC_BLOCK)" "True" "test func.addr_class"
 138
 139 # Stop in a second file and ensure we find its local static symbol.
 140 gdb_breakpoint "function_in_other_file"
 141 gdb_continue_to_breakpoint "function_in_other_file"
 142 gdb_test "python print (gdb.lookup_static_symbol ('rr').value ())" "99" \
 143     "print value of rr from other file"
 144 gdb_test "python print (gdb.lookup_static_symbols ('rr')\[0\].value ())" "99" \
 145     "print value of gdb.lookup_static_symbols ('rr')\[0\], from the other file"
 146 gdb_test "python print (gdb.lookup_static_symbols ('rr')\[1\].value ())" "42" \
 147     "print value of gdb.lookup_static_symbols ('rr')\[1\], from the other file"
 148
 149 # Now continue back to the first source file.
 150 set linenum [gdb_get_line_number "Break at end."]
 151 gdb_breakpoint "$srcfile:$linenum"
 152 gdb_continue_to_breakpoint "Break at end for variable a" ".*Break at end.*"
 153 gdb_py_test_silent_cmd "python frame = gdb.selected_frame()" "Get Frame" 0
 154
 155 # Check that we find the static sybol local to this file over the
 156 # static symbol from the second source file.
 157 gdb_test "python print (gdb.lookup_static_symbol ('rr').value ())" "42" \
 158     "print value of rr from main file"
 159 gdb_test "python print (gdb.lookup_static_symbols ('rr')\[0\].value ())" "99" \
 160     "print value of gdb.lookup_static_symbols ('rr')\[0\], from the main file"
 161 gdb_test "python print (gdb.lookup_static_symbols ('rr')\[1\].value ())" "42" \
 162     "print value of gdb.lookup_static_symbols ('rr')\[1\], from the main file"
 163
 164 # Test is_variable attribute.
 165 gdb_py_test_silent_cmd "python a = gdb.lookup_symbol(\'a\')" "Get variable a" 0
 166 gdb_test "python print (a\[0\].is_variable)" "True" "test a.is_variable"
 167 gdb_test "python print (a\[0\].is_constant)" "False" "test a.is_constant"
 168 gdb_test "python print (a\[0\].is_argument)" "False" "test a.is_argument"
 169 gdb_test "python print (a\[0\].is_function)" "False" "test a.is_function"
 170
 171 # Test attributes of a.
 172 gdb_test "python print (a\[0\].addr_class == gdb.SYMBOL_LOC_COMPUTED)" "True" "test a.addr_class"
 173
 174 gdb_test "python print (a\[0\].value())" \
 175     "symbol requires a frame to compute its value.*"\
 176     "try to print value of a without a frame"
 177 gdb_test "python print (a\[0\].value(frame))" "0" \
 178     "print value of a"
 179 gdb_test "python print (a\[0\].needs_frame)" "True" \
 180     "print whether a needs a frame"
 181
 182 # Test is_constant attribute
 183 gdb_py_test_silent_cmd "python t = gdb.lookup_symbol(\"one\")" "Get constant t" 0
 184 gdb_test "python print (t\[0\].is_variable)" "False" "test t.is_variable"
 185 gdb_test "python print (t\[0\].is_constant)" "True" "test t.is_constant"
 186 gdb_test "python print (t\[0\].is_argument)" "False" "test t.is_argument"
 187 gdb_test "python print (t\[0\].is_function)" "False" "test t.is_function"
 188
 189 # Test attributes of t.
 190 gdb_test "python print (t\[0\].addr_class == gdb.SYMBOL_LOC_CONST)" "True" "test t.addr_class"
 191
 192 # Test type attribute.
 193 gdb_test "python print (t\[0\].type)" "enum tag" "get type"
 194
 195 # Test symtab attribute.
 196 if { [is_remote host] } {
 197     set py_symbol_c [string_to_regexp $srcfile]
 198 } else {
 199     set py_symbol_c [string_to_regexp ${srcdir}/${subdir}/${srcfile}]
 200 }
 201 gdb_test "python print (t\[0\].symtab)" "${py_symbol_c}" "get symtab"
 202
 203 # C++ tests
 204 # Recompile binary.
 205 lappend opts c++
 206 if {[prepare_for_testing "failed to prepare" "${binfile}-cxx" \
 207          [list $srcfile $srcfile2] $opts]} {
 208     return -1
 209 }
 210
 211 gdb_test "python print (gdb.lookup_global_symbol ('(anonymous namespace)::anon') is None)" \
 212     "True" "anon is None"
 213 gdb_test "python print (gdb.lookup_static_symbol ('(anonymous namespace)::anon').value ())" \
 214     "10" "print value of anon"
 215
 216 if {![runto_main]} {
 217     return 0
 218 }
 219
 220 gdb_breakpoint [gdb_get_line_number "Break in class."]
 221 gdb_continue_to_breakpoint "Break in class."
 222
 223 gdb_py_test_silent_cmd "python cplusframe = gdb.selected_frame()" "Get Frame at class" 0
 224 gdb_py_test_silent_cmd "python cplusfunc = cplusframe.block().function" "Get function at class" 0
 225
 226 gdb_test "python print (cplusfunc.is_variable)" \
 227     "False" "Test cplusfunc.is_variable"
 228 gdb_test "python print (cplusfunc.is_constant)" \
 229     "False" "Test cplusfunc.is_constant"
 230 gdb_test "python print (cplusfunc.is_argument)" \
 231     "False" "Test cplusfunc.is_argument"
 232 gdb_test "python print (cplusfunc.is_function)" \
 233     "True" "Test cplusfunc.is_function"
 234
 235 gdb_test "python print (cplusfunc.name)" "SimpleClass::valueofi().*" "test method.name"
 236 gdb_test "python print (cplusfunc.print_name)" "SimpleClass::valueofi().*" "test method.print_name"
 237 gdb_test "python print (cplusfunc.linkage_name)" "_ZN11SimpleClass8valueofiEv.*" "test method.linkage_name"
 238 gdb_test "python print (cplusfunc.addr_class == gdb.SYMBOL_LOC_BLOCK)" "True" "test method.addr_class"
 239
 240 # Test is_valid when the objfile is unloaded.  This must be the last
 241 # test as it unloads the object file in GDB.
 242 # Start with a fresh gdb.
 243 clean_restart ${binfile}
 244 if {![runto_main]} {
 245     return 0
 246 }
 247
 248 gdb_breakpoint [gdb_get_line_number "Break at end."]
 249 gdb_continue_to_breakpoint "Break at end for symbol validity" ".*Break at end.*"
 250 gdb_py_test_silent_cmd "python a = gdb.lookup_symbol(\'a\')" "Get variable a" 0
 251 gdb_test "python print (a\[0\].is_valid())" "True" "test symbol validity"
 252 delete_breakpoints
 253 gdb_unload
 254 gdb_test "python print (a\[0\].is_valid())" "False" "test symbol non-validity"
 255 gdb_test_no_output "python a = None" "test symbol destructor"
 256
 257 # Test gdb.Symbol domain categories
 258 gdb_test "python print (gdb.SYMBOL_UNDEF_DOMAIN)" \
 259     "0" "test gdb.SYMBOL_UNDEF_DOMAIN"
 260 gdb_test "python print (gdb.SYMBOL_VAR_DOMAIN)" \
 261     "1" "test gdb.SYMBOL_VAR_DOMAIN"
 262 gdb_test "python print (gdb.SYMBOL_STRUCT_DOMAIN)" \
 263     "2" "test gdb.SYMBOL_STRUCT_DOMAIN"
 264 gdb_test "python print (gdb.SYMBOL_MODULE_DOMAIN)" \
 265     "3" "test gdb.SYMBOL_MODULE_DOMAIN"
 266 gdb_test "python print (gdb.SYMBOL_LABEL_DOMAIN)" \
 267     "4" "test gdb.SYMBOL_LABEL_DOMAIN"
 268 gdb_test "python print (gdb.SYMBOL_COMMON_BLOCK_DOMAIN)" \
 269     "5" "test gdb.SYMBOL_COMMON_BLOCK_DOMAIN"
 270
 271 # Test gdb.Symbol address class categories
 272 gdb_test "python print (gdb.SYMBOL_LOC_UNDEF)" \
 273     "0" "test gdb.SYMBOL_LOC_UNDEF"
 274 gdb_test "python print (gdb.SYMBOL_LOC_CONST)" \
 275     "1" "test gdb.SYMBOL_LOC_CONST"
 276 gdb_test "python print (gdb.SYMBOL_LOC_STATIC)" \
 277     "2" "test gdb.SYMBOL_LOC_STATIC"
 278 gdb_test "python print (gdb.SYMBOL_LOC_REGISTER)" \
 279     "3" "test gdb.SYMBOL_LOC_REGISTER"
 280 gdb_test "python print (gdb.SYMBOL_LOC_ARG)" \
 281     "4" "test gdb.SYMBOL_LOC_ARG"
 282 gdb_test "python print (gdb.SYMBOL_LOC_REF_ARG)" \
 283     "5" "test gdb.SYMBOL_LOC_REF_ARG"
 284 gdb_test "python print (gdb.SYMBOL_LOC_REGPARM_ADDR)" \
 285     "6" "test gdb.SYMBOL_LOC_REGPARM_ADDR"
 286 gdb_test "python print (gdb.SYMBOL_LOC_LOCAL)" \
 287     "7" "test gdb.SYMBOL_LOC_LOCAL"
 288 gdb_test "python print (gdb.SYMBOL_LOC_TYPEDEF)" \
 289     "8" "test gdb.SYMBOL_LOC_TYPEDEF"
 290 gdb_test "python print (gdb.SYMBOL_LOC_LABEL)" \
 291     "9" "test gdb.SYMBOL_LOC_LABEL"
 292 gdb_test "python print (gdb.SYMBOL_LOC_BLOCK)" \
 293     "10" "test gdb.SYMBOL_LOC_BLOCK"
 294 gdb_test "python print (gdb.SYMBOL_LOC_CONST_BYTES)" \
 295     "11" "test gdb.SYMBOL_LOC_CONST_BYTES"
 296 gdb_test "python print (gdb.SYMBOL_LOC_UNRESOLVED)" \
 297     "12" "test gdb.SYMBOL_LOC_UNRESOLVED"
 298 gdb_test "python print (gdb.SYMBOL_LOC_OPTIMIZED_OUT)" \
 299     "13" "test gdb.SYMBOL_LOC_OPTIMIZED_OUT"
 300 gdb_test "python print (gdb.SYMBOL_LOC_COMPUTED)" \
 301     "14" "test gdb.SYMBOL_LOC_COMPUTED"
 302 gdb_test "python print (gdb.SYMBOL_LOC_COMMON_BLOCK)" \
 303     "15" "test gdb.SYMBOL_LOC_COMMON_BLOCK"