manual/libm-err-tab.pl

   1 #!/usr/bin/perl -w
   2 # Copyright (C) 1999, 2001 Free Software Foundation, Inc.
   3 # This file is part of the GNU C Library.
   4 # Contributed by Andreas Jaeger <aj@suse.de>, 1999.
   5
   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.
  10
  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.
  15
  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/>.
  19
  20 # Information about tests are stored in: %results
  21 # $results{$test}{"type"} is the result type, e.g. normal or complex.
  22 # In the following description $platform, $type and $float are:
  23 # - $platform is the used platform
  24 # - $type is either "normal", "real" (for the real part of a complex number)
  25 #   or "imag" (for the imaginary part # of a complex number).
  26 # - $float is either of float, ifloat, double, idouble, ldouble, ildouble;
  27 #   It represents the underlying floating point type (float, double or long
  28 #   double) and if inline functions (the leading i stands for inline)
  29 #   are used.
  30 # $results{$test}{$platform}{$type}{$float} is defined and has a delta
  31 # or 'fail' as value.
  32
  33 use File::Find;
  34
  35 use strict;
  36
  37 use vars qw ($sources @platforms %pplatforms);
  38 use vars qw (%results @all_floats %suffices @all_functions);
  39
  40
  41 # all_floats is in output order and contains all recognised float types that
  42 # we're going to output
  43 @all_floats = ('float', 'double', 'ldouble');
  44 %suffices =
  45   ( 'float' => 'f',
  46     'double' => '',
  47     'ldouble' => 'l'
  48   );
  49
  50 # Pretty description of platform
  51 %pplatforms =
  52   ( "i386/fpu" => "ix86",
  53     "generic" => "Generic",
  54     "alpha/fpu" => "Alpha",
  55     "ia64/fpu" => "IA64",
  56     "m68k/fpu" => "M68k",
  57     "mips/fpu" => "MIPS",
  58     "powerpc/fpu" => "PowerPC",
  59     "sparc/sparc32/fpu" => "Sparc 32-bit",
  60     "sparc/sparc64/fpu" => "Sparc 64-bit",
  61     "sh/sh4/fpu" => "SH4",
  62     "s390/fpu" => "S/390",
  63     "arm" => "ARM"
  64   );
  65
  66 @all_functions =
  67   ( "acos", "acosh", "asin", "asinh", "atan", "atanh",
  68     "atan2", "cabs", "cacos", "cacosh", "carg", "casin", "casinh",
  69     "catan", "catanh", "cbrt", "ccos", "ccosh", "ceil", "cexp", "cimag",
  70     "clog", "clog10", "conj", "copysign", "cos", "cosh", "cpow", "cproj",
  71     "creal", "csin", "csinh", "csqrt", "ctan", "ctanh", "erf", "erfc",
  72     "exp", "exp10", "exp2", "expm1", "fabs", "fdim", "floor", "fma",
  73     "fmax", "fmin", "fmod", "frexp", "gamma", "hypot",
  74     "ilogb", "j0", "j1", "jn", "lgamma", "lrint",
  75     "llrint", "log", "log10", "log1p", "log2", "logb", "lround",
  76     "llround", "modf", "nearbyint", "nextafter", "nexttoward", "pow",
  77     "remainder", "remquo", "rint", "round", "scalb", "scalbn", "scalbln",
  78     "sin", "sincos", "sinh", "sqrt", "tan", "tanh", "tgamma",
  79     "trunc", "y0", "y1", "yn" );
  80 # "fpclassify", "isfinite", "isnormal", "signbit" are not tabulated
  81
  82 if ($#ARGV == 0) {
  83   $sources = $ARGV[0];
  84 } else {
  85   $sources = '/usr/src/cvs/libc';
  86 }
  87
  88 find (\&find_files, $sources);
  89
  90 @platforms = sort by_platforms @platforms;
  91
  92 &print_all;
  93
  94 sub find_files {
  95   if ($_ eq 'libm-test-ulps') {
  96     # print "Parsing $File::Find::name\n";
  97     push @platforms, $File::Find::dir;
  98     &parse_ulps ($File::Find::name, $File::Find::dir);
  99   }
 100 }
 101
 102 # Parse ulps file
 103 sub parse_ulps {
 104   my ($file, $platform) = @_;
 105   my ($test, $type, $float, $eps, $kind);
 106
 107   # $type has the following values:
 108   # "normal": No complex variable
 109   # "real": Real part of complex result
 110   # "imag": Imaginary part of complex result
 111   open ULP, $file  or die ("Can't open $file: $!");
 112   while (<ULP>) {
 113     chop;
 114     # ignore comments and empty lines
 115     next if /^#/;
 116     next if /^\s*$/;
 117     if (/^Test/) {
 118       $kind = 'test';
 119       next;
 120     }
 121     if (/^Function: /) {
 122       if (/Real part of/) {
 123         s/Real part of //;
 124         $type = 'real';
 125       } elsif (/Imaginary part of/) {
 126         s/Imaginary part of //;
 127         $type = 'imag';
 128       } else {
 129         $type = 'normal';
 130       }
 131       ($test) = ($_ =~ /^Function:\s*\"([a-zA-Z0-9_]+)\"/);
 132       $kind = 'fct';
 133       next;
 134     }
 135     # Only handle maximal errors of functions
 136     next if ($kind eq 'test');
 137     if (/^i?(float|double|ldouble):/) {
 138       ($float, $eps) = split /\s*:\s*/,$_,2;
 139       if ($eps eq 'fail') {
 140         $results{$test}{$platform}{$type}{$float} = 'fail';
 141       } elsif ($eps eq "0") {
 142         # ignore
 143         next;
 144       } elsif (!exists $results{$test}{$platform}{$type}{$float}
 145             || $results{$test}{$platform}{$type}{$float} ne 'fail') {
 146         $results{$test}{$platform}{$type}{$float} = $eps;
 147       }
 148       if ($type =~ /^real|imag$/) {
 149         $results{$test}{'type'} = 'complex';
 150       } elsif ($type eq 'normal') {
 151         $results{$test}{'type'} = 'normal';
 152       }
 153       next;
 154     }
 155     print "Skipping unknown entry: `$_'\n";
 156   }
 157   close ULP;
 158 }
 159
 160 sub get_value {
 161   my ($fct, $platform, $type, $float) = @_;
 162
 163   return (exists $results{$fct}{$platform}{$type}{$float}
 164           ? $results{$fct}{$platform}{$type}{$float} : "0");
 165 }
 166
 167 sub canonicalize_platform {
 168   my ($platform) = @_;
 169
 170   $platform =~ s|^(.*/sysdeps/)||;
 171
 172
 173   return exists $pplatforms{$platform} ? $pplatforms{$platform} : $platform;
 174 }
 175
 176 sub print_platforms {
 177   my (@p) = @_;
 178   my ($fct, $platform, $float, $first, $i, $platform_no, $platform_total);
 179
 180   print '@multitable {nexttowardf} ';
 181   foreach (@p) {
 182     print ' {1000 + i 1000}';
 183   }
 184   print "\n";
 185
 186   print '@item Function ';
 187   foreach (@p) {
 188     print ' @tab ';
 189     print &canonicalize_platform ($_);
 190   }
 191   print "\n";
 192
 193
 194   foreach $fct (@all_functions) {
 195     foreach $float (@all_floats) {
 196       print "\@item $fct$suffices{$float} ";
 197       foreach $platform (@p) {
 198         print ' @tab ';
 199         if (exists $results{$fct}{$platform}{'normal'}{$float}
 200             || exists $results{$fct}{$platform}{'real'}{$float}
 201             || exists $results{$fct}{$platform}{'imag'}{$float}) {
 202           if ($results{$fct}{'type'} eq 'complex') {
 203             print &get_value ($fct, $platform, 'real', $float),
 204             ' + i ', &get_value ($fct, $platform, 'imag', $float);
 205           } else {
 206             print $results{$fct}{$platform}{'normal'}{$float};
 207           }
 208         } else {
 209           print '-';
 210         }
 211       }
 212       print "\n";
 213     }
 214   }
 215
 216   print "\@end multitable\n";
 217 }
 218
 219 sub print_all {
 220   my ($i, $max);
 221
 222   my ($columns) = 5;
 223
 224   # Print only 5 platforms at a time.
 225   for ($i=0; $i < $#platforms; $i+=$columns) {
 226     $max = $i+$columns-1 > $#platforms ? $#platforms : $i+$columns-1;
 227     print_platforms (@platforms[$i .. $max]);
 228   }
 229 }
 230
 231 sub by_platforms {
 232   my ($pa, $pb);
 233
 234   $pa = $pplatforms{$a} ? $pplatforms{$a} : $a;
 235   $pb = $pplatforms{$b} ? $pplatforms{$b} : $b;
 236
 237   return $pa cmp $pb;
 238 }