]> git.saurik.com Git - bison.git/blobdiff - etc/bench.pl.in
Use strict on bench.pl.
[bison.git] / etc / bench.pl.in
index 041bc3f6a9003cf168a6937fa387dcc9150dcc2e..22328cfa91381893cc4820f7c799281d778c7710 100755 (executable)
@@ -23,42 +23,125 @@ bench.pl - perform benches on Bison parsers.
 
 =head1 SYNOPSIS
 
-  ./bench.pl
+  ./bench.pl [OPTIONS]... BENCHES
+
+=head1 BENCHES
+
+Specify the set of benches to run.  I<bench-name> should be one of:
+
+=over 4
+
+=item I<fusion>
+
+Test F<lalr1.cc> with three stacks against F<lalr1-fusion.cc> which
+uses a single one.
+
+=item I<push>
+
+Test the push parser vs. the pull interface.  Use the C parser.
+
+=item I<variant>
+
+Test the use of variants instead of union in the C++ parser.
+
+=back
 
 =head1 OPTIONS
 
 =item B<-c>, B<--cflags>=I<flags>
 
-Flags to pass to the C or C++ compiler.
+Flags to pass to the C or C++ compiler.  Defaults to -O2.
+
+=item B<-h>, B<--help>
+
+Display this message and exit succesfully.  The more verbose, the more
+details.
 
 =item B<-i>, B<--iterations>=I<integer>
 
-Say how many times a single test of the bench must be run.
+Say how many times a single test of the bench must be run.  If
+negative, specify the minimum number of CPU seconds to run.  Defaults
+to -1.
+
+=item B<-q>, B<--quiet>
+
+Decrease the verbosity level (defaults to 1).
 
 =item B<-v>, B<--verbose>
 
-Raise the verbosity level.  Currently only affects B<--help>.
+Raise the verbosity level (defaults to 1).
+
+=back
 
 =cut
 
+use strict;
 use IO::File;
-use Benchmark qw (:all);
+
+##################################################################
+
+=head1 VARIABLES
+
+=over 4
+
+=item C<@bench>
+
+The list of benches to run.
+
+=item C<$bison>
+
+The Bison program to use to compile the grammar.
+
+=item C<$cc>
+
+The C compiler.
+
+=item C<$cxx>
+
+The C++ compiler.
+
+=item C<$cflags>
+
+Compiler flags (C or C++).
+
+=item C<$iterations>
+
+The number of times the parser is run for a bench.
+
+=item C<$verbose>
+
+Verbosity level.
+
+=back
+
+=cut
 
 my $bison = $ENV{'BISON'} || '@abs_top_builddir@/tests/bison';
 my $cc = $ENV{'CC'} || 'gcc';
 my $cxx = $ENV{'CXX'} || 'g++';
-# Compiler flags (C or C++).
-my $cflags = '';
-# The number of times the parser is run for a bench.
-my $iterations = 50;
+my $cflags = '-O2';
+my $iterations = -1;
+my $verbose = 1;
 
-##################################################################
+=head1 FUNCTIONS
 
-=head1 DESCRIPTIONS
+=over 4
 
-=head2 Functions
+=item C<verbose($level, $message)>
 
-=over 4
+Report the C<$message> is C<$level> E<lt>= C<$verbose>.
+
+=cut
+
+sub verbose($$)
+{
+  my ($level, $message) = @_;
+  print STDERR $message
+    if $level <= $verbose;
+}
+
+
+######################################################################
 
 =item C<directives($bench, @directive)>
 
