[deliverable/binutils-gdb.git] / gas / testsuite / lib / gas-defs.exp

# Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001 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:
# DejaGnu@cygnus.com

# This file was written by Ken Raeburn (raeburn@cygnus.com).

proc gas_version {} {
    global AS
    catch "exec $AS -version < /dev/null" tmp
    # Should find a way to discard constant parts, keep whatever's
    # left, so the version string could be almost anything at all...
    regexp "\[^\n\]* (cygnus-|)(\[-0-9.a-zA-Z-\]+)\[\r\n\].*" $tmp version cyg number
    if ![info exists number] then {
        return "[which $AS] (no version number)\n"
    }
    clone_output "[which $AS] $number\n"
    unset version
}

proc gas_run { prog as_opts redir } {
    global AS
    global ASFLAGS
    global comp_output
    global srcdir
    global subdir
    global host_triplet

    verbose "Executing $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir"
    catch "exec $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir" comp_output
    set comp_output [prune_warnings $comp_output]
    verbose "output was $comp_output"
    return [list $comp_output ""];
}

proc all_ones { args } {
    foreach x $args { if [expr $x!=1] { return 0 } }
    return 1
}

proc gas_start { prog as_opts } {
    global AS
    global ASFLAGS
    global srcdir
    global subdir
    global spawn_id

    verbose "Starting $AS $ASFLAGS $as_opts $prog" 2
    catch {
	spawn -noecho -nottycopy $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog
    } foo
    if ![regexp {^[0-9]+} $foo] then {
	perror "Can't run $subdir/$prog: $foo"
    }
}

proc gas_finish { } {
    global spawn_id

    catch "close"
    catch "wait"
}

proc want_no_output { testname } {
    global comp_output

    if ![string match "" $comp_output] then {
	send_log "$comp_output\n"
	verbose "$comp_output" 3
    }
    if [string match "" $comp_output] then {
	pass "$testname"
	return 1
    } else {
	fail "$testname"
	return 0
    }
}

proc gas_test_old { file as_opts testname } {
    gas_run $file $as_opts ""
    return [want_no_output $testname]
}

proc gas_test { file as_opts var_opts testname } {
    global comp_output

    set i 0
    foreach word $var_opts {
	set ignore_stdout($i) [string match "*>" $word]
	set opt($i) [string trim $word {>}]
	incr i
    }
    set max [expr 1<<$i]
    for {set i 0} {[expr $i<$max]} {incr i} {
	set maybe_ignore_stdout ""
	set extra_opts ""
	for {set bit 0} {(1<<$bit)<$max} {incr bit} {
	    set num [expr 1<<$bit]
	    if [expr $i&$num] then {
		set extra_opts "$extra_opts $opt($bit)"
		if $ignore_stdout($bit) then {
		    set maybe_ignore_stdout ">/dev/null"
		}
	    }
	}
	set extra_opts [string trim $extra_opts]
	gas_run $file "$as_opts $extra_opts" $maybe_ignore_stdout

	# Should I be able to use a conditional expression here?
	if [string match "" $extra_opts] then {
	    want_no_output $testname
	} else {
	    want_no_output "$testname ($extra_opts)"
	}
    }
    if [info exists errorInfo] then {
        unset errorInfo
    }
}

proc gas_test_ignore_stdout { file as_opts testname } {
    global comp_output

    gas_run $file $as_opts ">/dev/null"
    want_no_output $testname
}

proc gas_test_error { file as_opts testname } {
    global comp_output

    gas_run $file $as_opts ">/dev/null"
    if ![string match "" $comp_output] then {
	send_log "$comp_output\n"
	verbose "$comp_output" 3
    }
    if [string match "" $comp_output] then {
	fail "$testname"
    } else {
	pass "$testname"
    }
}

proc gas_exit {} {}

proc gas_init { args } {
    global target_cpu
    global target_cpu_family
    global target_family
    global target_vendor
    global target_os
    global stdoptlist

    case "$target_cpu" in {
	"m68???"		{ set target_cpu_family m68k }
	"i[34]86"		{ set target_cpu_family i386 }
	default			{ set target_cpu_family $target_cpu }
    }

    set target_family "$target_cpu_family-$target_vendor-$target_os"
    set stdoptlist "-a>"

    if ![istarget "*-*-*"] {
	perror "Target name [istarget] is not a triple."
    }
    # Need to return an empty string.
    return
}


