NAME

Bencher::Scenario::Digest::SHA::SHA1 - Benchmark Digest::SHA against sha1sum

VERSION

This document describes version 0.004 of Bencher::Scenario::Digest::SHA::SHA1 (from Perl distribution Bencher-Scenarios-Digest-SHA), released on 2023-01-19.

SYNOPSIS

To run benchmark with default option:

 % bencher -m Digest::SHA::SHA1

To run module startup overhead benchmark:

 % bencher --module-startup -m Digest::SHA::SHA1

For more options (dump scenario, list/include/exclude/add participants, list/include/exclude/add datasets, etc), see bencher or run bencher --help.

DESCRIPTION

Packaging a benchmark script as a Bencher scenario makes it convenient to include/exclude/add participants/datasets (either via CLI or Perl code), send the result to a central repository, among others . See Bencher and bencher (CLI) for more details.

BENCHMARKED MODULES

Version numbers shown below are the versions used when running the sample benchmark.

String::ShellQuote 1.04

Digest::SHA 6.02

BENCHMARK PARTICIPANTS

• sha1sum (perl_code)

  Code template:

   my $cmd = "sha1sum ".String::ShellQuote::shell_quote(<filename>); my $res = `$cmd`; $res =~ s/\s.+//s; $res

• Digest::SHA (perl_code)

  Code template:

   my $ctx = Digest::SHA->new(1); open my $fh, "<", <filename>; $ctx->addfile($fh); $ctx->hexdigest

BENCHMARK DATASETS

• 30M_file

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.34.0, CPU: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz (2 cores), OS: GNU/Linux Ubuntu version 20.04, OS kernel: Linux version 5.4.0-91-generic.

Benchmark with default options (bencher -m Digest::SHA::SHA1):

 #table1#
 +-------------+-----------+-----------+-----------------------+-----------------------+-----------+---------+
 | participant | rate (/s) | time (ms) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors   | samples |
 +-------------+-----------+-----------+-----------------------+-----------------------+-----------+---------+
 | Digest::SHA |      13.6 |      73.7 |                 0.00% |                 0.36% | 2.8e-05   |       6 |
 | sha1sum     |      14   |      73   |                 0.36% |                 0.00% |   0.00014 |       6 |
 +-------------+-----------+-----------+-----------------------+-----------------------+-----------+---------+

Formatted as Benchmark.pm result:

                 Rate  Digest::SHA  sha1sum 
  Digest::SHA  13.6/s           --       0% 
  sha1sum        14/s           0%       -- 
 
 Legends:
   Digest::SHA: participant=Digest::SHA
   sha1sum: participant=sha1sum

Benchmark module startup overhead (bencher -m Digest::SHA::SHA1 --module-startup):

 #table2#
 +---------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
 | participant         | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
 +---------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
 | Digest::SHA         |      11.3 |               5.3 |                 0.00% |                81.00% | 5.3e-06 |       6 |
 | String::ShellQuote  |       9.7 |               3.7 |                16.76% |                55.02% | 8.1e-05 |       9 |
 | perl -e1 (baseline) |       6   |               0   |                81.00% |                 0.00% | 9.3e-05 |       7 |
 +---------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

                          Rate  D:S   S:S  perl -e1 (baseline) 
  D:S                   88.5/s   --  -14%                 -46% 
  S:S                  103.1/s  16%    --                 -38% 
  perl -e1 (baseline)  166.7/s  88%   61%                   -- 
 
 Legends:
   D:S: mod_overhead_time=5.3 participant=Digest::SHA
   S:S: mod_overhead_time=3.7 participant=String::ShellQuote
   perl -e1 (baseline): mod_overhead_time=0 participant=perl -e1 (baseline)

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

BENCHMARK NOTES

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher-Scenarios-Digest-SHA.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenarios-Digest-SHA.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2017, 2016 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher-Scenarios-Digest-SHA

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm Bencher::Scenarios::Digest::SHA

perl -MCPAN -e shell
install Bencher::Scenarios::Digest::SHA