# This testcase is part of GDB, the GNU debugger. # Copyright 1996, 1997, 1999, 2003 Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # Please email any bugs, comments, and/or additions to this file to: # bug-gdb@prep.ai.mit.edu if $tracelevel then { strace $tracelevel } set prms_id 0 set bug_id 0 # Some targets can't call functions, so don't even bother with this # test. if [target_info exists gdb,cannot_call_functions] { setup_xfail "*-*-*" fail "This target can not call functions" continue } set testfile "structs" set srcfile ${testfile}.c set binfile ${objdir}/${subdir}/${testfile} # Create and source the file that provides information about the # compiler used to compile the test case. if [get_compiler_info ${binfile}] { return -1; } # Compile a variant of structs.c using TYPES to specify the type of # the first N struct elements (the remaining elements take the type of # the last TYPES field). Run the compmiled program up to "main". # Also updates the global "testfile" to reflect the most recent build. proc start_structs_test { types } { global testfile global srcfile global binfile global objdir global subdir global srcdir global gdb_prompt # Create the additional flags set flags "debug" set testfile "structs" set n 0 for {set n 0} {$n<[llength ${types}]} {incr n} { set m [I2A ${n}] set t [lindex ${types} $n] lappend flags "additional_flags=-Dt${m}=${t}" append testfile "-" "$t" } set binfile ${objdir}/${subdir}/${testfile} if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable "${flags}"] != "" } { # built the second test case since we can't use prototypes warning "Prototypes not supported, rebuilding with -DNO_PROTOTYPES" if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable "${flags} additional_flags=-DNO_PROTOTYPES"] != "" } { gdb_suppress_entire_file "Testcase compile failed, so all tests in this file will automatically fail." } } # Start with a fresh gdb. gdb_start gdb_reinitialize_dir $srcdir/$subdir gdb_load ${binfile} # Make certain that the output is consistent gdb_test "set print sevenbit-strings" "" \ "set print sevenbit-strings; ${testfile}" gdb_test "set print address off" "" \ "set print address off; ${testfile}" gdb_test "set width 0" "" \ "set width 0; ${testfile}" # Advance to main if { ![runto_main] } then { gdb_suppress_tests; } # check that at the struct containing all the relevant types is correct set foo_t "type = struct struct[llength ${types}] \{" for {set n 0} {$n<[llength ${types}]} {incr n} { append foo_t "\[\r\n \]+[lindex ${types} $n] [i2a $n];" } append foo_t "\[\r\n \]+\}" gdb_test "ptype foo[llength ${types}]" "${foo_t}" \ "ptype foo[llength ${types}]; ${testfile}" } # The expected value for fun${n}, L${n} and foo${n}. First element is # empty to make indexing easier. "foo" returns the modified value, # "zed" returns the invalid value. proc foo { n } { return [lindex { "{}" "{a = 49 '1'}" "{a = 97 'a', b = 50 '2'}" "{a = 49 '1', b = 98 'b', c = 51 '3'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6', g = 103 'g', h = 56 '8'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7', h = 104 'h', i = 57 '9'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6', g = 103 'g', h = 56 '8', i = 105 'i', j = 65 'A'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7', h = 104 'h', i = 57 '9', j = 106 'j', k = 66 'B'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6', g = 103 'g', h = 56 '8', i = 105 'i', j = 65 'A', k = 107 'k', l = 67 'C'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7', h = 104 'h', i = 57 '9', j = 106 'j', k = 66 'B', l = 108 'l', m = 68 'D'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6', g = 103 'g', h = 56 '8', i = 105 'i', j = 65 'A', k = 107 'k', l = 67 'C', m = 109 'm', n = 69 'E'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7', h = 104 'h', i = 57 '9', j = 106 'j', k = 66 'B', l = 108 'l', m = 68 'D', n = 110 'n', o = 70 'F'}" "{a = 97 'a', b = 50 '2', c = 99 'c', d = 52 '4', e = 101 'e', f = 54 '6', g = 103 'g', h = 56 '8', i = 105 'i', j = 65 'A', k = 107 'k', l = 67 'C', m = 109 'm', n = 69 'E', o = 111 'o', p = 71 'G'}" "{a = 49 '1', b = 98 'b', c = 51 '3', d = 100 'd', e = 53 '5', f = 102 'f', g = 55 '7', h = 104 'h', i = 57 '9', j = 106 'j', k = 66 'B', l = 108 'l', m = 68 'D', n = 110 'n', o = 70 'F', p = 112 'p', q = 72 'H'}" } $n] } proc zed { n } { return [lindex { "{}" "{a = 90 'Z'}" "{a = 90 'Z', b = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z', m = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z', m = 90 'Z', n = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z', m = 90 'Z', n = 90 'Z', o = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z', m = 90 'Z', n = 90 'Z', o = 90 'Z', p = 90 'Z'}" "{a = 90 'Z', b = 90 'Z', c = 90 'Z', d = 90 'Z', e = 90 'Z', f = 90 'Z', g = 90 'Z', h = 90 'Z', i = 90 'Z', j = 90 'Z', k = 90 'Z', l = 90 'Z', m = 90 'Z', n = 90 'Z', o = 90 'Z', p = 90 'Z', q = 90 'Z'}" } $n] } # Given N (0..25), return the corresponding alphabetic letter in lower # or upper case. This is ment to be i18n proof. proc i2a { n } { return [string range "abcdefghijklmnopqrstuvwxyz" $n $n] } proc I2A { n } { return [string toupper [i2a $n]] } # Use the tuples in FAILS to set up any needed KFAILs. proc setup_kfails { fails bug } { foreach f $fails { setup_kfail $f $bug } } # Test GDB's ability to make inferior function calls to functions # returning (or passing in a single structs. # N identifies the number of elements in the struct that will be used # for the test case. FAILS is a list of target tuples that will fail # this test. # start_structs_test() will have previously built a program with a # specified combination of types for those elements. To ensure # robustness of the output, "p/c" is used. # This tests the code paths "which return-value convention?" and # "extract return-value from registers" called by "infcall.c". proc test_struct_calls { n fails } { global testfile global gdb_prompt # Check that GDB can always extract a struct-return value from an # inferior function call. Since GDB always knows the location of an # inferior function call's return value these should never fail # Implemented by calling the parameterless function "fun$N" and then # examining the return value printed by GDB. set tests "call $n ${testfile}" # Call fun${n}, checking the printed return-value. setup_kfails ${fails} gdb/1443 gdb_test "p/c fun${n}()" "[foo ${n}]" "p/c fun${n}(); ${tests}" # Check that GDB can always pass a structure to an inferior function. # This test can never fail. # Implemented by calling the one parameter function "Fun$N" which # stores its parameter in the global variable "L$N". GDB then # examining that global to confirm that the value is as expected. gdb_test "call Fun${n}(foo${n})" "" "call Fun${n}(foo${n}); ${tests}" setup_kfails ${fails} gdb/1443 gdb_test "p/c L${n}" [foo ${n}] "p/c L${n}; ${tests}" } # Test GDB's ability to both return a function (with "return" or # "finish") and correctly extract/store any corresponding # return-value. # Check that GDB can consistently extract/store structure return # values. There are two cases - returned in registers and returned in # memory. For the latter case, the return value can't be found and a # failure is "expected". However GDB must still both return the # function and display the final source and line information. # N identifies the number of elements in the struct that will be used # for the test case. FAILS is a list of target tuples that will fail # this test. # This tests the code paths "which return-value convention?", "extract # return-value from registers", and "store return-value in registers". # Unlike "test struct calls", this test is expected to "fail" when the # return-value is in memory (GDB can't find the location). proc test_struct_returns { n fails } { global gdb_prompt global testfile set tests "return $n ${testfile}" # Check that "return" works. # GDB must always force the return of a function that has # a struct result. Dependant on the ABI, it may, or may not be # possible to store the return value in a register. # The relevant code looks like "L{n} = fun{n}()". The test forces # "fun{n}" to "return" with an explicit value. Since that code # snippet will store the the returned value in "L{n}" the return # is tested by examining "L{n}". This assumes that the # compiler implemented this as fun{n}(&L{n}) and hence that when # the value isn't stored "L{n}" remains unchanged. Also check for # consistency between this and the "finish" case. # Get into a call of fun${n} gdb_test "advance fun${n}" \ "fun${n} .*\[\r\n\]+\[0-9\].*return foo${n}.*" \ "advance to fun${n} for return; ${tests}" # Check that the program invalidated the relevant global. if [string equal ${testfile} structs-tld] { setup_kfail i686-*-* gdb/1447 } gdb_test "p/c L${n}" " = [zed $n]" "zed L${n} for return; ${tests} .${testfile}." # Force the "return". This code is checking that GDB does # not leave the user dangling (did GDB really return?) and # that the final resting place of the return is clear (GDB 6.0 # sometimes forgot to print the "source and line" information # leaving the user with "No frame". Notice how it is careful # to give only one *PASS/FAIL. send_gdb "return foo${n}\n" set test "return foo${n}; ${tests}" set struct_return 0 gdb_expect { -re "The location" { # Ulgh, a struct return, remember this (still need prompt). set struct_return 1 exp_continue } -re "Make fun${n} return now.*y or n. $" { send_gdb "y\n" gdb_expect { -re "L${n} *= fun${n}.*${gdb_prompt} $" { # Need to step off the function call gdb_test "next" "L.* *= fun.*" "${test}" } -re "L[expr ${n} + 1] *= fun[expr ${n} + 1].*${gdb_prompt} $" { pass "${test}" } timeout { fail "${test} (timeout 2)" } } } -re "${gdb_prompt} $" { fail "${test} (no query)" } timeout { fail "${test} (timeout 1)" } } # Check that the return value is as expected. As noted below, # there are two expected outcomes. At this stage we're just # checking that GDB has returned a value consistent with # "struct_return" set above so only gag (kfail) failures. send_gdb "p/c L${n}\n" set test "value foo${n} returned; ${tests}" gdb_expect { -re " = [foo ${n}].*${gdb_prompt} $" { if $struct_return { # There's a contradiction between reading and writing # a struct-return value. "return" indicated that the # value couldn't be found, yet GDB then went and found # it. Gag this fail if possible. setup_kfails ${fails} gdb/1444 fail "${test}" } else { pass "${test}" } } -re " = [zed ${n}].*${gdb_prompt} $" { if $struct_return { # The struct return case. Since any modification # would be by reference, and that can't happen, the # value should be unmodified and hence Z is expected. pass "${test}" } else { # There's a contradiction between reading and writing # struct-return values. "return" indicated that this # value could be found, yet the value extracted is wrong. # Gag this fail if possible. setup_kfails ${fails} gdb/1444 fail "${test}" } } -re "${gdb_prompt} $" { # Garbage returned, garbage printed setup_kfails $fails gdb/1444 fail "${test}" } timeout { fail "${test} (timeout)" } } # Check that a "finish" works. # This is almost but not quite the same as "call struct funcs". # Architectures have subtle differences in the two code paths. # The relevant code snippet is "L{n} = fun{n}()". The program is # advanced into a call to "fun{n}" and then that function is # finished. The returned value that GDB prints is then checked. # Get into "fun${n}()". gdb_test "advance fun${n}" \ "fun${n} .*\[\r\n\]+\[0-9\].*return foo${n}.*" \ "advance to fun${n} for finish; ${tests}" # Check that the program invalidated the relevant global. if [string equal ${testfile} structs-tld] { setup_kfail i686-*-* gdb/1447 } gdb_test "p/c L${n}" " = [zed $n]" "zed L${n} for finish; ${tests}" # Finish that function, examine the result, remember a struct-return. send_gdb "finish\n" set test "finish foo${n}; ${tests}" # KFAIL all possible paths. Here a KFAILED PASS is a # contradiction and should be reported. setup_kfails $fails gdb/1444 gdb_expect { -re "Value returned is .*${gdb_prompt} $" { if $struct_return { # There's a contradiction between "finish" and # "return". One is managing to handle a return-value # in register, yet the other is not. fail "${test}" } else { pass "${test}" } } -re "Cannot determine contents.*${gdb_prompt} $" { if $struct_return { # Expected bad value. For the moment this is ok. pass "${test}" } else { # There's a contradiction between "finish" and # "return". One is managing to handle a return-value # in register, yet the other is not. fail "${test}" } } -re ".*${gdb_prompt} $" { # Garbage returned fail "${test}" } timeout { fail "${test} (timeout)" } } # Re-print the last (return-value) using the more robust # "p/c". If no return value was found, zed is seen. send_gdb "p/c\n" set test "value foo${n} finished; ${tests}" setup_kfails ${fails} gdb/1444 gdb_expect { -re "[foo ${n}]\[\r\n\]+${gdb_prompt} $" { if $struct_return { # There's a contradiction between "finish" and # "return". One is managing to handle a return-value # in register, yet the other is not. fail "${test}" } else { pass "${test}" } } -re "[zed ${n}]\[\r\n\]+${gdb_prompt} $" { # The value didn't get found. This is "expected". if $struct_return { pass "${test}" } else { # There's a contradiction between "finish" and # "return". One is managing to handle a return-value # in register, yet the other is not. fail "${test}" } } -re ".*${gdb_prompt} $" { # Garbage returned fail "${test}" } timeout { fail "${test} (timeout)" } } } # ABIs pass anything >8 or >16 bytes in memory but below that things # randomly use register and/and structure conventions. Check all # possible sized char structs in that range. But only a restricted # range of the other types. # NetBSD/PPC returns "unnatural" (3, 5, 6, 7) sized structs in memory. # d10v is weird. 5/6 byte structs go in memory. 2 or more char # structs go in memory. Everything else is in a register! # Test every single char struct from 1..17 in size. This is what the # original "structs" test was doing. start_structs_test { tc } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_calls 7 { } test_struct_calls 8 { } test_struct_calls 9 { } test_struct_calls 10 { } test_struct_calls 11 { } test_struct_calls 12 { } test_struct_calls 13 { } test_struct_calls 14 { } test_struct_calls 15 { } test_struct_calls 16 { } test_struct_calls 17 { } test_struct_returns 1 { i686-*-* } test_struct_returns 2 { i686-*-* } test_struct_returns 3 { i686-*-* } test_struct_returns 4 { i686-*-* } test_struct_returns 5 { i686-*-* } test_struct_returns 6 { i686-*-* } test_struct_returns 7 { i686-*-* } test_struct_returns 8 { i686-*-* } # Let the fun begin. # Assuming that any integer struct larger than 8 bytes goes in memory, # come up with many and varied combinations of a return struct. For # "struct calls" test just beyond that 8 byte boundary, for "struct # returns" test up to that boundary. # For floats, assumed that up to two struct elements can be stored in # floating point registers, regardless of their size. # The approx size of each structure it is computed assumed that tc=1, # ts=2, ti=4, tl=4, tll=8, tf=4, td=8, tld=16, and that all fields are # naturally aligned. Padding being added where needed. Note that # these numbers are just approx, the d10v has ti=2, a 64-bit has has # tl=8. # Approx size: 2, 4, ... start_structs_test { ts } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_returns 1 { i686-*-* } test_struct_returns 2 { i686-*-* } test_struct_returns 3 { i686-*-* } test_struct_returns 4 { i686-*-* } # Approx size: 4, 8, ... start_structs_test { ti } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_returns 1 { i686-*-* } test_struct_returns 2 { i686-*-* } # Approx size: 4, 8, ... start_structs_test { tl } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_returns 1 { i686-*-* } test_struct_returns 2 { i686-*-* } # Approx size: 8, 16, ... start_structs_test { tll } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_returns 1 { i686-*-* } # Approx size: 4, 8, ... start_structs_test { tf } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_returns 1 { i686-*-* } test_struct_returns 2 { i686-*-* } # Approx size: 8, 16, ... start_structs_test { td } test_struct_calls 1 { } test_struct_calls 2 { } test_struct_returns 1 { i686-*-* } # Approx size: 16, 32, ... start_structs_test { tld } test_struct_calls 1 { i686-*-* } test_struct_calls 2 { i686-*-* } test_struct_returns 1 { i686-*-* } # Approx size: 2+1=3, 4, ... start_structs_test { ts tc } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_calls 7 { } test_struct_calls 8 { } test_struct_returns 2 { i686-*-* } # Approx size: 4+1=5, 6, ... start_structs_test { ti tc } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_returns 2 { i686-*-* } # Approx size: 4+1=5, 6, ... start_structs_test { tl tc } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_returns 2 { i686-*-* } # Approx size: 8+1=9, 10, ... start_structs_test { tll tc } test_struct_calls 2 { } # Approx size: 4+1=5, 6, ... start_structs_test { tf tc } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_returns 2 { i686-*-* } # Approx size: 8+1=9, 10, ... start_structs_test { td tc } test_struct_calls 2 { } # Approx size: 16+1=17, 18, ... start_structs_test { tld tc } test_struct_calls 2 { i686-*-* } # Approx size: (1+1)+2=4, 6, ... start_structs_test { tc ts } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_calls 5 { } test_struct_calls 6 { } test_struct_returns 2 { i686-*-* } # Approx size: (1+3)+4=8, 12, ... start_structs_test { tc ti } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_returns 2 { i686-*-* } # Approx size: (1+3)+4=8, 12, ... start_structs_test { tc tl } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } test_struct_returns 2 { i686-*-* } # Approx size: (1+7)+8=16, 24, ... start_structs_test { tc tll } test_struct_calls 2 { } # Approx size: (1+3)+4=8, 12, ... start_structs_test { tc tf } test_struct_calls 2 { } test_struct_calls 3 { } test_struct_calls 4 { } # Approx size: (1+7)+8=16, 24, ... start_structs_test { tc td } test_struct_calls 2 { } # Approx size: (1+15)+16=32, 48, ... start_structs_test { tc tld } test_struct_calls 2 { i686-*-* } # Some float combinations # Approx size: 8+4=12, 16, ... # d10v: 4+4=8, 12, ... start_structs_test { td tf } test_struct_calls 2 { } test_struct_returns 2 { i686-*-* } # Approx size: (4+4)+8=16, 32, ... # d10v: 4+4=8, 12, ... start_structs_test { tf td } test_struct_calls 2 { } test_struct_returns 2 { i686-*-* } return 0