# run_dump_test FILE 
#
# Assemble a .s file, then run some utility on it and check the output.
# 
# There should be an assembly language file named FILE.s in the test
# suite directory, and a pattern file called FILE.d.  `run_dump_test'
# will assemble FILE.s, run some tool like `objdump', `objcopy', or
# `nm' on the .o file to produce textual output, and then analyze that
# with regexps.  The FILE.d file specifies what program to run, and
# what to expect in its output.
#
# The FILE.d file begins with zero or more option lines, which specify
# flags to pass to the assembler, the program to run to dump the
# assembler's output, and the options it wants.  The option lines have
# the syntax:
# 
#         # OPTION: VALUE
# 
# OPTION is the name of some option, like "name" or "objdump", and
# VALUE is OPTION's value.  The valid options are described below.
# Whitespace is ignored everywhere, except within VALUE.  The option
# list ends with the first line that doesn't match the above syntax
# (hmm, not great for error detection).
#
# The interesting options are:
# 
#   name: TEST-NAME
#	The name of this test, passed to DejaGNU's `pass' and `fail'
#       commands.  If omitted, this defaults to FILE, the root of the
#       .s and .d files' names.
# 
#   as: FLAGS
#	When assembling FILE.s, pass FLAGS to the assembler.
# 
#   PROG: PROGRAM-NAME
#       The name of the program to run to analyze the .o file produced
#       by the assembler.  This can be omitted; run_dump_test will guess
#       which program to run by seeing which of the flags options below
#	is present.
# 
#   objdump: FLAGS
#   nm: FLAGS
#   objcopy: FLAGS
#	Use the specified program to analyze the .o file, and pass it
#	FLAGS, in addition to the .o file name.
#
#   source: SOURCE
#	Assemble the file SOURCE.s.  If omitted, this defaults to FILE.s.
#       This is useful if several .d files want to share a .s file.
#
#   error: REGEX
#	An error with message matching REGEX must be emitted for the test
#	to pass.  The PROG, objdump, nm and objcopy options have no
#	meaning and need not supplied if this is present.
#
# Each option may occur at most once.
#
# After the option lines come regexp lines.  `run_dump_test' calls
# `regexp_diff' to compare the output of the dumping tool against the
# regexps in FILE.d.  `regexp_diff' is defined later in this file; see
# further comments there.

proc run_dump_test { name } {
    global subdir srcdir
    global OBJDUMP NM AS OBJCOPY READELF
    global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
    global host_triplet

    if [string match "*/*" $name] {
	set file $name
	set name [file tail $name]
    } else {
	set file "$srcdir/$subdir/$name"
    }
    set opt_array [slurp_options "${file}.d"]
    if { $opt_array == -1 } {
	perror "error reading options from $file.d"
	unresolved $subdir/$name
	return
    }
    set opts(as) {}
    set opts(objdump) {}
    set opts(nm) {}
    set opts(objcopy) {}
    set opts(readelf) {}
    set opts(name) {}
    set opts(PROG) {}
    set opts(source) {}
    set opts(stderr) {}
    set opts(error) {}

    foreach i $opt_array {
	set opt_name [lindex $i 0]
	set opt_val [lindex $i 1]
	if ![info exists opts($opt_name)] {
	    perror "unknown option $opt_name in file $file.d"
	    unresolved $subdir/$name
	    return
	}
	if [string length $opts($opt_name)] {
	    perror "option $opt_name multiply set in $file.d"
	    unresolved $subdir/$name
	    return
	}
	set opts($opt_name) $opt_val
    }

    if {$opts(PROG) != ""} {
	switch -- $opts(PROG) {
	    objdump
		{ set program objdump }
	    nm
		{ set program nm }
	    objcopy
		{ set program objcopy }
	    readelf
		{ set program readelf }
	    default
		{ perror "unrecognized program option $opts(PROG) in $file.d"
		  unresolved $subdir/$name
		  return }
	}
    } elseif { $opts(error) != "" } {
	# It's meaningless to require an output-testing method when we
	# expect an error.  For simplicity, we fake an arbitrary method.
	set program "nm"
    } else {
	# Guess which program to run, by seeing which option was specified.
	set program ""
	foreach p {objdump objcopy nm readelf} {
	    if {$opts($p) != ""} {
		if {$program != ""} {
		    perror "ambiguous dump program in $file.d"
		    unresolved $subdir/$name
		    return
		} else {
		    set program $p
		}
	    }
	}
	if {$program == ""} {
	    perror "dump program unspecified in $file.d"
	    unresolved $subdir/$name
	    return
	}
    }

    set progopts1 $opts($program)
    eval set progopts \$[string toupper $program]FLAGS
    eval set binary \$[string toupper $program]
    if { $opts(name) == "" } {
	set testname "$subdir/$name"
    } else {
	set testname $opts(name)
    }

    if { $opts(source) == "" } {
	set sourcefile ${file}.s
    } else {
	set sourcefile $srcdir/$subdir/$opts(source)
    }

    send_log "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile\n"
    catch "exec $srcdir/lib/run $AS $ASFLAGS $opts(as) -o dump.o $sourcefile" comp_output
    set comp_output [prune_warnings $comp_output]

    if ![string match "" $comp_output] then {
	if { $opts(stderr) == "" }  then {
	    send_log "$comp_output\n"
	    verbose "$comp_output" 3

	    if { $opts(error) != "" } {
		verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
		if [regexp $opts(error) $comp_output] {
		    pass $testname
		    return
		}
	    }
	    fail $testname
	    return
	} else {
	    catch {write_file dump.stderr "$comp_output"} write_output
	    if ![string match "" $write_output] then {
		send_log "error writing dump.stderr: $write_output\n"
		verbose "error writing dump.stderr: $write_output" 3
		send_log "$comp_output\n"
		verbose "$comp_output" 3
		fail $testname
		return
	    }
	    set stderrfile $srcdir/$subdir/$opts(stderr)
	    send_log "wrote pruned stderr to dump.stderr\n"
	    verbose "wrote pruned stderr to dump.stderr" 3
	    if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
		if { $opts(error) != "" } {
		    verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
		    if [regexp $opts(error) $comp_output] {
			pass $testname
			return
		    }
		}
		fail $testname
		verbose "pruned stderr is [file_contents "dump.stderr"]" 2
		return
	    }
	}
    }

    if { [which $binary] == 0 } {
	untested $testname
	return
    }

    if { $progopts1 == "" } { set $progopts1 "-r" }
    verbose "running $binary $progopts $progopts1" 3

    # Objcopy, unlike the other two, won't send its output to stdout,
    # so we have to run it specially.
    if { $program == "objcopy" } {
	send_log "$binary $progopts $progopts1 dump.o dump.out\n"
	catch "exec $binary $progopts $progopts1 dump.o dump.out" comp_output
	set comp_output [prune_warnings $comp_output]
	if ![string match "" $comp_output] then {
	    send_log "$comp_output\n"
	    fail $testname
	    return
	}
    } else {
	send_log "$binary $progopts $progopts1 dump.o > dump.out\n"
	catch "exec $binary $progopts $progopts1 dump.o > dump.out" comp_output
	set comp_output [prune_warnings $comp_output]
	if ![string match "" $comp_output] then {
	    send_log "$comp_output\n"
	    fail $testname
	    return
	}
    }

    verbose_eval {[file_contents "dump.out"]} 3
    if { [regexp_diff "dump.out" "${file}.d"] } then {
	fail $testname
	verbose "output is [file_contents "dump.out"]" 2
	return
    }

    pass $testname
}

