1 # This testcase is part of GDB, the GNU debugger.
3 # Copyright 2004 Free Software Foundation, Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 # Test "return", "finish", and "call" of functions that a scalar (int,
20 # float, enum) and/or take a single scalar parameter.
29 # Some targets can't call functions, so don't even bother with this
32 if [target_info exists gdb,cannot_call_functions] {
34 fail "This target can not call functions"
38 set testfile "call-sc"
39 set srcfile ${testfile}.c
40 set binfile ${objdir}/${subdir}/${testfile}
42 # Create and source the file that provides information about the
43 # compiler used to compile the test case.
45 if [get_compiler_info ${binfile}] {
49 # Use the file name, compiler and tuples to set up any needed KFAILs.
51 proc setup_kfails { file tuples bug } {
53 if [string match $file $testfile] {
54 foreach f $tuples { setup_kfail $f $bug }
58 proc setup_compiler_kfails { file compiler format tuples bug } {
60 if {[string match $file $testfile] && [test_compiler_info $compiler] && [test_debug_format $format]} {
61 foreach f $tuples { setup_kfail $f $bug }
65 # Compile a variant of scalars.c using TYPE to specify the type of the
66 # parameter and return-type. Run the compiled program up to "main".
67 # Also updates the global "testfile" to reflect the most recent build.
69 proc start_scalars_test { type } {
79 # Create the additional flags
80 set flags "debug additional_flags=-DT=${type}"
81 set testfile "call-sc-${type}"
83 set binfile ${objdir}/${subdir}/${testfile}
84 if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable "${flags}"] != "" } {
85 # built the second test case since we can't use prototypes
86 warning "Prototypes not supported, rebuilding with -DNO_PROTOTYPES"
87 if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable "${flags} additional_flags=-DNO_PROTOTYPES"] != "" } {
88 gdb_suppress_entire_file "Testcase compile failed, so all tests in this file will automatically fail."
92 # Start with a fresh gdb.
95 gdb_reinitialize_dir $srcdir/$subdir
98 # Make certain that the output is consistent
99 gdb_test "set print sevenbit-strings" "" \
100 "set print sevenbit-strings; ${testfile}"
101 gdb_test "set print address off" "" \
102 "set print address off; ${testfile}"
103 gdb_test "set width 0" "" \
104 "set width 0; ${testfile}"
107 if { ![runto_main] } then {
111 # Get the debug format
114 # check that type matches what was passed in
115 set test "ptype; ${testfile}"
117 gdb_test_multiple "ptype ${type}" "${test}" {
118 -re "type = (\[^\r\n\]*)\r\n$gdb_prompt $" {
119 set foo_t "$expect_out(1,string)"
120 pass "$test (${foo_t})"
123 gdb_test "ptype foo" "type = ${foo_t}" "ptype foo; ${testfile} $expect_out(1,string)"
127 # Given N (0..25), return the corresponding alphabetic letter in lower
128 # or upper case. This is ment to be i18n proof.
131 return [string range "abcdefghijklmnopqrstuvwxyz" $n $n]
135 return [string toupper [i2a $n]]
139 # Use the file name, compiler and tuples to set up any needed KFAILs.
141 proc setup_kfails { file tuples bug } {
143 if [string match $file $testfile] {
144 foreach f $tuples { setup_kfail $f $bug }
148 proc setup_compiler_kfails { file compiler format tuples bug } {
150 if {[string match $file $testfile] && [test_compiler_info $compiler] && [test_debug_format $format]} {
151 foreach f $tuples { setup_kfail $f $bug }
155 # Test GDB's ability to make inferior function calls to functions
156 # returning (or passing) in a single scalar.
158 # start_scalars_test() will have previously built a program with a
159 # specified scalar type. To ensure robustness of the output, "p/c" is
162 # This tests the code paths "which return-value convention?" and
163 # "extract return-value from registers" called by "infcall.c".
165 proc test_scalar_calls { } {
169 # Check that GDB can always extract a scalar-return value from an
170 # inferior function call. Since GDB always knows the location of
171 # an inferior function call's return value these should never fail
173 # Implemented by calling the parameterless function "fun" and then
174 # examining the return value printed by GDB.
176 set tests "call ${testfile}"
178 # Call fun, checking the printed return-value.
179 gdb_test "p/c fun()" "= 49 '1'" "p/c fun(); ${tests}"
181 # Check that GDB can always pass a structure to an inferior function.
182 # This test can never fail.
184 # Implemented by calling the one parameter function "Fun" which
185 # stores its parameter in the global variable "L". GDB then
186 # examining that global to confirm that the value is as expected.
188 gdb_test "call Fun(foo)" "" "call Fun(foo); ${tests}"
189 gdb_test "p/c L" " = 49 '1'" "p/c L; ${tests}"
192 # Test GDB's ability to both return a function (with "return" or
193 # "finish") and correctly extract/store any corresponding
196 # Check that GDB can consistently extract/store structure return
197 # values. There are two cases - returned in registers and returned in
198 # memory. For the latter case, the return value can't be found and a
199 # failure is "expected". However GDB must still both return the
200 # function and display the final source and line information.
202 # N identifies the number of elements in the struct that will be used
203 # for the test case. FAILS is a list of target tuples that will fail
206 # This tests the code paths "which return-value convention?", "extract
207 # return-value from registers", and "store return-value in registers".
208 # Unlike "test struct calls", this test is expected to "fail" when the
209 # return-value is in memory (GDB can't find the location). The test
210 # is in three parts: test "return"; test "finish"; check that the two
211 # are consistent. GDB can sometimes work for one command and not the
214 proc test_scalar_returns { } {
218 set tests "return ${testfile}"
221 # Check that "return" works.
223 # GDB must always force the return of a function that has
224 # a struct result. Dependant on the ABI, it may, or may not be
225 # possible to store the return value in a register.
227 # The relevant code looks like "L{n} = fun{n}()". The test forces
228 # "fun{n}" to "return" with an explicit value. Since that code
229 # snippet will store the the returned value in "L{n}" the return
230 # is tested by examining "L{n}". This assumes that the
231 # compiler implemented this as fun{n}(&L{n}) and hence that when
232 # the value isn't stored "L{n}" remains unchanged. Also check for
233 # consistency between this and the "finish" case.
235 # Get into a call of fun
236 gdb_test "advance fun" \
237 "fun .*\[\r\n\]+\[0-9\].*return foo.*" \
238 "advance to fun for return; ${tests}"
240 # Check that the program invalidated the relevant global.
241 gdb_test "p/c L" " = 90 'Z'" "zed L for return; ${tests}"
243 # Force the "return". This checks that the return is always
244 # performed, and that GDB correctly reported this to the user.
245 # GDB 6.0 and earlier, when the return-value's location wasn't
246 # known, both failed to print a final "source and line" and misplaced
247 # the frame ("No frame").
249 # The test is writen so that it only reports one FAIL/PASS for the
250 # entire operation. The value returned is checked further down.
251 # "return_value_unknown", if non-empty, records why GDB realised
252 # that it didn't know where the return value was.
254 set test "return foo; ${tests}"
255 set return_value_unknown 0
256 set return_value_unimplemented 0
257 gdb_test_multiple "return foo" "${test}" {
259 # Ulgh, a struct return, remember this (still need prompt).
260 set return_value_unknown 1
263 -re "A structure or union" {
264 # Ulgh, a struct return, remember this (still need prompt).
265 set return_value_unknown 1
266 # Double ulgh. Architecture doesn't use return_value and
267 # hence hasn't implemented small structure return.
268 set return_value_unimplemented 1
271 -re "Make fun return now.*y or n. $" {
272 gdb_test_multiple "y" "${test}" {
273 -re "L *= fun.*${gdb_prompt} $" {
274 # Need to step off the function call
275 gdb_test "next" "zed.*" "${test}"
277 -re "L[expr + 1] *= fun[expr + 1].*${gdb_prompt} $" {
284 # Check that the return-value is as expected. At this stage we're
285 # just checking that GDB has returned a value consistent with
286 # "return_value_unknown" set above.
288 set test "value foo returned; ${tests}"
289 setup_kfails call-sc-tc x86_64-*-* gdb/1624
290 setup_kfails call-sc-ts x86_64-*-* gdb/1624
291 setup_kfails call-sc-ti x86_64-*-* gdb/1624
292 setup_kfails call-sc-tl x86_64-*-* gdb/1624
293 setup_kfails call-sc-tll x86_64-*-* gdb/1624
294 setup_kfails call-sc-tld x86_64-*-* gdb/1624
295 setup_kfails call-sc-te x86_64-*-* gdb/1624
296 gdb_test_multiple "p/c L" "${test}" {
297 -re " = 49 '1'.*${gdb_prompt} $" {
298 if $return_value_unknown {
299 # This contradicts the above claim that GDB didn't
300 # know the location of the return-value.
306 -re " = 90 .*${gdb_prompt} $" {
307 if $return_value_unknown {
308 # The struct return case. Since any modification
309 # would be by reference, and that can't happen, the
310 # value should be unmodified and hence Z is expected.
311 # Is this a reasonable assumption?
314 # This contradicts the above claim that GDB knew
315 # the location of the return-value.
319 -re ".*${gdb_prompt} $" {
320 if $return_value_unimplemented {
321 # What a suprize. The architecture hasn't implemented
322 # return_value, and hence has to fail.
323 kfail "$test" gdb/1444
330 # Check that a "finish" works.
332 # This is almost but not quite the same as "call struct funcs".
333 # Architectures can have subtle differences in the two code paths.
335 # The relevant code snippet is "L{n} = fun{n}()". The program is
336 # advanced into a call to "fun{n}" and then that function is
337 # finished. The returned value that GDB prints, reformatted using
341 gdb_test "advance fun" \
342 "fun .*\[\r\n\]+\[0-9\].*return foo.*" \
343 "advance to fun for finish; ${tests}"
345 # Check that the program invalidated the relevant global.
346 gdb_test "p/c L" " = 90 'Z'" "zed L for finish; ${tests}"
348 # Finish the function, set 'finish_value_unknown" to non-empty if the
349 # return-value was not found.
350 set test "finish foo; ${tests}"
351 set finish_value_unknown 0
352 gdb_test_multiple "finish" "${test}" {
353 -re "Value returned is .*${gdb_prompt} $" {
356 -re "Cannot determine contents.*${gdb_prompt} $" {
357 # Expected bad value. For the moment this is ok.
358 set finish_value_unknown 1
363 # Re-print the last (return-value) using the more robust
364 # "p/c". If no return value was found, the 'Z' from the previous
365 # check that the variable was cleared, is printed.
366 set test "value foo finished; ${tests}"
367 gdb_test_multiple "p/c" "${test}" {
368 -re " = 49 '1'\[\r\n\]+${gdb_prompt} $" {
369 if $finish_value_unknown {
370 # This contradicts the above claim that GDB didn't
371 # know the location of the return-value.
377 -re " = 90 'Z'\[\r\n\]+${gdb_prompt} $" {
378 # The value didn't get found. This is "expected".
379 if $finish_value_unknown {
382 # This contradicts the above claim that GDB did
383 # know the location of the return-value.
389 # Finally, check that "return" and finish" have consistent
392 # Since both "return" and "finish" use equivalent "which
393 # return-value convention" logic, both commands should have
394 # identical can/can-not find return-value messages.
396 # Note that since "call" and "finish" use common code paths, a
397 # failure here is a strong indicator of problems with "store
398 # return-value" code paths. Suggest looking at "return_value"
399 # when investigating a fix.
401 set test "return and finish use same convention; ${tests}"
402 if {$finish_value_unknown == $return_value_unknown} {
405 kfail gdb/1444 "${test}"
409 # ABIs pass anything >8 or >16 bytes in memory but below that things
410 # randomly use register and/and structure conventions. Check all
411 # possible sized char scalars in that range. But only a restricted
412 # range of the other types.
414 # NetBSD/PPC returns "unnatural" (3, 5, 6, 7) sized scalars in memory.
416 # d10v is weird. 5/6 byte scalars go in memory. 2 or more char
417 # scalars go in memory. Everything else is in a register!
419 # Test every single char struct from 1..17 in size. This is what the
420 # original "scalars" test was doing.
422 start_scalars_test tc
429 # Assuming that any integer struct larger than 8 bytes goes in memory,
430 # come up with many and varied combinations of a return struct. For
431 # "struct calls" test just beyond that 8 byte boundary, for "struct
432 # returns" test up to that boundary.
434 # For floats, assumed that up to two struct elements can be stored in
435 # floating point registers, regardless of their size.
437 # The approx size of each structure it is computed assumed that tc=1,
438 # ts=2, ti=4, tl=4, tll=8, tf=4, td=8, tld=16, and that all fields are
439 # naturally aligned. Padding being added where needed. Note that
440 # these numbers are just approx, the d10v has ti=2, a 64-bit has has
443 # Approx size: 2, 4, ...
444 start_scalars_test ts
448 # Approx size: 4, 8, ...
449 start_scalars_test ti
453 # Approx size: 4, 8, ...
454 start_scalars_test tl
458 # Approx size: 8, 16, ...
459 start_scalars_test tll
463 # Approx size: 4, 8, ...
464 start_scalars_test tf
468 # Approx size: 8, 16, ...
469 start_scalars_test td
473 # Approx size: 16, 32, ...
474 start_scalars_test tld
478 # Approx size: 4, 8, ...
479 start_scalars_test te