Files
binutils-gdb/libctf/testsuite/lib/ctf-lib.exp
Nick Alcock 572b0825c7 libctf: fix querying of large structures
After GCC PR 121411 is fixed, large structures (with offsets > 512MiB)
are written correctly... but libctf cannot query them properly unless
they are even bigger (> 4GiB), because it checks to see if the ctt_size
is CTF_LSIZE_SENT to decide whether to use a ctf_lmember_t or a
ctf_member_t to encode the structure members.  But the structure member
offsets are in *bits*, not bytes: the right value to check is
CTF_LSTRUCT_THRESH, which is 1/8th the size.

(Thanks to Martin Pirker <martin.pirker1@chello.at> for the diagnosis
and fix.)

Testing this is a bit fun, because we don't want to emit an error if the
compiler is broken: but we cannot tell whether the compiler is broken
using the existing lookup harness, because its input is passed through
the linker (and thus the broken ld).  So add another sort of link mode,
"objects", which keeps the constituent object files around and passes
both the final linker output and the object files that make it up to the
lookup program.  Our testcase can then check the linker input to see if
the compiler is buggy, and only if it isn't check the linker output and
fail if things aren't right.

libctf/
	PR libctf/33339
	* ctf-types.c (ctf_struct_member): Check CTF_LSTRUCT_THRESH, not
	CTF_LSIZE_SENT.
	* testsuite/lib/ctf-lib.exp (run_lookup_test): New 'objects'
	link option.
	* testsuite/libctf-lookup/big-struct-corruption.*: New test.
	* testsuite/libctf-lookup/big-struct-ctf.c: New test input.
2025-09-22 22:28:53 +01:00

360 lines
11 KiB
Plaintext