proc slurp_options { file } {
    if [catch { set f [open $file r] } x] {
	#perror "couldn't open `$file': $x"
	perror "$x"
	return -1
    }
    set opt_array {}
    # whitespace expression
    set ws  {[ 	]*}
    set nws {[^ 	]*}
    # whitespace is ignored anywhere except within the options list;
    # option names are alphabetic only
    set pat "^#${ws}(\[a-zA-Z\]*)$ws:${ws}(.*)$ws\$"
    while { [gets $f line] != -1 } {
	set line [string trim $line]
	# Whitespace here is space-tab.
	if [regexp $pat $line xxx opt_name opt_val] {
	    # match!
	    lappend opt_array [list $opt_name $opt_val]
	} else {
	    break
	}
    }
    close $f
    return $opt_array
}

proc objdump { opts } {
    global OBJDUMP
    global comp_output
    global host_triplet

    catch "exec $OBJDUMP $opts" comp_output
    set comp_output [prune_warnings $comp_output]
    verbose "objdump output=$comp_output\n" 3
}

proc objdump_start_no_subdir { prog opts } {
    global OBJDUMP
    global srcdir
    global spawn_id

    verbose "Starting $OBJDUMP $opts $prog" 2
    catch {
	spawn -noecho -nottyinit $srcdir/lib/run $OBJDUMP $opts $prog
    } foo
    if ![regexp {^[0-9]+} $foo] then {
	perror "Can't run $prog: $foo"
    }
}

proc objdump_finish { } {
    global spawn_id

    catch "close"
    catch "wait"
}

# Default timeout is 10 seconds, loses on a slow machine.  But some
# configurations of dejagnu may override it.
if {$timeout<120} then { set timeout 120 }

expect_after -i {
    timeout			{ perror "timeout" }
    "virtual memory exhausted"	{ perror "virtual memory exhausted" }
    buffer_full			{ perror "buffer full" }
    eof				{ perror "eof" }
}

