POE::Devel::Benchmarker - Benchmarking POE's performance ( acts more like a smoker )
perl -MPOE::Devel::Benchmarker -e 'benchmark()'
This package of tools is designed to benchmark POE's performace across different configurations. The current "tests" are:
This tests how long it takes to post() N times
This tests how long it took to dispatch/deliver all the posts enqueued in the post() test
This tests how long it took to yield() between 2 states for N times
This tests how long it took to call() N times
This tests how long it took to add N alarms via alarm(), overwriting each other
This tests how long it took to add N alarms via alarm_add() and how long it took to delete them all
NOTE: alarm_add is not available on all versions of POE!
This tests how long it took to create N sessions, and how long it took to destroy them all
This tests how long it took to toggle select_read N times on STDIN and a real filehandle via open()
This tests how long it took to toggle select_write N times on STDIN and a real filehandle via open()
This tests how long it took to start + close N instances of a "virgin" POE without any sessions/etc
This is actually a "super" test where all of the specific tests is ran against various POE::Loop::XYZ/FOO for comparison
This is actually a "super" test where all of the specific tests is ran against POE with/without assertions enabled
This is actually a "super" test where all of the specific tests is ran against POE with XS goodness enabled/disabled
This module is poorly documented now. Please give me some time to properly document it over time :)
Here's a simple outline to get you up to speed quickly. ( and smoking! )
Download+install the POE::Devel::Benchmarker package from CPAN
apoc@apoc-x300:~$ cpanp -i POE::Devel::Benchmarker
Go anywhere, and create the "parent" directory where you'll be storing test results + stuff. For this example, I have chosen to use ~/poe-benchmarker:
apoc@apoc-x300:~$ mkdir poe-benchmarker apoc@apoc-x300:~$ cd poe-benchmarker apoc@apoc-x300:~/poe-benchmarker$ mkdir poedists apoc@apoc-x300:~/poe-benchmarker$ mkdir results apoc@apoc-x300:~/poe-benchmarker$ cd poedists/ apoc@apoc-x300:~/poe-benchmarker/poedists$ perl -MPOE::Devel::Benchmarker::GetPOEdists -e 'getPOEdists( 1 )' ( go get a coffee while it downloads if you're on a slow link, ha! )
At this point you can start running the benchmark!
NOTE: the Benchmarker expects everything to be in the "local" directory!
apoc@apoc-x300:~$ cd poe-benchmarker apoc@apoc-x300:~/poe-benchmarker$ perl -MPOE::Devel::Benchmarker -e 'benchmark()' ( go sleep or something, this will take a while! )
On startup the Benchmarker will look in the "poedists" directory and load all the distributions it sees untarred there. Once that is done it will begin autoprobing for available POE::Loop packages. Once it determines what's available, it will begin the benchmarks.
As the Benchmarker goes through the combinations of POE + Eventloop + Assertions + XS::Queue it will dump data into the results directory. The Analyzer module also dumps YAML output in the same place, with the suffix of ".yml"
This module exposes only one subroutine, the benchmark() one. You can pass a hashref to it to set various options. Here is a list of the valid options:
This will tell the Benchmarker to force the unavailability of POE::XS::Queue::Array and skip those tests.
NOTE: The Benchmarker will set this automatically if it cannot load the module!
benchmark( { noxsqueue => 1 } );
default: false
This will tell the Benchmarker to not run the ASSERT tests.
benchmark( { noasserts => 1 } );
This enables the "lite" tests which will not take up too much time.
benchmark( { litetests => 0 } );
default: true
This enables quiet mode which will not print anything to the console except for errors.
benchmark( { 'quiet' => 1 } );
This overrides the built-in loop detection algorithm which searches for all known loops.
There is some "magic" here where you can put a negative sign in front of a loop and we will NOT run that.
NOTE: Capitalization is important!
benchmark( { 'loop' => 'IO_Poll,Select' } ); # runs only IO::Poll and Select benchmark( { 'loop' => [ qw( Tk Gtk ) ] } ); # runs only Tk and Gtk benchmark( { 'loop' => '-Tk' } ); # runs all available loops EXCEPT for TK
Known loops: Event_Lib EV Glib Prima Gtk Wx Kqueue Tk Select IO_Poll
This overrides the built-in POE version detection algorithm which pulls the POE versions from the 'poedists' directory.
There is some "magic" here where you can put a negative sign in front of a version and we will NOT run that.
NOTE: The Benchmarker will ignore versions that wasn't found in the directory!
benchmark( { 'poe' => '0.35,1.003' } ); # runs on 0.35 and 1.003 benchmark( { 'poe' => [ qw( 0.3009 0.12 ) ] } ); # runs on 0.3009 and 0.12 benchmark( { 'poe' => '-0.35' } ); # runs ALL tests except 0.35
Please look at the POE::Devel::Benchmarker::Analyzer module.
This section will explain the miscellaneous questions and preemptively answer any concerns :)
Why would you want to? That's the whole point of this suite!
This will be added to the module soon. However if you have the time+energy, please feel free to dig into the YAML output that Benchmarker::Analyzer outputs.
This isn't implemented yet. You could always manually delete the POE versions that was tested and proceed with the rest. Or, use the 'poe' option to benchmark() and tweak the values.
Automatically exports the benchmark() subroutine.
We should be able to run the benchmark over different Perl versions. This would require some fiddling with our layout + logic. It's not that urgent because the workaround is to simply execute the benchmarker under a different perl binary. It's smart enough to use $^X to be consistent across tests/subprocesses :)
<Khisanth> and if you are benchmarking, try it with POE using EV with EV using Glib? :P <Apocalypse> I'm not sure how to configure the EV "backend" yet <Apocalypse> too much docs for me to read hah <Khisanth> Apocalypse: use EV::Glib; use Glib; use POE; :)
Currently we depend on the litetests option and hardcode some values including the timeout. If your machine is incredibly slow, there's a chance that it could timeout unnecessarily. Please look at the outputs and check to see if there are unusual failures, and inform me.
Also, some loops perform badly and take almost forever! /me glares at Gtk...
As usual, me and the crowd in #poe have plenty of ideas for tests. We'll be adding them over time, but if you have an idea please drop me a line and let me know!
dngor said there was some benchmarks in the POE svn under trunk/queue...
I want a bench that actually tests socket traffic - stream 10MB of traffic over localhost, and time it?
LotR and Tapout contributed some samples, let's see if I can integrate them...
It would be nice if we could have a local SQLite db to dump our stats into. This would make arbitrary reports much easier than loading raw YAML files and trying to make sense of them, ha! Also, this means somebody can do the smoking and send the SQLite db to another person to generate the graphs, cool!
As I don't have access to a *BSD box, I cannot really test this. Furthermore, it isn't clear on how I can force/unload this module from POE...
I have Wx installed, but it doesn't work. Obviously I don't know how to use Wx ;)
If you have experience, please drop me a line on how to do the "right" thing to get Wx loaded under POE. Here's the error:
Can't call method "MainLoop" on an undefined value at /usr/local/share/perl/5.8.8/POE/Loop/Wx.pm line 91.
The POE::XS::Loop::* modules theoretically could be tested too. However, they will only work in POE >= 1.003! This renders the concept somewhat moot. Maybe, after POE has progressed some versions we can implement this...
POE
Apocalypse <apocal@cpan.org>
BIG THANKS goes to Rocco Caputo <rcaputo@cpan.org> for the first benchmarks!
Copyright 2008 by Apocalypse
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install POE::Devel::Benchmarker, copy and paste the appropriate command in to your terminal.
cpanm
cpanm POE::Devel::Benchmarker
CPAN shell
perl -MCPAN -e shell install POE::Devel::Benchmarker
For more information on module installation, please visit the detailed CPAN module installation guide.