NAME

Bencher::Scenario::ArchiveTarModules::ListMemUsage - Benchmark memory usage for listing files of an archive

VERSION

This document describes version 0.002 of Bencher::Scenario::ArchiveTarModules::ListMemUsage (from Perl distribution Bencher-Scenarios-ArchiveTarModules), released on 2017-01-25.

SYNOPSIS

To run benchmark with default option:

% bencher -m ArchiveTarModules::ListMemUsage

To run module startup overhead benchmark:

% bencher --module-startup -m ArchiveTarModules::ListMemUsage

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.

Archive::Tar 2.04

Archive::Tar::Wrapper 0.23

BENCHMARK PARTICIPANTS

• Archive::Tar::Wrapper (perl_code)

  Code template:

  my $filename = <filename>;
  my $obj = Archive::Tar::Wrapper->new;
  my @res;
  $obj->list_reset;
  while (my $entry = $obj->list_next) {
      my ($tar_path, $phys_path) = @$entry;
      push @res, {
          name => $tar_path,
          size => (-s $phys_path),
      };
  }
  return @res;

• Archive::Tar (perl_code)

  Code template:

  my $filename = <filename>;
  my $obj = Archive::Tar->new;
  my @files = $obj->read($filename);
  my @res;
  for my $file (@files) {
      push @res, {
          name => $file->name,
          size => $file->size,
      };
  }
  return @res;

• perl (baseline) (perl_code)

  Code template:

  1

BENCHMARK DATASETS

• archive.tar.gz

  Sample archive with 10 files, ~10MB each

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.24.0, CPU: Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz (2 cores), OS: GNU/Linux LinuxMint version 17.3, OS kernel: Linux version 3.19.0-32-generic.

Benchmark with default options (bencher -m ArchiveTarModules::ListMemUsage):

#table1#
+-----------------------+------------------------------+--------------------+----------------+-------------+------------+------------+----------+---------+
| participant           | proc_private_dirty_size (MB) | proc_rss_size (MB) | proc_size (MB) | rate (/s)   | time (ms)  | vs_slowest |  errors  | samples |
+-----------------------+------------------------------+--------------------+----------------+-------------+------------+------------+----------+---------+
| Archive::Tar          | 79                           | 83                 | 120            |         1.5 | 660        |          1 |   0.0019 |       6 |
| Archive::Tar::Wrapper | 9.9                          | 14                 | 41             |      1400   |   0.74     |        890 |   2e-06  |       6 |
| perl (baseline)       | 0.8                          | 4                  | 20             | 700000000   |   0.000001 |  500000000 | 1.9e-10  |      11 |
+-----------------------+------------------------------+--------------------+----------------+-------------+------------+------------+----------+---------+

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

HOMEPAGE

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

SOURCE

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

BUGS

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

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.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by 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.

cpanm Bencher::Scenarios::ArchiveTarModules

perl -MCPAN -e shell
install Bencher::Scenarios::ArchiveTarModules