@@ -72,9 +155,9 @@ not a valid directive.
 
 sub directives($@)
 {
-  my ($bench, @directives) = @_;
+  my ($bench, @directive) = @_;
   my $res = "/* Directives for bench `$bench'. */\n";
-  for my $d (@directives)
+  for my $d (@directive)
     {
       $res .= $d . "\n"
         unless $d eq '%variant';
@@ -83,7 +166,9 @@ sub directives($@)
   return $res;
 }
 
-=item C<triangular_grammar ($base, $max, @directives)>
+######################################################################
+
+=item C<generate_grammar_triangular ($base, $max, @directive)>
 
 Create a large triangular grammar which looks like :
 
@@ -103,16 +188,16 @@ Create a large triangular grammar which looks like :
 
 C<$base> is the base name for the file to create (F<$base.y>).
 C<$max> is the number of such rules (here, 5).  You may pass
-additional Bison C<@directives>.
+additional Bison C<@directive>.
 
 The created parser is self contained: it includes its scanner, and
 source of input.
 =cut
 
-sub triangular_grammar ($$$)
+sub generate_grammar_triangular ($$@)
 {
-  my ($base, $max, @directives) = @_;
-  my $directives = directives ($base, @directives);
+  my ($base, $max, @directive) = @_;
+  my $directives = directives ($base, @directive);
 
   my $out = new IO::File ">$base.y"
     or die;
@@ -220,18 +305,19 @@ sub calc_input ($$)
 }
 
 ##################################################################
-=item C<calc_grammar ($base, $max, @directives)>
+
+=item C<generate_grammar_calc ($base, $max, @directive)>
 
 Generate a Bison file F<$base.y> for a calculator parser in C.  Pass
-the additional Bison C<@directives>.  C<$max> is ignored, but left to
+the additional Bison C<@directive>.  C<$max> is ignored, but left to
 have the same interface as C<triangular_grammar>.
 
 =cut
 
-sub calc_grammar ($$$)
+sub generate_grammar_calc ($$@)
 {
-  my ($base, $max, @directives) = @_;
-  my $directives = directives ($base, @directives);
+  my ($base, $max, @directive) = @_;
+  my $directives = directives ($base, @directive);
 
   my $out = new IO::File ">$base.y"
     or die;
@@ -430,32 +516,32 @@ EOF
 
 ##################################################################
 
-=item C<variant_grammar ($base, $max, @directives)>
+=item C<generate_grammar_variant ($base, $max, @directive)>
 
 Generate a Bison file F<$base.y> that uses, or not, the Boost.Variants
-depending on the C<@directives>.
+depending on the C<@directive>.
 
 =cut
 
-sub variant_grammar ($$$)
+sub generate_grammar_variant ($$@)
 {
-  my ($base, $max, @directives) = @_;
-  my $directives = directives ($base, @directives);
-  my $variant = grep { '%variant' } @directives;
+  my ($base, $max, @directive) = @_;
+  my $directives = directives ($base, @directive);
+  my $variant = grep { $_ eq '%variant' } @directive;
 
   my $out = new IO::File ">$base.y"
     or die;
   print $out <<EOF;
-%debug
 %language "C++"
 %defines
+$directives
 
-%code requires // code for the .hh file
+%code requires // variant.h
 {
 #include <string>
 }
 
-%code // code for the .cc file
+%code // variant.c
 {
 #include <algorithm>
 #include <iostream>
@@ -464,7 +550,7 @@ sub variant_grammar ($$$)
 // Prototype of the yylex function providing subsequent tokens.
 static yy::parser::token_type yylex(yy::parser::semantic_type* yylval);
 
-#define STAGE_MAX    ($max * 10)
+#define STAGE_MAX    ($max * 10) // max = $max
 #define USE_VARIANTS $variant
 #if USE_VARIANTS
 # define IF_VARIANTS(True, False) True
@@ -543,12 +629,12 @@ yylex(yy::parser::semantic_type* yylval)
     return yy::parser::token::END_OF_FILE;
   else if (stage % 2)
     {
-      IF_VARIANTS(*yylval, yylval->ival) = stage;
+      IF_VARIANTS(yylval->build<int>(), yylval->ival) = stage;
       return yy::parser::token::NUMBER;
     }
   else
     {
-      IF_VARIANTS(*yylval =, yylval->sval = new) std::string("A string.");
+      IF_VARIANTS(yylval->build<std::string>() =, yylval->sval = new) std::string("A string.");
       return yy::parser::token::TEXT;
     }
   abort();
@@ -565,7 +651,9 @@ yy::parser::error(const yy::parser::location_type& yylloc,
 int main(int argc, char *argv[])
 {
   yy::parser p;
+#if YYDEBUG
   p.set_debug_level(!!getenv("YYDEBUG"));
+#endif
   p.parse();
   return 0;
 }
@@ -574,6 +662,43 @@ EOF
 
 ##################################################################
 
+=item C<generate_grammar ($name, $base, @directive)>
+
+Generate F<$base.y> by calling C<&generate_grammar_$name>.
+
+=cut
+
+sub generate_grammar ($$@)
+{
+  my ($name, $base, @directive) = @_;
+  verbose 2, "Generating $base.y\n";
+  my %generator =
+    (
+      "calc"       => \&generate_grammar_calc,
+      "triangular" => \&generate_grammar_triangular,
+      "variant"    => \&generate_grammar_variant,
+    );
+  &{$generator{$name}}($base, 200, @directive);
+}
+
+##################################################################
+
+=item C<run ($command)>
+
+Run, possibly verbosely, the shell C<$command>.
+
+=cut
+
+sub run ($)
+{
+  my ($command) = @_;
+  verbose 2, "$command\n";
+  system ("$command") == 0
+    or die "$command failed";
+}
+
+##################################################################
+
 =item C<compile ($base)>
 
 Compile C<$base.y> to an executable C, Using the C or C++ compiler
@@ -589,20 +714,20 @@ sub compile ($)
 
   my $compiler = $language eq 'C++' ? $cxx : $cc;
 
-  system ("$bison $base.y -o $base.c") == 0
-    or die;
-  system ("$compiler -o $base $cflags $base.c") == 0
-    or die;
+  run "$bison $base.y -o $base.c";
+  run "$compiler -o $base $cflags $base.c";
 }
 
+######################################################################
+
 =item C<bench_grammar ($gram, %bench)>
 
 Generate benches for C<$gram>.  C<$gram> should be C<calc> or
 C<triangle>.  C<%bench> is a hash of the form:
 
-  $name => @directives
+  $name => @directive
 
-where C<$name> is the name of the bench, and C<@directives> are the
+where C<$name> is the name of the bench, and C<@directive> are the
 Bison directive to use for this bench.  All the benches are compared
 against each other, repeated 50 times.
 
@@ -612,25 +737,53 @@ sub bench_grammar ($%)
 {
   my ($gram, %test) = @_;
 
+  use Benchmark qw (:all :hireswallclock);
+
   # Set up the benches as expected by timethese.
   my %bench;
+  # For each bench, capture the size.
+  my %size;
   while (my ($name, $directives) = each %test)
     {
-      print STDERR "$name\n";
-      # Call the Bison input file generator.
-      my $generator = "$gram" . "_grammar";
-      &$generator ($name, 200, @$directives);
+      generate_grammar ($gram, $name, @$directives);
+      # Compile the executable.
       compile ($name);
       $bench{$name} = "system ('./$name');";
+      chop($size{$name} = `wc -c <$name`);
     }
 
-  print "$gram:\n";
   # Run the benches.
+  #
+  # STYLE can be any of 'all', 'none', 'noc', 'nop' or 'auto'.  'all'
+  # shows each of the 5 times available ('wallclock' time, user time,
+  # system time, user time of children, and system time of
+  # children). 'noc' shows all except the two children times. 'nop'
+  # shows only wallclock and the two children times.  'auto' (the
+  # default) will act as 'all' unless the children times are both
+  # zero, in which case it acts as 'noc'.  'none' prevents output.
+  verbose 2, "Running the benches for $gram\n";
   my $res = timethese ($iterations, \%bench, 'nop');
-  # Output the result.
+
+  # Output the speed result.
   cmpthese ($res, 'nop');
+
+  # Display the sizes.
+  print "Sizes (decreasing):\n";
+  my $width = 10;
+  for my $bench (keys %size)
+    {
+      $width = length $bench
+        if $width < length $bench;
+    }
+  # Benches sorted by decreasing size.
+  my @benches_per_size = sort {$size{$b} <=> $size{$a}} keys %size;
+  for my $bench (@benches_per_size)
+    {
+      printf "%${width}s: %5.2fkB\n", $bench, $size{$bench} / 1024;
+    }
 }
 
+######################################################################
 
 =item C<bench_push_parser ()>
 
@@ -653,6 +806,8 @@ sub bench_push_parser ()
     );
 }
 
+######################################################################
+
 =item C<bench_variant_parser ()>
 
 Bench the C++ lalr1.cc parser using Boost.Variants or %union.
@@ -664,8 +819,31 @@ sub bench_variant_parser ()
   bench_grammar
     ('variant',
      (
-      "union"    => [],
-      "variant"  => ['%variant'],
+      "f-union"         => ['%skeleton "lalr1-fusion.cc"'],
+      "f-uni-deb"   => ['%skeleton "lalr1-fusion.cc"', '%debug'],
+      "f-var"       => ['%skeleton "lalr1-fusion.cc"', '%variant'],
+      "f-var-deb" => ['%skeleton "lalr1-fusion.cc"', '%debug', '%variant'],
+      "f-var-dtr"       => ['%skeleton "lalr1-fusion.cc"', '%variant', "%code {\n#define VARIANT_DESTROY\n}"],
+      "f-var-deb-dtr" => ['%skeleton "lalr1-fusion.cc"', '%debug', '%variant', "%code {\n#define VARIANT_DESTROY\n}"],
+     )
+    );
+}
+
+######################################################################
+
+=item C<bench_fusion_parser ()>
+
+Bench the C++ lalr1.cc parser using Boost.Variants or %union.
+
+=cut
+
+sub bench_fusion_parser ()
+{
+  bench_grammar
+    ('variant',
+     (
+      "split"         => [],
+      "fused"         => ['%skeleton "lalr1-fusion.cc"'],
      )
     );
 }
@@ -683,14 +861,18 @@ sub help ($)
                -output  => \*STDOUT });
 }
 