# Support routines for libctf testsuite.
# Copyright (C) 1994-2025 Free Software Foundation, Inc.
#
# This file is part of the GNU Binutils.
#
# This file 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
# MA 02110-1301, USA.
load_file $srcdir/../../ld/testsuite/lib/ld-lib.exp
# Returns true if the target linker deduplicates CTF.
proc check_ctf_linker_dedup { } {
global ctf_linker_dedup_saved
if {![info exists ctf_linker_dedup_saved]} {
set ctf_linker_dedup_saved 0
if ([check_ctf_available]) {
global objdump srcdir
set basename "tmpdir/ctf_linker_dedups[pid]"
compile_one_cc $srcdir/libctf-lookup/ambiguous-struct-A.c ${basename}-A.o "-gctf -fPIC -c"
compile_one_cc $srcdir/libctf-lookup/ambiguous-struct-B.c ${basename}-B.o "-gctf -fPIC -c"
compile_one_cc "${basename}-A.o ${basename}-B.o" $basename.so "-gctf -fPIC -shared"
if {! [remote_file host exists $basename.so] } {
return 0
}
# Don't use run_host_cmd: it dumps the entire output into the log,
# even on success.
set cmdret [remote_exec host [concat sh -c [list "$objdump --ctf $basename.so >dump.out 2>dump.err"]] "" "/dev/null"]
set cmdret [lindex $cmdret 0]
remote_upload host "dump.out"
remote_upload host "dump.err"
set dump_out [prune_warnings [file_contents "dump.out"]]
set dump_err [prune_warnings [file_contents "dump.err"]]
remote_file host delete "dump.out" "dump.err"
remote_file build delete "dump.out" "dump.err"
if {$cmdret != 0} {
verbose -log "failed with $cmdret: stderr: $dump_err"
verbose -log "output: $dump_out"
return 0;
}
remote_file host delete $basename.so ${basename}-A.o ${basename}-B.o
if [regexp {CTF archive member: } $dump_out] {
set ctf_linker_dedup_saved 1
}
}
}
return $ctf_linker_dedup_saved
}
proc run_native_host_cmd { command } {
global link_output
global ld
verbose -log "$command"
set run_output ""
try {
set run_output [exec "sh" "-c" "$command" "2>@1"]
set status 0
} trap CHILDSTATUS {results options} {
set status [lindex [dict get $options -errorcode] 2]
set run_output $results
}
regsub "\n$" $run_output "" run_output
if { [lindex $status 0] != 0 && [string match "" $run_output] } then {
append run_output "child process exited abnormally"
}
if [string match "" $run_output] then {
return ""
}
verbose -log "$run_output"
return "$run_output"
}
# Compile and link a C source file for execution on the host.
proc compile_link_one_host_cc { src output additional_args } {
global CC
global CFLAGS
return [run_native_host_cmd "./libtool --quiet --tag=CC --mode=link $CC $CFLAGS $src -o $output $additional_args" ]
}
# run_lookup_test FILE
#
# Compile with the host compiler and link a .c file into a "lookup" binary, then
# compile and optionally link together a bunch of .s or .c files with CTF info
# and pass the name of the resulting binary to the "lookup" binary and check the
# output. (If none is specified, the binary is expected to generate its own CTF
# for testing purposes.)
#
# As with run_dump_test, this is all driven by a file (in this case, a .lk file)
# beginning with zero or more option lines, which specify the names of the
# lookup binary's source file, the source file(s) with CTF info to compile
# together, and whether to link them. The optional lines have the syntax:
#
# # OPTION: VALUE
#
# OPTION is the name of some option, like "name" or "lookup", and
# VALUE is OPTION's value. The valid options are described below.
# Whitespace is ignored everywhere, except within VALUE. The option
# list ends with the first line that doesn't match the above syntax.
# However, a line within the options that begins with a #, but doesn't
# have a recognizable option name followed by a colon, is considered a
# comment and entirely ignored.
#
# The interesting options are:
#
# name: TEST-NAME
# The name of this test, passed to DejaGNU's `pass' and `fail'
# commands. If omitted, this defaults to FILE, the root of the
# lookup .c file's name.
#
# lookup: SOURCE
# Compile the file SOURCE.c. If omitted, the lookup source defaults
# to FILE.c.
#
# source: SOURCE
# Assemble the file SOURCE.c and pass it to the LOOKUP program.
#
# nonshared:
# If set, do not link with -shared.
#
# link:
# If set, link the SOURCE together even if only one file is specified.
# If "objects", keep the input object files and pass them as additional
# arguments to LOOKUP.
#
# link_flags:
# If set, extra flags to pass to the linker.
#
# lookup_link:
# If set, extra libraries to link the lookup program with.
#
# xfail: GLOB|PROC ...
# This test is expected to fail on a specified list of targets.
#
# no_cross:
# If set, do not run this test when host != target.
#
# host:
# If set, only run this test on hosts matching the given glob.
#
# wrapper:
# Wrap invocations of LOOKUP in this command. (Useful for valgrind
# invocations, etc.)
#
# Each option may occur at most once unless otherwise mentioned.
#
# After the option lines come regexp lines. run_lookup_test calls
# regexp_diff to compare the output of the lookup program against the
# regexps in FILE.d.
#
proc run_lookup_test { name } {
global CC_FOR_TARGET CFLAGS_FOR_TARGET LIBS TEST_CROSS
global copyfile env runtests srcdir subdir verbose
if ![runtest_file_p $runtests $name] then {
return
}
if [string match "*/*" $name] {
set file $name
set name [file tail $name]
} else {
set file "$srcdir/$subdir/$name"
}
# strip off the srcdir, which contains build host specific pathnames
set file4log [string map [list $srcdir/ ""] $file]
set opt_array [slurp_options "${file}.lk"]
if { $opt_array == -1 } {
perror "error reading options from $file.lk"
unresolved $file4log
return
}
set run_ld 0
set shared "-shared"
set opts(link) {}
set opts(link_flags) {}
set opts(lookup_link) {}
set opts(nonshared) {}
set opts(lookup) {}
set opts(name) {}
set opts(source) {}
set opts(xfail) {}
set opts(no_cross) {}
set opts(host) {}
set opts(wrapper) {}
foreach i $opt_array {
set opt_name [lindex $i 0]
set opt_val [lindex $i 1]
if { $opt_name == "" } {
set in_extra 1
continue
}
if ![info exists opts($opt_name)] {
perror "unknown option $opt_name in file $file.lk"
unresolved $file4log
return
}
set opts($opt_name) [concat $opts($opt_name) $opt_val]
}
if { [llength $opts(no_cross)] != 0
&& "$TEST_CROSS" eq "yes" } {
untested "$file4log not tested when cross-compiling"
return
}
if { [llength $opts(host)] != 0 && ![ishost $opts(host)] } {
untested "$file4log only runs on $opts(host)"
return
}
if { [llength $opts(lookup)] == 0 } {
set opts(lookup) "$file.c"
} else {
set opts(lookup) "[file dirname $file]/$opts(lookup)"
}
if { [llength $opts(name)] == 0 } {
set opts(name) $opts(lookup)
}
if { [llength $opts(link)] != 0
|| [llength $opts(source)] > 1 } {
set run_ld 1
}
if { [llength $opts(nonshared)] != 0 } {
set shared ""
}
set testname $file4log
# Compile and link the lookup program.
set comp_output [prune_warnings [compile_link_one_host_cc $opts(lookup) "tmpdir/lookup" "libctf.la $opts(lookup_link)"]]
if { $comp_output != ""} {
send_log "compilation of lookup program $opts(lookup) failed with <$comp_output>"
perror "compilation of lookup program $opts(lookup) failed"
fail $testname
return 0
}
# Compile the inputs and posibly link them together.
set lookup_output ""
set objs {}
if { [llength $opts(source)] > 0 } {
set lookup_flags ""
set ld_flags ""
if { $run_ld } {
set lookup_output "tmpdir/out.so"
set lookup_flags "-gctf -fPIC"
set ld_flags "$shared $opts(link_flags)"
} else {
set lookup_output "tmpdir/out.o"
set lookup_flags "-gctf -fPIC -c"
}
if [board_info [target_info name] exists cflags] {
append lookup_flags " [board_info [target_info name] cflags]"
}
if [board_info [target_info name] exists ldflags] {
append lookup_flags " [board_info [target_info name] ldflags]"
}
set objsrcs {}
set local_srcs {}
foreach sfile $opts(source) {
set local_src [file join [file dirname $file] $sfile]
lappend local_srcs $local_src
if [is_remote host] {
set src [remote_download host [file join [file dirname $file] $sfile]]
} else {
set src [file join [file dirname $file] $sfile]
}
if { $opts(link) == "objects" } {
set obj "[file rootname $src].o"
set comp_output [prune_warnings [run_host_cmd "$CC_FOR_TARGET" "$CFLAGS_FOR_TARGET $lookup_flags $src -c -o $obj"]]
if { $comp_output != ""} {
send_log "compilation of CTF program $local_src failed with <$comp_output>"
fail $testname
return 0
}
lappend objsrcs $obj
lappend objs $obj
} else {
lappend objsrcs $src
}
}
set comp_output [prune_warnings [run_host_cmd "$CC_FOR_TARGET" "$CFLAGS_FOR_TARGET $lookup_flags $ld_flags [concat $objsrcs] -o $lookup_output"]]
if { $comp_output != ""} {
send_log "compilation of CTF program [concat $local_srcs] failed with <$comp_output>"
fail $testname
return 0
}
}
# Time to setup xfailures.
foreach targ $opts(xfail) {
if [match_target $targ] {
setup_xfail "*-*-*"
break
}
}
# Invoke the lookup program on the outputs, possibly through the wrapper, including all
# the object file names if they were filled out.
if { [llength $opts(wrapper)] == 0 } {
set results [run_host_cmd tmpdir/lookup "$lookup_output $objs"]
} else {
set results [run_host_cmd "$opts(wrapper) tmpdir/lookup" "$lookup_output $objs"]
}
if { [regexp {^UNSUPPORTED: (.*)$} $results -> reason] } {
unsupported "$testname: $reason"
return 0
}
set f [open "tmpdir/lookup.out" "w"]
puts $f $results
close $f
if { [regexp_diff "tmpdir/lookup.out" "${file}.lk"] } then {
fail $testname
if { $verbose == 2 } then { verbose "output is [file_contents tmpdir/lookup.out]" 2 }
return 0
}
pass $testname
return 0
}