# regexp_diff, based on simple_diff taken from ld test suite
#	compares two files line-by-line
#	file1 contains strings, file2 contains regexps and #-comments
#	blank lines are ignored in either file
#	returns non-zero if differences exist
#
proc regexp_diff { file_1 file_2 } {

    set eof -1
    set end_1 0
    set end_2 0
    set differences 0
    set diff_pass 0

    if [file exists $file_1] then {
	set file_a [open $file_1 r]
    } else {
	warning "$file_1 doesn't exist"
	return 1
    }

    if [file exists $file_2] then {
	set file_b [open $file_2 r]
    } else {
	fail "$file_2 doesn't exist"
	close $file_a
	return 1
    }

    verbose " Regexp-diff'ing: $file_1 $file_2" 2

    while { 1 } {
	set line_a ""
	set line_b ""
	while { [string length $line_a] == 0 } {
	    if { [gets $file_a line_a] == $eof } {
		set end_1 1
		break
	    }
	}
	while { [string length $line_b] == 0 || [string match "#*" $line_b] } {
	    if [ string match "#pass" $line_b ] {
		set end_2 1
		set diff_pass 1
		break
	    } elseif [ string match "#..." $line_b ] {
		if { [gets $file_b line_b] == $eof } {
		    set end_2 1
		    break
		}
		verbose "looking for \"^$line_b$\"" 3
		while { ![regexp "^$line_b$" "$line_a"] } {
		    verbose "skipping    \"$line_a\"" 3
		    if { [gets $file_a line_a] == $eof } {
			set end_1 1
			break
		    }
		}
		break
	    }
	    if { [gets $file_b line_b] == $eof } {
		set end_2 1
		break
	    }
	}

        if { $diff_pass } { 
            break 
        } elseif { $end_1 && $end_2 } { 
            break
        } elseif { $end_1 } {
            send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
            verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
            set differences 1
            break
        } elseif { $end_2 } {
            send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
            verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
            set differences 1
            break
        } else {
            verbose "regexp \"^$line_b$\"\nline   \"$line_a\"" 3
            if ![regexp "^$line_b$" "$line_a"] {
		send_log "regexp_diff match failure\n"
		send_log "regexp \"^$line_b$\"\nline   \"$line_a\"\n"
		verbose "regexp_diff match failure\n" 3
		set differences 1
            }
        }
    }

    if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
	send_log "$file_1 and $file_2 are different lengths\n"
	verbose "$file_1 and $file_2 are different lengths" 3
	set differences 1
    }

    close $file_a
    close $file_b

    return $differences
}

proc file_contents { filename } {
    set file [open $filename r]
    set contents [read $file]
    close $file
    return $contents
}

proc write_file { filename contents } {
    set file [open $filename w]
    puts $file "$contents"
    close $file
}

proc verbose_eval { expr { level 1 } } {
    global verbose
    if $verbose>$level then { eval verbose "$expr" $level }
}

