v2.3 - Dependency versions, show perl multi/thread

Author: dkechag

Changes

@@ -1,5 +1,10 @@
 Revision history for Benchmark-DKbench
 
+2.3     2023-09-25
+        - Show Perl threads/multi config.
+        - Minimum module version for passing benchmarks.
+        - Improvements for Strawberry Perl (prefer the much faster WSL though - or at least cygwin).
+
 2.2     2023-09-21
         - Time::Piece test is optional for all platforms.
         - Switched to monotonic clock instead of wall.

Makefile.PL

@@ -30,26 +30,27 @@ my %WriteMakefileArgs = (
     PREREQ_PM => {
         'Astro::Coord::Constellations'   => '0',
         'Astro::Coord::Precession'       => '0',
+        'CryptX'                         => '0.067',
         'Crypt::JWT'                     => '0.032',
         'CSS::Inliner'                   => '0',
-        'DateTime'                       => '0',
+        'DateTime'                       => '1.52',
         'DBD::Mock'                      => '0',
-        'DBI'                            => '0',
+        'DBI'                            => '1.642',
         'File::ShareDir'                 => '0',
         'HTML::FormatText'               => '0',
         'HTML::Parser'                   => '0',
         'HTML::TreeBuilder'              => '0',
-        'Imager'                         => '1',
+        'Imager'                         => '1.007',
         'Image::PHash'                   => '0.3',
-        'JSON::XS'                       => '0',
+        'JSON::XS'                       => '4.0',
         'Math::MatrixReal'               => '0',
         'Math::DCT'                      => '0',
-        'Moose'                          => '0',
+        'Moose'                          => '2.2005',
         'MCE::Loop'                      => '0',
         'SQL::Inserter'                  => '0',
         'SQL::Abstract::Classic'         => '0',
         'System::CPU'                    => '0',
-        'System::Info'                   => '0',
+        'System::Info'                   => '0.057',
         'Test::Harness'                  => '0',
         'Test::Requires'                 => '0',
         'Text::Levenshtein::XS'          => '0',

README.md

@@ -28,6 +28,12 @@ scenario.
 
 # INSTALLATION
 
+See the ["setup\_dkbench"](#setup_dkbench) script below for more on the installation of a couple
+of optional benchmarks and standardizing your benchmarking environment, otherwise
+here are some general guidelines for verious systems.
+
+## Linux / WSL etc
+
 The only non-CPAN software required to install/run the suite is a build environment
 for the C/XS modules (C compiler, make etc.) and Perl. On the most popular Linux
 package managers you can easily set up such an environment (as root or with sudo):
@@ -45,8 +51,34 @@ root/sudo is the easiest, will install for all users):
 
     cpanm -n Benchmark::DKbench
 
-See the `setup_dkbench` script below for more on the installation of a couple of
-optional benchmarks and standardizing your benchmarking environment.
+## Solaris
+
+You will need to install the Oracle Solaris Studio development package to have a
+compiler environment, and to add its `bin` directory to your PATH, before installing
+the benchmark suite.
+
+## Strawberry Perl
+
+If you are on Windows, you should be using the Windows Subsystem for Linux (WSL)
+for running Perl or, if you can't (e.g. old Windows verions), cygwin instead.
+The suite should still work on Strawberry Perl, as long as you don't try to run
+tests when installing (some dependencies will not pass them). The simplest way is
+with [App::cpanminus](https://metacpan.org/pod/App%3A%3Acpanminus) (most Strawberry Perl verions have it installed):
+
+    cpanm -n Benchmark::DKbench
+
+otherwise with the base CPAN shell:
+
+    perl -MCPAN -e shell
+
+    > notest install Benchmark::DKbench
+
+and then note that the scripts get the batch extension appended, so `dkbench.bat`
+runs the suite (and `setup_dkbench.bat` can assist with module versions, optional
+benchmarks etc.).
+
+Be aware that Strawberry Perl is slower, on my test system I get almost 50% slower
+performance than WSL and 30% slower than cygwin.
 
 # SCRIPTS
 
@@ -88,7 +120,8 @@ multi vs single threaded scalability.
 
 The scores are calibrated such that a reference CPU (Intel Xeon Platinum 8481C -
 Sapphire Rapids) would achieve a score of 1000 in a single-core benchmark run using
-the default software configuration (Linux/Perl 5.36.0 with reference CPAN modules).
+the default software configuration (Linux/Perl 5.36.0 built with multiplicity and
+threads, with reference CPAN module versions).
 
 The multi-thread scalability should approach 100% if each thread runs on a full core
 (i.e. no SMT), and the core can maintain the clock speed it had on the single-thread
@@ -106,7 +139,7 @@ there is an option to disable it, which forces a single-thread run.
 Simple installer to check/get the reference versions of CPAN modules and download
 the Genbank data file required for the BioPerl benchmarks of the DKbench suite.
 
-It assumes that you have some software already installed (see INSTALLATION above),
+It assumes that you have some software already installed (see ["INSTALLATION"](#installation) above),
 try `setup_dkbench --help` will give you more details.
 
     setup_dkbench [--force --sudo --test --data=s --help]

dkbench

@@ -112,7 +112,7 @@ if ($opt{threads} || !$max_threads || $max_threads == 1) {
 }
 
 sub check_kit {
-    warn "! Perl version v5.36.0 recommended as a comparison base\n"
+    warn "! Perl version v5.36 recommended as a comparison base\n"
         unless $^V =~ /v5.36.\d/;
 
     my %mod_ver = Benchmark::DKbench::Setup::cpan_versions();
@@ -123,7 +123,7 @@ sub check_kit {
         my $ver = eval "\$${module}::VERSION" || 'none';
         unless ($ver eq $mod_ver{$module}) {
             my $msg = "! $module $mod_ver{$module} recommended as a comparison base ($ver found).";
-            $msg .= " Older installed versions may cause issues to benchmarks."
+            $msg .= " Older versions may show benchmark failures."
                 if $mod_ver{$module} cmp $ver; # $ver is less
             if ($module =~ /^Bio/ && $ver eq 'none') {
                 $opt{skip_bio}   = 1;

lib/Benchmark/DKbench.pm

@@ -3,12 +3,13 @@ package Benchmark::DKbench;
 use strict;
 use warnings;
 
+use Config;
 use Digest;
 use Digest::MD5 qw(md5_hex);
 use Encode;
 use File::Spec::Functions;
 use List::Util qw(min max sum);
-use Time::HiRes qw(clock_gettime CLOCK_MONOTONIC);
+use Time::HiRes qw(CLOCK_MONOTONIC);
 use Time::Piece;
 
 use Astro::Coord::Constellations 'constellation_for_eq';
@@ -35,10 +36,11 @@ use Text::Levenshtein::Damerau::XS;
 use Text::Levenshtein::XS;
 
 use Exporter 'import';
-our @EXPORT = qw(system_identity suite_run calc_scalability);
-our $datadir = dist_dir("Benchmark-DKbench");
+our @EXPORT    = qw(system_identity suite_run calc_scalability);
+our $datadir   = dist_dir("Benchmark-DKbench");
+my $mono_clock = $^O !~ /win/i || $Time::HiRes::VERSION >= 1.9764;
 
-our $VERSION = '2.2';
+our $VERSION = '2.3';
 
 =head1 NAME
 
@@ -70,6 +72,12 @@ scenario.
 
 =head1 INSTALLATION
 
+See the L</"setup_dkbench"> script below for more on the installation of a couple
+of optional benchmarks and standardizing your benchmarking environment, otherwise
+here are some general guidelines for verious systems.
+
+=head2 Linux / WSL etc
+
 The only non-CPAN software required to install/run the suite is a build environment
 for the C/XS modules (C compiler, make etc.) and Perl. On the most popular Linux
 package managers you can easily set up such an environment (as root or with sudo):
@@ -87,8 +95,34 @@ root/sudo is the easiest, will install for all users):
 
  cpanm -n Benchmark::DKbench
 
-See the C<setup_dkbench> script below for more on the installation of a couple of
-optional benchmarks and standardizing your benchmarking environment.
+=head2 Solaris
+
+You will need to install the Oracle Solaris Studio development package to have a
+compiler environment, and to add its C<bin> directory to your PATH, before installing
+the benchmark suite.
+
+=head2 Strawberry Perl
+
+If you are on Windows, you should be using the Windows Subsystem for Linux (WSL)
+for running Perl or, if you can't (e.g. old Windows verions), cygwin instead.
+The suite should still work on Strawberry Perl, as long as you don't try to run
+tests when installing (some dependencies will not pass them). The simplest way is
+with L<App::cpanminus> (most Strawberry Perl verions have it installed):
+
+ cpanm -n Benchmark::DKbench
+
+otherwise with the base CPAN shell:
+
+ perl -MCPAN -e shell
+
+ > notest install Benchmark::DKbench
+
+and then note that the scripts get the batch extension appended, so C<dkbench.bat>
+runs the suite (and C<setup_dkbench.bat> can assist with module versions, optional
+benchmarks etc.).
+
+Be aware that Strawberry Perl is slower, on my test system I get almost 50% slower
+performance than WSL and 30% slower than cygwin.
 
 =head1 SCRIPTS
 
@@ -130,7 +164,8 @@ multi vs single threaded scalability.
 
 The scores are calibrated such that a reference CPU (Intel Xeon Platinum 8481C -
 Sapphire Rapids) would achieve a score of 1000 in a single-core benchmark run using
-the default software configuration (Linux/Perl 5.36.0 with reference CPAN modules).
+the default software configuration (Linux/Perl 5.36.0 built with multiplicity and
+threads, with reference CPAN module versions).
 
 The multi-thread scalability should approach 100% if each thread runs on a full core
 (i.e. no SMT), and the core can maintain the clock speed it had on the single-thread
@@ -148,7 +183,7 @@ there is an option to disable it, which forces a single-thread run.
 Simple installer to check/get the reference versions of CPAN modules and download
 the Genbank data file required for the BioPerl benchmarks of the DKbench suite.
 
-It assumes that you have some software already installed (see INSTALLATION above),
+It assumes that you have some software already installed (see L</"INSTALLATION"> above),
 try C<setup_dkbench --help> will give you more details.
 
  setup_dkbench [--force --sudo --test --data=s --help]
@@ -368,7 +403,9 @@ sub system_identity {
     my $arch  = System::CPU::get_arch || '';
     $arch = " ($arch)" if $arch;
     print "--------------- Software ---------------\nDKbench v$VERSION\n";
-    print "Perl $^V\n";
+    printf "Perl $^V (%sthreads, %smulti)\n",
+        $Config{usethreads}      ? '' : 'no ',
+        $Config{usemultiplicity} ? '' : 'no ',;
     print "OS: $osn\n--------------- Hardware ---------------\n";
     print "CPU type: $model$arch\n";
     print "CPUs: $ncpu";
@@ -507,9 +544,9 @@ sub bench_run {
     my ($benchmark, $srand) = @_;
     $srand //= 1;
     srand($srand); # For repeatability
-    my $t0   = clock_gettime(CLOCK_MONOTONIC);
+    my $t0   = _get_time();
     my $out  = $benchmark->[2]->($benchmark->[3]);
-    my $time = sprintf("%.3f", clock_gettime(CLOCK_MONOTONIC)-$t0);
+    my $time = sprintf("%.3f", _get_time()-$t0);
     my $r    = $out eq $benchmark->[0] ? 'Pass' : "Fail ($out)";
     return $time, $r;
 }
@@ -1218,6 +1255,10 @@ sub _decode_jwt2 {
     return $payload;
 }
 
+sub _get_time {
+    return $mono_clock ? Time::HiRes::clock_gettime(CLOCK_MONOTONIC) : Time::HiRes::time();
+}
+
 # Helper package for Moose benchmark
 
 {

setup_dkbench

@@ -31,8 +31,14 @@ may show 'Fail' under Pass/Fail and scores may not be comparable to the baseline
 This might be perfectly fine for your purposes - in fact it might be intended if
 you are benchmarking to compare different software instead of hardware.
 
-This installer assumes you have at least cpanm already installed
-(C<curl -L https://cpanmin.us | perl - --sudo App::cpanminus>).
+This installer assumes you have at least cpanm (L<App::cpanminus>) already installed.
+If not, on must systems you can do that with:
+
+ # System-wide with sudo:
+ curl -L https://cpanmin.us | perl - --sudo App::cpanminus
+
+ # Locally or system-wide when root
+ curl -L https://cpanmin.us | perl - App::cpanminus
 
 You will also need to have a build enviroment set up (compiler, make etc). If you
 want to add a couple of optional BioPerl bencharks you'd want an XML library in
@@ -62,6 +68,8 @@ version lower than 5.14 make sure you install L<IO::Socket::IP> 0.41 or lower fi
 
  cpanm -n http://cpan.metacpan.org/authors/id/P/PE/PEVANS/IO-Socket-IP-0.41.tar.gz
 
+Some benchmarks will report failure on "ancient" Perls.
+
 =cut
 
 use strict;

t/simple.t

@@ -6,7 +6,7 @@ use File::ShareDir 'dist_dir';
 my $threads;
 my @std = capture {$threads = system_identity()};
 like($std[0], qr/CPU/, 'System identity');
-warn $std[0];
+diag $std[0];
 
 my %opt = (
     iter       => 1,
@@ -20,21 +20,21 @@ my %opt = (
 my (%stats1, %stats2);
 @std = capture {%stats1 = suite_run({%opt, no_mce=>1})};
 like($std[0], qr/Overall Time/, 'Bench');
-warn $std[0];
+diag $std[0];
 
 if ($threads && $threads > 1) {
     $opt{include} = 'Astro';
     $opt{ver}     = 1;
     @std = capture {%stats2 = suite_run({%opt, threads=>2})};
-    warn $std[0];
+    diag $std[0];
 } else {
     %stats2 = %stats1;
     $stats2{threads} = 2;
 }
 
 @std = capture {calc_scalability(\%opt, \%stats1, \%stats2)};
 like($std[0], qr/scalability/, 'Scalability');
-warn $std[0];
+diag $std[0];
 
 @std = capture {
     %stats1 = suite_run({
@@ -48,7 +48,7 @@ warn $std[0];
     )
 };
 like($std[0], qr/Overall Avg Score/, 'Aggregate');
-warn $std[0];
+diag $std[0];
 
 %stats2 = %stats1;
 $stats2{threads} = 2;