+######################################################################
+
 sub getopt ()
 {
   use Getopt::Long;
-  my $verbose = 0;
-  %option = ("h|help"     => sub { help ($verbose) },
-            "v|verbose"  => sub { ++$verbose },
-             "c|cflags=s" => \$cflags,
-             "i|iterations=i" => \$iterations);
+  my %option = (
+    "c|cflags=s"     => \$cflags,
+    "h|help"         => sub { help ($verbose) },
+    "i|iterations=i" => \$iterations,
+    "q|quiet"        => sub { --$verbose },
+    "v|verbose"      => sub { ++$verbose },
+    );
   Getopt::Long::Configure ("bundling", "pass_through");
   GetOptions (%option)
     or exit 1;
@@ -699,9 +881,18 @@ sub getopt ()
 ######################################################################
 
 getopt;
-print STDERR "Using bison=$bison, cc=$cc, cxx=$cxx, cflags=$cflags.\n";
-# bench_push_parser();
-bench_variant_parser();
+verbose 1, "Using bison=$bison.\n";
+verbose 1, "Using cc=$cc.\n";
+verbose 1, "Using cxx=$cxx.\n";
+verbose 1, "Using cflags=$cflags.\n";
+
+for my $b (@ARGV)
+{
+  verbose 1, "Running benchmark $b.\n";
+  bench_fusion_parser()  if $b eq "fusion";
+  bench_push_parser()    if $b eq "push";
+  bench_variant_parser() if $b eq "variant";
+}
 
 ### Setup "GNU" style for perl-mode and cperl-mode.
 ## Local Variables: