1 # Expect script for linker support of IFUNC symbols and relocations.
3 # Copyright (C) 2009-2021 Free Software Foundation, Inc.
4 # Contributed by Red Hat.
6 # This file is part of the GNU Binutils.
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
23 # Written by Nick Clifton <nickc@redhat.com>
26 if { ![is_elf_format] || ![supports_gnu_osabi]
27 || [istarget alpha-*-*]
28 || [istarget arc*-*-*]
29 || [istarget am33*-*-*]
30 || [istarget bfin-*-*]
31 || [istarget cris*-*-*]
33 || [istarget lm32-*-*]
34 || [istarget m32r-*-*]
35 || [istarget m68k-*-*]
36 || [istarget microblaze-*-*]
37 || [istarget mips*-*-*]
38 || [istarget mn10300-*-*]
39 || [istarget nds32*-*-*]
40 || [istarget nios2-*-*]
41 || [istarget or1k-*-*]
42 || [istarget score*-*-*]
44 || [istarget tic6x-*-*]
45 || [istarget tile*-*-*]
46 || [istarget vax-*-*] } {
47 verbose "IFUNC tests not run - target does not support IFUNC"
51 # Skip targets where -shared is not supported
53 if ![check_shared_lib_support] {
57 set saved_ASFLAGS "$ASFLAGS"
58 if { [istarget "i?86-*-*"] || [istarget "x86_64-*-*"] } {
59 set ASFLAGS "$ASFLAGS -mx86-used-note=no"
62 # This test does not need a compiler...
63 run_dump_test "ifuncmod5"
65 set test_list [lsort [glob -nocomplain $srcdir/$subdir/*.d]]
66 foreach t $test_list {
67 # We need to strip the ".d", but can leave the dirname.
68 verbose [file rootname $t]
69 run_dump_test [file rootname $t]
72 # We need a working compiler. (Strictly speaking this is
73 # not true, we could use target specific assembler files).
74 if { ![check_compiler_available] } {
75 verbose "IFUNC tests not run - no compiler available"
79 # A procedure to check the OS/ABI field in the ELF header of a binary file.
80 proc check_osabi { binary_file expected_osabi } {
84 catch "exec $READELF $READELFFLAGS --file-header $binary_file > readelf.out" got
86 if ![string match "" $got] then {
87 verbose "proc check_osabi: Readelf produced unexpected out processing $binary_file: $got"
91 if { ![regexp "\n\[ \]*OS/ABI:\[ \]*(.+)\n\[ \]*ABI" \
92 [file_contents readelf.out] nil osabi] } {
93 verbose "proc check_osabi: Readelf failed to extract an ELF header from $binary_file"
97 if { $osabi == $expected_osabi } {
101 verbose "Expected OSABI: $expected_osabi, Obtained osabi: $osabi"
106 # A procedure to confirm that a file contains the IFUNC symbol.
107 # Returns -1 upon error, 0 if the symbol was not found and 1 if it was found.
108 proc contains_ifunc_symbol { binary_file } {
112 catch "exec $READELF $READELFFLAGS --symbols $binary_file > readelf.out" got
114 if ![string match "" $got] then {
115 verbose "proc contains_ifunc_symbol: Readelf produced unexpected out processing $binary_file: $got"
119 # Look for a line like this:
120 # 58: 0000000000400600 30 IFUNC GLOBAL DEFAULT 12 library_func2
121 # with perhaps some other info between the visibility and section
123 if { ![regexp ".*\[ \]*IFUNC\[ \]+GLOBAL\[ \]+DEFAULT .* \[UND0-9\]+\[ \]+library_func2\n" [file_contents readelf.out]] } {
130 # A procedure to confirm that a file contains the R_*_IRELATIVE
132 # Returns -1 upon error, 0 if the relocation was not found and 1 if
134 proc contains_irelative_reloc { binary_file } {
138 catch "exec $READELF $READELFFLAGS --relocs --wide $binary_file > readelf.out" got
140 if ![string match "" $got] then {
141 verbose "proc contains_irelative_reloc: Readelf produced unexpected out processing $binary_file: $got"
145 # Look for a line like this:
146 # 0000000000600ab0 0000000000000025 R_X86_64_IRELATIVE 000000000040061c
147 # 080496f4 0000002a R_386_IRELATIVE
150 if { ![regexp "\[0-9a-f\]+\[ \]+\[0-9a-f\]+\[ \]+R_(\[_0-9A-Z\]+_IREL(|ATIVE)|PARISC_IPLT)\[ \]*\[0-9a-f\]*\n" [file_contents readelf.out]] } {
157 # A procedure to confirm that a file contains a relocation that references an IFUNC symbol.
158 # Returns -1 upon error, 0 if the reloc was not found and 1 if it was found.
159 proc contains_ifunc_reloc { binary_file } {
163 catch "exec $READELF $READELFFLAGS --relocs $binary_file > readelf.out" got
165 if ![string match "" $got] then {
166 verbose "proc contains_ifunc_reloc: Readelf produced unexpected out processing $binary_file: $got"
170 if [string match "" [file_contents readelf.out]] then {
171 verbose "No relocs found in $binary_file"
175 if { ![regexp "\\(\\)" [file_contents readelf.out]] } {
184 # Disable LTO for these tests.
186 if {[check_lto_available]} {
187 append cc_cmd " -fno-lto"
190 # Create the object files, libraries and executables.
191 if ![ld_compile "$cc_cmd -c -fPIC" "$srcdir/$subdir/prog.c" "tmpdir/shared_prog.o"] {
192 fail "Could not create a PIC object file"
193 set fails [expr $fails + 1]
195 if ![ld_compile "$cc_cmd -c $NOPIE_CFLAGS" "$srcdir/$subdir/prog.c" "tmpdir/static_prog.o"] {
196 fail "Could not create a non-PIC object file"
197 set fails [expr $fails + 1]
199 if ![ld_compile "$cc_cmd -c -fPIC -DWITH_IFUNC" "$srcdir/$subdir/lib.c" "tmpdir/shared_ifunc.o"] {
200 fail "Could not create a PIC object file containing an IFUNC symbol"
201 set fails [expr $fails + 1]
203 if ![ld_compile "$cc_cmd -c $NOPIE_CFLAGS -DWITH_IFUNC" "$srcdir/$subdir/lib.c" "tmpdir/static_ifunc.o"] {
204 fail "Could not create a non-PIC object file containing an IFUNC symbol"
205 set fails [expr $fails + 1]
207 if ![ld_compile "$cc_cmd -c -DWITHOUT_IFUNC" "$srcdir/$subdir/lib.c" "tmpdir/static_noifunc.o"] {
208 fail "Could not create an ordinary non-PIC object file"
209 set fails [expr $fails + 1]
211 if ![ld_assemble $as "$srcdir/ld-elf/empty.s" "tmpdir/empty.o"] {
212 fail "Could not create an empty object file"
213 set fails [expr $fails + 1]
215 if ![ld_compile "$cc_cmd -c" "$srcdir/$subdir/test-1.c" "tmpdir/test-1.o"] {
216 fail "Could not create test-1.o"
217 set fails [expr $fails + 1]
219 if ![ld_compile "$cc_cmd -fPIC -c" "$srcdir/$subdir/test-2.c" "tmpdir/test-2.o"] {
220 fail "Could not create test-2.o"
221 set fails [expr $fails + 1]
228 if ![ld_link $ld "tmpdir/libshared_ifunc.so" "-shared tmpdir/shared_ifunc.o"] {
229 fail "Could not create a shared library containing an IFUNC symbol"
230 set fails [expr $fails + 1]
232 if ![ar_simple_create $ar "" "tmpdir/libifunc.a" "tmpdir/static_ifunc.o"] {
233 fail "Could not create a static library containing an IFUNC symbol"
234 set fails [expr $fails + 1]
241 if ![ld_link $CC "tmpdir/dynamic_prog" "-Wl,--no-as-needed,-rpath=./tmpdir,-Bdynamic -Ltmpdir tmpdir/shared_prog.o -lshared_ifunc"] {
242 fail "Could not link a dynamic executable"
243 set fails [expr $fails + 1]
245 if ![ld_link $CC "tmpdir/local_prog" "$NOPIE_LDFLAGS -Wl,--no-as-needed,-rpath=./tmpdir -Ltmpdir tmpdir/static_prog.o -lifunc"] {
246 fail "Could not link a dynamic executable using local ifunc"
247 set fails [expr $fails + 1]
249 if ![string match "" $STATIC_LDFLAGS] {
250 if ![ld_link $CC "tmpdir/static_prog" "-static -Ltmpdir tmpdir/static_prog.o -lifunc"] {
251 fail "Could not link a static executable"
252 set fails [expr $fails + 1]
255 if ![ld_link $ld "tmpdir/static_nonifunc_prog" "-static tmpdir/empty.o"] {
256 fail "Could not link a non-ifunc using static executable"
257 set fails [expr $fails + 1]
259 if ![ld_link $CC "tmpdir/test-1" "-Wl,--no-as-needed,-rpath=./tmpdir tmpdir/test-1.o tmpdir/libshared_ifunc.so"] {
260 fail "Could not link test-1"
261 set fails [expr $fails + 1]
263 if ![ld_link $ld "tmpdir/libtest-2.so" "-shared tmpdir/test-2.o"] {
264 fail "Could not link libtest-2.so"
265 set fails [expr $fails + 1]
267 if ![ld_link $ld "tmpdir/libtest-2-now.so" "-shared -z now tmpdir/test-2.o"] {
268 fail "Could not link libtest-2-now.so"
269 set fails [expr $fails + 1]
273 pass "Building ifunc binaries"
279 # Check the executables and shared libraries
281 # The linked ifunc using executables and the shared library containing
282 # ifunc should have an OSABI field of GNU. The linked non-ifunc using
283 # executable should have an OSABI field of NONE (aka System V).
285 switch -glob $target_triplet {
286 hppa*-*-linux* { set expected_none {UNIX - GNU} }
287 default { set expected_none {UNIX - System V} }
290 if {! [check_osabi tmpdir/libshared_ifunc.so {UNIX - GNU}]} {
291 fail "Shared libraries containing ifunc does not have an OS/ABI field of GNU"
292 set fails [expr $fails + 1]
294 if {! [check_osabi tmpdir/local_prog {UNIX - GNU}]} {
295 fail "Local ifunc-using executable does not have an OS/ABI field of GNU"
296 set fails [expr $fails + 1]
298 if { ![string match "" $STATIC_LDFLAGS] \
299 && ![check_osabi tmpdir/static_prog {UNIX - GNU}]} {
300 fail "Static ifunc-using executable does not have an OS/ABI field of GNU"
301 set fails [expr $fails + 1]
303 if {! [check_osabi tmpdir/dynamic_prog $expected_none]} {
304 fail "Dynamic ifunc-using executable does not have an OS/ABI field of $expected_none"
305 set fails [expr $fails + 1]
307 if {! [check_osabi tmpdir/static_nonifunc_prog $expected_none]} {
308 fail "Static non-ifunc-using executable does not have an OS/ABI field of $expected_none"
309 set fails [expr $fails + 1]
312 # The linked ifunc using executables and the shared library containing
313 # ifunc should contain an IFUNC symbol. The non-ifunc using executable
316 if {[contains_ifunc_symbol tmpdir/libshared_ifunc.so] != 1} {
317 fail "Shared libraries containing ifunc does not contain an IFUNC symbol"
318 set fails [expr $fails + 1]
320 if {[contains_ifunc_symbol tmpdir/local_prog] != 1} {
321 fail "Local ifunc-using executable does not contain an IFUNC symbol"
322 set fails [expr $fails + 1]
324 if { ![string match "" $STATIC_LDFLAGS] \
325 && [contains_ifunc_symbol tmpdir/static_prog] != 1} {
326 fail "Static ifunc-using executable does not contain an IFUNC symbol"
327 set fails [expr $fails + 1]
329 if {[contains_ifunc_symbol tmpdir/dynamic_prog] != 0} {
330 fail "Dynamic ifunc-using executable contains an IFUNC symbol"
331 set fails [expr $fails + 1]
333 if {[contains_ifunc_symbol tmpdir/static_nonifunc_prog] != 0} {
334 fail "Static non-ifunc-using executable contains an IFUNC symbol"
335 set fails [expr $fails + 1]
337 if {[contains_ifunc_symbol tmpdir/test-1] != 0} {
338 fail "test-1 contains IFUNC symbols"
339 set fails [expr $fails + 1]
341 if {[contains_ifunc_symbol tmpdir/libtest-2.so] != 0} {
342 fail "libtest-2.so contains IFUNC symbols"
343 set fails [expr $fails + 1]
345 if {[contains_ifunc_symbol tmpdir/libtest-2-now.so] != 0} {
346 fail "libtest-2-now.so contains IFUNC symbols"
347 set fails [expr $fails + 1]
350 # The linked ifunc using executables and shared libraries should contain
351 # a dynamic reloc referencing the IFUNC symbol. (Even the static
352 # executable which should have a dynamic section created for it). The
353 # non-ifunc using executable should not.
355 if {[contains_irelative_reloc tmpdir/libshared_ifunc.so] != 1} {
356 fail "ifunc-using shared library does not contain R_*_IRELATIVE relocation"
357 set fails [expr $fails + 1]
359 if {[contains_irelative_reloc tmpdir/local_prog] != 1} {
360 fail "Local ifunc-using executable does not contain R_*_IRELATIVE relocation"
361 set fails [expr $fails + 1]
363 if { ![string match "" $STATIC_LDFLAGS] \
364 && [contains_irelative_reloc tmpdir/static_prog] != 1} {
365 fail "Static ifunc-using executable does not contain R_*_IRELATIVE relocation"
366 set fails [expr $fails + 1]
368 if {[contains_ifunc_reloc tmpdir/dynamic_prog] != 0} {
369 fail "Dynamic ifunc-using executable contains a reloc against an IFUNC symbol"
370 set fails [expr $fails + 1]
372 if {[contains_ifunc_reloc tmpdir/static_nonifunc_prog] == 1} {
373 fail "Static non-ifunc-using executable contains a reloc against an IFUNC symbol!"
374 set fails [expr $fails + 1]
378 pass "Checking ifunc binaries"
381 run_cc_link_tests [list \
383 "Build libpr16467a.so" \
384 "-shared -Wl,--version-script=pr16467a.map" \
391 "Build libpr16467b.a" \
399 "Build libpr16467b.so" \
400 "-shared tmpdir/pr16467b.o tmpdir/libpr16467a.so \
401 -Wl,--version-script=pr16467b.map" \
408 "Build libpr16467c.a" \
416 "Build libpr16467an.so" \
417 "-shared -Wl,-z,now -Wl,--version-script=pr16467a.map" \
424 "Build libpr16467bn.so" \
425 "-shared tmpdir/pr16467b.o tmpdir/libpr16467an.so \
426 -Wl,--version-script=pr16467b.map" \
434 run_ld_link_exec_tests [list \
436 "Common symbol override ifunc test 1a" \
439 { ifunc-common-1a.c ifunc-common-1b.c } \
441 "ifunc-common-1.out" \
445 "Common symbol override ifunc test 1b" \
448 { ifunc-common-1b.c ifunc-common-1a.c } \
450 "ifunc-common-1.out" \
455 # Run-time tests which require working IFUNC support.
456 if { ![check_ifunc_available] } {
460 run_cc_link_tests [list \
462 "Build ifunc-lib.so" \
470 "Build ifunc-libn.so" \
471 "-shared -Wl,-z,now" \
479 run_ld_link_exec_tests [list \
482 "-Wl,--no-as-needed tmpdir/pr16467c.o tmpdir/libpr16467b.so tmpdir/libpr16467a.so" \
490 "Run pr16467 (-z now)" \
491 "-Wl,-z,now -Wl,--no-as-needed tmpdir/pr16467c.o tmpdir/libpr16467bn.so tmpdir/libpr16467an.so" \
500 "-Wl,--no-as-needed tmpdir/libifunc-lib.so" \
507 "Run ifunc-main with -fpic" \
508 "-Wl,--no-as-needed tmpdir/libifunc-lib.so" \
516 "Run ifunc-main (-z now)" \
517 "-Wl,-z,now -Wl,--no-as-needed tmpdir/libifunc-libn.so" \
524 "Run ifunc-main with PIE (-z now)" \
525 "-pie -Wl,-z,now -Wl,--no-as-needed tmpdir/libifunc-libn.so" \
534 # Run-time tests which require working ifunc attribute support.
535 if { ![check_ifunc_attribute_available] } {
539 run_cc_link_tests [list \
549 "Build libpr18808.so" \
557 "Build libpr18808n.so" \
558 "-shared -Wl,-z,now" \
573 "Build libpr18841b.so" \
581 "Build libpr18841c.so" \
589 "Build libpr18841bn.so" \
590 "-Wl,-z,now -shared" \
597 "Build libpr18841cn.so" \
599 "-Wl,-z,now -fPIC -O0 -g" \
605 "Build libpr23169a.so" \
613 "Build libpr23169b.so" \
614 "-shared -Wl,-z,now" \
622 "$NOPIE_LDFLAGS -Wl,--no-as-needed tmpdir/libpr23169a.so" \
623 "$NOPIE_CFLAGS -O2 -g" \
624 { pr23169b.c pr23169c.c } \
625 {{readelf {--dyn-syms} pr23169a.rd} \
626 {readelf {-r -W} pr23169b.rd}} \
631 "-pie -Wl,--no-as-needed tmpdir/libpr23169a.so" \
633 { pr23169b.c pr23169c.c } \
634 {{readelf {--dyn-syms} pr23169c.rd} \
635 {readelf {-r -W} pr23169b.rd}} \
640 "$NOPIE_LDFLAGS -Wl,--no-as-needed tmpdir/libpr23169a.so" \
642 { pr23169b.c pr23169c.c } \
643 {{readelf {--dyn-syms} pr23169c.rd} \
644 {readelf {-r -W} pr23169b.rd}} \
649 "$NOPIE_LDFLAGS -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
650 "$NOPIE_CFLAGS -O2 -g" \
651 { pr23169b.c pr23169c.c } \
652 {{readelf {--dyn-syms} pr23169a.rd} \
653 {readelf {-r -W} pr23169b.rd}} \
658 "-pie -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
660 { pr23169b.c pr23169c.c } \
661 {{readelf {--dyn-syms} pr23169c.rd} \
662 {readelf {-r -W} pr23169b.rd}} \
667 "$NOPIE_LDFLAGS -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
669 { pr23169b.c pr23169c.c } \
670 {{readelf {--dyn-syms} pr23169c.rd} \
671 {readelf {-r -W} pr23169b.rd}} \
676 run_ld_link_exec_tests [list \
679 "-Wl,--no-as-needed tmpdir/pr18808a.o tmpdir/libpr18808.so" \
686 "Run pr18808 (-z now)" \
687 "-Wl,-z,now -Wl,--no-as-needed tmpdir/pr18808a.o tmpdir/libpr18808n.so" \
694 "Run pr18841 with libpr18841b.so" \
695 "$NOPIE_LDFLAGS -Wl,--no-as-needed tmpdir/pr18841a.o tmpdir/libpr18841b.so" \
702 "Run pr18841 with libpr18841c.so" \
703 "$NOPIE_LDFLAGS -Wl,--as-needed tmpdir/pr18841a.o tmpdir/libpr18841c.so" \
710 "Run pr18841 with libpr18841bn.so (-z now)" \
711 "$NOPIE_LDFLAGS -Wl,-z,now -Wl,--no-as-needed tmpdir/pr18841a.o tmpdir/libpr18841bn.so" \
718 "Run pr18841 with libpr18841cn.so (-z now)" \
719 "$NOPIE_LDFLAGS -Wl,-z,now -Wl,--as-needed tmpdir/pr18841a.o tmpdir/libpr18841cn.so" \
727 # The pr23169 testcase is not valid. In general, you can't call ifunc
728 # resolvers in another binary unless you know what you're doing. In
729 # particular you must ensure that the binary containing the resolver
730 # is relocated before the resolver is called (for example, the
731 # function addresses returned by the resolver may be loaded from the
733 # That does not happen for the pr23169 testcase where the resolver is
734 # in the executable (which is relocated last by ld.so).
736 && !([istarget "powerpc-*-*"]
737 || [istarget "aarch64*-*-*"]
738 || [istarget "sparc*-*-*"]
739 || [istarget "riscv*-*-*"]) } {
740 run_ld_link_exec_tests [list \
743 "$NOPIE_LDFLAGS -Wl,--no-as-needed tmpdir/libpr23169a.so" \
745 { pr23169b.c pr23169c.c } \
748 "$NOPIE_CFLAGS -O2 -g" \
752 "-pie -Wl,--no-as-needed tmpdir/libpr23169a.so" \
754 { pr23169b.c pr23169c.c } \
761 "$NOPIE_LDFLAGS -Wl,--no-as-needed tmpdir/libpr23169a.so" \
763 { pr23169b.c pr23169c.c } \
770 "$NOPIE_LDFLAGS -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
772 { pr23169b.c pr23169c.c } \
775 "$NOPIE_CFLAGS -O2 -g" \
779 "-pie -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
781 { pr23169b.c pr23169c.c } \
788 "$NOPIE_LDFLAGS -Wl,--no-as-needed,-z,now tmpdir/libpr23169b.so" \
790 { pr23169b.c pr23169c.c } \
796 if { $STATIC_PIE_LDFLAGS != "" } then {
797 run_ld_link_exec_tests [list \
800 "$STATIC_PIE_LDFLAGS" \
802 { pr23169a.c pr23169b.c pr23169c.c } \
811 set ASFLAGS "$saved_ASFLAGS"