1# Copyright 1998, 2000, 2001, 2002, 2003, 2004, 2007
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 3 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, see <http://www.gnu.org/licenses/>.
16#
17# Please email any bugs, comments, and/or additions to this file to:
18# bug-gdb@prep.ai.mit.edu
19#
20# This file was written by Kendra.
21
22if $tracelevel then {
23    strace $tracelevel
24}
25
26#
27# Test debugging assembly level programs.
28# This file uses asmsrc[12].s for input.
29#
30
31set prms_id 0
32set bug_id 0
33
34set asm-arch ""
35set asm-note "empty"
36set asm-flags ""
37set link-flags "-e _start"
38set debug-flags ""
39
40switch -glob -- [istarget] {
41    "alpha*-*-*" {
42        set asm-arch alpha
43	# ??? Won't work with ecoff systems like Tru64, but then we also
44	# don't have any other -g flag that creates mdebug output.
45        set asm-flags "-no-mdebug -I${srcdir}/${subdir} -I${objdir}/${subdir}"
46	set debug-flags "-gdwarf-2"
47    }
48    "*arm-*-*" {
49        set asm-arch arm
50    }
51    "xscale-*-*" {
52        set asm-arch arm
53    }
54    "frv-*-*" {
55	set asm-arch frv
56    }
57    "s390-*-*" {
58        set asm-arch s390
59    }
60    "s390x-*-*" {
61        set asm-arch s390x
62    }
63    "x86_64-*-*" {
64        set asm-arch x86_64
65	set debug-flags "-gdwarf-2"
66    }
67    "i\[3456\]86-*-*" {
68        set asm-arch i386
69    }
70    "m32r*-linux*" {
71        set asm-arch m32r-linux
72    }
73    "m32c-*-*" {
74        set asm-arch m32c
75    }
76    "m32r*-*" {
77        set asm-arch m32r
78        append link-flags "--whole-archive -lgloss --no-whole-archive"
79    }
80    "m6811-*-*" {
81        set asm-arch m68hc11
82        set asm-flags "-mshort-double -m68hc11 --no-warn -I${srcdir}/${subdir} -I${objdir}/${subdir}"
83	set debug-flags "-gdwarf-2"
84	# This asm test is specific and uses the linker directly.
85	# We must not use the target board linker script defined for other
86	# tests.  Remove it and restore it later on.
87	set board [target_info name]
88	set old_ldscript [board_info $board ldscript]
89	unset_board_info "ldscript"
90    }
91    "m6812-*-*" {
92        set asm-arch m68hc11
93        set asm-flags "-mshort-double -m68hc12 --no-warn -I${srcdir}/${subdir} -I${objdir}/${subdir}"
94	set debug-flags "-gdwarf-2"
95	# This asm test is specific and uses the linker directly.
96	# We must not use the target board linker script defined for other
97	# tests.  Remove it and restore it later on.
98	set board [target_info name]
99	set old_ldscript [board_info $board ldscript]
100	set_board_info ldscript ""
101    }
102    "mips*-*" {
103        set asm-arch mips
104    }
105    "powerpc*-*" {
106        set asm-arch powerpc
107    }
108    "sh*-*-*" {
109        set asm-arch sh
110	set debug-flags "-gdwarf-2"
111    }
112    "sparc-*-*" {
113        set asm-arch sparc
114    }
115    "sparc64-*-*" {
116        set asm-arch sparc64
117        set asm-flags "-xarch=v9 -I${srcdir}/${subdir} -I${objdir}/${subdir}"
118	set debug-flags "-gdwarf-2"
119    }
120    "spu*-*-*" {
121       set asm-arch spu
122       set asm-flags "-I${srcdir}/${subdir} -I${objdir}/${subdir} --no-warn"
123       set debug-flags "-gdwarf-2"
124    }
125    "xstormy16-*-*" {
126        set asm-arch xstormy16
127	set debug-flags "-gdwarf-2"
128    }
129    "v850-*-*" {
130        set asm-arch v850
131        set gdb_wrapper_initialized 1
132    }
133    "m68k-*-*" {
134        set asm-arch m68k
135    }
136    "ia64-*-*" {
137        set asm-arch ia64
138	set debug-flags "-gdwarf-2"
139    }
140    "iq2000-*-*" {
141    	set asm-arch iq2000
142    }
143    "hppa*-linux-*" {
144        set asm-arch pa
145	set debug-flags "-gdwarf-2"
146    }
147    "hppa-*-openbsd*" {
148        set asm-arch pa
149	set debug-flags "-gdwarf-2"
150    }
151    "hppa64-*-hpux*" {
152        set asm-arch pa64
153	set debug-flags "-gdwarf-2"
154    }
155    "h83*-*" {
156	set asm-arch h8300
157        set debug-flags "-gdwarf-2"
158    }
159}
160
161if { "${asm-arch}" == "" } {
162    untested asm-source.exp
163    return -1
164}
165
166# On NetBSD/ELF we need a special NetBSD-identifying note section.
167if { [istarget "*-*-netbsdelf*"]
168     || [istarget "alpha-*-netbsd*"]
169     || [istarget "mips*-*-netbsd*"]
170     || [istarget "powerpc-*-netbsd*"]
171     || [istarget "x86_64-*-netbsd*"] } then {
172    set asm-note "netbsd"
173}
174
175# On OpenBSD/ELF we need a similar note section.  We make no attempt
176# of handing a.out here since most OpenBSD/a.out systems use a rather
177# outdated assembler that doesn't assemble this test's code anyway.
178if { [istarget "*-*-openbsd*"] } then {
179    set asm-note "openbsd"
180}
181
182# Watch out, we are invoking the assembler, but the testsuite sets multilib
183# switches according to compiler syntax.  If we pass these options straight
184# to the assembler, they won't always make sense.  If we don't pass them to
185# the assembler, the final link will complain that the object files were
186# built with different defaults.  So no matter what we do, we lose.  We may as
187# well get out of this test sooner rather than later.
188set dest [target_info name]
189if [board_info $dest exists multilib_flags] {
190	set multilib_flags [board_info $dest multilib_flags]
191	if { "${multilib_flags}" != "" } {
192	   untested asm-source.exp
193	   return -1
194	   return;
195	 }
196}
197
198set testfile "asm-source"
199set binfile ${objdir}/${subdir}/${testfile}
200set srcfile1 asmsrc1.s
201set srcfile2 asmsrc2.s
202
203remote_exec build "rm -f ${subdir}/arch.inc"
204remote_download host ${srcdir}/${subdir}/${asm-arch}.inc ${subdir}/arch.inc
205remote_exec build "rm -f ${subdir}/note.inc"
206remote_download host ${srcdir}/${subdir}/${asm-note}.inc ${subdir}/note.inc
207
208if { [string equal ${asm-flags} ""] } {
209    set asm-flags "-I${srcdir}/${subdir} -I${objdir}/${subdir}"
210}
211
212if { [string equal ${debug-flags} ""] } {
213    set debug-flags "-gstabs"
214}
215
216# Allow the target board to override the debug flags.
217if { [board_info $dest exists debug_flags] } then {
218    set debug-flags "[board_info $dest debug_flags]"
219}
220
221# The debug flags are in the format that gcc expects:
222# "-gdwarf-2", "-gstabs+", or "-gstabs".  To be compatible with the
223# other languages in the test suite, we accept this input format.
224# So the user can run the test suite with:
225#
226#   runtest --target_board unix/gdb:debug_flags=-gdwarf-2
227#   make check RUNTESTFLAGS="--target_board unix/gdb:debug_flags=-gdwarf-2"
228#
229# However, the GNU assembler has different spellings than gcc.
230# So I adjust the debug flags here.
231
232# The GNU assembler spells "dwarf-2" as "dwarf2".
233regsub "--" "-gdwarf-2" "${debug-flags}" "-gdwarf2" debug-flags
234
235# The GNU assembler before 2.15 did not support "stabs+".
236regsub "--" "-gstabs\[+\]" "${debug-flags}" "-gstabs" debug-flags
237
238# The GNU assembler does not support level options like "-g2" or "-g3".
239regsub "--" "-g\[0-9\]" "${debug-flags}" "" debug-flags
240
241if {[target_assemble ${srcdir}/${subdir}/${srcfile1} asmsrc1.o "${asm-flags} ${debug-flags}"] != ""} then {
242     untested asm-source.exp
243     return -1
244}
245if {[target_assemble ${srcdir}/${subdir}/${srcfile2} asmsrc2.o "${asm-flags} ${debug-flags}"] != ""} then {
246     untested asm-source.exp
247     return -1
248}
249
250# We deliberately don't use gdb_compile here to link together the
251# assembled object files.  Using gdb_compile, and therefore the C
252# compiler, is conceptually wrong, since we're testing raw assembler
253# code here that provides its own startup code.  Using target_link
254# also avoids a lot of problems on many systems, most notably on
255# *-*-*bsd* and *-*-solaris2*.
256if {[target_link "asmsrc1.o asmsrc2.o" "${binfile}" ${link-flags}] != "" } then {
257     untested asm-source.exp
258     return -1
259}
260
261# Restore the target board linker script for HC11/HC12.
262if { [istarget "m6811-*-*"] || [istarget "m6812-*-*"] } {
263    set_board_info ldscript $old_ldscript
264}
265
266remote_exec build "mv asmsrc1.o asmsrc2.o ${objdir}/${subdir}"
267
268
269gdb_start
270gdb_reinitialize_dir $srcdir/$subdir
271gdb_load ${binfile}
272
273#
274# Run to `main' where we begin our tests.
275#
276
277if ![runto_main] then {
278    gdb_suppress_tests
279}
280
281# Execute the `f' command and see if the result includes source info.
282gdb_test "f" "asmsrc1\[.\]s:29.*several_nops" "f at main"
283
284# See if we properly `next' over a macro with several insns.
285gdb_test "n" "33\[ 	\]*.*foo2" "next over macro"
286
287# See if we can properly `step' into a subroutine call.
288gdb_test "s" "8\[ 	\]*.*" "step into foo2"
289
290# Test 'info target', and incidentally capture the entry point address.
291set entry_point 0
292send_gdb "info target\n"
293gdb_expect {
294    -re "Symbols from .*asm-source.*Entry point: 0x(\[01232456789abcdefABCDEF\]+).*$gdb_prompt $" {
295	set entry_point $expect_out(1,string)
296	pass "info target"
297    }
298    -re ".*$gdb_prompt $" {
299	fail "info target"
300    }
301    timeout {
302	fail "info target (timeout)"
303    }
304}
305
306# Capture the start symbol (may be '_start' or 'start')
307set entry_symbol ""
308send_gdb "info symbol 0x$entry_point\n"
309gdb_expect {
310    -re "info symbol 0x$entry_point\[\r\n\]+(\[^\r\n\]*) in section .*$gdb_prompt $" {
311        # We match the echoed `info symbol' command here, to help us
312        # reliably identify the beginning of the start symbol in the
313        # command's output.  You might think we could just use '^' to
314        # start matching at the beginning of the line, but
315        # unfortunately, in Expect, '^' matches the beginning of the
316        # input that hasn't been matched by any expect clause yet.  If
317        # every expect clause consumes a complete line, along with its
318        # terminating CR/LF, this is equivalent to the beginning of a
319        # line.  But expect clauses that end with `.*' will consume as
320        # much as happened to arrive from the TTY --- exactly where
321        # they leave you depends on inter-process timing.  :(
322	set entry_symbol $expect_out(1,string)
323	pass "info symbol"
324    }
325    -re ".*$gdb_prompt $" {
326	fail "info symbol"
327    }
328    timeout {
329	fail "info symbol (timeout)"
330    }
331}
332
333# Now try a 'list' from the other source file.
334gdb_test "list $entry_symbol" ".*gdbasm_startup.*" "list"
335
336# Now try a source file search
337gdb_test "search A routine for foo2 to call" \
338	"40\[ \t\]+comment \"A routine for foo2 to call.\"" "search"
339
340# See if `f' prints the right source file.
341gdb_test "f" ".*asmsrc2\[.\]s:8.*" "f in foo2"
342
343# `next' one insn (or macro) to set up our stackframe (for the following bt).
344gdb_test "n" "12\[ 	\]*.*foo3" "n in foo2"
345
346# See if a simple `bt' prints the right source files and
347# doesn't fall off the stack.
348
349gdb_test "bt 10" \
350	"\#0.*foo2.*asmsrc2\[.\]s:12.*\#1.*main.*asmsrc1\[.\]s:33" \
351	"bt ALL in foo2"
352
353# See if a capped `bt' prints the right source files.
354gdb_test "bt 2" "\#0.*foo2.*asmsrc2\[.\]s:12.*\#1.*main.*asmsrc1\[.\]s:33.*" "bt 2 in foo2"
355
356# Step into another subroutine which lives back in the first source file.
357gdb_test "s" "" "s 2"
358
359# Next over insns to set up the stack frame.
360gdb_test "n" "" "n 2"
361
362# Now see if a capped `bt' is correct.
363gdb_test "bt 3" "\#0.*foo3.*asmsrc1\[.\]s:45.*\#1.*foo2.*asmsrc2\[.\]s:12.*\#2.*main.*asmsrc1\[.\]s:33.*" "bt 3 in foo3"
364
365# Try 'info source' from asmsrc1.s
366gdb_test "info source" \
367	"Current source file is .*asmsrc1.s.*Source language is asm.*" \
368	"info source asmsrc1.s"
369
370# Try 'finishing' from foo3
371gdb_test "finish" "Run till exit from.*\[\r\n\]13\[ \t\]+gdbasm_call foo3" \
372	"finish from foo3"
373
374# Try 'info source' from asmsrc2.s
375gdb_test "info source" \
376	"Current source file is .*asmsrc2.s.*Source language is asm.*" \
377	"info source asmsrc2.s"
378
379# Try 'info sources'.  This can produce a lot of output on systems
380# with dynamic linking, where the system's shared libc was compiled
381# with debugging info; for example, on Linux, this produces 47kb of
382# output.  So we consume it as we go.
383send_gdb "info sources\n"
384set seen_asmsrc_1 0
385set seen_asmsrc_2 0
386gdb_expect {
387    -re "^\[^,\]*asmsrc1.s(, |\[\r\n\]+)" {
388        set seen_asmsrc_1 1
389        exp_continue
390    }
391    -re "^\[^,\]*asmsrc2.s(, |\[\r\n\]+)" {
392        set seen_asmsrc_2 1
393        exp_continue
394    }
395    -re ", " {
396        exp_continue
397    }
398    -re "$gdb_prompt $" {
399        if {$seen_asmsrc_1 && $seen_asmsrc_2} {
400            pass "info sources"
401        } else {
402            fail "info sources"
403        }
404    }
405    timeout {
406            fail "info sources (timeout)"
407    }
408}
409
410
411# Try 'info line'
412gdb_test "info line" \
413	"Line 13 of.*asmsrc2.s.*starts at.*<foo2+.*> and ends at.*<foo2+.*>." \
414	"info line"
415
416# Try 'nexting' over next call to foo3
417gdb_test "next" "17\[ \t\]+gdbasm_leave" "next over foo3"
418
419# Try 'return' from foo2
420gdb_test "return" "\#0  main .*37\[ \t\]+gdbasm_exit0" "return from foo2" \
421	"Make (foo2|selected stack frame) return now\?.*" "y"
422
423# Disassemble something, check the output
424proc test_dis { command var } {
425    global gdb_prompt
426    send_gdb "${command}\n"
427    gdb_expect {
428	-re "${var}.*:.*(Cannot access|Bad address)" {
429	    # The "disassembler" was only accessing the local
430	    # executable and that would cause attempts to disassemble
431	    # variables to fail (memory not valid).
432	    fail "${command} (memory read error)"
433	}
434	-re "${var}.*:.*${gdb_prompt}" {
435	    pass "${command}"
436	}
437	timeout {
438	    fail "${command} (timeout)"
439	}
440    }
441}
442
443# See if we can look at a global variable, three ways
444gdb_test "print globalvar" ".* = 11" "look at global variable"
445test_dis "x/i &globalvar" "globalvar"
446test_dis "disassem &globalvar &globalvar+1" "globalvar"
447
448# See if we can look at a static variable, three ways
449gdb_test "print staticvar" ".* = 5" "look at static variable"
450test_dis "x/i &staticvar" "staticvar"
451test_dis "disassem &staticvar &staticvar+1" "staticvar"
452
453# See if we can look at a static function
454gdb_test "disassem foostatic" ".*<foostatic\\+0>:.*End of assembler dump." \
455	"look at static function"
456
457remote_exec build "rm -f ${subdir}/arch.inc"
458remote_exec build "rm -f ${subdir}/note.inc"
459