etc/bench.pl.in

   1 #! /usr/bin/perl -w
   2
   3 # Copyright (C) 2006, 2008 Free Software Foundation, Inc.
   4 #
   5 # This file is part of Bison, the GNU Compiler Compiler.
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 =head1 NAME
  21
  22 bench.pl - bench marks for Bison parsers.
  23
  24 =head1 SYNOPSIS
  25
  26   ./bench.pl [OPTIONS]... DIRECTIVES
  27
  28 =head1 DIRECTIVES
  29
  30 Specify the set of benches to run.  The following grammar defines the
  31 I<directives>:
  32
  33    I<directives> ::= I<directives> | I<directives>  -- Alternation
  34                   |  I<directives> & I<directives>  -- Concatenation
  35                   |  [ I<directives> ]              -- Optional
  36                   |  ( I<directives> )              -- Parentheses
  37                   | I<directive>
  38
  39 Parentheses only group to override precedence.  For instance:
  40
  41   [ %debug ] & [ %error-verbose ] & [ %define variant ]
  42
  43 will generate eight different cases.
  44
  45 =head1 OPTIONS
  46
  47 =over 4
  48
  49 =item B<-b>, B<--bench>
  50
  51 Predefined benches, that is, combimation between a grammar and a I<directives>
  52 request.
  53
  54 =over 4
  55
  56 =item I<fusion>
  57
  58 Test F<lalr1.cc> with three stacks against F<lalr1-fusion.cc> which
  59 uses a single one.
  60
  61 =item I<push>
  62
  63 Test the push parser vs. the pull interface.  Use the C parser.
  64
  65 =item I<variant>
  66
  67 Test the use of variants instead of union in the C++ parser.
  68
  69 =back
  70
  71 =item B<-c>, B<--cflags>=I<flags>
  72
  73 Flags to pass to the C or C++ compiler.  Defaults to -O2.
  74
  75 =item B<-d>, B<--directive>=I<directives>
  76
  77 Add a set of Bison directives to bench against each other.
  78
  79 =item B<-g>, B<--grammar>=I<grammar>
  80
  81 Select the base I<grammar> to use.  Defaults to I<calc>.
  82
  83 =over 4
  84
  85 =item I<calc>
  86
  87 Traditional calculator.
  88
  89 =item I<list>
  90
  91 C++ grammar that uses std::string and std::list.  Can be used with
  92 or without %define variant.
  93
  94 =item I<triangular>
  95
  96 Artificial grammar with very long rules.
  97
  98 =back
  99
 100 =item B<-h>, B<--help>
 101
 102 Display this message and exit succesfully.  The more verbose, the more
 103 details.
 104
 105 =item B<-i>, B<--iterations>=I<integer>
 106
 107 Say how many times a single test of the bench must be run.  If
 108 negative, specify the minimum number of CPU seconds to run.  Defaults
 109 to -1.
 110
 111 =item B<-q>, B<--quiet>
 112
 113 Decrease the verbosity level (defaults to 1).
 114
 115 =item B<-v>, B<--verbose>
 116
 117 Raise the verbosity level (defaults to 1).
 118
 119 =back
 120
 121 =cut
 122
 123 use strict;
 124 use IO::File;
 125
 126 ##################################################################
 127
 128 =head1 VARIABLES
 129
 130 =over 4
 131
 132 =item C<@bench>
 133
 134 The list of benches to run.
 135
 136 =item C<$bison>
 137
 138 The Bison program to use to compile the grammar.
 139
 140 =item C<$cc>
 141
 142 The C compiler.
 143
 144 =item C<$cxx>
 145
 146 The C++ compiler.
 147
 148 =item C<$cflags>
 149
 150 Compiler flags (C or C++).
 151
 152 =item C<@directive>
 153
 154 A list of directive sets to measure against each other.
 155
 156 =item C<$iterations>
 157
 158 The number of times the parser is run for a bench.
 159
 160 =item C<$verbose>
 161
 162 Verbosity level.
 163
 164 =back
 165
 166 =cut
 167
 168 my $bench;
 169 my $bison = $ENV{'BISON'} || '@abs_top_builddir@/tests/bison';
 170 my $cc = $ENV{'CC'} || 'gcc';
 171 my $cxx = $ENV{'CXX'} || 'g++';
 172 my $cflags = '-O2';
 173 my @directive = ();
 174 my $grammar = 'calc';
 175 my $iterations = -1;
 176 my $verbose = 1;
 177
 178 =head1 FUNCTIONS
 179
 180 =over 4
 181
 182 =item C<verbose($level, $message)>
 183
 184 Report the C<$message> is C<$level> E<lt>= C<$verbose>.
 185
 186 =cut
 187
 188 sub verbose($$)
 189 {
 190   my ($level, $message) = @_;
 191   print STDERR $message
 192     if $level <= $verbose;
 193 }
 194
 195
 196 ######################################################################
 197
 198 =item C<directives($bench, @directive)>
 199
 200 Format the list of directives for Bison for bench named C<$bench>.
 201
 202 =cut
 203
 204 sub directives($@)
 205 {
 206   my ($bench, @directive) = @_;
 207   my $res = "/* Directives for bench `$bench'. */\n";
 208   $res .= join ("\n", @directive) . "\n";
 209   $res .= "/* End of directives for bench `$bench'. */\n";
 210   return $res;
 211 }
 212
 213 ######################################################################
 214
 215 =item C<generate_grammar_triangular ($base, $max, @directive)>
 216
 217 Create a large triangular grammar which looks like :
 218
 219   input:
 220     exp        { if ($1 != 0) abort (); $$ = $1; }
 221   | input exp  { if ($2 != $1 + 1) abort (); $$ = $2; }
 222   ;
 223
 224   exp:
 225     END                         { $$ = 0; }
 226   | "1"  END                    { $$ = 1; }
 227   | "1" "2"  END                { $$ = 2; }
 228   | "1" "2" "3"  END            { $$ = 3; }
 229   | "1" "2" "3" "4"  END        { $$ = 4; }
 230   | "1" "2" "3" "4" "5"  END    { $$ = 5; }
 231   ;
 232
 233 C<$base> is the base name for the file to create (F<$base.y>).
 234 C<$max> is the number of such rules (here, 5).  You may pass
 235 additional Bison C<@directive>.
 236
 237 The created parser is self contained: it includes its scanner, and
 238 source of input.
 239 =cut
 240
 241 sub generate_grammar_triangular ($$@)
 242 {
 243   my ($base, $max, @directive) = @_;
 244   my $directives = directives ($base, @directive);
 245
 246   my $out = new IO::File ">$base.y"
 247     or die;
 248   print $out <<EOF;
 249 %error-verbose
 250 %debug
 251 %{
 252 #include <stdio.h>
 253 #include <stdlib.h>
 254
 255 static int yylex (void);
 256 static void yyerror (const char *msg);
 257 %}
 258 $directives
 259 %union
 260 {
 261   int val;
 262 };
 263
 264 %token END "end"
 265 %type <val> exp input
 266 EOF
 267
 268   for my $size (1 .. $max)
 269     {
 270       print $out "%token t$size $size \"$size\"\n";
 271     };
 272
 273 print $out <<EOF;
 274 %%
 275 input:
 276   exp        { if (\$1 != 0) abort (); \$\$ = \$1; }
 277 | input exp  { if (\$2 != \$1 + 1) abort (); \$\$ = \$2; }
 278 ;
 279
 280 exp:
 281   END
 282     { \$\$ = 0; }
 283 EOF
 284
 285 for my $size (1 .. $max)
 286   {
 287     use Text::Wrap;
 288     print $out wrap ("| ", "   ",
 289                      (map { "\"$_\"" } (1 .. $size)),
 290                      " END \n"),
 291                "    { \$\$ = $size; }\n";
 292   };
 293 print $out ";\n";
 294
 295 print $out <<EOF;
 296 %%
 297 static int
 298 yylex (void)
 299 {
 300   static int inner = 1;
 301   static int outer = 0;
 302   if (outer > $max)
 303     return 0;
 304   else if (inner > outer)
 305     {
 306       inner = 1;
 307       ++outer;
 308       return END;
 309     }
 310   return inner++;
 311 }
 312
 313 static void
 314 yyerror (const char *msg)
 315 {
 316   fprintf (stderr, "%s\\n", msg);
 317 }
 318
 319 int
 320 main (void)
 321 {
 322   yydebug = !!getenv ("YYDEBUG");
 323   return yyparse ();
 324 }
 325 EOF
 326 }
 327
 328 ##################################################################
 329
 330 =item C<calc_input ($base, $max)>
 331
 332 Generate the input file F<$base.input> for the calc parser.  The input
 333 is composed of two expressions.  The first one is using left recursion
 334 only and consumes no stack.  The second one requires a deep stack.
 335 These two expressions are repeated C<$max> times in the output file.
 336
 337 =cut
 338
 339 sub calc_input ($$)
 340 {
 341   my ($base, $max) = @_;
 342   my $out = new IO::File ">$base.input"
 343     or die;
 344   foreach (1 .. $max)
 345     {
 346       print $out "0+1+2+3+4+5+6+7+8+9+10+11+12+13+14+15+16+17+18+19+20+21+22+23+24+25+26+27+28+29+30+31+32+33+34+35+36+37+38+39+40+41+42+43+44+45+46+47+48+49+50+51+52+53+54+55+56+57+58+59+60+61+62+63+64+65+66+67+68+69+70+71+72+73+74+75+76+77+78+79+80+81+82+83+84+85+86+87+88+89+90+91+92+93+94+95+96+97+98+99\n";
 347       print $out "1+1*(2+2*(3+3*(4+4*(5+5*(6+6*(7+7*(8+8*(9+9*(10+10*(11+11*(12+12*(13+13*(14+14*(15+15*(16+16*(17+17*(18+18*(19+19*(20+20*(21+21*(22+22*(23+23*(24+24*(25+25*(26+26*(27+27*(28+28*(29+29*(30+30*(31+31*(32+32*(33+33*(34+34*(35+35*(36+36*(37+37*(38+38*(39+39*(40+40*(41+41*(42+42*(43+43*(44+44*(45+45*(46+46*(47+47*(48+48*(49+49*(50+50*(51+51*(52+52*(53+53*(54+54*(55+55*(56+56*(57+57*(58+58*(59+59*(60+60*(61+61*(62+62*(63+63*(64+64*(65+65*(66+66*(67+67*(68+68*(69+69*(70+70*(71+71*(72+72*(73+73*(74+74*(75+75*(76+76*(77+77*(78+78*(79+79*(80+80*(81+81*(82+82*(83+83*(84+84*(85+85*(86+86*(87+87*(88+88*(89+89*(90+90*(91+91*(92+92*(93+93*(94+94*(95+95*(96+96*(97+97*(98+98*(99+99*(100+100*(101+101*(102+102*(103+103*(104+104*(105+105*(106+106*(107+107*(108+108*(109+109*(110+110*(111+111*(112+112*(113+113*(114+114*(115+115*(116+116*(117+117*(118+118*(119+119*(120+120*(121+121*(122+122*(123+123*(124+124*(125+125*(126+126*(127+127*(128+128*(129+129*(130+130*(131+131*(132+132*(133+133*(134+134*(135+135*(136+136*(137+137*(138+138*(139+139*(140+140*(141+141*(142+142*(143+143*(144+144*(145+145*(146+146*(147+147*(148+148*(149+149*(150+150*(151+151*(152+152*(153+153*(154+154*(155+155*(156+156*(157+157*(158+158*(159+159*(160+160*(161+161*(162+162*(163+163*(164+164*(165+165*(166+166*(167+167*(168+168*(169+169*(170+170*(171+171*(172+172*(173+173*(174+174*(175+175*(176+176*(177+177*(178+178*(179+179*(180+180*(181+181*(182+182*(183+183*(184+184*(185+185*(186+186*(187+187*(188+188*(189+189*(190+190*(191+191*(192+192*(193+193*(194+194*(195+195*(196+196*(197+197*(198+198*(199+199*(200+200*(201+201*(202+202*(203+203*(204+204*(205+205*(206+206*(207+207*(208+208*(209+209*(210+210*(211+211*(212+212*(213+213*(214+214*(215+215*(216+216*(217+217*(218+218*(219+219*(220+220*(221+221*(222+222*(223+223*(224+224*(225+225*(226+226*(227+227*(228+228*(229+229*(230+230*(231+231*(232+232*(233+233*(234+234*(235+235*(236+236*(237+237*(238+238*(239+239*(240+240*(241+241*(242+242*(243+243*(244+244*(245+245*(246+246*(247+247*(248+248*(249+249*(250+250*(251+251*(252+252*(253+253*(254+254*(255+255*(256+256*(257+257*(258+258*(259+259*(260+260*(261+261*(262+262*(263+263*(264+264*(265+265*(266+266*(267+267*(268+268*(269+269*(270+270*(271+271*(272+272*(273+273*(274+274*(275+275*(276+276*(277+277*(278+278*(279+279*(280+280*(281+281*(282+282*(283+283*(284+284*(285+285*(286+286*(287+287*(288+288*(289+289*(290+290*(291+291*(292+292*(293+293*(294+294*(295+295*(296+296*(297+297*(298+298*(299+299*(300+300*(301+301*(302+302*(303+303*(304+304*(305+305*(306+306*(307+307*(308+308*(309+309*(310+310*(311+311*(312+312*(313+313*(314+314*(315+315*(316+316*(317+317*(318+318*(319+319*(320+320*(321+321*(322+322*(323+323*(324+324*(325+325*(326+326*(327+327*(328+328*(329+329*(330+330*(331+331*(332+332*(333+333*(334+334*(335+335*(336+336*(337+337*(338+338*(339+339*(340+340*(341+341*(342+342*(343+343*(344+344*(345+345*(346+346*(347+347*(348+348*(349+349*(350+350*(351+351*(352+352*(353+353*(354+354*(355+355*(356+356*(357+357*(358+358*(359+359*(360+360*(361+361*(362+362*(363+363*(364+364*(365+365*(366+366*(367+367*(368+368*(369+369*(370+370*(371+371*(372+372*(373+373*(374+374*(375+375*(376+376*(377+377*(378+378*(379+379*(380+380*(381+381*(382+382*(383+383*(384+384*(385+385*(386+386*(387+387*(388+388*(389+389*(390+390*(391+391*(392+392*(393+393*(394+394*(395+395*(396+396*(397+397*(398+398*(399+399*(400+400*(401+401*(402+402*(403+403*(404+404*(405+405*(406+406*(407+407*(408+408*(409+409*(410+410*(411+411*(412+412*(413+413*(414+414*(415+415*(416+416*(417+417*(418+418*(419+419*(420+420*(421+421*(422+422*(423+423*(424+424*(425+425*(426+426*(427+427*(428+428*(429+429*(430+430*(431+431*(432+432*(433+433*(434+434*(435+435*(436+436*(437+437*(438+438*(439+439*(440+440*(441+441*(442+442*(443+443*(444+444*(445+445*(446+446*(447+447*(448+448*(449+449*(450+450*(451+451*(452+452*(453+453*(454+454*(455+455*(456+456*(457+457*(458+458*(459+459*(460+460*(461+461*(462+462*(463+463*(464+464*(465+465*(466+466*(467+467*(468+468*(469+469*(470+470*(471+471*(472+472*(473+473*(474+474*(475+475*(476+476*(477+477*(478+478*(479+479*(480+480*(481+481*(482+482*(483+483*(484+484*(485+485*(486+486*(487+487*(488+488*(489+489*(490+490*(491+491*(492+492*(493+493*(494+494*(495+495*(496+496*(497+497*(498+498*(499+499*(500+500*(501+501*(502+502*(503+503*(504+504*(505+505*(506+506*(507+507*(508+508*(509+509*(510+510*(511+511*(512+512*(513+513*(514+514*(515+515*(516+516*(517+517*(518+518*(519+519*(520+520*(521+521*(522+522*(523+523*(524+524*(525+525*(526+526*(527+527*(528+528*(529+529*(530+530*(531+531*(532+532*(533+533*(534+534*(535+535*(536+536*(537+537*(538+538*(539+539*(540+540*(541+541*(542+542*(543+543*(544+544*(545+545*(546+546*(547+547*(548+548*(549+549*(550+550*(551+551*(552+552*(553+553*(554+554*(555+555*(556+556*(557+557*(558+558*(559+559*(560+560*(561+561*(562+562*(563+563*(564+564*(565+565*(566+566*(567+567*(568+568*(569+569*(570+570*(571+571*(572+572*(573+573*(574+574*(575+575*(576+576*(577+577*(578+578*(579+579*(580+580*(581+581*(582+582*(583+583*(584+584*(585+585*(586+586*(587+587*(588+588*(589+589*(590+590*(591+591*(592+592*(593+593*(594+594*(595+595*(596+596*(597+597*(598+598*(599+599*(600+600*(601+601*(602+602*(603+603*(604+604*(605+605*(606+606*(607+607*(608+608*(609+609*(610+610*(611+611*(612+612*(613+613*(614+614*(615+615*(616+616*(617+617*(618+618*(619+619*(620+620*(621+621*(622+622*(623+623*(624+624*(625+625*(626+626*(627+627*(628+628*(629+629*(630+630*(631+631*(632+632*(633+633*(634+634*(635+635*(636+636*(637+637*(638+638*(639+639*(640+640*(641+641*(642+642*(643+643*(644+644*(645+645*(646+646*(647+647*(648+648*(649+649*(650+650*(651+651*(652+652*(653+653*(654+654*(655+655*(656+656*(657+657*(658+658*(659+659*(660+660*(661+661*(662+662*(663+663*(664+664*(665+665*(666+666*(667+667*(668+668*(669+669*(670+670*(671+671*(672+672*(673+673*(674+674*(675+675*(676+676*(677+677*(678+678*(679+679*(680+680*(681+681*(682+682*(683+683*(684+684*(685+685*(686+686*(687+687*(688+688*(689+689*(690+690*(691+691*(692+692*(693+693*(694+694*(695+695*(696+696*(697+697*(698+698*(699+699*(700+700*(701+701*(702+702*(703+703*(704+704*(705+705*(706+706*(707+707*(708+708*(709+709*(710+710*(711+711*(712+712*(713+713*(714+714*(715+715*(716+716*(717+717*(718+718*(719+719*(720+720*(721+721*(722+722*(723+723*(724+724*(725+725*(726+726*(727+727*(728+728*(729+729*(730+730*(731+731*(732+732*(733+733*(734+734*(735+735*(736+736*(737+737*(738+738*(739+739*(740+740*(741+741*(742+742*(743+743*(744+744*(745+745*(746+746*(747+747*(748+748*(749+749*(750+750*(751+751*(752+752*(753+753*(754+754*(755+755*(756+756*(757+757*(758+758*(759+759*(760+760*(761+761*(762+762*(763+763*(764+764*(765+765*(766+766*(767+767*(768+768*(769+769*(770+770*(771+771*(772+772*(773+773*(774+774*(775+775*(776+776*(777+777*(778+778*(779+779*(780+780*(781+781*(782+782*(783+783*(784+784*(785+785*(786+786*(787+787*(788+788*(789+789*(790+790*(791+791*(792+792*(793+793*(794+794*(795+795*(796+796*(797+797*(798+798*(799+799*(800+800*(801+801*(802+802*(803+803*(804+804*(805+805*(806+806*(807+807*(808+808*(809+809*(810+810*(811+811*(812+812*(813+813*(814+814*(815+815*(816+816*(817+817*(818+818*(819+819*(820+820*(821+821*(822+822*(823+823*(824+824*(825+825*(826+826*(827+827*(828+828*(829+829*(830+830*(831+831*(832+832*(833+833*(834+834*(835+835*(836+836*(837+837*(838+838*(839+839*(840+840*(841+841*(842+842*(843+843*(844+844*(845+845*(846+846*(847+847*(848+848*(849+849*(850+850*(851+851*(852+852*(853+853*(854+854*(855+855*(856+856*(857+857*(858+858*(859+859*(860+860*(861+861*(862+862*(863+863*(864+864*(865+865*(866+866*(867+867*(868+868*(869+869*(870+870*(871+871*(872+872*(873+873*(874+874*(875+875*(876+876*(877+877*(878+878*(879+879*(880+880*(881+881*(882+882*(883+883*(884+884*(885+885*(886+886*(887+887*(888+888*(889+889*(890+890*(891+891*(892+892*(893+893*(894+894*(895+895*(896+896*(897+897*(898+898*(899+899*(900+900*(901+901*(902+902*(903+903*(904+904*(905+905*(906+906*(907+907*(908+908*(909+909*(910+910*(911+911*(912+912*(913+913*(914+914*(915+915*(916+916*(917+917*(918+918*(919+919*(920+920*(921+921*(922+922*(923+923*(924+924*(925+925*(926+926*(927+927*(928+928*(929+929*(930+930*(931+931*(932+932*(933+933*(934+934*(935+935*(936+936*(937+937*(938+938*(939+939*(940+940*(941+941*(942+942*(943+943*(944+944*(945+945*(946+946*(947+947*(948+948*(949+949*(950+950*(951+951*(952+952*(953+953*(954+954*(955+955*(956+956*(957+957*(958+958*(959+959*(960+960*(961+961*(962+962*(963+963*(964+964*(965+965*(966+966*(967+967*(968+968*(969+969*(970+970*(971+971*(972+972*(973+973*(974+974*(975+975*(976+976*(977+977*(978+978*(979+979*(980+980*(981+981*(982+982*(983+983*(984+984*(985+985*(986+986*(987+987*(988+988*(989+989*(990+990*(991+991*(992+992*(993+993*(994+994*(995+995*(996+996*(997+997*(998+998*(999+999*(1000+1000*(1001))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))\n";
 348     }
 349 }
 350
 351 ##################################################################
 352
 353 =item C<generate_grammar_calc ($base, $max, @directive)>
 354
 355 Generate a Bison file F<$base.y> for a calculator parser in C.  Pass
 356 the additional Bison C<@directive>.  C<$max> is ignored, but left to
 357 have the same interface as C<triangular_grammar>.
 358
 359 =cut
 360
 361 sub generate_grammar_calc ($$@)
 362 {
 363   my ($base, $max, @directive) = @_;
 364   my $directives = directives ($base, @directive);
 365
 366   # Putting this request here is stupid, since the input will be
 367   # generated each time we generate a grammar.
 368   calc_input ('calc', 200);
 369
 370   my $out = new IO::File ">$base.y"
 371     or die;
 372   print $out <<EOF;
 373 %{
 374 #include <stdio.h>
 375
 376 #include <stdlib.h>
 377 #include <string.h>
 378 #include <ctype.h>
 379 #define USE(Var)
 380
 381 /* Exercise pre-prologue dependency to %union.  */
 382 typedef int semantic_value;
 383
 384 static semantic_value global_result = 0;
 385 static int global_count = 0;
 386 %}
 387
 388 $directives
 389 %error-verbose
 390 /* Exercise %union. */
 391 %union
 392 {
 393   semantic_value ival;
 394 };
 395
 396 %{
 397 static int power (int base, int exponent);
 398 /* yyerror receives the location if:
 399    - %location & %pure & %glr
 400    - %location & %pure & %yacc & %parse-param. */
 401 static void yyerror (const char *s);
 402 #if YYPURE
 403 static int yylex (YYSTYPE* yylvalp);
 404 #else
 405 static int yylex (void);
 406 #endif
 407 %}
 408
 409 /* Bison Declarations */
 410 %token CALC_EOF 0 "end of input"
 411 %token <ival> NUM "number"
 412 %type  <ival> exp
 413
 414 %nonassoc '=' /* comparison            */
 415 %left '-' '+'
 416 %left '*' '/'
 417 %left NEG     /* negation--unary minus */
 418 %right '^'    /* exponentiation        */
 419
 420 /* Grammar follows */
 421 %%
 422 input:
 423   line
 424 | input line
 425 ;
 426
 427 line:
 428   '\\n'
 429 | exp '\\n'           { USE (\$1); }
 430 ;
 431
 432 exp:
 433   NUM                { \$\$ = \$1;             }
 434 | exp '=' exp
 435   {
 436     if (\$1 != \$3)
 437       fprintf (stderr, "calc: error: %d != %d\\n", \$1, \$3);
 438     \$\$ = \$1;
 439   }
 440 | exp '+' exp        { \$\$ = \$1 + \$3;        }
 441 | exp '-' exp        { \$\$ = \$1 - \$3;        }
 442 | exp '*' exp        { \$\$ = \$1 * \$3;        }
 443 | exp '/' exp        { \$\$ = \$1 / \$3;        }
 444 | '-' exp  %prec NEG { \$\$ = -\$2;            }
 445 | exp '^' exp        { \$\$ = power (\$1, \$3); }
 446 | '(' exp ')'        { \$\$ = \$2;             }
 447 | '(' error ')'      { \$\$ = 1111;           }
 448 | '!'                { \$\$ = 0; YYERROR;     }
 449 | '-' error          { \$\$ = 0; YYERROR;     }
 450 ;
 451 %%
 452 /* The input.  */
 453 static FILE *input;
 454
 455 static void
 456 yyerror (const char *s)
 457 {
 458   fprintf (stderr, "%s\\n", s);
 459 }
 460
 461 static int
 462 get_char (void)
 463 {
 464   return getc (input);
 465 }
 466
 467
 468 static void
 469 unget_char ( int c)
 470 {
 471   ungetc (c, input);
 472 }
 473
 474 static int
 475 read_signed_integer (void)
 476 {
 477   int c = get_char ();
 478   int sign = 1;
 479   int n = 0;
 480
 481   if (c == '-')
 482     {
 483       c = get_char ();
 484       sign = -1;
 485     }
 486
 487   while (isdigit (c))
 488     {
 489       n = 10 * n + (c - '0');
 490       c = get_char ();
 491     }
 492
 493   unget_char (c);
 494
 495   return sign * n;
 496 }
 497
 498 static int
 499 #if YYPURE
 500 # define yylval (*yylvalp)
 501 yylex (YYSTYPE* yylvalp)
 502 #else
 503 yylex (void)
 504 #endif
 505 {
 506   int c;
 507
 508   /* Skip white space.  */
 509   while ((c = get_char ()) == ' ' || c == '\t')
 510     continue;
 511
 512   /* process numbers   */
 513   if (c == '.' || isdigit (c))
 514     {
 515       unget_char ( c);
 516       yylval.ival = read_signed_integer ();
 517       return NUM;
 518     }
 519
 520   /* Return end-of-file.  */
 521   if (c == EOF)
 522     return CALC_EOF;
 523
 524   /* Return single chars. */
 525   return c;
 526 }
 527
 528 static int
 529 power (int base, int exponent)
 530 {
 531   int res = 1;
 532   if (exponent < 0)
 533     exit (3);
 534   for (/* Niente */; exponent; --exponent)
 535     res *= base;
 536   return res;
 537 }
 538
 539
 540 int
 541 main (int argc, const char **argv)
 542 {
 543   semantic_value result = 0;
 544   int count = 0;
 545   int status;
 546
 547   input = fopen ("calc.input", "r");
 548   if (!input)
 549     {
 550       perror ("calc.input");
 551       return 3;
 552     }
 553
 554   status = yyparse ();
 555   if (global_result != result)
 556     abort ();
 557   if (global_count != count)
 558     abort ();
 559
 560   return status;
 561 }
 562 EOF
 563 }
 564
 565 ##################################################################
 566
 567 =item C<generate_grammar_list ($base, $max, @directive)>
 568
 569 Generate a Bison file F<$base.y> for a C++ parser that uses C++
 570 objects (std::string, std::list).  Tailored for using %define variant.
 571
 572 =cut
 573
 574 sub generate_grammar_list ($$@)
 575 {
 576   my ($base, $max, @directive) = @_;
 577   my $directives = directives ($base, @directive);
 578   my $variant = grep { /%define "?variant"?/ } @directive;
 579   my $out = new IO::File ">$base.y"
 580     or die;
 581   print $out <<EOF;
 582 %language "C++"
 583 %defines
 584 $directives
 585
 586 %code requires // *.h
 587 {
 588 #include <string>
 589 }
 590
 591 %code // *.c
 592 {
 593 #include <algorithm>
 594 #include <iostream>
 595 #include <sstream>
 596
 597 // Prototype of the yylex function providing subsequent tokens.
 598 static yy::parser::token_type yylex(yy::parser::semantic_type* yylval);
 599
 600 #define STAGE_MAX    ($max * 10) // max = $max
 601
 602 #define USE_VARIANTS $variant
 603 #if USE_VARIANTS
 604 # define IF_VARIANTS(True, False) True
 605 #else
 606 # define IF_VARIANTS(True, False) False
 607 #endif
 608
 609 #ifdef ONE_STAGE_BUILD
 610 # define IF_ONE_STAGE_BUILD(True, False) True
 611 #else
 612 # define IF_ONE_STAGE_BUILD(True, False) False
 613 #endif
 614 }
 615 EOF
 616
 617   if ($variant)
 618     {
 619       print $out <<'EOF';
 620 %token <std::string> TEXT
 621 %token <int> NUMBER
 622 %printer { std::cerr << "Number: " << $$; } <int>
 623 %printer { std::cerr << "Text: " << $$; } <std::string>
 624 %token END_OF_FILE 0
 625 %type <std::string> text result
 626
 627 %%
 628 result:
 629   text                  { /* Throw away the result. */ }
 630 ;
 631
 632 text:
 633   /* nothing */         { /* This will generate an empty string */ }
 634 | text TEXT             { std::swap($$,$1); $$.append($2); }
 635 | text NUMBER           {
 636                           std::swap($$,$1);
 637                           std::ostringstream ss;
 638                           ss << ' ' << $2;
 639                           $$.append(ss.str());
 640                          }
 641 ;
 642 EOF
 643     }
 644   else
 645     {
 646       # Not using Bison variants.
 647       print $out <<'EOF';
 648 %union {int ival; std::string* sval;}
 649 %token <sval> TEXT
 650 %token <ival> NUMBER
 651 %printer { std::cerr << "Number: " << $$; } <ival>
 652 %printer { std::cerr << "Text: " << *$$; } <sval>
 653 %token END_OF_FILE 0
 654 %type <sval> text result
 655
 656 %%
 657 result:
 658   text                  { delete $1; }
 659 ;
 660
 661 text:
 662   /* nothing */         { $$ = new std::string; }
 663 | text TEXT             { $$->append(*$2); delete $2; }
 664 | text NUMBER           {
 665                           std::ostringstream ss;
 666                           ss << ' ' << $2;
 667                           $$->append(ss.str());
 668                          }
 669 ;
 670 EOF
 671     }
 672
 673   print $out <<'EOF';
 674 %%
 675 static
 676 yy::parser::token_type
 677 yylex(yy::parser::semantic_type* yylval)
 678 {
 679   static int stage = -1;
 680   ++stage;
 681   if (stage == STAGE_MAX)
 682     return yy::parser::token::END_OF_FILE;
 683   else if (stage % 2)
 684     {
 685 #if USE_VARIANTS
 686 # ifdef ONE_STAGE_BUILD
 687       yylval->build(stage);
 688 # else
 689       yylval->build<int>() = stage;
 690 # endif
 691 #else
 692       yylval->ival = stage;
 693 #endif
 694       return yy::parser::token::NUMBER;
 695     }
 696   else
 697     {
 698 #if USE_VARIANTS
 699 # ifdef ONE_STAGE_BUILD
 700       yylval->build(std::string("A string."));
 701 # else
 702       yylval->build<std::string>() = std::string("A string.");
 703 # endif
 704 #else
 705       yylval->sval = new std::string("A string.");
 706 #endif
 707       return yy::parser::token::TEXT;
 708     }
 709   abort();
 710 }
 711
 712 // Mandatory error function
 713 void
 714 yy::parser::error(const yy::parser::location_type& yylloc,
 715                   const std::string& message)
 716 {
 717   std::cerr << yylloc << ": " << message << std::endl;
 718 }
 719
 720 int main(int argc, char *argv[])
 721 {
 722   yy::parser p;
 723 #if YYDEBUG
 724   p.set_debug_level(!!getenv("YYDEBUG"));
 725 #endif
 726   p.parse();
 727   return 0;
 728 }
 729 EOF
 730 }
 731
 732 ##################################################################
 733
 734 =item C<generate_grammar ($name, $base, @directive)>
 735
 736 Generate F<$base.y> by calling C<&generate_grammar_$name>.
 737
 738 =cut
 739
 740 sub generate_grammar ($$@)
 741 {
 742   my ($name, $base, @directive) = @_;
 743   verbose 3, "Generating $base.y\n";
 744   my %generator =
 745     (
 746       "calc"       => \&generate_grammar_calc,
 747       "list"       => \&generate_grammar_list,
 748       "triangular" => \&generate_grammar_triangular,
 749     );
 750   &{$generator{$name}}($base, 200, @directive);
 751 }
 752
 753 ##################################################################
 754
 755 =item C<run ($command)>
 756
 757 Run, possibly verbosely, the shell C<$command>.
 758
 759 =cut
 760
 761 sub run ($)
 762 {
 763   my ($command) = @_;
 764   verbose 3, "$command\n";
 765   system ("$command") == 0
 766     or die "$command failed";
 767 }
 768
 769 ##################################################################
 770
 771 =item C<compile ($base)>
 772
 773 Compile C<$base.y> to an executable C, Using the C or C++ compiler
 774 depending on the %language specification in C<$base.y>.
 775
 776 =cut
 777
 778 sub compile ($)
 779 {
 780   my ($base) = @_;
 781   my $language = `sed -ne '/%language "\\(.*\\)"/{s//\\1/;p;q;}' $base.y`;
 782   chomp $language;
 783
 784   my $compiler = $language eq 'C++' ? $cxx : $cc;
 785
 786   run "$bison $base.y -o $base.c";
 787   run "$compiler -o $base $cflags $base.c";
 788 }
 789
 790 ######################################################################
 791
 792 =item C<bench ($grammar, @token)>
 793
 794 Generate benches for the C<$grammar> and the directive specification
 795 given in the list of C<@token>.
 796
 797 =cut
 798
 799 sub bench ($@)
 800 {
 801   my ($grammar, @token) = @_;
 802   use Benchmark qw (:all :hireswallclock);
 803
 804   my @directive = parse (@token);
 805
 806   # Set up the benches as expected by timethese.
 807   my %bench;
 808   # A counter of directive sets.
 809   my $count = 1;
 810   for my $d (@directive)
 811     {
 812       $bench{$count} = $d;
 813       printf " %2d. %s\n", $count, join (' ', split ("\n", $d));
 814       $count++;
 815     };
 816
 817   # For each bench, capture the size.
 818   my %size;
 819
 820   while (my ($name, $directives) = each %bench)
 821     {
 822       generate_grammar ($grammar, $name, $directives);
 823       # Compile the executable.
 824       compile ($name);
 825       $bench{$name} = "system ('./$name');";
 826       chop($size{$name} = `wc -c <$name`);
 827     }
 828
 829   # Run the benches.
 830   #
 831   # STYLE can be any of 'all', 'none', 'noc', 'nop' or 'auto'.  'all'
 832   # shows each of the 5 times available ('wallclock' time, user time,
 833   # system time, user time of children, and system time of
 834   # children). 'noc' shows all except the two children times. 'nop'
 835   # shows only wallclock and the two children times.  'auto' (the
 836   # default) will act as 'all' unless the children times are both
 837   # zero, in which case it acts as 'noc'.  'none' prevents output.
 838   verbose 3, "Running the benches for $grammar\n";
 839   my $res = timethese ($iterations, \%bench, 'nop');
 840
 841   # Output the speed result.
 842   cmpthese ($res, 'nop');
 843
 844   # Display the sizes.
 845   print "Sizes (decreasing):\n";
 846   my $width = 10;
 847   for my $bench (keys %size)
 848     {
 849       $width = length $bench
 850         if $width < length $bench;
 851     }
 852   # Benches sorted by decreasing size.
 853   my @benches_per_size = sort {$size{$b} <=> $size{$a}} keys %size;
 854   for my $bench (@benches_per_size)
 855     {
 856       printf "%${width}s: %5.2fkB\n", $bench, $size{$bench} / 1024;
 857     }
 858 }
 859
 860 ######################################################################
 861
 862 =item C<bench_push_parser ()>
 863
 864 Bench the C push parser against the pull parser, pure and impure
 865 interfaces.
 866
 867 =cut
 868
 869 sub bench_push_parser ()
 870 {
 871   bench ('calc',
 872          (
 873           '[', '%define api.pure', ']',
 874           '&',
 875           '[', '%define api.push_pull "both"', ']'
 876          ));
 877 }
 878
 879 ######################################################################
 880
 881 =item C<bench_variant_parser ()>
 882
 883 Bench the C++ lalr1.cc parser using Boost.Variants or %union.
 884
 885 =cut
 886
 887 sub bench_variant_parser ()
 888 {
 889   bench ('list',
 890          ('%skeleton "lalr1.cc"',
 891           '&',
 892           '[', '%debug', ']',
 893           '&',
 894           '[', '%define variant',
 895             '&',
 896             '[', "%code {\n#define VARIANT_DESTROY\n}", ']',
 897             '&',
 898             '[', "%code {\n#define ONE_STAGE_BUILD\n}", ']',
 899           ']'
 900          ));
 901 }
 902
 903 ######################################################################
 904
 905 =item C<bench_fusion_parser ()>
 906
 907 Bench the C++ lalr1.cc parser using Boost.Variants or %union.
 908
 909 =cut
 910
 911 sub bench_fusion_parser ()
 912 {
 913   bench ('list',
 914          ('%skeleton "lalr1-split.cc"',
 915           '|',
 916           '%skeleton "lalr1.cc"'));
 917 }
 918
 919 ############################################################################
 920
 921 sub help ($)
 922 {
 923   my ($verbose) = @_;
 924   use Pod::Usage;
 925   # See <URL:http://perldoc.perl.org/pod2man.html#NOTES>.
 926   pod2usage( { -message => "Bench Bison parsers",
 927                -exitval => 0,
 928                -verbose => $verbose,
 929                -output  => \*STDOUT });
 930 }
 931
 932 ######################################################################
 933
 934 # The list of tokens parsed by the following functions.
 935 my @token;
 936
 937 # Parse directive specifications:
 938 #   expr: term (| term)*
 939 #   term: fact (& fact)*
 940 #   fact: ( expr ) | [ expr ] | dirs
 941 sub parse (@)
 942 {
 943   @token = @_;
 944   verbose 3, "Parsing: @token\n";
 945   my @res = parse_expr ();
 946   die "expected end of directives, unexpected: @token"
 947     if defined $token[0];
 948   return @res;
 949 }
 950
 951 sub parse_expr ()
 952 {
 953   my @res = parse_term ();
 954   while (defined $token[0] && $token[0] eq '|')
 955     {
 956       shift @token;
 957       # Alternation.
 958       push @res, parse_term ();
 959     }
 960   return @res;
 961 }
 962
 963 sub parse_term ()
 964 {
 965   my @res = parse_fact ();
 966   while (defined $token[0] && $token[0] eq '&')
 967     {
 968       shift @token;
 969       # Cartesian product.
 970       my @lhs = @res;
 971       @res = ();
 972       for my $rhs (parse_fact ())
 973         {
 974           for my $lhs (@lhs)
 975             {
 976               push @res, "$lhs\n$rhs";
 977             }
 978         }
 979     }
 980   return @res;
 981 }
 982
 983 sub parse_fact ()
 984 {
 985   my @res;
 986   die "unexpected end of expression"
 987     unless defined $token[0];
 988
 989   if ($token[0] eq '(')
 990     {
 991       shift @token;
 992       @res = parse_expr ();
 993       die "unexpected $token[0], expected )"
 994         unless $token[0] eq ')';
 995       shift @token;
 996     }
 997   elsif ($token[0] eq '[')
 998     {
 999       shift @token;
1000       @res = (parse_expr (), '');
1001       die "unexpected $token[0], expected ]"
1002         unless $token[0] eq ']';
1003       shift @token;
1004     }
1005   else
1006     {
1007       @res = $token[0];
1008       shift @token;
1009     }
1010   return @res;
1011 }
1012
1013 ######################################################################
1014
1015 sub getopt ()
1016 {
1017   use Getopt::Long;
1018   my %option = (
1019     "b|bench=s"      => \$bench,
1020     "c|cflags=s"     => \$cflags,
1021     "d|directive=s"  => \@directive,
1022     "g|grammar=s"    => \$grammar,
1023     "h|help"         => sub { help ($verbose) },
1024     "i|iterations=i" => \$iterations,
1025     "q|quiet"        => sub { --$verbose },
1026     "v|verbose"      => sub { ++$verbose },
1027     );
1028   Getopt::Long::Configure ("bundling", "pass_through");
1029   GetOptions (%option)
1030     or exit 1;
1031 }
1032
1033 ######################################################################
1034
1035 getopt;
1036
1037 # Create the directory we work in.
1038 my $count = 1;
1039 ++$count
1040   while -d "bench-$count";
1041 my $dir = "bench-$count";
1042 mkdir $dir
1043   or die "cannot create $dir";
1044 chdir $dir
1045   or die "cannot chdir $dir";
1046 # The following message is tailored to please Emacs' compilation-mode.
1047 verbose 1, "Entering directory `$dir'\n";
1048 verbose 1, "Using bison=$bison.\n";
1049 verbose 2, "Using cc=$cc.\n";
1050 verbose 2, "Using cxx=$cxx.\n";
1051 verbose 2, "Using cflags=$cflags.\n";
1052 verbose 2, "Grammar: $grammar\n";
1053
1054
1055 # Support -b: predefined benches.
1056 my %bench =
1057   (
1058    "fusion"   => \&bench_fusion_parser,
1059    "push"     => \&bench_push_parser,
1060    "variant"  => \&bench_variant_parser,
1061   );
1062
1063 if (defined $bench)
1064 {
1065   die "invalid argument for --bench: $bench"
1066     unless defined $bench{$bench};
1067   &{$bench{$bench}}();
1068   exit 0;
1069 }
1070 else
1071 {
1072   # Launch the bench marking.
1073   bench ($grammar, @ARGV);
1074 }
1075
1076 ### Setup "GNU" style for perl-mode and cperl-mode.
1077 ## Local Variables:
1078 ## perl-indent-level: 2
1079 ## perl-continued-statement-offset: 2
1080 ## perl-continued-brace-offset: 0
1081 ## perl-brace-offset: 0
1082 ## perl-brace-imaginary-offset: 0
1083 ## perl-label-offset: -2
1084 ## cperl-indent-level: 2
1085 ## cperl-brace-offset: 0
1086 ## cperl-continued-brace-offset: 0
1087 ## cperl-label-offset: -2
1088 ## cperl-extra-newline-before-brace: t
1089 ## cperl-merge-trailing-else: nil
1090 ## cperl-continued-statement-offset: 2
1091 ## End: