2 # Copyright (C) 1999-2016 Free Software Foundation, Inc.
3 # This file is part of the GNU C Library.
4 # Contributed by Andreas Jaeger <aj@suse.de>, 1999.
6 # The GNU C Library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
11 # The GNU C Library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with the GNU C Library; if not, see
18 # <http://www.gnu.org/licenses/>.
20 # This file needs to be tidied up
21 # Note that functions and tests share the same namespace.
23 # Information about tests are stored in: %results
24 # $results{$test}{"type"} is the result type, e.g. normal or complex.
25 # $results{$test}{"has_ulps"} is set if deltas exist.
26 # In the following description $type and $float are:
27 # - $type is either "normal", "real" (for the real part of a complex number)
28 # or "imag" (for the imaginary part # of a complex number).
29 # - $float is either of float, ifloat, double, idouble, ldouble, ildouble;
30 # It represents the underlying floating point type (float, double or long
31 # double) and if inline functions (the leading i stands for inline)
33 # $results{$test}{$type}{"ulp"}{$float} is defined and has a delta as value
40 use vars qw
($input $output $auto_input);
41 use vars qw
(%results);
42 use vars qw
(%beautify @all_floats %all_floats_pfx);
43 use vars qw
($output_dir $ulps_file $srcdir);
44 use vars qw
(%auto_tests);
46 # all_floats is sorted and contains all recognised float types
47 @all_floats = ('double', 'float', 'idouble',
48 'ifloat', 'ildouble', 'ldouble');
50 # all_floats_pfx maps C types to their C like prefix for macros.
58 ( "minus_zero" => "-0",
66 "minus_infty" => "-inf",
67 "plus_infty" => "inf",
68 "qnan_value" => "qNaN",
69 "snan_value" => "sNaN",
70 "snan_value_ld" => "sNaN",
79 # n: generate new ulps file
80 use vars
qw($opt_u $opt_h $opt_o $opt_n);
83 $ulps_file = 'libm-test-ulps';
85 ($srcdir = $0) =~ s{[^/]*$}{};
88 print "Usage: gen-libm-test.pl [OPTIONS]\n";
89 print " -h print this help, then exit\n";
90 print " -o DIR directory where generated files will be placed\n";
91 print " -n only generate sorted file NewUlps from libm-test-ulps\n";
92 print " -u FILE input file with ulps\n";
96 $ulps_file = $opt_u if ($opt_u);
97 $output_dir = $opt_o if ($opt_o);
99 $input = "libm-test.inc";
100 $auto_input = "${srcdir}auto-libm-test-out";
101 $output = "${output_dir}libm-test.c";
103 &parse_ulps ($ulps_file);
104 &parse_auto_input ($auto_input);
105 &generate_testfile ($input, $output) unless ($opt_n);
106 &output_ulps ("${output_dir}libm-test-ulps.h", $ulps_file) unless ($opt_n);
107 &print_ulps_file ("${output_dir}NewUlps") if ($opt_n);
109 # Return a nicer representation
114 if (exists $beautify{$arg}) {
115 return $beautify{$arg};
120 if (exists $beautify{$tmp}) {
121 return '-' . $beautify{$tmp};
124 if ($arg =~ /^-?0x[0-9a-f.]*p[-+][0-9]+f$/) {
127 if ($arg =~ /[0-9]L$/) {
133 # Return a nicer representation of a complex number
134 sub build_complex_beautify {
138 $str1 = &beautify ($r);
139 $str2 = &beautify ($i);
142 $str1 .= ' - ' . $str2;
144 $str1 .= ' + ' . $str2;
150 # Return the text to put in an initializer for a test's exception
152 sub show_exceptions {
153 my ($ignore_result, $non_finite, $test_snan, $exception) = @_;
154 $ignore_result = ($ignore_result ? "IGNORE_RESULT|" : "");
155 $non_finite = ($non_finite ? "NON_FINITE|" : "");
156 $test_snan = ($test_snan ? "TEST_SNAN|" : "");
157 if (defined $exception) {
158 return ", ${ignore_result}${non_finite}${test_snan}$exception";
160 return ", ${ignore_result}${non_finite}${test_snan}0";
164 # Apply the LIT(x) macro to a literal floating point constant
165 # and strip any existing suffix.
168 my $exp_re = "([+-])?[[:digit:]]+";
169 # Don't wrap something that does not look like a:
170 # * Hexadecimal FP value
171 # * Decimal FP value without a decimal point
172 # * Decimal value with a fraction
173 return $lit if $lit !~ /([+-])?0x[[:xdigit:]\.]+[pP]$exp_re/
174 and $lit !~ /[[:digit:]]+[eE]$exp_re/
175 and $lit !~ /[[:digit:]]*\.[[:digit:]]*([eE]$exp_re)?/;
177 # Strip any existing literal suffix.
180 return "LIT (${lit})";
183 # Apply LIT macro to individual tokens within an expression.
185 # This function assumes the C expression follows GNU coding
186 # standards. Specifically, a space separates each lexical
187 # token. Otherwise, this post-processing may apply LIT
188 # incorrectly, or around an entire expression.
191 my @toks = split (/ /, $lit);
193 $_ = _apply_lit ($_);
195 return join (' ', @toks);
198 # Parse the arguments to TEST_x_y
200 my ($file, $descr, $args) = @_;
201 my (@args, $descr_args, $descr_res, @descr);
202 my ($current_arg, $cline, $cline_res, $i);
205 my ($ignore_result_any, $ignore_result_all);
206 my ($num_res, @args_res, @start_rm, $rm);
207 my (@plus_oflow, @minus_oflow, @plus_uflow, @minus_uflow);
208 my (@errno_plus_oflow, @errno_minus_oflow);
209 my (@errno_plus_uflow, @errno_minus_uflow);
210 my ($non_finite, $test_snan);
212 ($descr_args, $descr_res) = split /_/,$descr, 2;
214 @args = split /,\s*/, $args;
218 # Generate first the string that's shown to the user
220 @descr = split //,$descr_args;
221 for ($i = 0; $i <= $#descr; $i++) {
223 if ($current_arg > 1) {
226 # FLOAT, int, long int, long long int
227 if ($descr[$i] =~ /f|j|i|l|L/) {
228 $call_args .= $comma . &beautify ($args[$current_arg]);
232 # &FLOAT, &int - simplify call by not showing argument.
233 if ($descr[$i] =~ /F|I/) {
237 if ($descr[$i] eq 'c') {
238 $call_args .= $comma . &build_complex_beautify ($args[$current_arg], $args[$current_arg+1]);
243 die ("$descr[$i] is unknown");
247 @args_res = @args[$current_arg .. $#args];
249 @descr = split //,$descr_res;
251 if ($_ =~ /f|i|l|L/) {
253 } elsif ($_ eq 'c') {
255 } elsif ($_ eq 'b') {
258 } elsif ($_ eq '1') {
261 die ("$_ is unknown");
265 if ($#args_res == $num_res - 1) {
266 # One set of results for all rounding modes, no flags.
267 @start_rm = ( 0, 0, 0, 0 );
268 } elsif ($#args_res == $num_res) {
269 # One set of results for all rounding modes, with flags.
270 die ("wrong number of arguments")
271 unless ($args_res[$#args_res] =~ /EXCEPTION|ERRNO|IGNORE_ZERO_INF_SIGN|TEST_NAN_SIGN|NO_TEST_INLINE|XFAIL_TEST/);
272 @start_rm = ( 0, 0, 0, 0 );
273 } elsif ($#args_res == 4 * $num_res + 3) {
274 # One set of results per rounding mode, with flags.
275 @start_rm = ( 0, $num_res + 1, 2 * $num_res + 2, 3 * $num_res + 3 );
277 die ("wrong number of arguments");
280 # Put the C program line together
281 # Reset some variables to start again
283 $cline = "{ \"$call_args\"";
284 @descr = split //,$descr_args;
285 for ($i=0; $i <= $#descr; $i++) {
286 # FLOAT, int, long int, long long int
287 if ($descr[$i] =~ /f|j|i|l|L/) {
288 if ($descr[$i] eq "f") {
289 $cline .= ", " . &apply_lit ($args[$current_arg]);
291 $cline .= ", $args[$current_arg]";
297 if ($descr[$i] =~ /F|I/) {
301 if ($descr[$i] eq 'c') {
302 $cline .= ", " . &apply_lit ($args[$current_arg]);
303 $cline .= ", " . &apply_lit ($args[$current_arg+1]);
309 @descr = split //,$descr_res;
310 @plus_oflow = qw(max_value plus_infty max_value plus_infty);
311 @minus_oflow = qw(minus_infty minus_infty -max_value -max_value);
312 @plus_uflow = qw(plus_zero plus_zero plus_zero min_subnorm_value);
313 @minus_uflow = qw(-min_subnorm_value minus_zero minus_zero minus_zero);
314 @errno_plus_oflow = qw(0 ERRNO_ERANGE 0 ERRNO_ERANGE);
315 @errno_minus_oflow = qw(ERRNO_ERANGE ERRNO_ERANGE 0 0);
316 @errno_plus_uflow = qw(ERRNO_ERANGE ERRNO_ERANGE ERRNO_ERANGE 0);
317 @errno_minus_uflow = qw(0 ERRNO_ERANGE ERRNO_ERANGE ERRNO_ERANGE);
318 for ($rm = 0; $rm <= 3; $rm++) {
319 $current_arg = $start_rm[$rm];
320 $ignore_result_any = 0;
321 $ignore_result_all = 1;
325 if ($_ =~ /b|f|j|i|l|L/ ) {
326 my ($result) = $args_res[$current_arg];
327 if ($result eq "IGNORE") {
328 $ignore_result_any = 1;
331 $ignore_result_all = 0;
334 $result = apply_lit
($result);
336 $cline_res .= ", $result";
338 } elsif ($_ eq 'c') {
339 my ($result1) = $args_res[$current_arg];
340 if ($result1 eq "IGNORE") {
341 $ignore_result_any = 1;
344 $ignore_result_all = 0;
346 my ($result2) = $args_res[$current_arg + 1];
347 if ($result2 eq "IGNORE") {
348 $ignore_result_any = 1;
351 $ignore_result_all = 0;
353 $result1 = apply_lit
($result1);
354 $result2 = apply_lit
($result2);
355 $cline_res .= ", $result1, $result2";
357 } elsif ($_ eq '1') {
358 push @special, $args_res[$current_arg];
362 if ($ignore_result_any && !$ignore_result_all) {
363 die ("some but not all function results ignored\n");
365 # Determine whether any arguments or results, for any rounding
366 # mode, are non-finite.
367 $non_finite = ($args =~ /qnan_value|snan_value|plus_infty|minus_infty/);
368 $test_snan = ($args =~ /snan_value/);
370 $cline_res .= show_exceptions
($ignore_result_any,
373 ($current_arg <= $#args_res)
374 ?
$args_res[$current_arg]
377 # special treatment for some functions
381 my ($extra_expected) = $_;
382 my ($run_extra) = ($extra_expected ne "IGNORE" ?
1 : 0);
384 $extra_expected = "0";
386 $extra_expected = apply_lit
($extra_expected);
388 $cline_res .= ", $run_extra, $extra_expected";
390 $cline_res =~ s/^, //;
391 $cline_res =~ s/plus_oflow/$plus_oflow[$rm]/g;
392 $cline_res =~ s/minus_oflow/$minus_oflow[$rm]/g;
393 $cline_res =~ s/plus_uflow/$plus_uflow[$rm]/g;
394 $cline_res =~ s/minus_uflow/$minus_uflow[$rm]/g;
395 $cline_res =~ s/ERRNO_PLUS_OFLOW/$errno_plus_oflow[$rm]/g;
396 $cline_res =~ s/ERRNO_MINUS_OFLOW/$errno_minus_oflow[$rm]/g;
397 $cline_res =~ s/ERRNO_PLUS_UFLOW/$errno_plus_uflow[$rm]/g;
398 $cline_res =~ s/ERRNO_MINUS_UFLOW/$errno_minus_uflow[$rm]/g;
399 $cline .= ", { $cline_res }";
401 print $file " $cline },\n";
404 # Convert a condition from auto-libm-test-out to C form.
405 sub convert_condition
{
408 @conds = split /:/, $cond;
413 $ret = join " && ", @conds;
417 # Return text to OR a value into an accumulated flags string.
427 # Return a conditional expression between two values.
429 my ($cond, $if, $else) = @_;
432 } elsif ($cond eq "0") {
435 return "($cond ? $if : $else)";
439 # Return text to OR a conditional expression between two values into
440 # an accumulated flags string.
442 my ($cond, $if, $else) = @_;
443 return or_value
(cond_value
($cond, $if, $else));
446 # Generate libm-test.c
447 sub generate_testfile
{
448 my ($input, $output) = @_;
450 open INPUT
, $input or die ("Can't open $input: $!");
451 open OUTPUT
, ">$output" or die ("Can't open $output: $!");
453 # Replace the special macros
455 # AUTO_TESTS (function),
456 if (/^\s*AUTO_TESTS_/) {
457 my ($descr, $func, @modes, $auto_test, $num_auto_tests);
458 my (@rm_tests, $rm, $i);
459 @modes = qw(downward tonearest towardzero upward);
460 ($descr, $func) = ($_ =~ /AUTO_TESTS_(\w+)\s*\((\w+)\)/);
461 for ($rm = 0; $rm <= 3; $rm++) {
462 $rm_tests[$rm] = [sort keys %{$auto_tests{$func}{$modes[$rm]}}];
464 $num_auto_tests = scalar @
{$rm_tests[0]};
465 for ($rm = 1; $rm <= 3; $rm++) {
466 if ($num_auto_tests != scalar @
{$rm_tests[$rm]}) {
467 die ("inconsistent numbers of tests for $func\n");
469 for ($i = 0; $i < $num_auto_tests; $i++) {
470 if ($rm_tests[0][$i] ne $rm_tests[$rm][$i]) {
471 die ("inconsistent list of tests of $func\n");
475 if ($num_auto_tests == 0) {
476 die ("no automatic tests for $func\n");
478 foreach $auto_test (@
{$rm_tests[0]}) {
479 my ($format, $inputs, $format_conv, $args_str);
480 ($format, $inputs) = split / /, $auto_test, 2;
482 $format_conv = convert_condition
($format);
483 print OUTPUT
"#if $format_conv\n";
484 $args_str = "$func, $inputs";
485 for ($rm = 0; $rm <= 3; $rm++) {
486 my ($auto_test_out, $outputs, $flags);
487 my ($flags_conv, @flags, %flag_cond);
488 $auto_test_out = $auto_tests{$func}{$modes[$rm]}{$auto_test};
489 ($outputs, $flags) = split / : */, $auto_test_out;
490 $outputs =~ s/ /, /g;
491 @flags = split / /, $flags;
493 if (/^([^:]*):(.*)$/) {
496 $cond = convert_condition
($2);
497 if (defined ($flag_cond{$flag})) {
498 if ($flag_cond{$flag} ne "1") {
499 $flag_cond{$flag} .= " || $cond";
502 $flag_cond{$flag} = $cond;
505 $flag_cond{$_} = "1";
509 if (defined ($flag_cond{"ignore-zero-inf-sign"})) {
510 $flags_conv .= or_cond_value
($flag_cond{"ignore-zero-inf-sign"},
511 "IGNORE_ZERO_INF_SIGN", "0");
513 if (defined ($flag_cond{"no-test-inline"})) {
514 $flags_conv .= or_cond_value
($flag_cond{"no-test-inline"},
515 "NO_TEST_INLINE", "0");
517 if (defined ($flag_cond{"xfail"})) {
518 $flags_conv .= or_cond_value
($flag_cond{"xfail"},
521 my (@exc_list) = qw(divbyzero inexact invalid overflow underflow);
523 foreach $exc (@exc_list) {
524 my ($exc_expected, $exc_ok, $no_exc, $exc_cond, $exc_ok_cond);
525 $exc_expected = "\U$exc\E_EXCEPTION";
526 $exc_ok = "\U$exc\E_EXCEPTION_OK";
528 if ($exc eq "inexact") {
530 $no_exc = "NO_INEXACT_EXCEPTION";
532 if (defined ($flag_cond{$exc})) {
533 $exc_cond = $flag_cond{$exc};
537 if (defined ($flag_cond{"$exc-ok"})) {
538 $exc_ok_cond = $flag_cond{"$exc-ok"};
542 $flags_conv .= or_cond_value
($exc_cond,
543 cond_value
($exc_ok_cond,
544 $exc_ok, $exc_expected),
545 cond_value
($exc_ok_cond,
548 my ($errno_expected, $errno_unknown_cond);
549 if (defined ($flag_cond{"errno-edom"})) {
550 if ($flag_cond{"errno-edom"} ne "1") {
551 die ("unexpected condition for errno-edom");
553 if (defined ($flag_cond{"errno-erange"})) {
554 die ("multiple errno values expected");
556 $errno_expected = "ERRNO_EDOM";
557 } elsif (defined ($flag_cond{"errno-erange"})) {
558 if ($flag_cond{"errno-erange"} ne "1") {
559 die ("unexpected condition for errno-erange");
561 $errno_expected = "ERRNO_ERANGE";
563 $errno_expected = "ERRNO_UNCHANGED";
565 if (defined ($flag_cond{"errno-edom-ok"})) {
566 if (defined ($flag_cond{"errno-erange-ok"})
567 && ($flag_cond{"errno-erange-ok"}
568 ne $flag_cond{"errno-edom-ok"})) {
569 $errno_unknown_cond = "($flag_cond{\"errno-edom-ok\"} || $flag_cond{\"errno-erange-ok\"})";
571 $errno_unknown_cond = $flag_cond{"errno-edom-ok"};
573 } elsif (defined ($flag_cond{"errno-erange-ok"})) {
574 $errno_unknown_cond = $flag_cond{"errno-erange-ok"};
576 $errno_unknown_cond = "0";
578 $flags_conv .= or_cond_value
($errno_unknown_cond,
579 "0", $errno_expected);
580 if ($flags_conv eq "") {
581 $flags_conv = ", NO_EXCEPTION";
583 $flags_conv =~ s/^ \|/,/;
585 $args_str .= ", $outputs$flags_conv";
587 &parse_args
(\
*OUTPUT
, $descr, $args_str);
588 print OUTPUT
"#endif\n";
597 ($descr, $args) = ($_ =~ /TEST_(\w+)\s*\((.*)\)/);
598 &parse_args
(\
*OUTPUT
, $descr, $args);
612 my ($test, $type, $float, $eps, $float_regex);
614 # Build a basic regex to match type entries in the
615 # generated ULPS file.
616 foreach my $ftype (@all_floats) {
617 $float_regex .= "|" . $ftype;
619 $float_regex = "^" . substr ($float_regex, 1) . ":";
621 # $type has the following values:
622 # "normal": No complex variable
623 # "real": Real part of complex result
624 # "imag": Imaginary part of complex result
625 open ULP
, $file or die ("Can't open $file: $!");
628 # ignore comments and empty lines
632 if (/Real part of/) {
635 } elsif (/Imaginary part of/) {
636 s/Imaginary part of //;
641 ($test) = ($_ =~ /^Function:\s*\"([a-zA-Z0-9_]+)\"/);
644 if (/$float_regex/) {
645 ($float, $eps) = split /\s*:\s*/,$_,2;
651 if (!defined ($results{$test}{$type}{'ulp'}{$float})
652 || $results{$test}{$type}{'ulp'}{$float} < $eps) {
653 $results{$test}{$type}{'ulp'}{$float} = $eps;
654 $results{$test}{'has_ulps'} = 1;
657 if ($type =~ /^real|imag$/) {
658 $results{$test}{'type'} = 'complex';
659 } elsif ($type eq 'normal') {
660 $results{$test}{'type'} = 'normal';
664 print "Skipping unknown entry: `$_'\n";
670 # Clean up a floating point number
671 sub clean_up_number
{
674 # Remove trailing zeros after the decimal point
675 if ($number =~ /\./) {
682 # Output a file which can be read in as ulps file.
683 sub print_ulps_file
{
685 my ($test, $type, $float, $eps, $fct, $last_fct);
688 open NEWULP
, ">$file" or die ("Can't open $file: $!");
689 print NEWULP
"# Begin of automatic generation\n";
690 print NEWULP
"\n# Maximal error of functions:\n";
692 foreach $fct (sort keys %results) {
693 foreach $type ('real', 'imag', 'normal') {
694 if (exists $results{$fct}{$type}) {
695 if ($type eq 'normal') {
696 print NEWULP
"Function: \"$fct\":\n";
697 } elsif ($type eq 'real') {
698 print NEWULP
"Function: Real part of \"$fct\":\n";
699 } elsif ($type eq 'imag') {
700 print NEWULP
"Function: Imaginary part of \"$fct\":\n";
702 foreach $float (@all_floats) {
703 if (exists $results{$fct}{$type}{'ulp'}{$float}) {
704 print NEWULP
"$float: ",
705 &clean_up_number
($results{$fct}{$type}{'ulp'}{$float}),
713 print NEWULP
"# end of automatic generation\n";
718 my ($test, $type, $float) = @_;
720 return (exists $results{$test}{$type}{'ulp'}{$float}
721 ?
$results{$test}{$type}{'ulp'}{$float} : "0");
724 # Return the ulps value for a single test.
725 sub get_all_ulps_for_test
{
726 my ($test, $type) = @_;
727 my ($ldouble, $double, $float, $ildouble, $idouble, $ifloat);
730 if (exists $results{$test}{'has_ulps'}) {
731 foreach $float (@all_floats) {
732 $ulps_str .= &get_ulps
($test, $type, $float) . ", ";
734 return "{" . substr ($ulps_str, 0, -2) . "}";
736 die "get_all_ulps_for_test called for \"$test\" with no ulps\n";
742 my ($file, $ulps_filename) = @_;
743 my ($i, $fct, $type, $ulp, $ulp_real, $ulp_imag);
744 my (%func_ulps, %func_real_ulps, %func_imag_ulps);
746 open ULP
, ">$file" or die ("Can't open $file: $!");
748 print ULP
"/* This file is automatically generated\n";
749 print ULP
" from $ulps_filename with gen-libm-test.pl.\n";
750 print ULP
" Don't change it - change instead the master files. */\n\n";
752 print ULP
"struct ulp_data\n";
754 print ULP
" const char *name;\n";
755 print ULP
" FLOAT max_ulp[" . @all_floats . "];\n";
758 for ($i = 0; $i <= $#all_floats; $i++) {
759 $type = $all_floats[$i];
760 print ULP
"#define ULP_";
763 $type = substr $type, 1;
765 print ULP
"$all_floats_pfx{$type} $i\n";
768 foreach $fct (keys %results) {
769 $type = $results{$fct}{'type'};
770 if ($type eq 'normal') {
771 $ulp = get_all_ulps_for_test
($fct, 'normal');
772 } elsif ($type eq 'complex') {
773 $ulp_real = get_all_ulps_for_test
($fct, 'real');
774 $ulp_imag = get_all_ulps_for_test
($fct, 'imag');
776 die "unknown results ($fct) type $type\n";
778 if ($type eq 'normal') {
779 $func_ulps{$fct} = $ulp;
781 $func_real_ulps{$fct} = $ulp_real;
782 $func_imag_ulps{$fct} = $ulp_imag;
785 print ULP
"\n/* Maximal error of functions. */\n";
786 print ULP
"static const struct ulp_data func_ulps[] =\n {\n";
787 foreach $fct (sort keys %func_ulps) {
788 print ULP
" { \"$fct\", $func_ulps{$fct} },\n";
791 print ULP
"static const struct ulp_data func_real_ulps[] =\n {\n";
792 foreach $fct (sort keys %func_real_ulps) {
793 print ULP
" { \"$fct\", $func_real_ulps{$fct} },\n";
796 print ULP
"static const struct ulp_data func_imag_ulps[] =\n {\n";
797 foreach $fct (sort keys %func_imag_ulps) {
798 print ULP
" { \"$fct\", $func_imag_ulps{$fct} },\n";
804 # Parse auto-libm-test-out.
805 sub parse_auto_input
{
807 open AUTO
, $file or die ("Can't open $file: $!");
812 if (/^(\S+) (\S+) ([^:]*) : (.*)$/) {
813 $auto_tests{$1}{$2}{$3} = $4;
815 die ("bad automatic test line: $_\n");