# This definition is taken from an unreleased version of DejaGnu.  Once
# that version gets released, and has been out in the world for a few
# months at least, it may be safe to delete this copy.
if ![string length [info proc prune_warnings]] {
    #
    # prune_warnings -- delete various system verbosities from TEXT.
    #
    # An example is:
    # ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
    #
    # Sites with particular verbose os's may wish to override this in site.exp.
    #
    proc prune_warnings { text } {
	# This is from sun4's.  Do it for all machines for now.
	# The "\\1" is to try to preserve a "\n" but only if necessary.
	regsub -all "(^|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text

	# It might be tempting to get carried away and delete blank lines, etc.
	# Just delete *exactly* what we're ask to, and that's it.
	return $text
    }
}
Commit	Line	Data
4b0d96c2	1	# Copyright (C) 1993, 1994, 1997, 1998, 1999, 2000, 2001 Free Software
77f42f92	2	# Foundation, Inc.
252b5132 RH	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@cygnus.com
	20
	21	# This file was written by Ken Raeburn (raeburn@cygnus.com).
	22
	23	proc gas_version {} {
	24	global AS
	25	catch "exec $AS -version < /dev/null" tmp
	26	# Should find a way to discard constant parts, keep whatever's
	27	# left, so the version string could be almost anything at all...
	28	regexp "\[^\n\]* (cygnus-\|)(\[-0-9.a-zA-Z-\]+)\[\r\n\].*" $tmp version cyg number
	29	if ![info exists number] then {
	30	return "[which $AS] (no version number)\n"
	31	}
	32	clone_output "[which $AS] $number\n"
	33	unset version
	34	}
	35
	36	proc gas_run { prog as_opts redir } {
	37	global AS
	38	global ASFLAGS
	39	global comp_output
	40	global srcdir
	41	global subdir
	42	global host_triplet
	43
	44	verbose "Executing $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir"
	45	catch "exec $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog $redir" comp_output
	46	set comp_output [prune_warnings $comp_output]
	47	verbose "output was $comp_output"
	48	return [list $comp_output ""];
	49	}
	50
	51	proc all_ones { args } {
	52	foreach x $args { if [expr $x!=1] { return 0 } }
	53	return 1
	54	}
	55
	56	proc gas_start { prog as_opts } {
	57	global AS
	58	global ASFLAGS
	59	global srcdir
	60	global subdir
	61	global spawn_id
	62
	63	verbose "Starting $AS $ASFLAGS $as_opts $prog" 2
	64	catch {
	65	spawn -noecho -nottycopy $srcdir/lib/run $AS $ASFLAGS $as_opts $srcdir/$subdir/$prog
	66	} foo
67	if ![regexp {^[0-9]+} $foo] then {
68	perror "Can't run $subdir/$prog: $foo"
69	}
70	}
71
72	proc gas_finish { } {
73	global spawn_id
74
75	catch "close"
76	catch "wait"
77	}
78
79	proc want_no_output { testname } {
80	global comp_output
81
82	if ![string match "" $comp_output] then {
83	send_log "$comp_output\n"
84	verbose "$comp_output" 3
85	}
86	if [string match "" $comp_output] then {
87	pass "$testname"
88	return 1
89	} else {
90	fail "$testname"
91	return 0
92	}
93	}
94
95	proc gas_test_old { file as_opts testname } {
96	gas_run $file $as_opts ""
97	return [want_no_output $testname]
98	}
99
100	proc gas_test { file as_opts var_opts testname } {
101	global comp_output
102
103	set i 0
104	foreach word $var_opts {
105	set ignore_stdout($i) [string match "*>" $word]
106	set opt($i) [string trim $word {>}]
107	incr i
108	}
109	set max [expr 1<<$i]
110	for {set i 0} {[expr $i<$max]} {incr i} {
111	set maybe_ignore_stdout ""
112	set extra_opts ""
113	for {set bit 0} {(1<<$bit)<$max} {incr bit} {
114	set num [expr 1<<$bit]
115	if [expr $i&$num] then {
116	set extra_opts "$extra_opts $opt($bit)"
117	if $ignore_stdout($bit) then {
118	set maybe_ignore_stdout ">/dev/null"
119	}
120	}
121	}
122	set extra_opts [string trim $extra_opts]
123	gas_run $file "$as_opts $extra_opts" $maybe_ignore_stdout
124
125	# Should I be able to use a conditional expression here?
126	if [string match "" $extra_opts] then {
127	want_no_output $testname
128	} else {
129	want_no_output "$testname ($extra_opts)"
130	}
131	}
132	if [info exists errorInfo] then {
133	unset errorInfo
134	}
135	}
136
137	proc gas_test_ignore_stdout { file as_opts testname } {
138	global comp_output
139
140	gas_run $file $as_opts ">/dev/null"
141	want_no_output $testname
142	}
143
144	proc gas_test_error { file as_opts testname } {
145	global comp_output
146
147	gas_run $file $as_opts ">/dev/null"
148	if ![string match "" $comp_output] then {
149	send_log "$comp_output\n"
150	verbose "$comp_output" 3
151	}
152	if [string match "" $comp_output] then {
153	fail "$testname"
154	} else {
155	pass "$testname"
156	}
157	}
158
159	proc gas_exit {} {}
160
161	proc gas_init { args } {
162	global target_cpu
163	global target_cpu_family
164	global target_family
165	global target_vendor
166	global target_os
167	global stdoptlist
168
169	case "$target_cpu" in {
170	"m68???" { set target_cpu_family m68k }
171	"i[34]86" { set target_cpu_family i386 }
172	default { set target_cpu_family $target_cpu }
173	}
174
175	set target_family "$target_cpu_family-$target_vendor-$target_os"
176	set stdoptlist "-a>"
177
178	if ![istarget "--*"] {
179	perror "Target name [istarget] is not a triple."
180	}
181	# Need to return an empty string.
182	return
183	}
184
185
186	# run_dump_test FILE
187	#
188	# Assemble a .s file, then run some utility on it and check the output.
189	#
190	# There should be an assembly language file named FILE.s in the test
191	# suite directory, and a pattern file called FILE.d. `run_dump_test'
192	# will assemble FILE.s, run some tool like `objdump', `objcopy', or
193	# `nm' on the .o file to produce textual output, and then analyze that
194	# with regexps. The FILE.d file specifies what program to run, and
195	# what to expect in its output.
196	#
197	# The FILE.d file begins with zero or more option lines, which specify
198	# flags to pass to the assembler, the program to run to dump the
199	# assembler's output, and the options it wants. The option lines have
200	# the syntax:
201	#
202	# # OPTION: VALUE
203	#
204	# OPTION is the name of some option, like "name" or "objdump", and
205	# VALUE is OPTION's value. The valid options are described below.
206	# Whitespace is ignored everywhere, except within VALUE. The option
207	# list ends with the first line that doesn't match the above syntax
208	# (hmm, not great for error detection).
209	#
210	# The interesting options are:
211	#
212	# name: TEST-NAME
213	# The name of this test, passed to DejaGNU's `pass' and `fail'
214	# commands. If omitted, this defaults to FILE, the root of the
215	# .s and .d files' names.
216	#
217	# as: FLAGS
218	# When assembling FILE.s, pass FLAGS to the assembler.
219	#
220	# PROG: PROGRAM-NAME
221	# The name of the program to run to analyze the .o file produced
222	# by the assembler. This can be omitted; run_dump_test will guess
223	# which program to run by seeing which of the flags options below
224	# is present.
225	#
226	# objdump: FLAGS
227	# nm: FLAGS
228	# objcopy: FLAGS
229	# Use the specified program to analyze the .o file, and pass it
230	# FLAGS, in addition to the .o file name.
231	#
232	# source: SOURCE
233	# Assemble the file SOURCE.s. If omitted, this defaults to FILE.s.
234	# This is useful if several .d files want to share a .s file.
235	#
8c2784a5 TR	236	# error: REGEX
	237	# An error with message matching REGEX must be emitted for the test
	238	# to pass. The PROG, objdump, nm and objcopy options have no
	239	# meaning and need not supplied if this is present.
	240	#
