etc/bench.pl.in

   1 #! /usr/bin/perl -w
   2
   3 # Copyright (C) 2006, 2008-2012 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    directives ::=
  34        directives | directives  -- Alternation
  35      | directives & directives  -- Concatenation
  36      | [ directives> ]          -- Optional
  37      | ( directives> )          -- Parentheses
  38      | #d NAME[=VALUE]          -- %code { #define NAME [VALUE] }
  39      | %d NAME[=VALUE]          -- %define NAME ["VALUE"]
  40      | %s skeleton              -- %skeleton "skeleton"
  41      | directive
  42
  43 Parentheses only group to override precedence.  For instance:
  44
  45   [ %debug ] & [ %error-verbose ] & [ %define variant ]
  46
  47 will generate eight different cases.
  48
  49 =head1 OPTIONS
  50
  51 =over 4
  52
  53 =item B<-b>, B<--bench>
  54
  55 Predefined benches, that is, combimation between a grammar and a I<directives>
  56 request.
  57
  58 =over 4
  59
  60 =item I<push>
  61
  62 Test the push parser vs. the pull interface.  Use the C parser.
  63
  64 =item I<variant>
  65
  66 Test the use of variants instead of union in the C++ parser.
  67
  68 =back
  69
  70 =item B<-c>, B<--cflags>=I<flags>
  71
  72 Flags to pass to the C or C++ compiler.  Defaults to -O2.
  73
  74 =item B<-d>, B<--directive>=I<directives>
  75
  76 Add a set of Bison directives to bench against each other.
  77
  78 =item B<-g>, B<--grammar>=I<grammar>
  79
  80 Select the base I<grammar> to use.  Defaults to I<calc>.
  81
  82 =over 4
  83
  84 =item I<calc>
  85
  86 Traditional calculator.
  87
  88 =item I<list>
  89
  90 C++ grammar that uses std::string and std::list.  Can be used with
  91 or without %define variant.
  92
  93 =item I<triangular>
  94
  95 Artificial grammar with very long rules.
  96
  97 =back
  98
  99 =item B<-h>, B<--help>
 100
 101 Display this message and exit succesfully.  The more verbose, the more
 102 details.
 103
 104 =item B<-i>, B<--iterations>=I<integer>
 105
 106 Say how many times a single test of the bench must be run.  If
 107 negative, specify the minimum number of CPU seconds to run.  Defaults
 108 to -1.
 109
 110 =item B<-q>, B<--quiet>
 111
 112 Decrease the verbosity level (defaults to 1).
 113
 114 =item B<-v>, B<--verbose>
 115
 116 Raise the verbosity level (defaults to 1).
 117
 118 =back
 119
 120 =cut
 121
 122 use strict;
 123 use IO::File;
 124
 125 ##################################################################
 126
 127 =head1 VARIABLES
 128
 129 =over 4
 130
 131 =item C<@bench>
 132
 133 The list of benches to run.
 134
 135 =item C<$bison>
 136
 137 The Bison program to use to compile the grammar.
 138
 139 =item C<$cc>
 140
 141 The C compiler.
 142
 143 =item C<$cxx>
 144
 145 The C++ compiler.
 146
 147 =item C<$cflags>
 148
 149 Compiler flags (C or C++).
 150
 151 =item C<@directive>
 152
 153 A list of directive sets to measure against each other.
 154
 155 =item C<$iterations>
 156
 157 The number of times the parser is run for a bench.
 158
 159 =item C<$verbose>
 160
 161 Verbosity level.
 162
 163 =back
 164
 165 =cut
 166
 167 my $bench;
 168 my $bison = $ENV{'BISON'} || '@abs_top_builddir@/tests/bison';
 169 my $cc = $ENV{'CC'} || 'gcc';
 170 my $cxx = $ENV{'CXX'} || 'g++';
 171 my $cflags = '-O2';
 172 my @directive = ();
 173 my $grammar = 'calc';
 174 my $iterations = -1;
 175 my $verbose = 1;
 176
 177 =head1 FUNCTIONS
 178
 179 =over 4
 180
 181 =item C<verbose($level, $message)>
 182
 183 Report the C<$message> is C<$level> E<lt>= C<$verbose>.
 184
 185 =cut
 186
 187 sub verbose($$)
 188 {
 189   my ($level, $message) = @_;
 190   print STDERR $message
 191     if $level <= $verbose;
 192 }
 193
 194
 195 ######################################################################
 196
 197 =item C<directives($bench, @directive)>
 198
 199 Format the list of directives for Bison for bench named C<$bench>.
 200
 201 =cut
 202
 203 sub directives($@)
 204 {
 205   my ($bench, @directive) = @_;
 206   my $res = "/* Directives for bench `$bench'. */\n";
 207   $res .= join ("\n", @directive) . "\n";
 208   $res .= "/* End of directives for bench `$bench'. */\n";
 209   return $res;
 210 }
 211
 212 ######################################################################
 213
 214 =item C<generate_grammar_triangular ($base, $max, @directive)>
 215
 216 Create a large triangular grammar which looks like :
 217
 218   input:
 219     exp        { if ($1 != 0) abort (); $$ = $1; }
 220   | input exp  { if ($2 != $1 + 1) abort (); $$ = $2; }
 221   ;
 222
 223   exp:
 224     END                         { $$ = 0; }
 225   | "1"  END                    { $$ = 1; }
 226   | "1" "2"  END                { $$ = 2; }
 227   | "1" "2" "3"  END            { $$ = 3; }
 228   | "1" "2" "3" "4"  END        { $$ = 4; }
 229   | "1" "2" "3" "4" "5"  END    { $$ = 5; }
 230   ;
 231
 232 C<$base> is the base name for the file to create (F<$base.y>).
 233 C<$max> is the number of such rules (here, 5).  You may pass
 234 additional Bison C<@directive>.
 235
 236 The created parser is self contained: it includes its scanner, and
 237 source of input.
 238 =cut
 239
 240 sub generate_grammar_triangular ($$@)
 241 {
 242   my ($base, $max, @directive) = @_;
 243   my $directives = directives ($base, @directive);
 244
 245   my $out = new IO::File ">$base.y"
 246     or die;
 247   print $out <<EOF;
 248 %error-verbose
 249 %{
 250 #include <stdio.h>
 251 #include <stdlib.h>
 252
 253 static int yylex (void);
 254 static void yyerror (const char *msg);
 255 %}
 256 $directives
 257 %union
 258 {
 259   int val;
 260 };
 261
 262 %token END "end"
 263 %type <val> exp input
 264 EOF
 265
 266   for my $size (1 .. $max)
 267     {
 268       print $out "%token t$size $size \"$size\"\n";
 269     };
 270
 271 print $out <<EOF;
 272 %%
 273 input:
 274   exp        { if (\$1 != 0) abort (); \$\$ = \$1; }
 275 | input exp  { if (\$2 != \$1 + 1) abort (); \$\$ = \$2; }
 276 ;
 277
 278 exp:
 279   END
 280     { \$\$ = 0; }
 281 EOF
 282
 283 for my $size (1 .. $max)
 284   {
 285     use Text::Wrap;
 286     print $out wrap ("| ", "   ",
 287                      (map { "\"$_\"" } (1 .. $size)),
 288                      " END \n"),
 289                "    { \$\$ = $size; }\n";
 290   };
 291 print $out ";\n";
 292
 293 print $out <<EOF;
 294 %%
 295 static int
 296 yylex (void)
 297 {
 298   static int inner = 1;
 299   static int outer = 0;
 300   if (outer > $max)
 301     return 0;
 302   else if (inner > outer)
 303     {
 304       inner = 1;
 305       ++outer;
 306       return END;
 307     }
 308   return inner++;
 309 }
 310
 311 static void
 312 yyerror (const char *msg)
 313 {
 314   fprintf (stderr, "%s\\n", msg);
 315 }
 316
 317 int
 318 main (void)
 319 {
 320 #if YYDEBUG
 321   yydebug = !!getenv ("YYDEBUG");
 322 #endif
 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 <assert.h>
 375 #include <stdio.h>
 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   assert (0 <= exponent);
 532   int res = 1;
 533   for (/* Niente */; exponent; --exponent)
 534     res *= base;
 535   return res;
 536 }
 537
 538
 539 int
 540 main (int argc, const char **argv)
 541 {
 542   semantic_value result = 0;
 543   int count = 0;
 544   int status;
 545
 546 #if YYDEBUG
 547   yydebug = !!getenv ("YYDEBUG");
 548 #endif
 549
 550   input = fopen ("calc.input", "r");
 551   if (!input)
 552     {
 553       perror ("calc.input");
 554       return 3;
 555     }
 556
 557   status = yyparse ();
 558   if (global_result != result)
 559     abort ();
 560   if (global_count != count)
 561     abort ();
 562
 563   return status;
 564 }
 565 EOF
 566 }
 567
 568 ##################################################################
 569
 570 =item C<generate_grammar_list ($base, $max, @directive)>
 571
 572 Generate a Bison file F<$base.y> for a C++ parser that uses C++
 573 objects (std::string, std::list).  Tailored for using %define variant.
 574
 575 =cut
 576
 577 sub generate_grammar_list ($$@)
 578 {
 579   my ($base, $max, @directive) = @_;
 580   my $directives = directives ($base, @directive);
 581   my $variant = grep { /%define "?variant"?/ } @directive;
 582   my $token_ctor = grep { /%define "?api.token.constructor"?/ } @directive;
 583   my $out = new IO::File ">$base.y"
 584     or die;
 585   print $out <<EOF;
 586 %language "C++"
 587 %defines
 588 %locations
 589 $directives
 590
 591 %code requires // *.h
 592 {
 593 #include <string>
 594 }
 595
 596 %code // *.c
 597 {
 598 #include <algorithm>
 599 #include <iostream>
 600 #include <sstream>
 601
 602 #define STAGE_MAX    ($max * 10) // max = $max
 603
 604 #define USE_TOKEN_CTOR $token_ctor
 605 #define USE_VARIANTS $variant
 606
 607   // Prototype of the yylex function providing subsequent tokens.
 608   static
 609 #if USE_TOKEN_CTOR
 610   yy::parser::symbol_type yylex();
 611 #else
 612   yy::parser::token_type yylex(yy::parser::semantic_type* yylval,
 613                                yy::parser::location_type* yylloc);
 614 #endif
 615
 616   // Conversion to string.
 617   template <typename T>
 618     inline
 619     std::string
 620     string_cast (const T& t)
 621   {
 622     std::ostringstream o;
 623     o << t;
 624     return o.str ();
 625   }
 626 }
 627
 628 %token END_OF_FILE 0
 629 EOF
 630
 631   if ($variant)
 632     {
 633       print $out <<'EOF';
 634 %token <std::string> TEXT
 635 %token <int> NUMBER
 636 %printer { std::cerr << "Number: " << $$; } <int>
 637 %printer { std::cerr << "Text: " << $$; } <std::string>
 638 %type <std::string> text result
 639
 640 %%
 641 result:
 642   text                  { /* Throw away the result. */ }
 643 ;
 644
 645 text:
 646   /* nothing */         { /* This will generate an empty string */ }
 647 | text TEXT             { std::swap ($$, $2); }
 648 | text NUMBER           { $$ = string_cast($2); }
 649 ;
 650 EOF
 651     }
 652   else
 653     {
 654       # Not using Bison variants.
 655       print $out <<'EOF';
 656 %union {int ival; std::string* sval;}
 657 %token <sval> TEXT
 658 %token <ival> NUMBER
 659 %printer { std::cerr << "Number: " << $$; } <ival>
 660 %printer { std::cerr << "Text: " << *$$; } <sval>
 661 %type <sval> text result
 662
 663 %%
 664 result:
 665   text                  { delete $1; }
 666 ;
 667
 668 text:
 669   /* nothing */         { $$ = new std::string; }
 670 | text TEXT             { delete $1; $$ = $2; }
 671 | text NUMBER           { delete $1; $$ = new std::string (string_cast ($2)); }
 672 ;
 673 EOF
 674     }
 675
 676   print $out <<'EOF';
 677 %%
 678 #
 679
 680 static
 681 #if USE_TOKEN_CTOR
 682 yy::parser::symbol_type yylex()
 683 #else
 684 yy::parser::token_type yylex(yy::parser::semantic_type* yylval,
 685                              yy::parser::location_type* yylloc)
 686 #endif
 687 {
 688   typedef yy::parser::location_type location_type;
 689   typedef yy::parser::token token;
 690   static int stage = -1;
 691   ++stage;
 692   if (stage == STAGE_MAX)
 693     {
 694 #if USE_TOKEN_CTOR
 695       return yy::parser::make_END_OF_FILE (location_type ());
 696 #else
 697       *yylloc = location_type ();
 698       return token::END_OF_FILE;
 699 #endif
 700     }
 701   else if (stage % 2)
 702     {
 703 #if USE_TOKEN_CTOR
 704       return yy::parser::make_NUMBER (stage, location_type ());
 705 #else
 706 # if defined ONE_STAGE_BUILD
 707       yylval->build(stage);
 708 # elif USE_VARIANTS
 709       yylval->build<int>() = stage;
 710 # else
 711       yylval->ival = stage;
 712 # endif
 713       *yylloc = location_type ();
 714       return token::NUMBER;
 715 #endif
 716     }
 717   else
 718     {
 719 #if USE_TOKEN_CTOR
 720       return yy::parser::make_TEXT ("A string.", location_type ());
 721 #else
 722 # if defined ONE_STAGE_BUILD
 723       yylval->build(std::string("A string."));
 724 # elif USE_VARIANTS
 725       yylval->build<std::string>() = std::string("A string.");
 726 # else
 727       yylval->sval = new std::string("A string.");
 728 # endif
 729       *yylloc = location_type ();
 730       return token::TEXT;
 731 #endif
 732     }
 733   abort();
 734 }
 735
 736 // Mandatory error function
 737 void
 738 yy::parser::error(const yy::parser::location_type& loc, const std::string& msg)
 739 {
 740   std::cerr << loc << ": " << msg << std::endl;
 741 }
 742
 743 int main(int argc, char *argv[])
 744 {
 745   yy::parser p;
 746 #if YYDEBUG
 747   p.set_debug_level(!!getenv("YYDEBUG"));
 748 #endif
 749   p.parse();
 750   return 0;
 751 }
 752 EOF
 753 }
 754
 755 ##################################################################
 756
 757 =item C<generate_grammar ($name, $base, @directive)>
 758
 759 Generate F<$base.y> by calling C<&generate_grammar_$name>.
 760
 761 =cut
 762
 763 sub generate_grammar ($$@)
 764 {
 765   my ($name, $base, @directive) = @_;
 766   verbose 3, "Generating $base.y\n";
 767   my %generator =
 768     (
 769       "calc"       => \&generate_grammar_calc,
 770       "list"       => \&generate_grammar_list,
 771       "triangular" => \&generate_grammar_triangular,
 772     );
 773   &{$generator{$name}}($base, 200, @directive);
 774 }
 775
 776 ##################################################################
 777
 778 =item C<run ($command)>
 779
 780 Run, possibly verbosely, the shell C<$command>.
 781
 782 =cut
 783
 784 sub run ($)
 785 {
 786   my ($command) = @_;
 787   verbose 3, "$command\n";
 788   system ("$command") == 0
 789     or die "$command failed";
 790 }
 791
 792 ##################################################################
 793
 794 =item C<compile ($base)>
 795
 796 Compile C<$base.y> to an executable C, Using the C or C++ compiler
 797 depending on the %language specification in C<$base.y>.
 798
 799 =cut
 800
 801 sub compile ($)
 802 {
 803   my ($base) = @_;
 804   my $language = `sed -ne '/%language "\\(.*\\)"/{s//\\1/;p;q;}' $base.y`;
 805   chomp $language;
 806
 807   my $compiler = $language eq 'C++' ? $cxx : $cc;
 808
 809   run "$bison $base.y -o $base.c";
 810   run "$compiler -o $base $cflags $base.c";
 811 }
 812
 813 ######################################################################
 814
 815 =item C<bench ($grammar, @token)>
 816
 817 Generate benches for the C<$grammar> and the directive specification
 818 given in the list of C<@token>.
 819
 820 =cut
 821
 822 sub bench ($@)
 823 {
 824   my ($grammar, @token) = @_;
 825   use Benchmark qw (:all :hireswallclock);
 826
 827   my @directive = parse (@token);
 828
 829   # Set up the benches as expected by timethese.
 830   my %bench;
 831   # A counter of directive sets.
 832   my $count = 1;
 833   for my $d (@directive)
 834     {
 835       $bench{$count} = $d;
 836       printf " %2d. %s\n", $count, join (' ', split ("\n", $d));
 837       $count++;
 838     };
 839
 840   # For each bench, capture the size.
 841   my %size;
 842
 843   while (my ($name, $directives) = each %bench)
 844     {
 845       generate_grammar ($grammar, $name, $directives);
 846       # Compile the executable.
 847       compile ($name);
 848       $bench{$name} = "system ('./$name');";
 849       chop($size{$name} = `wc -c <$name`);
 850     }
 851
 852   # Run the benches.
 853   #
 854   # STYLE can be any of 'all', 'none', 'noc', 'nop' or 'auto'.  'all'
 855   # shows each of the 5 times available ('wallclock' time, user time,
 856   # system time, user time of children, and system time of
 857   # children). 'noc' shows all except the two children times. 'nop'
 858   # shows only wallclock and the two children times.  'auto' (the
 859   # default) will act as 'all' unless the children times are both
 860   # zero, in which case it acts as 'noc'.  'none' prevents output.
 861   verbose 3, "Running the benches for $grammar\n";
 862   my $res = timethese ($iterations, \%bench, 'nop');
 863
 864   # Output the speed result.
 865   cmpthese ($res, 'nop');
 866
 867   # Display the sizes.
 868   print "Sizes (decreasing):\n";
 869   my $width = 10;
 870   for my $bench (keys %size)
 871     {
 872       $width = length $bench
 873         if $width < length $bench;
 874     }
 875   # Benches sorted by decreasing size.
 876   my @benches_per_size = sort {$size{$b} <=> $size{$a}} keys %size;
 877   for my $bench (@benches_per_size)
 878     {
 879       printf "%${width}s: %5.2fkB\n", $bench, $size{$bench} / 1024;
 880     }
 881 }
 882
 883 ######################################################################
 884
 885 =item C<bench_push_parser ()>
 886
 887 Bench the C push parser against the pull parser, pure and impure
 888 interfaces.
 889
 890 =cut
 891
 892 sub bench_push_parser ()
 893 {
 894   bench ('calc',
 895          qw(
 896             [ %d api.pure ]
 897             &
 898             [ %d api.push-pull=both ]
 899          ));
 900 }
 901
 902 ######################################################################
 903
 904 =item C<bench_variant_parser ()>
 905
 906 Bench the C++ lalr1.cc parser using variants or %union.
 907
 908 =cut
 909
 910 sub bench_variant_parser ()
 911 {
 912   bench ('list',
 913          qw(
 914             [
 915               %d variant
 916               &
 917               [ #d ONE_STAGE_BUILD | %d api.token.constructor ]
 918             ]
 919          )
 920     );
 921 }
 922
 923 ############################################################################
 924
 925 sub help ($)
 926 {
 927   my ($verbose) = @_;
 928   use Pod::Usage;
 929   # See <URL:http://perldoc.perl.org/pod2man.html#NOTES>.
 930   pod2usage( { -message => "Bench Bison parsers",
 931                -exitval => 0,
 932                -verbose => $verbose,
 933                -output  => \*STDOUT });
 934 }
 935
 936 ######################################################################
 937
 938 # The end of the directives to parse.
 939 my $eod = "end of directives";
 940 # The list of tokens parsed by the following functions.
 941 my @token;
 942
 943 # eat ($EXPECTED)
 944 # ---------------
 945 # Check that the current token is $EXPECTED, and move to the next.
 946 sub eat ($)
 947 {
 948   my ($expected) = @_;
 949   die "expected $expected, unexpected: $token[0] (@token)\n"
 950     unless $token[0] eq $expected;
 951   shift @token;
 952 }
 953
 954 # Parse directive specifications:
 955 #   expr: term (| term)*
 956 #   term: fact (& fact)*
 957 #   fact: ( expr ) | [ expr ] | dirs
 958 #   dirs: %s SKELETON | #d NAME[=VALUE] | %d NAME[=VALUE] | directive
 959 sub parse (@)
 960 {
 961   @token = (@_, $eod);
 962   verbose 3, "Parsing: @token\n";
 963   my @res = parse_expr ();
 964   eat ($eod);
 965   return @res;
 966 }
 967
 968 sub parse_expr ()
 969 {
 970   my @res = parse_term ();
 971   while ($token[0] eq '|')
 972     {
 973       eat ('|');
 974       # Alternation.
 975       push @res, parse_term ();
 976     }
 977   return @res;
 978 }
 979
 980 sub parse_term ()
 981 {
 982   my @res = parse_fact ();
 983   while ($token[0] eq '&')
 984     {
 985       eat ('&');
 986       # Cartesian product.
 987       my @lhs = @res;
 988       @res = ();
 989       for my $rhs (parse_fact ())
 990         {
 991           for my $lhs (@lhs)
 992             {
 993               push @res, $lhs . ($lhs && $rhs ? "\n" : "") . $rhs;
 994             }
 995         }
 996     }
 997   return @res;
 998 }
 999
1000 sub parse_fact ()
1001 {
1002   my @res;
1003   die "unexpected end of expression"
1004     unless defined $token[0];
1005
1006   if ($token[0] eq '(')
1007     {
1008       eat ('(');
1009       @res = parse_expr ();
1010       eat (')');
1011     }
1012   elsif ($token[0] eq '[')
1013     {
1014       eat ('[');
1015       @res = (parse_expr (), '');
1016       eat (']');
1017     }
1018   else
1019     {
1020       @res = parse_dirs ();
1021     }
1022   return @res;
1023 }
1024
1025 sub parse_dirs ()
1026 {
1027   my @res;
1028   die "unexpected end of expression"
1029     unless defined $token[0];
1030
1031   if ($token[0] eq '#d')
1032     {
1033       eat ('#d');
1034       $token[0] =~ s/(.*?)=(.*)/$1 $2/;
1035       @res = ("%code {\n#define $token[0]\n}");
1036       shift @token;
1037     }
1038   elsif ($token[0] eq '%d')
1039     {
1040       shift @token;
1041       $token[0] =~ s/(.*?)=(.*)/$1 "$2"/;
1042       @res = ("%define $token[0]");
1043       shift @token;
1044     }
1045   elsif ($token[0] eq '%s')
1046     {
1047       shift @token;
1048       @res = ("%skeleton \"$token[0]\"");
1049       shift @token;
1050     }
1051   else
1052     {
1053       @res = $token[0];
1054       shift @token;
1055     }
1056
1057   return @res;
1058 }
1059
1060 ######################################################################
1061
1062 sub getopt ()
1063 {
1064   use Getopt::Long;
1065   my %option = (
1066     "b|bench=s"      => \$bench,
1067     "c|cflags=s"     => \$cflags,
1068     "d|directive=s"  => \@directive,
1069     "g|grammar=s"    => \$grammar,
1070     "h|help"         => sub { help ($verbose) },
1071     "i|iterations=i" => \$iterations,
1072     "q|quiet"        => sub { --$verbose },
1073     "v|verbose"      => sub { ++$verbose },
1074     );
1075   Getopt::Long::Configure ("bundling", "pass_through");
1076   GetOptions (%option)
1077     or exit 1;
1078 }
1079
1080 ######################################################################
1081
1082 getopt;
1083
1084 # Create the directory we work in.
1085 mkdir "benches" or die "cannot create benches"
1086   unless -d "benches";
1087 my $count = 1;
1088 ++$count
1089   while -d "benches/$count";
1090 my $dir = "benches/$count";
1091 mkdir $dir
1092   or die "cannot create $dir";
1093 chdir $dir
1094   or die "cannot chdir $dir";
1095
1096 # The following message is tailored to please Emacs' compilation-mode.
1097 verbose 1, "Entering directory `$dir'\n";
1098 verbose 1, "Using bison=$bison.\n";
1099 verbose 2, "Using cc=$cc.\n";
1100 verbose 2, "Using cxx=$cxx.\n";
1101 verbose 2, "Using cflags=$cflags.\n";
1102 verbose 2, "Grammar: $grammar\n";
1103
1104
1105 # Support -b: predefined benches.
1106 my %bench =
1107   (
1108    "push"     => \&bench_push_parser,
1109    "variant"  => \&bench_variant_parser,
1110   );
1111
1112 if (defined $bench)
1113 {
1114   die "invalid argument for --bench: $bench"
1115     unless defined $bench{$bench};
1116   &{$bench{$bench}}();
1117   exit 0;
1118 }
1119 else
1120 {
1121   # Launch the bench marking.
1122   bench ($grammar, @ARGV);
1123 }
1124
1125 ### Setup "GNU" style for perl-mode and cperl-mode.
1126 ## Local Variables:
1127 ## perl-indent-level: 2
1128 ## perl-continued-statement-offset: 2
1129 ## perl-continued-brace-offset: 0
1130 ## perl-brace-offset: 0
1131 ## perl-brace-imaginary-offset: 0
1132 ## perl-label-offset: -2
1133 ## cperl-indent-level: 2
1134 ## cperl-brace-offset: 0
1135 ## cperl-continued-brace-offset: 0
1136 ## cperl-label-offset: -2
1137 ## cperl-extra-newline-before-brace: t
1138 ## cperl-merge-trailing-else: nil
1139 ## cperl-continued-statement-offset: 2
1140 ## End: