Update year range in copyright notice of binutils files
[external/binutils.git] / binutils / testsuite / binutils-all / objdump.exp
1 #   Copyright (C) 1993-2019 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, write to the Free Software
15 # Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
16
17 # Please email any bugs, comments, and/or additions to this file to:
18 # bug-dejagnu@prep.ai.mit.edu
19
20 # This file was written by Rob Savoye <rob@cygnus.com>
21 # and rewritten by Ian Lance Taylor <ian@cygnus.com>
22
23 if ![is_remote host] {
24     if {[which $OBJDUMP] == 0} then {
25         perror "$OBJDUMP does not exist"
26         return
27     }
28 }
29
30 send_user "Version [binutil_version $OBJDUMP]"
31
32 # Simple test of objdump -i
33
34 set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -i"]
35
36 set cpus_expected [list]
37 lappend cpus_expected aarch64 alpha am33-2 arc ARC700 ARCv2 arm cris
38 lappend cpus_expected d10v d30v fr30 fr500 fr550 h8 hppa i386 iamcu ip2022
39 lappend cpus_expected m16c m32c m32r m68hc11 m68hc12 m68k MCore mep c5 h1 MicroBlaze
40 lappend cpus_expected mips mn10200 mn10300 ms1 msp MSP430 nds32 n1h_v3 ns32k
41 lappend cpus_expected or1k or1knd pj powerpc pyramid riscv romp rs6000 s390 sh sparc
42 lappend cpus_expected tic54x tic80 tilegx tms320c30 tms320c4x tms320c54x
43 lappend cpus_expected v850 vax x86-64 xscale xtensa z8k z8001 z8002
44
45 # Make sure the target CPU shows up in the list.
46 lappend cpus_expected ${target_cpu}
47
48 # Create regexp
49 set cpus_regex "([join $cpus_expected | ])"
50
51 verbose -log "CPU regex: $cpus_regex"
52
53 set want "BFD header file version.*srec\[^\n\]*\n\[^\n\]*header \[^\n\]*endian\[^\n\]*, data \[^\n\]*endian.*$cpus_regex"
54
55 if [regexp $want $got] then {
56     pass "objdump -i"
57 } else {
58     fail "objdump -i"
59 }
60
61 # The remaining tests require a test file.
62
63
64 if {![binutils_assemble $srcdir/$subdir/bintest.s tmpdir/bintest.o]} then {
65     fail "objdump (assembling)"
66     return
67 }
68 if {![binutils_assemble $srcdir/$subdir/bintest.s tmpdir/bintest2.o]} then {
69     fail "objdump (assembling)"
70     return
71 }
72 if [is_remote host] {
73     set testfile [remote_download host tmpdir/bintest.o]
74     set testfile2 [remote_download host tmpdir/bintest2.o]
75 } else {
76     set testfile tmpdir/bintest.o
77     set testfile2 tmpdir/bintest2.o
78 }
79
80 # $testarchive exists only if it is supported.
81 set testarchive tmpdir/bintest.a
82 remote_file host file delete $testarchive
83 if { ![istarget "alpha-*-*"] || [is_elf_format] } then {
84     set got [binutils_run $AR "rc tmpdir/bintest.a $testfile2"]
85     if ![string match "" $got] then {
86         fail "bintest.a"
87         remote_file host delete tmpdir/bintest.a
88     } elseif [is_remote host] {
89         set testarchive [remote_download host tmpdir/bintest.a]
90     }
91     remote_file host delete tmpdir/bintest2.o
92 }
93
94 # Test objdump -f
95
96 proc test_objdump_f { testfile dumpfile } {
97     global OBJDUMP
98     global OBJDUMPFLAGS
99     global cpus_regex
100
101     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -f $testfile"]
102
103     set want "$dumpfile:\[      \]*file format.*architecture:\[         \]*${cpus_regex}.*HAS_RELOC.*HAS_SYMS"
104
105     if ![regexp $want $got] then {
106         fail "objdump -f ($testfile, $dumpfile)"
107     } else {
108         pass "objdump -f ($testfile, $dumpfile)"
109     }
110 }
111
112 test_objdump_f $testfile $testfile
113 if { [ remote_file host exists $testarchive ] } then {
114     test_objdump_f $testarchive bintest2.o
115 }
116
117 # Test objdump -h
118
119 proc test_objdump_h { testfile dumpfile } {
120     global OBJDUMP
121     global OBJDUMPFLAGS
122
123     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -h $testfile"]
124
125     set want "$dumpfile:\[      \]*file format.*Sections.*\[0-9\]+\[    \]+\[^  \]*(text|TEXT|P|\\\$CODE\\\$)\[^        \]*\[   \]*(\[0-9a-fA-F\]+).*\[0-9\]+\[         \]+\[^  \]*(\\.data|DATA|D_1)\[^        \]*\[   \]*(\[0-9a-fA-F\]+)"
126
127     if ![regexp $want $got all text_name text_size data_name data_size] then {
128         fail "objdump -h ($testfile, $dumpfile)"
129     } else {
130         verbose "text name is $text_name size is $text_size"
131         verbose "data name is $data_name size is $data_size"
132         set ets 8
133         set eds 4
134         # The [ti]c4x target has the property sizeof(char)=sizeof(long)=1
135         if [istarget *c4x*-*-*] then {
136             set ets 2
137             set eds 1
138         }
139         # c54x section sizes are in bytes, not octets; adjust accordingly
140         if [istarget *c54x*-*-*] then {
141             set ets 4
142             set eds 2
143         }
144         if {[expr "0x$text_size"] < $ets || [expr "0x$data_size"] < $eds} then {
145             send_log "sizes too small\n"
146             fail "objdump -h ($testfile, $dumpfile)"
147         } else {
148             pass "objdump -h ($testfile, $dumpfile)"
149         }
150     }
151 }
152
153 test_objdump_h $testfile $testfile
154 if { [ remote_file host exists $testarchive ] } then {
155     test_objdump_h $testarchive bintest2.o
156 }
157
158 # Test objdump -t
159
160 proc test_objdump_t { testfile} {
161     global OBJDUMP
162     global OBJDUMPFLAGS
163
164     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -t $testfile"]
165
166     if [info exists vars] then { unset vars }
167     while {[regexp "(\[a-z\]*_symbol)(.*)" $got all symbol rest]} {
168         set vars($symbol) 1
169         set got $rest
170     }
171
172     if {![info exists vars(text_symbol)] \
173          || ![info exists vars(data_symbol)] \
174          || ![info exists vars(common_symbol)] \
175          || ![info exists vars(external_symbol)]} then {
176         fail "objdump -t ($testfile)"
177     } else {
178         pass "objdump -t ($testfile)"
179     }
180 }
181
182 test_objdump_t $testfile
183 if { [ remote_file host exists $testarchive ] } then {
184     test_objdump_t $testarchive
185 }
186
187 # Test objdump -r
188
189 proc test_objdump_r { testfile dumpfile } {
190     global OBJDUMP
191     global OBJDUMPFLAGS
192
193     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -r $testfile"]
194
195     set want "$dumpfile:\[      \]*file format.*RELOCATION RECORDS FOR \\\[\[^\]\]*(text|TEXT|P|\\\$CODE\\\$)\[^\]\]*\\\].*external_symbol"
196
197     if [regexp $want $got] then {
198         pass "objdump -r ($testfile, $dumpfile)"
199     } else {
200         fail "objdump -r ($testfile, $dumpfile)"
201     }
202 }
203
204 test_objdump_r $testfile $testfile
205 if { [ remote_file host exists $testarchive ] } then {
206     test_objdump_r $testarchive bintest2.o
207 }
208
209 # Test objdump -d
210 proc test_objdump_d { testfile dumpfile } {
211     global OBJDUMP
212     global OBJDUMPFLAGS
213
214     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -d $testfile"]
215
216     set want "$dumpfile:.*Disassembly of section"
217     if ![regexp $want $got] then {
218         fail "objdump -d $testfile: No disassembly title"
219         return
220     }
221
222     set want "$dumpfile:.*00+0 <text_symbol>"
223     if ![regexp $want $got] then {
224         fail "objdump -d $testfile: Missing symbol name and address"
225         return
226     }
227
228     set want "$dumpfile:.*00+. <text_symbol2>"
229     if ![regexp $want $got] then {
230         fail "objdump -d $testfile: Missing second symbol"
231         return
232     }
233
234     set want "$dumpfile:.*00+. <text_symbol3>"
235     if ![regexp $want $got] then {
236         fail "objdump -d $testfile: Missing third symbol"
237         return
238     }
239
240     pass "objdump -d $testfile"
241 }
242
243 test_objdump_d $testfile $testfile
244 if { [ remote_file host exists $testarchive ] } then {
245     test_objdump_d $testarchive bintest2.o
246 }
247
248 # Test objdump --disassemble=<symbol>
249 proc test_objdump_d_sym { testfile dumpfile } {
250     global OBJDUMP
251     global OBJDUMPFLAGS
252
253     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS --disassemble=text_symbol2 $testfile"]
254
255     set want "$dumpfile:.*Disassembly of section"
256     if ![regexp $want $got] then {
257         fail "objdump --disassemble=text_symbol2 $testfile: No disassembly title"
258         return
259     }
260
261     set want "$dumpfile:.*00+0 <text_symbol>"
262     if [regexp $want $got] then {
263         fail "objdump --disassemble=text_symbol2 $testfile: First symbol displayed, when it should be absent"
264         return
265     }
266
267     set want "$dumpfile:.*00+. <text_symbol2>"
268     if ![regexp $want $got] then {
269         fail "objdump --disassemble=text_symbol2 $testfile: Missing second symbol"
270         return
271     }
272
273     set want "$dumpfile:.*00+. <text_symbol3>"
274     if [regexp $want $got] then {
275         fail "objdump --disassemble=text_symbol2 $testfile: Third symbol displayed when it should be absent"
276         return
277     }
278
279     pass "objdump --disassemble=text_symbol2 $testfile"
280 }
281
282 test_objdump_d_sym $testfile $testfile
283 if { [ remote_file host exists $testarchive ] } then {
284     test_objdump_d_sym $testarchive bintest2.o
285 }
286
287
288 # Test objdump -s
289
290 proc test_objdump_s { testfile dumpfile } {
291     global OBJDUMP
292     global OBJDUMPFLAGS
293
294     set got [binutils_run $OBJDUMP "$OBJDUMPFLAGS -s $testfile"]
295
296     set want "$dumpfile:\[      \]*file format.*Contents.*(text|TEXT|P|\\\$CODE\\\$)\[^0-9\]*\[         \]*\[0-9a-fA-F\]*\[     \]*(00000001|01000000|00000100).*Contents.*(data|DATA|D_1)\[^0-9\]*\[   \]*\[0-9a-fA-F\]*\[     \]*(00000002|02000000|00000200)"
297
298     if [regexp $want $got] then {
299         pass "objdump -s ($testfile, $dumpfile)"
300     } else {
301         fail "objdump -s ($testfile, $dumpfile)"
302     }
303 }
304
305 test_objdump_s $testfile $testfile
306 if { [ remote_file host exists $testarchive ] } then {
307     test_objdump_s $testarchive bintest2.o
308 }
309
310 # Test objdump -s on a file that contains a compressed .debug section
311
312 if { ![is_elf_format] } then {
313     unsupported "objdump compressed debug"
314 } elseif { ![binutils_assemble $srcdir/$subdir/dw2-compressed.S tmpdir/dw2-compressed.o] } then {
315     fail "objdump compressed debug"
316 } else {
317     if [is_remote host] {
318         set compressed_testfile [remote_download host tmpdir/dw2-compressed.o]
319     } else {
320         set compressed_testfile tmpdir/dw2-compressed.o
321     }
322
323     set got [remote_exec host "$OBJDUMP $OBJDUMPFLAGS -s -j .zdebug_abbrev $compressed_testfile" "" "/dev/null" "objdump.out"]
324
325     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
326         fail "objdump -s -j .zdebug_abbrev (reason: unexpected output)"
327         send_log $got
328         send_log "\n"
329     }
330
331     if { [regexp_diff objdump.out $srcdir/$subdir/objdump.s] } then {
332         fail "objdump -s -j .zdebug_abbrev"
333     } else {
334         pass "objdump -s -j .zdebug_abbrev"
335     }
336
337     # Test objdump -W on a file that contains some compressed .debug sections
338
339     set got [remote_exec host "$OBJDUMP $OBJDUMPFLAGS -W $compressed_testfile" "" "/dev/null" "objdump.out"]
340
341     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
342         fail "objdump -W (reason: unexpected output)"
343         send_log $got
344         send_log "\n"
345     }
346
347     if { [regexp_diff objdump.out $srcdir/$subdir/objdump.W] } then {
348         fail "objdump -W"
349     } else {
350         pass "objdump -W"
351     }
352 }
353
354 # Test objdump -WL on a file that contains line information for multiple files and search directories.
355 # Not supported on mcore and moxie targets because they do not (yet) support the generation
356 # of DWARF2 line debug information.
357
358 if { ![is_elf_format]
359      || [istarget "hppa64*-*-hpux*"]
360      || [istarget "ia64*-*-*"]
361      || [istarget "mcore-*-*"]
362      || [istarget "moxie-*-*"]
363 } then {
364     unsupported "objump decode line"
365 } else {
366     if { [istarget "or1k*-*-*"] } then {
367         set decodedline_testsrc $srcdir/$subdir/dw2-decodedline-1.S
368     } else {
369         set decodedline_testsrc $srcdir/$subdir/dw2-decodedline.S
370     }
371     if { ![binutils_assemble $decodedline_testsrc tmpdir/dw2-decodedline.o] } then {
372         fail "objdump decoded line"
373     }
374
375     if [is_remote host] {
376         set decodedline_testfile [remote_download host tmpdir/dw2-decodedline.o]
377     } else {
378         set decodedline_testfile tmpdir/dw2-decodedline.o
379     }
380
381     set got [remote_exec host "$OBJDUMP $OBJDUMPFLAGS -WL $decodedline_testfile" "" "/dev/null" "objdump.out"]
382
383     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
384         fail "objdump -WL (reason: unexpected output)"
385         send_log $got
386         send_log "\n"
387     }
388
389     if { [regexp_diff objdump.out $srcdir/$subdir/objdump.WL] } then {
390         fail "objdump -WL"
391     } else {
392         pass "objdump -WL"
393     }
394 }
395
396 # Test objdump -W on a file containing debug_ranges information.
397
398 if { ![is_elf_format] } then {
399     unsupported "objdump debug_ranges test"
400 } elseif { ![binutils_assemble $srcdir/$subdir/dw2-ranges.S tmpdir/dw2-ranges.o] } then {
401     fail "objdump debug_ranges test"
402 } else {
403     if [is_remote host] {
404         set ranges_testfile [remote_download host tmpdir/dw2-ranges.o]
405     } else {
406         set ranges_testfile tmpdir/dw2-ranges.o
407     }
408
409     set got [remote_exec host "$OBJDUMP $OBJDUMPFLAGS --dwarf=Ranges $ranges_testfile" "" "/dev/null" "objdump.out"]
410
411     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
412         fail "objdump -W for debug_ranges (reason: unexpected output)"
413         send_log $got
414         send_log "\n"
415     }
416
417     setup_xfail "msp430-*-*" "nds32*-*-*"
418     if { [regexp_diff objdump.out $srcdir/$subdir/dw2-ranges.W] } then {
419         fail "objdump -W for debug_ranges"
420     } else {
421         pass "objdump -W for debug_ranges"
422     }
423 }
424
425 proc test_build_id_debuglink {} {
426     global srcdir
427     global subdir
428     global env
429     global STRIP
430     global OBJCOPY
431     global OBJDUMP
432     global CFLAGS_FOR_TARGET
433     
434     set test "build-id-debuglink"
435
436     # Use a fixed build-id.
437     if { [info exists CFLAGS_FOR_TARGET] } {
438         set save_CFLAGS_FOR_TARGET $CFLAGS_FOR_TARGET
439     }
440     set CFLAGS_FOR_TARGET "-g -Wl,--build-id=0x12345678abcdef01"
441
442     if { [target_compile $srcdir/$subdir/testprog.c tmpdir/testprog exectuable debug] != "" } {
443         unsupported "$test (build)"
444         return
445     }
446
447     if { [info exists save_CFLAGS_FOR_TARGET] } {
448         set CFLAGS_FOR_TARGET $save_CFLAGS_FOR_TARGET
449     } else {
450         unset CFLAGS_FOR_TARGET
451     }
452
453     if { [binutils_run $STRIP "--strip-debug --remove-section=.comment tmpdir/testprog -o tmpdir/testprog.strip"] != "" } {
454         fail "$test (strip debug info)"
455         return
456     }
457
458     if { [binutils_run $OBJCOPY "--only-keep-debug tmpdir/testprog tmpdir/testprog.debug"] != "" } {
459         fail "$test (create separate debug info file)"
460         return
461     }
462
463     set got [remote_exec host "mkdir -p .build-id/12" ]
464     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
465         fail "$test (make debug directory)"
466         return
467     }
468
469     set got [remote_exec host "cp tmpdir/testprog.debug .build-id/12/345678abcdef01.debug"]
470     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
471         fail "$test (copy debug info into debug directory)"
472         return
473     }
474     
475     set got [remote_exec host "$OBJDUMP -Sl tmpdir/testprog.strip" "" "/dev/null" "tmpdir/testprog.strip.dump"]
476     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
477         fail "$test (post strip dump)"
478         return
479     }
480
481     set src2 tmpdir/testprog.strip.dump
482     verbose " grep -e testprog.c ${src2}"
483     set status [remote_exec build grep "-e testprog.c ${src2}"]
484     set exec_output [lindex $status 1]
485     set exec_output [prune_warnings $exec_output]
486     if [string match "" $exec_output] then {
487         send_log "$exec_output\n"
488         verbose "$exec_output" 1
489         fail "$test (grepping for source file name in disassembly output)"
490     } else {
491         pass "$test"
492         # Cleanup...
493         set got [remote_exec host "rm .build-id/12/345678abcdef01.debug"]
494         set got [remote_exec host "rmdir -p .build-id/12" ]
495         set got [remote_exec host "rm tmpdir/testprog.strip.dump"]
496         set got [remote_exec host "rm tmpdir/testprog.debug"]
497         set got [remote_exec host "rm tmpdir/testprog.strip"]
498     }
499 }
500
501 if {[is_elf_format]} then {
502     test_build_id_debuglink
503 }
504
505 # Test objdump -Wk on a file containing debug links.
506
507 if { [is_elf_format] } then {
508     set testsrc $srcdir/$subdir/debuglink.s
509
510     if { ![binutils_assemble $testsrc tmpdir/debuglink.o] } then {
511         fail "objdump -Wk (reason: could not assemble source)"
512     }
513
514     if [is_remote host] {
515         set testfile [remote_download host tmpdir/debuglink.o]
516     } else {
517         set testfile tmpdir/debuglink.o
518     }
519
520     set got [remote_exec host "$OBJDUMP $OBJDUMPFLAGS -Wk $testfile" "" "/dev/null" "objdump.out"]
521
522     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
523         fail "objdump -Wk (reason: unexpected output)"
524         send_log $got
525         send_log "\n"
526     }
527
528     if { [regexp_diff objdump.out $srcdir/$subdir/objdump.Wk] } then {
529         fail "objdump -Wk"
530     } else {
531         pass "objdump -Wk"
532     }
533 }
534
535
536 # Very similar to proc test_build_id_debuglink except this time we
537 # display some of the contents of the separate debug info file.
538
539 proc test_follow_debuglink {} {
540     global srcdir
541     global subdir
542     global OBJDUMP
543     
544     set test "follow-debuglink"
545
546     if {![binutils_assemble $srcdir/$subdir/debuglink.s tmpdir/debuglink.o]} then {
547         fail "$test (reason: assemble first source file)"
548         return
549     }
550
551     if {![binutils_assemble $srcdir/$subdir/linkdebug.s tmpdir/linkdebug.debug]} then {
552         fail "$test (reason: assemble second source file)"
553         return
554     }
555
556     if ![is_remote host] {
557         set tempfile tmpdir/debuglink.o
558     } else {
559         set tempfile [remote_download host tmpdir/linkdebug.debug]
560         set tempfile [remote_download host tmpdir/debuglink.o]
561     }
562     
563     set got [remote_exec host "$OBJDUMP --dwarf=follow-links --dwarf=info --dwarf=str $tempfile" "" "/dev/null" "tmpdir/objdump.out"]
564     if { [lindex $got 0] != 0 || ![string match "" [lindex $got 1]] } then {
565         fail "$test (reason: unexpected error output from objdump)"
566         return
567     }
568
569     if { [regexp_diff tmpdir/objdump.out $srcdir/$subdir/objdump.WK2] } then {
570         fail $test
571         verbose "output is \n[file_contents objdump.out]" 2
572         return
573     }
574
575     pass $test
576
577     # Tidy up
578     set got [remote_exec host "rm tmpdir/objdump.out"]
579     set got [remote_exec host "rm $tempfile"]
580     set got [remote_exec host "rm tmpdir/linkdebug.debug"]
581 }
582
583 if {[is_elf_format]} then {
584     test_follow_debuglink
585 }
586
587 # Options which are not tested: -a -D -R -T -x -l --stabs
588 # I don't see any generic way to test any of these other than -a.
589 # Tests could be written for specific targets, and that should be done
590 # if specific problems are found.