252b5132 RH	241	# Each option may occur at most once.
	242	#
	243	# After the option lines come regexp lines. `run_dump_test' calls
	244	# `regexp_diff' to compare the output of the dumping tool against the
	245	# regexps in FILE.d. `regexp_diff' is defined later in this file; see
	246	# further comments there.
	247
	248	proc run_dump_test { name } {
	249	global subdir srcdir
4b0d96c2 HPN	250	global OBJDUMP NM AS OBJCOPY READELF
4b0d96c2 HPN	251	global OBJDUMPFLAGS NMFLAGS ASFLAGS OBJCOPYFLAGS READELFFLAGS
252b5132 RH	252	global host_triplet
	253
	254	if [string match "/" $name] {
	255	set file $name
	256	set name [file tail $name]
	257	} else {
	258	set file "$srcdir/$subdir/$name"
	259	}
	260	set opt_array [slurp_options "${file}.d"]
	261	if { $opt_array == -1 } {
61feeec2	262	perror "error reading options from $file.d"
252b5132 RH	263	unresolved $subdir/$name
	264	return
	265	}
	266	set opts(as) {}
	267	set opts(objdump) {}
	268	set opts(nm) {}
	269	set opts(objcopy) {}
4b0d96c2	270	set opts(readelf) {}
252b5132 RH	271	set opts(name) {}
	272	set opts(PROG) {}
	273	set opts(source) {}
ff970196	274	set opts(stderr) {}
8c2784a5	275	set opts(error) {}
252b5132 RH	276
	277	foreach i $opt_array {
	278	set opt_name [lindex $i 0]
	279	set opt_val [lindex $i 1]
	280	if ![info exists opts($opt_name)] {
	281	perror "unknown option $opt_name in file $file.d"
	282	unresolved $subdir/$name
	283	return
	284	}
	285	if [string length $opts($opt_name)] {
	286	perror "option $opt_name multiply set in $file.d"
	287	unresolved $subdir/$name
	288	return
	289	}
	290	set opts($opt_name) $opt_val
	291	}
	292
	293	if {$opts(PROG) != ""} {
	294	switch -- $opts(PROG) {
	295	objdump
	296	{ set program objdump }
	297	nm
	298	{ set program nm }
	299	objcopy
	300	{ set program objcopy }
4b0d96c2 HPN	301	readelf
4b0d96c2 HPN	302	{ set program readelf }
252b5132 RH	303	default
	304	{ perror "unrecognized program option $opts(PROG) in $file.d"
	305	unresolved $subdir/$name
	306	return }
	307	}
8c2784a5 TR	308	} elseif { $opts(error) != "" } {
	309	# It's meaningless to require an output-testing method when we
	310	# expect an error. For simplicity, we fake an arbitrary method.
	311	set program "nm"
252b5132 RH	312	} else {
	313	# Guess which program to run, by seeing which option was specified.
	314	set program ""
4b0d96c2	315	foreach p {objdump objcopy nm readelf} {
252b5132 RH	316	if {$opts($p) != ""} {
	317	if {$program != ""} {
	318	perror "ambiguous dump program in $file.d"
	319	unresolved $subdir/$name
	320	return
	321	} else {
	322	set program $p
	323	}
	324	}
	325	}
	326	if {$program == ""} {
	327	perror "dump program unspecified in $file.d"
	328	unresolved $subdir/$name
	329	return
	330	}
	331	}
	332
	333	set progopts1 $opts($program)
	334	eval set progopts \$[string toupper $program]FLAGS
	335	eval set binary \$[string toupper $program]
	336	if { $opts(name) == "" } {
	337	set testname "$subdir/$name"
	338	} else {
	339	set testname $opts(name)
	340	}
	341
	342	if { $opts(source) == "" } {
	343	set sourcefile ${file}.s
	344	} else {
	345	set sourcefile $srcdir/$subdir/$opts(source)
	346	}
	347
	348	send_log "$AS $ASFLAGS $opts(as) -o dump.o $sourcefile\n"
	349	catch "exec $srcdir/lib/run $AS $ASFLAGS $opts(as) -o dump.o $sourcefile" comp_output
	350	set comp_output [prune_warnings $comp_output]
	351
	352	if ![string match "" $comp_output] then {
ff970196 CD	353	if { $opts(stderr) == "" } then {
	354	send_log "$comp_output\n"
	355	verbose "$comp_output" 3
8c2784a5 TR	356
	357	if { $opts(error) != "" } {
	358	verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
	359	if [regexp $opts(error) $comp_output] {
	360	pass $testname
	361	return
	362	}
	363	}
ff970196 CD	364	fail $testname
	365	return
	366	} else {
	367	catch {write_file dump.stderr "$comp_output"} write_output
	368	if ![string match "" $write_output] then {
	369	send_log "error writing dump.stderr: $write_output\n"
	370	verbose "error writing dump.stderr: $write_output" 3
	371	send_log "$comp_output\n"
	372	verbose "$comp_output" 3
	373	fail $testname
	374	return
	375	}
	376	set stderrfile $srcdir/$subdir/$opts(stderr)
	377	send_log "wrote pruned stderr to dump.stderr\n"
	378	verbose "wrote pruned stderr to dump.stderr" 3
	379	if { [regexp_diff "dump.stderr" "$stderrfile"] } then {
8c2784a5 TR	380	if { $opts(error) != "" } {
	381	verbose -log "failed with: <$comp_output>, expected: <$opts(error)>"
	382	if [regexp $opts(error) $comp_output] {
	383	pass $testname
	384	return
	385	}
	386	}
ff970196 CD	387	fail $testname
	388	verbose "pruned stderr is [file_contents "dump.stderr"]" 2
	389	return
	390	}
	391	}
252b5132 RH	392	}
	393
	394	if { [which $binary] == 0 } {
	395	untested $testname
	396	return
	397	}
	398
	399	if { $progopts1 == "" } { set $progopts1 "-r" }
	400	verbose "running $binary $progopts $progopts1" 3
	401
	402	# Objcopy, unlike the other two, won't send its output to stdout,
	403	# so we have to run it specially.
	404	if { $program == "objcopy" } {
	405	send_log "$binary $progopts $progopts1 dump.o dump.out\n"
	406	catch "exec $binary $progopts $progopts1 dump.o dump.out" comp_output
	407	set comp_output [prune_warnings $comp_output]
	408	if ![string match "" $comp_output] then {
	409	send_log "$comp_output\n"
	410	fail $testname
	411	return
	412	}
	413	} else {
	414	send_log "$binary $progopts $progopts1 dump.o > dump.out\n"
	415	catch "exec $binary $progopts $progopts1 dump.o > dump.out" comp_output
	416	set comp_output [prune_warnings $comp_output]
	417	if ![string match "" $comp_output] then {
	418	send_log "$comp_output\n"
	419	fail $testname
	420	return
	421	}
	422	}
	423
	424	verbose_eval {[file_contents "dump.out"]} 3
	425	if { [regexp_diff "dump.out" "${file}.d"] } then {
	426	fail $testname
	427	verbose "output is [file_contents "dump.out"]" 2
	428	return
	429	}
	430
	431	pass $testname
	432	}
	433
	434	proc slurp_options { file } {
	435	if [catch { set f [open $file r] } x] {
	436	#perror "couldn't open `$file': $x"
	437	perror "$x"
	438	return -1
	439	}
	440	set opt_array {}
	441	# whitespace expression
	442	set ws {[ ]*}
	443	set nws {[^ ]*}
	444	# whitespace is ignored anywhere except within the options list;
	445	# option names are alphabetic only
	446	set pat "^#${ws}(\[a-zA-Z\])$ws:${ws}(.)$ws\$"
	447	while { [gets $f line] != -1 } {
	448	set line [string trim $line]
	449	# Whitespace here is space-tab.
	450	if [regexp $pat $line xxx opt_name opt_val] {
	451	# match!
	452	lappend opt_array [list $opt_name $opt_val]
	453	} else {
	454	break
	455	}
456	}
457	close $f
458	return $opt_array
459	}
460
461	proc objdump { opts } {
462	global OBJDUMP
463	global comp_output
464	global host_triplet
465
466	catch "exec $OBJDUMP $opts" comp_output
467	set comp_output [prune_warnings $comp_output]
468	verbose "objdump output=$comp_output\n" 3
469	}
470
471	proc objdump_start_no_subdir { prog opts } {
472	global OBJDUMP
473	global srcdir
474	global spawn_id
475
476	verbose "Starting $OBJDUMP $opts $prog" 2
477	catch {
478	spawn -noecho -nottyinit $srcdir/lib/run $OBJDUMP $opts $prog
479	} foo
480	if ![regexp {^[0-9]+} $foo] then {
481	perror "Can't run $prog: $foo"
482	}
483	}
484
485	proc objdump_finish { } {
486	global spawn_id
487
488	catch "close"
489	catch "wait"
490	}
491
492	# Default timeout is 10 seconds, loses on a slow machine. But some
493	# configurations of dejagnu may override it.
494	if {$timeout<120} then { set timeout 120 }
495
496	expect_after -i {
497	timeout { perror "timeout" }
498	"virtual memory exhausted" { perror "virtual memory exhausted" }
499	buffer_full { perror "buffer full" }
500	eof { perror "eof" }
501	}
502
503	# regexp_diff, based on simple_diff taken from ld test suite
504	# compares two files line-by-line
505	# file1 contains strings, file2 contains regexps and #-comments
506	# blank lines are ignored in either file
507	# returns non-zero if differences exist
508	#
509	proc regexp_diff { file_1 file_2 } {
510
511	set eof -1
512	set end_1 0
513	set end_2 0
514	set differences 0
515	set diff_pass 0
516
517	if [file exists $file_1] then {
518	set file_a [open $file_1 r]
519	} else {
520	warning "$file_1 doesn't exist"
521	return 1
522	}
523
524	if [file exists $file_2] then {
525	set file_b [open $file_2 r]
526	} else {
527	fail "$file_2 doesn't exist"
528	close $file_a
529	return 1
530	}
531
532	verbose " Regexp-diff'ing: $file_1 $file_2" 2
533
534	while { 1 } {
535	set line_a ""
536	set line_b ""
537	while { [string length $line_a] == 0 } {
538	if { [gets $file_a line_a] == $eof } {
539	set end_1 1
540	break
541	}
542	}
543	while { [string length $line_b] == 0 \|\| [string match "#*" $line_b] } {
544	if [ string match "#pass" $line_b ] {
545	set end_2 1
546	set diff_pass 1
547	break
a6ea59ce GK	548	} elseif [ string match "#..." $line_b ] {
	549	if { [gets $file_b line_b] == $eof } {
	550	set end_2 1
	551	break
	552	}
	553	verbose "looking for \"^$line_b$\"" 3
	554	while { ![regexp "^$line_b$" "$line_a"] } {
	555	verbose "skipping \"$line_a\"" 3
	556	if { [gets $file_a line_a] == $eof } {
	557	set end_1 1
	558	break
	559	}
	560	}
	561	break
252b5132 RH	562	}
	563	if { [gets $file_b line_b] == $eof } {
	564	set end_2 1
	565	break
	566	}
	567	}
	568
	569	if { $diff_pass } {
	570	break
	571	} elseif { $end_1 && $end_2 } {
	572	break
	573	} elseif { $end_1 } {
	574	send_log "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1\n"
	575	verbose "extra regexps in $file_2 starting with \"^$line_b$\"\nEOF from $file_1" 3
	576	set differences 1
	577	break
	578	} elseif { $end_2 } {
	579	send_log "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n"
	580	verbose "extra lines in $file_1 starting with \"^$line_a$\"\nEOF from $file_2\n" 3
	581	set differences 1
	582	break
	583	} else {
	584	verbose "regexp \"^$line_b$\"\nline \"$line_a\"" 3
	585	if ![regexp "^$line_b$" "$line_a"] {
	586	send_log "regexp_diff match failure\n"
	587	send_log "regexp \"^$line_b$\"\nline \"$line_a\"\n"
3ad62fc4	588	verbose "regexp_diff match failure\n" 3
252b5132	589	set differences 1
252b5132 RH	590	}
	591	}
	592	}
	593
	594	if { $differences == 0 && !$diff_pass && [eof $file_a] != [eof $file_b] } {
	595	send_log "$file_1 and $file_2 are different lengths\n"
	596	verbose "$file_1 and $file_2 are different lengths" 3
	597	set differences 1
	598	}
	599
	600	close $file_a
	601	close $file_b
	602
	603	return $differences
	604	}
	605
	606	proc file_contents { filename } {
	607	set file [open $filename r]
	608	set contents [read $file]
	609	close $file
	610	return $contents
	611	}
	612
