This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Move some libm-test logic for running tests from gen-libm-test.pl to libm-test.inc
- From: "Joseph S. Myers" <joseph at codesourcery dot com>
- To: <libc-alpha at sourceware dot org>
- Date: Tue, 7 May 2013 22:05:17 +0000
- Subject: Move some libm-test logic for running tests from gen-libm-test.pl to libm-test.inc
As discussed, it would be desirable to move libm-test.inc tests to
storing details of the test inputs and expected results in arrays so
that the test functions just need to loop over those arrays rather
than containing large amounts of code in each function that takes a
while to compile.
This patch prepares for an incremental conversion to the use of such
arrays. The idea is that when some tests are in arrays and others are
still in code, the logic for what C statements to use to run a
particular kind of test should be in one place only, so the same
statements get used in both cases, whether repeated inside a function
for tests still in code or inside a C loop for tests moved to an
array.
Accordingly, this patch defines RUN_TEST_* macros in libm-test.inc,
with gen-libm-test.pl no longer generating calls to check_* functions,
or various assignment statements, directly.
Inevitably these macros look quite similar to each other, but I don't
see a good way to avoid duplication, and for the various special cases
such as checking the values of variables set through pointers, I'd
rather have the special cases in the form of separate macros than in
the form of magic in gen-libm-test.pl that knows about specific
functions. Once the conversion to tables is complete, some of the
magic in gen-libm-test.pl should be able to go away (it won't need to
know about which cases are type-generic macros, for example, and
variable names will be passed directly in RUN_TEST_* macros in
libm-test.inc). This is the best I could come up with for this stage
of the conversion.
I'm thinking that each of these macros will end up having a
corresponding struct type[*] to store the test data, and a
corresponding RUN_TEST_LOOP_* macro that runs the tests listed in an
array, optionally also setting and restoring the rounding mode. For
the transition, gen-libm-test.pl will handle both TEST_* calls inside
an array (generate array initializers) and inside a function (generate
calls to RUN_TEST_*). The only difference between initializer
contents and contents of a call will be that calls name the variables
used for results set through pointers or implicitly, but those aren't
included in initializers.
[*] The macro variants for type-generic macros don't need separate
struct types from the non-type-generic variants. However, TEST_ff_f
is used for conventional two-argument functions (atan2, pow, etc.),
and nexttoward whose second argument always has type long double
rather than the type FLOAT being tested and which will need a separate
struct. (It's also used for jn/yn, but that's a clear bug where
TEST_if_f (not currently used) should be used instead.)
Tested x86_64.
2013-05-07 Joseph Myers <joseph@codesourcery.com>
* math/libm-test.inc (RUN_TEST_f_f): New macro.
(RUN_TEST_2_f): Likewise.
(RUN_TEST_ff_f): Likewise.
(RUN_TEST_fi_f): Likewise.
(RUN_TEST_fl_f): Likewise.
(RUN_TEST_fff_f): Likewise.
(RUN_TEST_c_f): Likewise.
(RUN_TEST_f_f1): Likewise.
(RUN_TEST_fF_f1): Likewise.
(RUN_TEST_fI_f1): Likewise.
(RUN_TEST_ffI_f1): Likewise.
(RUN_TEST_c_c): Likewise.
(RUN_TEST_cc_c): Likewise.
(RUN_TEST_f_i): Likewise.
(RUN_TEST_f_i_tg): Likewise.
(RUN_TEST_ff_i_tg): Likewise.
(RUN_TEST_f_b): Likewise.
(RUN_TEST_f_b_tg): Likewise.
(RUN_TEST_f_l): Likewise.
(RUN_TEST_f_L): Likewise.
(RUN_TEST_sincos): Likewise.
* math/gen-libm-test.pl (new_test): Take new argument to indicate
whether to show exceptions. Do not include ");\n" in return
value.
(special_functions): Output call to RUN_TEST_sincos instead of
check_float calls. Update calls to new_test.
(parse_args): Output call to single RUN_TEST_* macro instead of
check_* calls and other assignments. Update calls to new_test.
diff --git a/math/gen-libm-test.pl b/math/gen-libm-test.pl
index 2f93898..3170b05 100755
--- a/math/gen-libm-test.pl
+++ b/math/gen-libm-test.pl
@@ -163,7 +163,7 @@ sub get_variable {
# Add a new test to internal data structures and fill in the
# ulps and exception information for the C line.
sub new_test {
- my ($test, $exception) = @_;
+ my ($test, $exception, $show_exception) = @_;
my $rest;
# Add ulp.
@@ -172,12 +172,13 @@ sub new_test {
} else {
$rest = ', 0';
}
- if (defined $exception) {
- $rest .= ", $exception";
- } else {
- $rest .= ', 0';
+ if ($show_exception) {
+ if (defined $exception) {
+ $rest .= ", $exception";
+ } else {
+ $rest .= ', 0';
+ }
}
- $rest .= ");\n";
# We must increment here to keep @tests and count in sync
push @tests, $test;
++$count;
@@ -195,24 +196,21 @@ sub special_functions {
unless ($args[0] =~ /sincos/) {
die ("Don't know how to handle $args[0] extra.");
}
- print $file " {\n";
- print $file " FUNC (sincos) ($args[1], &sin_res, &cos_res);\n";
+ $cline = " RUN_TEST_sincos ($args[1]";
$str = 'sincos (' . &beautify ($args[1]) . ', &sin_res, &cos_res)';
# handle sin
$test = $str . ' puts ' . &beautify ($args[2]) . ' in sin_res';
- $cline = " check_float (\"$test\", sin_res, $args[2]";
- $cline .= &new_test ($test, $args[4]);
- print $file $cline;
+ $cline .= ", \"$test\", sin_res, $args[2]";
+ $cline .= &new_test ($test, $args[4], 0);
# handle cos
$test = $str . ' puts ' . &beautify ($args[3]) . ' in cos_res';
- $cline = " check_float (\"$test\", cos_res, $args[3]";
- # only tests once for exception
- $cline .= &new_test ($test, undef);
+ $cline .= ", \"$test\", cos_res, $args[3]";
+ $cline .= &new_test ($test, $args[4], 1);
+ $cline .= ");\n";
print $file $cline;
- print $file " }\n";
}
# Parse the arguments to TEST_x_y
@@ -220,8 +218,8 @@ sub parse_args {
my ($file, $descr, $fct, $args) = @_;
my (@args, $str, $descr_args, $descr_res, @descr);
my ($current_arg, $cline, $i);
- my ($pre, $post, @special);
- my ($extra_var, $call, $c_call);
+ my (@special);
+ my ($extra_var, $call);
if ($descr eq 'extra') {
&special_functions ($file, $args);
@@ -299,54 +297,34 @@ sub parse_args {
# Reset some variables to start again
$current_arg = 1;
$extra_var = 0;
- if (substr($descr_res,0,1) eq 'f') {
- $cline = 'check_float'
- } elsif (substr($descr_res,0,1) eq 'b') {
- $cline = 'check_bool';
- } elsif (substr($descr_res,0,1) eq 'c') {
- $cline = 'check_complex';
- } elsif (substr($descr_res,0,1) eq 'i') {
- $cline = 'check_int';
- } elsif (substr($descr_res,0,1) eq 'l') {
- $cline = 'check_long';
- } elsif (substr($descr_res,0,1) eq 'L') {
- $cline = 'check_longlong';
- }
+ $cline = "RUN_TEST_$descr";
# Special handling for some macros:
- $cline .= " (\"$str\", ";
if ($args[0] =~ /fpclassify|isnormal|isfinite|isinf|isnan|issignaling|signbit
|isgreater|isgreaterequal|isless|islessequal
|islessgreater|isunordered/x) {
- $c_call = "$args[0] (";
- } else {
- $c_call = " FUNC($args[0]) (";
+ $cline = "${cline}_tg";
}
+ $cline .= " (\"$str\", $args[0]";
@descr = split //,$descr_args;
for ($i=0; $i <= $#descr; $i++) {
- if ($i >= 1) {
- $c_call .= ', ';
- }
# FLOAT, int, long int, long long int
if ($descr[$i] =~ /f|i|l|L/) {
- $c_call .= $args[$current_arg];
+ $cline .= ", $args[$current_arg]";
$current_arg++;
next;
}
# &FLOAT, &int
if ($descr[$i] =~ /F|I/) {
- ++$extra_var;
- $c_call .= '&' . &get_variable ($extra_var);
next;
}
# complex
if ($descr[$i] eq 'c') {
- $c_call .= "BUILD_COMPLEX ($args[$current_arg], $args[$current_arg+1])";
+ $cline .= ", $args[$current_arg], $args[$current_arg+1]";
$current_arg += 2;
next;
}
}
- $c_call .= ')';
- $cline .= "$c_call, ";
+ $cline .= ", ";
@descr = split //,$descr_res;
foreach (@descr) {
@@ -354,7 +332,7 @@ sub parse_args {
$cline .= $args[$current_arg];
$current_arg++;
} elsif ($_ eq 'c') {
- $cline .= "BUILD_COMPLEX ($args[$current_arg], $args[$current_arg+1])";
+ $cline .= "$args[$current_arg], $args[$current_arg+1]";
$current_arg += 2;
} elsif ($_ eq '1') {
push @special, $args[$current_arg];
@@ -362,48 +340,75 @@ sub parse_args {
}
}
# Add ulp.
- $cline .= &new_test ($str, ($current_arg <= $#args) ? $args[$current_arg] : undef);
+ $cline .= &new_test ($str, ($current_arg <= $#args) ? $args[$current_arg] : undef, 1);
# special treatment for some functions
if ($args[0] eq 'frexp') {
- $pre = " x = 123456789;\n";
- if (defined $special[0] && $special[0] ne "IGNORE") {
- my ($str) = "$call sets x to $special[0]";
- $post = " check_int (\"$str\", x, $special[0]";
- $post .= &new_test ($str, undef);
+ if (defined $special[0]) {
+ my ($extra_expected) = $special[0];
+ my ($run_extra) = ($extra_expected ne "IGNORE" ? 1 : 0);
+ my ($str) = "$call sets x to $extra_expected";
+ if (!$run_extra) {
+ $str = "";
+ $extra_expected = "0";
+ }
+ $cline .= ", \"$str\", x, 123456789, $run_extra, $extra_expected";
+ if ($run_extra) {
+ $cline .= &new_test ($str, undef, 0);
+ } else {
+ $cline .= ", 0";
+ }
}
} elsif ($args[0] eq 'gamma' || $args[0] eq 'lgamma') {
- $pre = " signgam = 0;\n";
- if (defined $special[0] && $special[0] ne "IGNORE") {
- my ($str) = "$call sets signgam to $special[0]";
- $post = " check_int (\"$str\", signgam, $special[0]";
- $post .= &new_test ($str, undef);
+ if (defined $special[0]) {
+ my ($extra_expected) = $special[0];
+ my ($run_extra) = ($extra_expected ne "IGNORE" ? 1 : 0);
+ my ($str) = "$call sets signgam to $extra_expected";
+ if (!$run_extra) {
+ $str = "";
+ $extra_expected = "0";
+ }
+ $cline .= ", \"$str\", signgam, 0, $run_extra, $extra_expected";
+ if ($run_extra) {
+ $cline .= &new_test ($str, undef, 0);
+ } else {
+ $cline .= ", 0";
+ }
}
} elsif ($args[0] eq 'modf') {
- $pre = " x = 123.456789;\n";
- if (defined $special[0] && $special[0] ne "IGNORE") {
- my ($str) = "$call sets x to $special[0]";
- $post = " check_float (\"$str\", x, $special[0]";
- $post .= &new_test ($str, undef);
+ if (defined $special[0]) {
+ my ($extra_expected) = $special[0];
+ my ($run_extra) = ($extra_expected ne "IGNORE" ? 1 : 0);
+ my ($str) = "$call sets x to $extra_expected";
+ if (!$run_extra) {
+ $str = "";
+ $extra_expected = "0";
+ }
+ $cline .= ", \"$str\", x, 123.456789, $run_extra, $extra_expected";
+ if ($run_extra) {
+ $cline .= &new_test ($str, undef, 0);
+ } else {
+ $cline .= ", 0";
+ }
}
} elsif ($args[0] eq 'remquo') {
- $pre = " x = 123456789;\n";
- if (defined $special[0] && $special[0] ne "IGNORE") {
- my ($str) = "$call sets x to $special[0]";
- $post = " check_int (\"$str\", x, $special[0]";
- $post .= &new_test ($str, undef);
+ if (defined $special[0]) {
+ my ($extra_expected) = $special[0];
+ my ($run_extra) = ($extra_expected ne "IGNORE" ? 1 : 0);
+ my ($str) = "$call sets x to $extra_expected";
+ if (!$run_extra) {
+ $str = "";
+ $extra_expected = "0";
+ }
+ $cline .= ", \"$str\", x, 123456789, $run_extra, $extra_expected";
+ if ($run_extra) {
+ $cline .= &new_test ($str, undef, 0);
+ } else {
+ $cline .= ", 0";
+ }
}
}
-
- if (defined $pre or defined $post) {
- print $file " {\n";
- print $file " $pre" if (defined $pre);
- print $file " $cline";
- print $file " $post" if (defined $post);
- print $file " }\n";
- } else {
- print $file " $cline";
- }
+ print $file " $cline);\n";
}
# Generate libm-test.c
diff --git a/math/libm-test.inc b/math/libm-test.inc
index f289e99..3d7d276 100644
--- a/math/libm-test.inc
+++ b/math/libm-test.inc
@@ -855,6 +855,139 @@ check_longlong (const char *test_name, long long int computed,
errno = 0;
}
+/* Run an individual test, including any required setup and checking
+ of results. */
+#define RUN_TEST_f_f(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_2_f(TEST_NAME, FUNC_NAME, ARG1, ARG2, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG1, ARG2), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_ff_f RUN_TEST_2_f
+#define RUN_TEST_fi_f RUN_TEST_2_f
+#define RUN_TEST_fl_f RUN_TEST_2_f
+#define RUN_TEST_fff_f(TEST_NAME, FUNC_NAME, ARG1, ARG2, ARG3, \
+ EXPECTED, MAX_ULP, EXCEPTIONS) \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG1, ARG2, ARG3), \
+ EXPECTED, MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_c_f(TEST_NAME, FUNC_NAME, ARG1, ARG2, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_float (TEST_NAME, \
+ FUNC (FUNC_NAME) (BUILD_COMPLEX (ARG1, ARG2)), \
+ EXPECTED, MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_f1(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS, \
+ EXTRA_NAME, EXTRA_VAR, EXTRA_INIT, EXTRA_TEST, \
+ EXTRA_EXPECTED, EXTRA_ULP) \
+ do \
+ { \
+ (EXTRA_VAR) = (EXTRA_INIT); \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS); \
+ if (EXTRA_TEST) \
+ check_int (EXTRA_NAME, EXTRA_VAR, EXTRA_EXPECTED, \
+ EXTRA_ULP, 0); \
+ } \
+ while (0)
+#define RUN_TEST_fF_f1(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS, \
+ EXTRA_NAME, EXTRA_VAR, EXTRA_INIT, EXTRA_TEST, \
+ EXTRA_EXPECTED, EXTRA_ULP) \
+ do \
+ { \
+ (EXTRA_VAR) = (EXTRA_INIT); \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG, &(EXTRA_VAR)), \
+ EXPECTED, MAX_ULP, EXCEPTIONS); \
+ if (EXTRA_TEST) \
+ check_float (EXTRA_NAME, EXTRA_VAR, EXTRA_EXPECTED, \
+ EXTRA_ULP, 0); \
+ } \
+ while (0)
+#define RUN_TEST_fI_f1(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS, \
+ EXTRA_NAME, EXTRA_VAR, EXTRA_INIT, EXTRA_TEST, \
+ EXTRA_EXPECTED, EXTRA_ULP) \
+ do \
+ { \
+ (EXTRA_VAR) = (EXTRA_INIT); \
+ check_float (TEST_NAME, FUNC (FUNC_NAME) (ARG, &(EXTRA_VAR)), \
+ EXPECTED, MAX_ULP, EXCEPTIONS); \
+ if (EXTRA_TEST) \
+ check_int (EXTRA_NAME, EXTRA_VAR, EXTRA_EXPECTED, \
+ EXTRA_ULP, 0); \
+ } \
+ while (0)
+#define RUN_TEST_ffI_f1(TEST_NAME, FUNC_NAME, ARG1, ARG2, EXPECTED, \
+ MAX_ULP, EXCEPTIONS, \
+ EXTRA_NAME, EXTRA_VAR, EXTRA_INIT, EXTRA_TEST, \
+ EXTRA_EXPECTED, EXTRA_ULP) \
+ do \
+ { \
+ (EXTRA_VAR) = (EXTRA_INIT); \
+ check_float (TEST_NAME, \
+ FUNC (FUNC_NAME) (ARG1, ARG2, &(EXTRA_VAR)), \
+ EXPECTED, MAX_ULP, EXCEPTIONS); \
+ if (EXTRA_TEST) \
+ check_int (EXTRA_NAME, EXTRA_VAR, EXTRA_EXPECTED, \
+ EXTRA_ULP, 0); \
+ } \
+ while (0)
+#define RUN_TEST_c_c(TEST_NAME, FUNC_NAME, ARGR, ARGC, EXPR, EXPC, \
+ MAX_ULP, EXCEPTIONS) \
+ check_complex (TEST_NAME, \
+ FUNC (FUNC_NAME) (BUILD_COMPLEX (ARGR, ARGC)), \
+ BUILD_COMPLEX (EXPR, EXPC), \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_cc_c(TEST_NAME, FUNC_NAME, ARG1R, ARG1C, ARG2R, ARG2C, \
+ EXPR, EXPC, MAX_ULP, EXCEPTIONS) \
+ check_complex (TEST_NAME, \
+ FUNC (FUNC_NAME) (BUILD_COMPLEX (ARG1R, ARG1C), \
+ BUILD_COMPLEX (ARG2R, ARG2C)), \
+ BUILD_COMPLEX (EXPR, EXPC), \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_i(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_int (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_i_tg(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_int (TEST_NAME, FUNC_NAME (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_ff_i_tg(TEST_NAME, FUNC_NAME, ARG1, ARG2, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_int (TEST_NAME, FUNC_NAME (ARG1, ARG2), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_b(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_bool (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_b_tg(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_bool (TEST_NAME, FUNC_NAME (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_l(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_long (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_f_L(TEST_NAME, FUNC_NAME, ARG, EXPECTED, \
+ MAX_ULP, EXCEPTIONS) \
+ check_longlong (TEST_NAME, FUNC (FUNC_NAME) (ARG), EXPECTED, \
+ MAX_ULP, EXCEPTIONS)
+#define RUN_TEST_sincos(ARG, TEST_NAME_SIN, SIN_RES_VAR, EXPECTED_SIN, \
+ MAX_ULP_SIN, TEST_NAME_COS, COS_RES_VAR, \
+ EXPECTED_COS, MAX_ULP_COS, EXCEPTIONS) \
+ do \
+ { \
+ FUNC (sincos) (ARG, &(SIN_RES_VAR), &(COS_RES_VAR)); \
+ check_float (TEST_NAME_SIN, SIN_RES_VAR, \
+ EXPECTED_SIN, MAX_ULP_SIN, EXCEPTIONS); \
+ check_float (TEST_NAME_COS, COS_RES_VAR, \
+ EXPECTED_COS, MAX_ULP_COS, 0); \
+ } \
+ while (0)
+
/* This is to prevent messages from the SVID libm emulation. */
--
Joseph S. Myers
joseph@codesourcery.com