mirror/glibc
2
0
Fork 0
mirror of git://sourceware.org/git/glibc.git synced 2024-12-15 04:20:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
930de6f09e
glibc/math/gen-libm-test.pl

753 lines
20 KiB
Perl
Executable File
Raw Blame History

#!/usr/bin/perl -w
# Copyright (C) 1999-2013 Free Software Foundation, Inc.
# This file is part of the GNU C Library.
# Contributed by Andreas Jaeger <aj@suse.de>, 1999.
# The GNU C Library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
# The GNU C Library 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
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with the GNU C Library; if not, see
# <http://www.gnu.org/licenses/>.
# This file needs to be tidied up
# Note that functions and tests share the same namespace.
# Information about tests are stored in: %results
# $results{$test}{"kind"} is either "fct" or "test" and flags whether this
# is a maximal error of a function or a single test.
# $results{$test}{"type"} is the result type, e.g. normal or complex.
# $results{$test}{"has_ulps"} is set if deltas exist.
# In the following description $type and $float are:
# - $type is either "normal", "real" (for the real part of a complex number)
# or "imag" (for the imaginary part # of a complex number).
# - $float is either of float, ifloat, double, idouble, ldouble, ildouble;
# It represents the underlying floating point type (float, double or long
# double) and if inline functions (the leading i stands for inline)
# are used.
# $results{$test}{$type}{"ulp"}{$float} is defined and has a delta as value
use Getopt::Std;
use strict;
use vars qw ($input $output $auto_input);
use vars qw (%results);
use vars qw (%beautify @all_floats);
use vars qw ($output_dir $ulps_file);
use vars qw (%auto_tests);
# all_floats is sorted and contains all recognised float types
@all_floats = ('double', 'float', 'idouble',
'ifloat', 'ildouble', 'ldouble');
%beautify =
( "minus_zero" => "-0",
"plus_zero" => "+0",
"-0x0p+0f" => "-0",
"-0x0p+0" => "-0",
"-0x0p+0L" => "-0",
"0x0p+0f" => "+0",
"0x0p+0" => "+0",
"0x0p+0L" => "+0",
"minus_infty" => "-inf",
"plus_infty" => "inf",
"qnan_value" => "qNaN",
"M_El" => "e",
"M_E2l" => "e^2",
"M_E3l" => "e^3",
"M_LOG10El", "log10(e)",
"M_PIl" => "pi",
"M_PI_34l" => "3/4 pi",
"M_PI_2l" => "pi/2",
"M_PI_4l" => "pi/4",
"M_PI_6l" => "pi/6",
"M_PI_34_LOG10El" => "3/4 pi*log10(e)",
"M_PI_LOG10El" => "pi*log10(e)",
"M_PI2_LOG10El" => "pi/2*log10(e)",
"M_PI4_LOG10El" => "pi/4*log10(e)",
"M_LOG_SQRT_PIl" => "log(sqrt(pi))",
"M_LOG_2_SQRT_PIl" => "log(2*sqrt(pi))",
"M_2_SQRT_PIl" => "2 sqrt (pi)",
"M_SQRT_PIl" => "sqrt (pi)",
);
# get Options
# Options:
# u: ulps-file
# h: help
# o: output-directory
# n: generate new ulps file
use vars qw($opt_u $opt_h $opt_o $opt_n);
getopts('u:o:nh');
$ulps_file = 'libm-test-ulps';
$output_dir = '';
if ($opt_h) {
print "Usage: gen-libm-test.pl [OPTIONS]\n";
print " -h print this help, then exit\n";
print " -o DIR directory where generated files will be placed\n";
print " -n only generate sorted file NewUlps from libm-test-ulps\n";
print " -u FILE input file with ulps\n";
exit 0;
}
$ulps_file = $opt_u if ($opt_u);
$output_dir = $opt_o if ($opt_o);
$input = "libm-test.inc";
$auto_input = "auto-libm-test-out";
$output = "${output_dir}libm-test.c";
&parse_ulps ($ulps_file);
&parse_auto_input ($auto_input);
&generate_testfile ($input, $output) unless ($opt_n);
&output_ulps ("${output_dir}libm-test-ulps.h", $ulps_file) unless ($opt_n);
&print_ulps_file ("${output_dir}NewUlps") if ($opt_n);
# Return a nicer representation
sub beautify {
my ($arg) = @_;
my ($tmp);
if (exists $beautify{$arg}) {
return $beautify{$arg};
}
if ($arg =~ /^-/) {
$tmp = $arg;
$tmp =~ s/^-//;
if (exists $beautify{$tmp}) {
return '-' . $beautify{$tmp};
}
}
if ($arg =~ /^-?0x[0-9a-f.]*p[-+][0-9]+f$/) {
$arg =~ s/f$//;
}
if ($arg =~ /[0-9]L$/) {
$arg =~ s/L$//;
}
return $arg;
}
# Return a nicer representation of a complex number
sub build_complex_beautify {
my ($r, $i) = @_;
my ($str1, $str2);
$str1 = &beautify ($r);
$str2 = &beautify ($i);
if ($str2 =~ /^-/) {
$str2 =~ s/^-//;
$str1 .= ' - ' . $str2;
} else {
$str1 .= ' + ' . $str2;
}
$str1 .= ' i';
return $str1;
}
# Return the text to put in an initializer for a test's exception
# information.
sub show_exceptions {
my ($ignore_result, $exception) = @_;
$ignore_result = ($ignore_result ? "IGNORE_RESULT|" : "");
if (defined $exception) {
return ", ${ignore_result}$exception";
} else {
return ", ${ignore_result}0";
}
}
# Parse the arguments to TEST_x_y
sub parse_args {
my ($file, $descr, $args) = @_;
my (@args, $descr_args, $descr_res, @descr);
my ($current_arg, $cline, $i);
my (@special);
my ($call_args);
my ($ignore_result_any, $ignore_result_all);
($descr_args, $descr_res) = split /_/,$descr, 2;
@args = split /,\s*/, $args;
$call_args = "";
# Generate first the string that's shown to the user
$current_arg = 1;
@descr = split //,$descr_args;
for ($i = 0; $i <= $#descr; $i++) {
my $comma = "";
if ($current_arg > 1) {
$comma = ', ';
}
# FLOAT, int, long int, long long int
if ($descr[$i] =~ /f|i|l|L/) {
$call_args .= $comma . &beautify ($args[$current_arg]);
++$current_arg;
next;
}
# &FLOAT, &int - simplify call by not showing argument.
if ($descr[$i] =~ /F|I/) {
next;
}
# complex
if ($descr[$i] eq 'c') {
$call_args .= $comma . &build_complex_beautify ($args[$current_arg], $args[$current_arg+1]);
$current_arg += 2;
next;
}
die ("$descr[$i] is unknown");
}
# Result
@descr = split //,$descr_res;
foreach (@descr) {
if ($_ =~ /f|i|l|L/) {
++$current_arg;
} elsif ($_ eq 'c') {
$current_arg += 2;
} elsif ($_ eq 'b') {
# boolean
++$current_arg;
} elsif ($_ eq '1') {
++$current_arg;
} else {
die ("$_ is unknown");
}
}
# consistency check
if ($current_arg == $#args) {
die ("wrong number of arguments")
unless ($args[$current_arg] =~ /EXCEPTION|ERRNO|IGNORE_ZERO_INF_SIGN|TEST_NAN_SIGN|NO_TEST_INLINE|XFAIL_TEST/);
} elsif ($current_arg < $#args) {
die ("wrong number of arguments");
} elsif ($current_arg > ($#args+1)) {
die ("wrong number of arguments");
}
# Put the C program line together
# Reset some variables to start again
$current_arg = 1;
$cline = "{ \"$call_args\"";
@descr = split //,$descr_args;
for ($i=0; $i <= $#descr; $i++) {
# FLOAT, int, long int, long long int
if ($descr[$i] =~ /f|i|l|L/) {
$cline .= ", $args[$current_arg]";
$current_arg++;
next;
}
# &FLOAT, &int
if ($descr[$i] =~ /F|I/) {
next;
}
# complex
if ($descr[$i] eq 'c') {
$cline .= ", $args[$current_arg], $args[$current_arg+1]";
$current_arg += 2;
next;
}
}
@descr = split //,$descr_res;
$ignore_result_any = 0;
$ignore_result_all = 1;
foreach (@descr) {
if ($_ =~ /b|f|i|l|L/ ) {
my ($result) = $args[$current_arg];
if ($result eq "IGNORE") {
$ignore_result_any = 1;
$result = "0";
} else {
$ignore_result_all = 0;
}
$cline .= ", $result";
$current_arg++;
} elsif ($_ eq 'c') {
my ($result1) = $args[$current_arg];
if ($result1 eq "IGNORE") {
$ignore_result_any = 1;
$result1 = "0";
} else {
$ignore_result_all = 0;
}
my ($result2) = $args[$current_arg + 1];
if ($result2 eq "IGNORE") {
$ignore_result_any = 1;
$result2 = "0";
} else {
$ignore_result_all = 0;
}
$cline .= ", $result1, $result2";
$current_arg += 2;
} elsif ($_ eq '1') {
push @special, $args[$current_arg];
++$current_arg;
}
}
if ($ignore_result_any && !$ignore_result_all) {
die ("some but not all function results ignored\n");
}
# Add exceptions.
$cline .= show_exceptions ($ignore_result_any,
($current_arg <= $#args)
? $args[$current_arg]
: undef);
# special treatment for some functions
$i = 0;
foreach (@special) {
++$i;
my ($extra_expected) = $_;
my ($run_extra) = ($extra_expected ne "IGNORE" ? 1 : 0);
if (!$run_extra) {
$extra_expected = "0";
}
$cline .= ", $run_extra, $extra_expected";
}
print $file " $cline },\n";
}
# Convert a condition from auto-libm-test-out to C form.
sub convert_condition {
my ($cond) = @_;
my (@conds, $ret);
@conds = split /:/, $cond;
foreach (@conds) {
s/-/_/g;
s/^/TEST_COND_/;
}
$ret = join " && ", @conds;
return "($ret)";
}
# Return text to OR a value into an accumulated flags string.
sub or_value {
my ($cond) = @_;
if ($cond eq "0") {
return "";
} else {
return " | $cond";
}
}
# Return text to OR a conditional expression between two values into
# an accumulated flags string.
sub or_cond_value {
my ($cond, $if, $else) = @_;
if ($cond eq "1") {
return or_value ($if);
} elsif ($cond eq "0") {
return or_value ($else);
} else {
return or_value ("($cond ? $if : $else)");
}
}
# Generate libm-test.c
sub generate_testfile {
my ($input, $output) = @_;
open INPUT, $input or die ("Can't open $input: $!");
open OUTPUT, ">$output" or die ("Can't open $output: $!");
# Replace the special macros
while (<INPUT>) {
# AUTO_TESTS (function, mode),
if (/^\s*AUTO_TESTS_/) {
my ($descr, $func, $mode, $auto_test, $num_auto_tests);
($descr, $func, $mode) = ($_ =~ /AUTO_TESTS_(\w+)\s*\((\w+),\s*(\w+)\)/);
$num_auto_tests = 0;
foreach $auto_test (sort keys %{$auto_tests{$func}{$mode}}) {
my ($finputs, $format, $inputs, $outputs, $flags);
my ($format_conv, $flags_conv, @flags, %flag_cond);
$num_auto_tests++;
($finputs, $outputs, $flags) = split / : */, $auto_test;
($format, $inputs) = split / /, $finputs, 2;
$inputs =~ s/ /, /g;
$outputs =~ s/ /, /g;
$format_conv = convert_condition ($format);
print OUTPUT "#if $format_conv\n";
@flags = split / /, $flags;
foreach (@flags) {
if (/^([^:]*):(.*)$/) {
my ($flag, $cond);
$flag = $1;
$cond = convert_condition ($2);
if (defined ($flag_cond{$flag})) {
if ($flag_cond{$flag} ne "1") {
$flag_cond{$flag} .= " || $cond";
}
} else {
$flag_cond{$flag} = $cond;
}
} else {
$flag_cond{$_} = "1";
}
}
$flags_conv = "";
if (defined ($flag_cond{"no-test-inline"})) {
$flags_conv .= or_cond_value ($flag_cond{"no-test-inline"},
"NO_TEST_INLINE", "0");
}
if (defined ($flag_cond{"xfail"})) {
$flags_conv .= or_cond_value ($flag_cond{"xfail"},
"XFAIL_TEST", "0");
}
my (@exc_list) = qw(divbyzero inexact invalid overflow underflow);
my ($exc);
foreach $exc (@exc_list) {
my ($exc_expected, $exc_ok, $no_exc);
$exc_expected = "\U$exc\E_EXCEPTION";
$exc_ok = "\U$exc\E_EXCEPTION_OK";
$no_exc = "0";
if ($exc eq "inexact") {
$exc_ok = "0";
$no_exc = "NO_INEXACT_EXCEPTION";
}
if (defined ($flag_cond{$exc})) {
if ($flag_cond{$exc} ne "1") {
die ("unexpected condition for $exc\n");
}
if (defined ($flag_cond{"$exc-ok"})) {
$flags_conv .= or_cond_value ($flag_cond{"$exc-ok"},
$exc_ok, $exc_expected);
} else {
$flags_conv .= or_value ($exc_expected);
}
} else {
if (defined ($flag_cond{"$exc-ok"})) {
$flags_conv .= or_cond_value ($flag_cond{"$exc-ok"},
$exc_ok, $no_exc);
} else {
$flags_conv .= or_value ($no_exc);
}
}
}
my ($errno_expected, $errno_unknown_cond);
if (defined ($flag_cond{"errno-edom"})) {
if ($flag_cond{"errno-edom"} ne "1") {
die ("unexpected condition for errno-edom");
}
if (defined ($flag_cond{"errno-erange"})) {
die ("multiple errno values expected");
}
$errno_expected = "ERRNO_EDOM";
} elsif (defined ($flag_cond{"errno-erange"})) {
if ($flag_cond{"errno-erange"} ne "1") {
die ("unexpected condition for errno-erange");
}
$errno_expected = "ERRNO_ERANGE";
} else {
$errno_expected = "ERRNO_UNCHANGED";
}
if (defined ($flag_cond{"errno-edom-ok"})) {
if (defined ($flag_cond{"errno-erange-ok"})
&& $flag_cond{"errno-erange-ok"} ne $flag_cond{"errno-edom-ok"}) {
$errno_unknown_cond = "($flag_cond{\"errno-edom-ok\"} || $flag_cond{\"errno-erange-ok\"})";
} else {
$errno_unknown_cond = $flag_cond{"errno-edom-ok"};
}
} elsif (defined ($flag_cond{"errno-erange-ok"})) {
$errno_unknown_cond = $flag_cond{"errno-erange-ok"};
} else {
$errno_unknown_cond = "0";
}
$flags_conv .= or_cond_value ($errno_unknown_cond,
"0", $errno_expected);
if ($flags_conv ne "") {
$flags_conv =~ s/^ \|/,/;
}
&parse_args (\*OUTPUT, $descr,
"$func, $inputs, $outputs$flags_conv");
print OUTPUT "#endif\n";
}
if ($num_auto_tests == 0) {
die ("no automatic tests for $func, $mode\n");
}
next;
}
# TEST_...
if (/^\s*TEST_/) {
my ($descr, $args);
chop;
($descr, $args) = ($_ =~ /TEST_(\w+)\s*\((.*)\)/);
&parse_args (\*OUTPUT, $descr, $args);
next;
}
print OUTPUT;
}
close INPUT;
close OUTPUT;
}
# Parse ulps file
sub parse_ulps {
my ($file) = @_;
my ($test, $type, $float, $eps, $kind);
# $type has the following values:
# "normal": No complex variable
# "real": Real part of complex result
# "imag": Imaginary part of complex result
open ULP, $file or die ("Can't open $file: $!");
while (<ULP>) {
chop;
# ignore comments and empty lines
next if /^#/;
next if /^\s*$/;
if (/^Test/) {
if (/Real part of:/) {
s/Real part of: //;
$type = 'real';
} elsif (/Imaginary part of:/) {
s/Imaginary part of: //;
$type = 'imag';
} else {
$type = 'normal';
}
s/^.+\"(.*)\".*$/$1/;
$test = $_;
$kind = 'test';
next;
}
if (/^Function: /) {
if (/Real part of/) {
s/Real part of //;
$type = 'real';
} elsif (/Imaginary part of/) {
s/Imaginary part of //;
$type = 'imag';
} else {
$type = 'normal';
}
($test) = ($_ =~ /^Function:\s*\"([a-zA-Z0-9_]+)\"/);
$kind = 'fct';
next;
}
if (/^i?(float|double|ldouble):/) {
($float, $eps) = split /\s*:\s*/,$_,2;
if ($eps eq "0") {
# ignore
next;
} else {
$results{$test}{$type}{'ulp'}{$float} = $eps;
$results{$test}{'has_ulps'} = 1;
}
if ($type =~ /^real|imag$/) {
$results{$test}{'type'} = 'complex';
} elsif ($type eq 'normal') {
$results{$test}{'type'} = 'normal';
}
$results{$test}{'kind'} = $kind;
next;
}
print "Skipping unknown entry: `$_'\n";
}
close ULP;
}
# Clean up a floating point number
sub clean_up_number {
my ($number) = @_;
# Remove trailing zeros after the decimal point
if ($number =~ /\./) {
$number =~ s/0+$//;
$number =~ s/\.$//;
}
return $number;
}
# Output a file which can be read in as ulps file.
sub print_ulps_file {
my ($file) = @_;
my ($test, $type, $float, $eps, $fct, $last_fct);
$last_fct = '';
open NEWULP, ">$file" or die ("Can't open $file: $!");
print NEWULP "# Begin of automatic generation\n";
# first the function calls
foreach $test (sort keys %results) {
next if ($results{$test}{'kind'} ne 'test');
foreach $type ('real', 'imag', 'normal') {
if (exists $results{$test}{$type}) {
if (defined $results{$test}) {
($fct) = ($test =~ /^(\w+)\s/);
if ($fct ne $last_fct) {
$last_fct = $fct;
print NEWULP "\n# $fct\n";
}
}
if ($type eq 'normal') {
print NEWULP "Test \"$test\":\n";
} elsif ($type eq 'real') {
print NEWULP "Test \"Real part of: $test\":\n";
} elsif ($type eq 'imag') {
print NEWULP "Test \"Imaginary part of: $test\":\n";
}
foreach $float (@all_floats) {
if (exists $results{$test}{$type}{'ulp'}{$float}) {
print NEWULP "$float: ",
&clean_up_number ($results{$test}{$type}{'ulp'}{$float}),
"\n";
}
}
}
}
}
print NEWULP "\n# Maximal error of functions:\n";
foreach $fct (sort keys %results) {
next if ($results{$fct}{'kind'} ne 'fct');
foreach $type ('real', 'imag', 'normal') {
if (exists $results{$fct}{$type}) {
if ($type eq 'normal') {
print NEWULP "Function: \"$fct\":\n";
} elsif ($type eq 'real') {
print NEWULP "Function: Real part of \"$fct\":\n";
} elsif ($type eq 'imag') {
print NEWULP "Function: Imaginary part of \"$fct\":\n";
}
foreach $float (@all_floats) {
if (exists $results{$fct}{$type}{'ulp'}{$float}) {
print NEWULP "$float: ",
&clean_up_number ($results{$fct}{$type}{'ulp'}{$float}),
"\n";
}
}
print NEWULP "\n";
}
}
}
print NEWULP "# end of automatic generation\n";
close NEWULP;
}
sub get_ulps {
my ($test, $type, $float) = @_;
return (exists $results{$test}{$type}{'ulp'}{$float}
? $results{$test}{$type}{'ulp'}{$float} : "0");
}
# Return the ulps value for a single test.
sub get_all_ulps_for_test {
my ($test, $type) = @_;
my ($ldouble, $double, $float, $ildouble, $idouble, $ifloat);
if (exists $results{$test}{'has_ulps'}) {
# XXX use all_floats (change order!)
$ldouble = &get_ulps ($test, $type, "ldouble");
$double = &get_ulps ($test, $type, "double");
$float = &get_ulps ($test, $type, "float");
$ildouble = &get_ulps ($test, $type, "ildouble");
$idouble = &get_ulps ($test, $type, "idouble");
$ifloat = &get_ulps ($test, $type, "ifloat");
return "CHOOSE ($ldouble, $double, $float, $ildouble, $idouble, $ifloat)";
} else {
die "get_all_ulps_for_test called for \"$test\" with no ulps\n";
}
}
# Print include file
sub output_ulps {
my ($file, $ulps_filename) = @_;
my ($i, $fct, $type, $ulp, $ulp_real, $ulp_imag);
my (%test_ulps, %func_ulps, %func_real_ulps, %func_imag_ulps);
open ULP, ">$file" or die ("Can't open $file: $!");
print ULP "/* This file is automatically generated\n";
print ULP " from $ulps_filename with gen-libm-test.pl.\n";
print ULP " Don't change it - change instead the master files. */\n\n";
foreach $fct (keys %results) {
$type = $results{$fct}{'type'};
if ($type eq 'normal') {
$ulp = get_all_ulps_for_test ($fct, 'normal');
} elsif ($type eq 'complex') {
$ulp_real = get_all_ulps_for_test ($fct, 'real');
$ulp_imag = get_all_ulps_for_test ($fct, 'imag');
} else {
die "unknown results ($fct) type $type\n";
}
if ($results{$fct}{'kind'} eq 'fct') {
if ($type eq 'normal') {
$func_ulps{$fct} = $ulp;
} else {
$func_real_ulps{$fct} = $ulp_real;
$func_imag_ulps{$fct} = $ulp_imag;
}
} elsif ($results{$fct}{'kind'} eq 'test') {
if ($type eq 'normal') {
$test_ulps{$fct} = $ulp;
} else {
$test_ulps{"Real part of: $fct"} = $ulp_real;
$test_ulps{"Imaginary part of: $fct"} = $ulp_imag;
}
} else {
die "unknown results ($fct) kind $results{$fct}{'kind'}\n";
}
}
print ULP "\n/* Maximal error of functions. */\n";
print ULP "static const struct ulp_data func_ulps[] =\n {\n";
foreach $fct (sort keys %func_ulps) {
print ULP " { \"$fct\", $func_ulps{$fct} },\n";
}
print ULP " };\n";
print ULP "static const struct ulp_data func_real_ulps[] =\n {\n";
foreach $fct (sort keys %func_real_ulps) {
print ULP " { \"$fct\", $func_real_ulps{$fct} },\n";
}
print ULP " };\n";
print ULP "static const struct ulp_data func_imag_ulps[] =\n {\n";
foreach $fct (sort keys %func_imag_ulps) {
print ULP " { \"$fct\", $func_imag_ulps{$fct} },\n";
}
print ULP " };\n";
print ULP "\n/* Error of single function calls. */\n";
print ULP "static const struct ulp_data test_ulps[] =\n {\n";
foreach $fct (sort keys %test_ulps) {
print ULP " { \"$fct\", $test_ulps{$fct} },\n";
}
print ULP " };\n";
close ULP;
}
# Parse auto-libm-test-out.
sub parse_auto_input {
my ($file) = @_;
open AUTO, $file or die ("Can't open $file: $!");
while (<AUTO>) {
chop;
next if !/^= /;
s/^= //;
if (/^(\S+) (\S+) (.*)$/) {
$auto_tests{$1}{$2}{$3} = 1;
} else {
die ("bad automatic test line: $_\n");
}
}
close AUTO;
}
Reference in New Issue View Git Blame Copy Permalink