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);
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');
51 ( "minus_zero" => "-0",
59 "minus_infty" => "-inf",
60 "plus_infty" => "inf",
61 "qnan_value" => "qNaN",
70 # n: generate new ulps file
71 use vars
qw($opt_u $opt_h $opt_o $opt_n);
74 $ulps_file = 'libm-test-ulps';
76 ($srcdir = $0) =~ s{[^/]*$}{};
79 print "Usage: gen-libm-test.pl [OPTIONS]\n";
80 print " -h print this help, then exit\n";
81 print " -o DIR directory where generated files will be placed\n";
82 print " -n only generate sorted file NewUlps from libm-test-ulps\n";
83 print " -u FILE input file with ulps\n";
87 $ulps_file = $opt_u if ($opt_u);
88 $output_dir = $opt_o if ($opt_o);
90 $input = "libm-test.inc";
91 $auto_input = "${srcdir}auto-libm-test-out";
92 $output = "${output_dir}libm-test.c";
94 &parse_ulps ($ulps_file);
95 &parse_auto_input ($auto_input);
96 &generate_testfile ($input, $output) unless ($opt_n);
97 &output_ulps ("${output_dir}libm-test-ulps.h", $ulps_file) unless ($opt_n);
98 &print_ulps_file ("${output_dir}NewUlps") if ($opt_n);
100 # Return a nicer representation
105 if (exists $beautify{$arg}) {
106 return $beautify{$arg};
111 if (exists $beautify{$tmp}) {
112 return '-' . $beautify{$tmp};
115 if ($arg =~ /^-?0x[0-9a-f.]*p[-+][0-9]+f$/) {
118 if ($arg =~ /[0-9]L$/) {
124 # Return a nicer representation of a complex number
125 sub build_complex_beautify {
129 $str1 = &beautify ($r);
130 $str2 = &beautify ($i);
133 $str1 .= ' - ' . $str2;
135 $str1 .= ' + ' . $str2;
141 # Return the text to put in an initializer for a test's exception
143 sub show_exceptions {
144 my ($ignore_result, $non_finite, $exception) = @_;
145 $ignore_result = ($ignore_result ? "IGNORE_RESULT|" : "");
146 $non_finite = ($non_finite ? "NON_FINITE|" : "");
147 if (defined $exception) {
148 return ", ${ignore_result}${non_finite}$exception";
150 return ", ${ignore_result}${non_finite}0";
154 # Parse the arguments to TEST_x_y
156 my ($file, $descr, $args) = @_;
157 my (@args, $descr_args, $descr_res, @descr);
158 my ($current_arg, $cline, $cline_res, $i);
161 my ($ignore_result_any, $ignore_result_all);
162 my ($num_res, @args_res, @start_rm, $rm);
163 my (@plus_oflow, @minus_oflow, @plus_uflow, @minus_uflow);
164 my (@errno_plus_oflow, @errno_minus_oflow);
165 my (@errno_plus_uflow, @errno_minus_uflow);
168 ($descr_args, $descr_res) = split /_/,$descr, 2;
170 @args = split /,\s*/, $args;
174 # Generate first the string that's shown to the user
176 @descr = split //,$descr_args;
177 for ($i = 0; $i <= $#descr; $i++) {
179 if ($current_arg > 1) {
182 # FLOAT, int, long int, long long int
183 if ($descr[$i] =~ /f|i|l|L/) {
184 $call_args .= $comma . &beautify ($args[$current_arg]);
188 # &FLOAT, &int - simplify call by not showing argument.
189 if ($descr[$i] =~ /F|I/) {
193 if ($descr[$i] eq 'c') {
194 $call_args .= $comma . &build_complex_beautify ($args[$current_arg], $args[$current_arg+1]);
199 die ("$descr[$i] is unknown");
203 @args_res = @args[$current_arg .. $#args];
205 @descr = split //,$descr_res;
207 if ($_ =~ /f|i|l|L/) {
209 } elsif ($_ eq 'c') {
211 } elsif ($_ eq 'b') {
214 } elsif ($_ eq '1') {
217 die ("$_ is unknown");
221 if ($#args_res == $num_res - 1) {
222 # One set of results for all rounding modes, no flags.
223 @start_rm = ( 0, 0, 0, 0 );
224 } elsif ($#args_res == $num_res) {
225 # One set of results for all rounding modes, with flags.
226 die ("wrong number of arguments")
227 unless ($args_res[$#args_res] =~ /EXCEPTION|ERRNO|IGNORE_ZERO_INF_SIGN|TEST_NAN_SIGN|NO_TEST_INLINE|XFAIL_TEST/);
228 @start_rm = ( 0, 0, 0, 0 );
229 } elsif ($#args_res == 4 * $num_res + 3) {
230 # One set of results per rounding mode, with flags.
231 @start_rm = ( 0, $num_res + 1, 2 * $num_res + 2, 3 * $num_res + 3 );
233 die ("wrong number of arguments");
236 # Put the C program line together
237 # Reset some variables to start again
239 $cline = "{ \"$call_args\"";
240 @descr = split //,$descr_args;
241 for ($i=0; $i <= $#descr; $i++) {
242 # FLOAT, int, long int, long long int
243 if ($descr[$i] =~ /f|i|l|L/) {
244 $cline .= ", $args[$current_arg]";
249 if ($descr[$i] =~ /F|I/) {
253 if ($descr[$i] eq 'c') {
254 $cline .= ", $args[$current_arg], $args[$current_arg+1]";
260 @descr = split //,$descr_res;
261 @plus_oflow = qw(max_value plus_infty max_value plus_infty);
262 @minus_oflow = qw(minus_infty minus_infty -max_value -max_value);
263 @plus_uflow = qw(plus_zero plus_zero plus_zero min_subnorm_value);
264 @minus_uflow = qw(-min_subnorm_value minus_zero minus_zero minus_zero);
265 @errno_plus_oflow = qw(0 ERRNO_ERANGE 0 ERRNO_ERANGE);
266 @errno_minus_oflow = qw(ERRNO_ERANGE ERRNO_ERANGE 0 0);
267 @errno_plus_uflow = qw(ERRNO_ERANGE ERRNO_ERANGE ERRNO_ERANGE 0);
268 @errno_minus_uflow = qw(0 ERRNO_ERANGE ERRNO_ERANGE ERRNO_ERANGE);
269 for ($rm = 0; $rm <= 3; $rm++) {
270 $current_arg = $start_rm[$rm];
271 $ignore_result_any = 0;
272 $ignore_result_all = 1;
276 if ($_ =~ /b|f|i|l|L/ ) {
277 my ($result) = $args_res[$current_arg];
278 if ($result eq "IGNORE") {
279 $ignore_result_any = 1;
282 $ignore_result_all = 0;
284 $cline_res .= ", $result";
286 } elsif ($_ eq 'c') {
287 my ($result1) = $args_res[$current_arg];
288 if ($result1 eq "IGNORE") {
289 $ignore_result_any = 1;
292 $ignore_result_all = 0;
294 my ($result2) = $args_res[$current_arg + 1];
295 if ($result2 eq "IGNORE") {
296 $ignore_result_any = 1;
299 $ignore_result_all = 0;
301 $cline_res .= ", $result1, $result2";
303 } elsif ($_ eq '1') {
304 push @special, $args_res[$current_arg];
308 if ($ignore_result_any && !$ignore_result_all) {
309 die ("some but not all function results ignored\n");
311 # Determine whether any arguments or results, for any rounding
312 # mode, are non-finite.
313 $non_finite = ($args =~ /qnan_value|plus_infty|minus_infty/);
315 $cline_res .= show_exceptions
($ignore_result_any,
317 ($current_arg <= $#args_res)
318 ?
$args_res[$current_arg]
321 # special treatment for some functions
325 my ($extra_expected) = $_;
326 my ($run_extra) = ($extra_expected ne "IGNORE" ?
1 : 0);
328 $extra_expected = "0";
330 $cline_res .= ", $run_extra, $extra_expected";
332 $cline_res =~ s/^, //;
333 $cline_res =~ s/plus_oflow/$plus_oflow[$rm]/g;
334 $cline_res =~ s/minus_oflow/$minus_oflow[$rm]/g;
335 $cline_res =~ s/plus_uflow/$plus_uflow[$rm]/g;
336 $cline_res =~ s/minus_uflow/$minus_uflow[$rm]/g;
337 $cline_res =~ s/ERRNO_PLUS_OFLOW/$errno_plus_oflow[$rm]/g;
338 $cline_res =~ s/ERRNO_MINUS_OFLOW/$errno_minus_oflow[$rm]/g;
339 $cline_res =~ s/ERRNO_PLUS_UFLOW/$errno_plus_uflow[$rm]/g;
340 $cline_res =~ s/ERRNO_MINUS_UFLOW/$errno_minus_uflow[$rm]/g;
341 $cline .= ", { $cline_res }";
343 print $file " $cline },\n";
346 # Convert a condition from auto-libm-test-out to C form.
347 sub convert_condition
{
350 @conds = split /:/, $cond;
355 $ret = join " && ", @conds;
359 # Return text to OR a value into an accumulated flags string.
369 # Return a conditional expression between two values.
371 my ($cond, $if, $else) = @_;
374 } elsif ($cond eq "0") {
377 return "($cond ? $if : $else)";
381 # Return text to OR a conditional expression between two values into
382 # an accumulated flags string.
384 my ($cond, $if, $else) = @_;
385 return or_value
(cond_value
($cond, $if, $else));
388 # Generate libm-test.c
389 sub generate_testfile
{
390 my ($input, $output) = @_;
392 open INPUT
, $input or die ("Can't open $input: $!");
393 open OUTPUT
, ">$output" or die ("Can't open $output: $!");
395 # Replace the special macros
397 # AUTO_TESTS (function),
398 if (/^\s*AUTO_TESTS_/) {
399 my ($descr, $func, @modes, $auto_test, $num_auto_tests);
400 my (@rm_tests, $rm, $i);
401 @modes = qw(downward tonearest towardzero upward);
402 ($descr, $func) = ($_ =~ /AUTO_TESTS_(\w+)\s*\((\w+)\)/);
403 for ($rm = 0; $rm <= 3; $rm++) {
404 $rm_tests[$rm] = [sort keys %{$auto_tests{$func}{$modes[$rm]}}];
406 $num_auto_tests = scalar @
{$rm_tests[0]};
407 for ($rm = 1; $rm <= 3; $rm++) {
408 if ($num_auto_tests != scalar @
{$rm_tests[$rm]}) {
409 die ("inconsistent numbers of tests for $func\n");
411 for ($i = 0; $i < $num_auto_tests; $i++) {
412 if ($rm_tests[0][$i] ne $rm_tests[$rm][$i]) {
413 die ("inconsistent list of tests of $func\n");
417 if ($num_auto_tests == 0) {
418 die ("no automatic tests for $func\n");
420 foreach $auto_test (@
{$rm_tests[0]}) {
421 my ($format, $inputs, $format_conv, $args_str);
422 ($format, $inputs) = split / /, $auto_test, 2;
424 $format_conv = convert_condition
($format);
425 print OUTPUT
"#if $format_conv\n";
426 $args_str = "$func, $inputs";
427 for ($rm = 0; $rm <= 3; $rm++) {
428 my ($auto_test_out, $outputs, $flags);
429 my ($flags_conv, @flags, %flag_cond);
430 $auto_test_out = $auto_tests{$func}{$modes[$rm]}{$auto_test};
431 ($outputs, $flags) = split / : */, $auto_test_out;
432 $outputs =~ s/ /, /g;
433 @flags = split / /, $flags;
435 if (/^([^:]*):(.*)$/) {
438 $cond = convert_condition
($2);
439 if (defined ($flag_cond{$flag})) {
440 if ($flag_cond{$flag} ne "1") {
441 $flag_cond{$flag} .= " || $cond";
444 $flag_cond{$flag} = $cond;
447 $flag_cond{$_} = "1";
451 if (defined ($flag_cond{"ignore-zero-inf-sign"})) {
452 $flags_conv .= or_cond_value
($flag_cond{"ignore-zero-inf-sign"},
453 "IGNORE_ZERO_INF_SIGN", "0");
455 if (defined ($flag_cond{"no-test-inline"})) {
456 $flags_conv .= or_cond_value
($flag_cond{"no-test-inline"},
457 "NO_TEST_INLINE", "0");
459 if (defined ($flag_cond{"xfail"})) {
460 $flags_conv .= or_cond_value
($flag_cond{"xfail"},
463 my (@exc_list) = qw(divbyzero inexact invalid overflow underflow);
465 foreach $exc (@exc_list) {
466 my ($exc_expected, $exc_ok, $no_exc, $exc_cond, $exc_ok_cond);
467 $exc_expected = "\U$exc\E_EXCEPTION";
468 $exc_ok = "\U$exc\E_EXCEPTION_OK";
470 if ($exc eq "inexact") {
472 $no_exc = "NO_INEXACT_EXCEPTION";
474 if (defined ($flag_cond{$exc})) {
475 $exc_cond = $flag_cond{$exc};
479 if (defined ($flag_cond{"$exc-ok"})) {
480 $exc_ok_cond = $flag_cond{"$exc-ok"};
484 $flags_conv .= or_cond_value
($exc_cond,
485 cond_value
($exc_ok_cond,
486 $exc_ok, $exc_expected),
487 cond_value
($exc_ok_cond,
490 my ($errno_expected, $errno_unknown_cond);
491 if (defined ($flag_cond{"errno-edom"})) {
492 if ($flag_cond{"errno-edom"} ne "1") {
493 die ("unexpected condition for errno-edom");
495 if (defined ($flag_cond{"errno-erange"})) {
496 die ("multiple errno values expected");
498 $errno_expected = "ERRNO_EDOM";
499 } elsif (defined ($flag_cond{"errno-erange"})) {
500 if ($flag_cond{"errno-erange"} ne "1") {
501 die ("unexpected condition for errno-erange");
503 $errno_expected = "ERRNO_ERANGE";
505 $errno_expected = "ERRNO_UNCHANGED";
507 if (defined ($flag_cond{"errno-edom-ok"})) {
508 if (defined ($flag_cond{"errno-erange-ok"})
509 && ($flag_cond{"errno-erange-ok"}
510 ne $flag_cond{"errno-edom-ok"})) {
511 $errno_unknown_cond = "($flag_cond{\"errno-edom-ok\"} || $flag_cond{\"errno-erange-ok\"})";
513 $errno_unknown_cond = $flag_cond{"errno-edom-ok"};
515 } elsif (defined ($flag_cond{"errno-erange-ok"})) {
516 $errno_unknown_cond = $flag_cond{"errno-erange-ok"};
518 $errno_unknown_cond = "0";
520 $flags_conv .= or_cond_value
($errno_unknown_cond,
521 "0", $errno_expected);
522 if ($flags_conv eq "") {
523 $flags_conv = ", NO_EXCEPTION";
525 $flags_conv =~ s/^ \|/,/;
527 $args_str .= ", $outputs$flags_conv";
529 &parse_args
(\
*OUTPUT
, $descr, $args_str);
530 print OUTPUT
"#endif\n";
539 ($descr, $args) = ($_ =~ /TEST_(\w+)\s*\((.*)\)/);
540 &parse_args
(\
*OUTPUT
, $descr, $args);
554 my ($test, $type, $float, $eps);
556 # $type has the following values:
557 # "normal": No complex variable
558 # "real": Real part of complex result
559 # "imag": Imaginary part of complex result
560 open ULP
, $file or die ("Can't open $file: $!");
563 # ignore comments and empty lines
567 if (/Real part of/) {
570 } elsif (/Imaginary part of/) {
571 s/Imaginary part of //;
576 ($test) = ($_ =~ /^Function:\s*\"([a-zA-Z0-9_]+)\"/);
579 if (/^i?(float|double|ldouble):/) {
580 ($float, $eps) = split /\s*:\s*/,$_,2;
586 if (!defined ($results{$test}{$type}{'ulp'}{$float})
587 || $results{$test}{$type}{'ulp'}{$float} < $eps) {
588 $results{$test}{$type}{'ulp'}{$float} = $eps;
589 $results{$test}{'has_ulps'} = 1;
592 if ($type =~ /^real|imag$/) {
593 $results{$test}{'type'} = 'complex';
594 } elsif ($type eq 'normal') {
595 $results{$test}{'type'} = 'normal';
599 print "Skipping unknown entry: `$_'\n";
605 # Clean up a floating point number
606 sub clean_up_number
{
609 # Remove trailing zeros after the decimal point
610 if ($number =~ /\./) {
617 # Output a file which can be read in as ulps file.
618 sub print_ulps_file
{
620 my ($test, $type, $float, $eps, $fct, $last_fct);
623 open NEWULP
, ">$file" or die ("Can't open $file: $!");
624 print NEWULP
"# Begin of automatic generation\n";
625 print NEWULP
"\n# Maximal error of functions:\n";
627 foreach $fct (sort keys %results) {
628 foreach $type ('real', 'imag', 'normal') {
629 if (exists $results{$fct}{$type}) {
630 if ($type eq 'normal') {
631 print NEWULP
"Function: \"$fct\":\n";
632 } elsif ($type eq 'real') {
633 print NEWULP
"Function: Real part of \"$fct\":\n";
634 } elsif ($type eq 'imag') {
635 print NEWULP
"Function: Imaginary part of \"$fct\":\n";
637 foreach $float (@all_floats) {
638 if (exists $results{$fct}{$type}{'ulp'}{$float}) {
639 print NEWULP
"$float: ",
640 &clean_up_number
($results{$fct}{$type}{'ulp'}{$float}),
648 print NEWULP
"# end of automatic generation\n";
653 my ($test, $type, $float) = @_;
655 return (exists $results{$test}{$type}{'ulp'}{$float}
656 ?
$results{$test}{$type}{'ulp'}{$float} : "0");
659 # Return the ulps value for a single test.
660 sub get_all_ulps_for_test
{
661 my ($test, $type) = @_;
662 my ($ldouble, $double, $float, $ildouble, $idouble, $ifloat);
664 if (exists $results{$test}{'has_ulps'}) {
665 # XXX use all_floats (change order!)
666 $ldouble = &get_ulps
($test, $type, "ldouble");
667 $double = &get_ulps
($test, $type, "double");
668 $float = &get_ulps
($test, $type, "float");
669 $ildouble = &get_ulps
($test, $type, "ildouble");
670 $idouble = &get_ulps
($test, $type, "idouble");
671 $ifloat = &get_ulps
($test, $type, "ifloat");
672 return "CHOOSE ($ldouble, $double, $float, $ildouble, $idouble, $ifloat)";
674 die "get_all_ulps_for_test called for \"$test\" with no ulps\n";
680 my ($file, $ulps_filename) = @_;
681 my ($i, $fct, $type, $ulp, $ulp_real, $ulp_imag);
682 my (%func_ulps, %func_real_ulps, %func_imag_ulps);
684 open ULP
, ">$file" or die ("Can't open $file: $!");
686 print ULP
"/* This file is automatically generated\n";
687 print ULP
" from $ulps_filename with gen-libm-test.pl.\n";
688 print ULP
" Don't change it - change instead the master files. */\n\n";
690 foreach $fct (keys %results) {
691 $type = $results{$fct}{'type'};
692 if ($type eq 'normal') {
693 $ulp = get_all_ulps_for_test
($fct, 'normal');
694 } elsif ($type eq 'complex') {
695 $ulp_real = get_all_ulps_for_test
($fct, 'real');
696 $ulp_imag = get_all_ulps_for_test
($fct, 'imag');
698 die "unknown results ($fct) type $type\n";
700 if ($type eq 'normal') {
701 $func_ulps{$fct} = $ulp;
703 $func_real_ulps{$fct} = $ulp_real;
704 $func_imag_ulps{$fct} = $ulp_imag;
707 print ULP
"\n/* Maximal error of functions. */\n";
708 print ULP
"static const struct ulp_data func_ulps[] =\n {\n";
709 foreach $fct (sort keys %func_ulps) {
710 print ULP
" { \"$fct\", $func_ulps{$fct} },\n";
713 print ULP
"static const struct ulp_data func_real_ulps[] =\n {\n";
714 foreach $fct (sort keys %func_real_ulps) {
715 print ULP
" { \"$fct\", $func_real_ulps{$fct} },\n";
718 print ULP
"static const struct ulp_data func_imag_ulps[] =\n {\n";
719 foreach $fct (sort keys %func_imag_ulps) {
720 print ULP
" { \"$fct\", $func_imag_ulps{$fct} },\n";
726 # Parse auto-libm-test-out.
727 sub parse_auto_input
{
729 open AUTO
, $file or die ("Can't open $file: $!");
734 if (/^(\S+) (\S+) ([^:]*) : (.*)$/) {
735 $auto_tests{$1}{$2}{$3} = $4;
737 die ("bad automatic test line: $_\n");