gas/testsuite:
[external/binutils.git] / ld / testsuite / ld-sh / arch / arch.exp
1 # Copyright (C) 2004
2 # Free Software Foundation, Inc.
3
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 2 of the License, or
7 # (at your option) any later version.
8
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  
17
18 # Please email any bugs, comments, and/or additions to this file to:
19 # dejagnu@gnu.org
20
21 # This scripts tests of all available SH architectures with all other SH
22 # architectures. It ensures that those combinations which should not work
23 # do not work, and that those that should work produce the correct output
24 # architecture.
25 #
26 # It looks for files in the same directory as this file named sh*.s .
27 # Each file must contain one or more instructions which uniquely identifies
28 # that architecture. The architecture name is inferred from the file name.
29 #
30 # It also creates another architecture named 'sh-unknown' by modifying
31 # another arch type (there is no way to assemble such an arch) in order
32 # to test what the linker would do with an older object file.
33 #
34 # The script generates the architecture  permutations automatically,
35 # but it reads the expected results from the file arch_expected.txt (also
36 # found in the same directory as this script).
37 #
38 # The arch_expected.txt file should NOT be hand edited. Whenever the script
39 # is run (e.g. with 'make check') it creates a new (usually identical) file
40 # named arch_results.txt in the <objdir>/ld/testsuite directory. When the
41 # expected results change (or new architectures are added) this new file
42 # can be used to replace arch_expected.txt with no modification required.
43
44
45 # The procedure extracts the architecture name from the objdump output.
46 # If there is no architecture name (or objdump output changes significantly)
47 # then the behaviour is undefined, but it will most likely return junk.
48
49 proc get_sh_arch { ofile } {
50     global OBJDUMP
51
52     set cmd "$OBJDUMP -f $ofile"
53     verbose -log $cmd
54     catch "exec $cmd" objdump_output
55     verbose -log $objdump_output
56
57     set objdump_output [string replace $objdump_output 0 \
58             [expr [string first "architecture:" $objdump_output] + 13] ""]
59
60     return [string range $objdump_output 0 [expr [string first "," $objdump_output] - 1]]
61 }
62
63
64 # This procedure runs two tests:
65 #   Test 1: Check the linker can link the given files.
66 #   Test 2: Check that the resultant architecture is as expected.
67 # It also writes an entry to the arch_results.txt file.
68
69 proc test_arch { file1 file2 arch resultfile } {
70     global LD
71
72     set name1 [file tail $file1]
73     set rootname1 [file rootname $name1]
74
75     set name2 [file tail $file2]
76     set rootname2 [file rootname $name2]
77
78     set result [default_ld_simple_link $LD "${rootname1}_${rootname2}.o" "$file1 $file2"]
79
80     if {$result == 1} then {
81         pass "$rootname1 file should link with $rootname2 file"
82
83         set result [get_sh_arch "${rootname1}_${rootname2}.o"]
84         puts $resultfile [format "%-20s %-20s %s" $file1 $file2 $result]
85
86         if {$result == $arch} then {
87             pass "$rootname1 file with $rootname2 file should link to arch $arch"
88             file delete "${rootname1}_${rootname2}.o"
89         } else {
90             fail "$rootname1 file with $rootname2 file should link to arch $arch"
91         }
92     } else {
93         fail "$rootname1 file should link with $rootname2 file"
94
95         puts $resultfile [format "%-20s %-20s ERROR" $file1 $file2]
96         untested "$rootname2 file with $rootname2 file should link to arch $arch"
97     }
98
99 }
100
101
102
103 # This procedure tests that a pair of files that are not
104 # suposed to link does, in fact, not link.
105 # It also writes an entry to the arch_results.txt file.
106
107 proc test_arch_error { file1 file2 resultfile} {
108     global link_output LD
109
110     set name1 [file tail $file1]
111     set rootname1 [file rootname $name1]
112
113     set name2 [file tail $file2]
114     set rootname2 [file rootname $name2]
115
116     set result [default_ld_simple_link $LD "${rootname1}_${rootname2}.o" "$file1 $file2"]
117
118     if {$result == 1} then {
119         fail "$rootname1 file should NOT link with $rootname2 file"
120         puts $resultfile [format "%-20s %-20s [get_sh_arch ${rootname1}_${rootname2}.o]" $file1 $file2]
121     } else {
122         pass "$rootname1 file should NOT link with $rootname2 file"
123         puts $resultfile [format "%-20s %-20s ERROR" $file1 $file2]
124     }
125 }   
126
127 # These tests are not suitable for sh-coff because
128 # coff does not store the architecture information.
129
130 if [istarget sh*-*-elf] then {
131     global subdir srcdir
132     global AS
133
134     # Find all the architectures and assemble all the files
135     # we will use for the linker tests.
136
137     set sfilelist [lsort -ascii [glob "$srcdir/$subdir/sh*.s"]]
138     set ofilelist {}
139     foreach sfile $sfilelist {
140         set ofile "[file rootname [file tail $sfile]].o"
141         lappend ofilelist $ofile
142
143         set endian "-big"
144         if [string equal [big_or_little_endian] " -EL"] then {
145             set endian "-little"
146         }
147
148         set cmd "$AS $endian -isa=any $sfile -o $ofile"
149         verbose -log $cmd
150         catch "exec $cmd" as_output
151         if ![file exists $ofile] then {
152             verbose -log $as_output
153             perror "$sfile: assembly failed"
154         }
155     }
156
157     # Create the default arch ofile
158     # This cannot be created with the assembler
159     # sh4al-dsp is number 6, sh-unknown is 0
160
161     lappend ofilelist "sh-unknown.o"
162
163     if [string equal [big_or_little_endian] " -EL"] then {
164         set cmd {xxd sh4al-dsp.o | sed {s/\(^0000020: .... .... \)06/\100/} | xxd -r - sh-unknown.o}
165     } else {
166         set cmd {xxd sh4al-dsp.o | sed {s/\(^0000020: .... .... .... ..\)06/\100/} | xxd -r - sh-unknown.o}
167     }
168     verbose -log $cmd
169     catch "exec $cmd" xxd_output
170     verbose -log $xxd_output
171     if [string equal [get_sh_arch "sh-unknown.o"] "sh4al-dsp"] then {
172         perror "sh-unknown.o not generated correctly"
173     }
174
175
176     # Initialise the results file
177
178     set outfile [open "arch_results.txt" w 0666]
179     puts $outfile "# Generated file. DO NOT EDIT"
180     puts $outfile "#"
181     puts $outfile "# This file is generated by ld/testsuite/ld-sh/arch/arch.exp ."
182     puts $outfile "# It contains the expected results of the tests."
183     puts $outfile "# If the tests are failing because the expected results"
184     puts $outfile "# have changed then run 'make check' and copy the new file"
185     puts $outfile "# from <objdir>/ld/arch_results.txt"
186     puts $outfile "# to   <srcdir>/ld/testsuite/ld-sh/arch/arch_expected.txt ."
187     puts $outfile "# Make sure the new expected results are ALL correct."
188     puts $outfile "#"
189     puts $outfile [format "# %-18s %-20s %s" "FILE1" "FILE2" "OUTPUT"]
190     puts $outfile [format "# %-18s %-20s %s" "-----" "-----" "------"]
191
192     # Open the expected results file and skip the header
193
194     set infile [open "$srcdir/$subdir/arch_expected.txt" r]
195     while {[gets $infile line] >= 0 && [string match {\#*} $line]} {verbose -log "reading '$line'"}
196
197     foreach file1 $ofilelist {
198         foreach file2 $ofilelist {
199             set name1 [file tail $file1]
200             set rootname1 [file rootname $name1]
201
202             set name2 [file tail $file2]
203             set rootname2 [file rootname $name2]
204
205             # Decode the expected result from the file
206
207             scan $line "%s %s %s" exfile1 exfile2 exarch
208             verbose -log "exfile1 = '$exfile1', exfile2 = '$exfile2', exarch = '$exarch'"
209             verbose -log "  name1 = '$name1',   name2 = '$name2'"
210
211             if {[string equal $exfile1 $name1] && [string equal $exfile2 $file2]} then {
212                 # The expected result file makes sense and
213                 # appears up-to-date (the file and options match)
214
215                 if {[string equal $exarch "ERROR"]} then {
216                     test_arch_error $file1 $file2 $outfile
217                 } else {
218                     test_arch $file1 $file2 $exarch $outfile
219                 }
220             } else {
221                 # The expected result file isn't right somehow
222                 # so just try any old test. This will cause
223                 # many failures, but will genrate the results file.
224
225                 test_arch $file1 $file2 $rootname1 $outfile
226             }
227
228             # Read the next line from the expected result file.
229             # This is at the end because the process of skipping
230             # the header reads the first real line
231
232             if [gets $infile line] then {
233                 verbose -log "reading '$line'"
234             }
235         }
236     }
237
238     close $infile
239     close $outfile
240
241     foreach file $ofilelist {
242         file delete $file
243     }
244 }