ff970196 CD	613	proc write_file { filename contents } {
	614	set file [open $filename w]
	615	puts $file "$contents"
	616	close $file
	617	}
	618
252b5132 RH	619	proc verbose_eval { expr { level 1 } } {
	620	global verbose
	621	if $verbose>$level then { eval verbose "$expr" $level }
	622	}
	623
	624	# This definition is taken from an unreleased version of DejaGnu. Once
	625	# that version gets released, and has been out in the world for a few
	626	# months at least, it may be safe to delete this copy.
	627	if ![string length [info proc prune_warnings]] {
	628	#
	629	# prune_warnings -- delete various system verbosities from TEXT.
	630	#
	631	# An example is:
	632	# ld.so: warning: /usr/lib/libc.so.1.8.1 has older revision than expected 9
	633	#
	634	# Sites with particular verbose os's may wish to override this in site.exp.
	635	#
	636	proc prune_warnings { text } {
	637	# This is from sun4's. Do it for all machines for now.
	638	# The "\\1" is to try to preserve a "\n" but only if necessary.
	639	regsub -all "(^\|\n)(ld.so: warning:\[^\n\]*\n?)+" $text "\\1" text
	640
	641	# It might be tempting to get carried away and delete blank lines, etc.
	642	# Just delete exactly what we're ask to, and that's it.
	643	return $text
	644	}
	645	}