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

# Copyright 2013-2024 Free Software Foundation, Inc.

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

load_lib gdb-python.exp
require allow_python_tests
set opts {}
standard_testfile .S

if [info exists COMPILE] {
    # make check RUNTESTFLAGS="gdb.python/py-linetable.exp COMPILE=1"
    standard_testfile
    lappend opts debug optimize=-O2
} else {
    require is_x86_64_m64_target
}

if { [prepare_for_testing "failed to prepare" ${testfile} ${srcfile} $opts] } {
    return -1
}

if ![runto_main] {
    return -1
}

gdb_py_test_silent_cmd "python lt = gdb.selected_frame().find_sal().symtab.linetable()" \
    "get instruction" 0

gdb_test_multiline "input simple command" \
  "python" "" \
  "def list_lines(lt):" "" \
  "   for l in lt:" "" \
  "     print ('L' + str(l.line) + ' A ' + hex(l.pc))" "" \
  "end" ""

gdb_test "python list_lines(lt)" \
    "L20 A $hex.*L21 A $hex.*L22 A $hex.*L24 A $hex.*L25 A $hex.*L40 A $hex.*L42 A $hex.*L44 A $hex.*L42 A $hex.*L46 A $hex.*" \
    "test linetable iterator addr"
gdb_test "python print(len(lt.line(42)))" "2" \
    "Test length of a multiple pc line"
gdb_test "python print(len(lt.line(20)))" "1" \
    "Test length of a single pc line"
gdb_test "python print(lt.line(1))" "None" \
    "Test None returned for line with no pc"
gdb_test "python print(next(iter(lt)).is_stmt)" \
	 "(True|False)" \
	 "Test is_stmt"
gdb_test "python print(next(iter(lt)).prologue_end)" \
	 "(True|False)" \
	 "Test prologue_end"
gdb_test "python print(next(iter(lt)).epilogue_begin)" \
	 "(True|False)" \
	 "Test epilogue_begin"


# Test gdb.Linetable.sourcelines ()
gdb_py_test_silent_cmd "python fset = lt.source_lines()" \
    "Get all source lines into a frozen set" 0
gdb_test "python print (sorted(fset))" \
    "\\\[20, 21, 22, 24, 25, 28, 29, 30, 32, 33, 37, 39, 40, 42, 44, 45, 46\\\].*" \
    "test frozen set contains line numbers"

# Test gdb.Linetable.has_line ()
gdb_test "python print(lt.has_line(20))" \
    "True.*" \
    "Test has_pcs at line 20"
gdb_test "python print(lt.has_line(44))" \
    "True.*" \
    "Test has_pcs at line 40"
gdb_test "python print(lt.has_line(10))" \
    "False.*" \
    "test has_pcs at line 10"

# Test gdb.LineTableEntry.__init__ ()
gdb_test "python print( gdb.LineTableEntry(10, 0xcafe0000).line)" \
    "10" \
    "test new LineTableEntry line"

gdb_test "python print( gdb.LineTableEntry(10, 123456).pc)" \
    "123456" \
    "test new LineTableEntry pc"

gdb_test "python print( gdb.LineTableEntry(10, 123456).is_stmt)" \
    "False" \
    "test new LineTableEntry is_stmt"
gdb_test "python print( gdb.LineTableEntry(10, 123456).prologue_end)" \
    "False" \
    "test new LineTableEntry prologue_end"
gdb_test "python print( gdb.LineTableEntry(10, 123456).epilogue_begin)" \
    "False" \
    "test new LineTableEntry epilogue_begin"
gdb_test "python print( gdb.LineTableEntry('xx', 123456).pc)" \
    "TypeError.*:.*" \
    "test creating invalid gdb.LineTableEntry"
gdb_test "python print( gdb.LineTableEntry(10, 123456, prologue_end = True).prologue_end)" \
    "True" \
    "test prologue_end keyword argument"

# Test gdb.LineTable.__init__(). To do so, we create new compunit and new
# symtab.
gdb_py_test_silent_cmd "python cu = gdb.Compunit(\"dynamic_cu\", gdb.Objfile(\"dynamic_objf\"), 0x100, 0x200)" \
    "create new compunit" 1
gdb_py_test_silent_cmd "python st = gdb.Symtab(\"dynamic_st\", cu)" \
    "create new symtab" 1
gdb_test "python lt2 = gdb.LineTable(st, \[gdb.LineTableEntry(10, 0x123)\]); print(lt)" \
    "<gdb.LineTable object at $hex.*" \
    "create new linetable"
gdb_test "python print(lt2.is_valid())" \
    "True" \
    "test new linetable is valid"
gdb_test "python list_lines(lt2)" \
    "L10 A 0x123.*" \
    "test new linetable iterator"
gdb_test "python print(len(list(gdb.LineTable(st, \[\]))))" \
    "0" \
    "test creating empty linetable"
gdb_test "python gdb.LineTable(123, \[gdb.LineTableEntry(10, 0x123)\])" \
    "TypeError.*:.*" \
    "test creating linetable with invalid symtab"
gdb_test "python gdb.LineTable(st, gdb.LineTableEntry(10, 0x123))" \
    "TypeError.*:.*" \
    "test creating linetable with invalid entries"
gdb_test "python gdb.LineTable(st, \[gdb.LineTableEntry(10, 0x123), \"xxx\"\])" \
    "TypeError.*:.*" \
    "test creating linetable with invalid element in entries"