Metadata-Version: 2.0
Name: BenchExec
Version: 1.6
Summary: A Framework for Reliable Benchmarking and Resource Measurement.
Home-page: https://github.com/sosy-lab/benchexec/
Author: Dirk Beyer
Author-email: UNKNOWN
License: Apache 2.0 License
Keywords: benchmarking resource measurement
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: System :: Benchmark
Requires-Dist: tempita (==0.5.2)

BenchExec
=========

A Framework for Reliable Benchmarking and Resource Measurement
--------------------------------------------------------------

|Build Status| |Code Quality| |Test Coverage| |PyPI version| |Apache 2.0
License|

**News**: We have published a paper titled `Benchmarking and Resource
Measurement <http://www.sosy-lab.org/~dbeyer/Publications/2015-SPIN.Benchmarking_and_Resource_Measurement.pdf>`__
on BenchExec and its background at `SPIN
2015 <http://www.spin2015.org/>`__. It also contains a list of rules
that you should always follow when doing benchmarking (and which
BenchExec handles for you).

BenchExec provides three major features:

-  execution of arbitrary commands with precise and reliable measurement
   and limitation of resource usage (e.g., CPU time and memory)
-  an easy way to define benchmarks with specific tool configurations
   and resource limits, and automatically executing them on large sets
   of input files
-  generation of interactive tables and plots for the results

Contrary to other benchmarking frameworks, it is able to reliably
measure and limit resource usage of the benchmarked tool even if it
spawns subprocesses. In order to achieve this, it uses the `cgroups
feature <https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt>`__
of the Linux kernel to correctly handle groups of processes. Optionally,
it can execute benchmarks under a separate user account. BenchExec is
intended for benchmarking non-interactive tools on Linux systems. It
measures CPU time, wall time, and memory usage of a tool, and allows to
specify limits for these resources. It also allows to limit the CPU
cores and (on NUMA systems) memory regions. In addition to measuring
resource usage, BenchExec can verify that the result of the tool was as
expected, and extract further statistical data from the output. Results
from multiple runs can be combined into CSV and interactive HTML tables,
of which the latter provide scatter and quantile plots (have a look at
our `demo
table <https://sosy-lab.github.io/benchexec/example-table/svcomp-simple-cbmc-cpachecker.table.html>`__).

BenchExec works only on Linux and needs a one-time setup of cgroups by
the machine's administrator. The actual benchmarking can be done by any
user and does not need root access.

BenchExec was originally developed for use with the software
verification framework `CPAchecker <http://cpachecker.sosy-lab.org>`__
and is now developed as an independent project at the `Software Systems
Lab <http://www.sosy-lab.org>`__ at the `University of
Passau <http://www.uni-passau.de>`__.

Links
~~~~~

-  `Documentation <https://github.com/sosy-lab/benchexec/tree/master/doc/INDEX.md>`__
-  `Demo <https://sosy-lab.github.io/benchexec/example-table/svcomp-simple-cbmc-cpachecker.table.html>`__
   of a result table
-  `Downloads <https://github.com/sosy-lab/benchexec/releases>`__
-  `Changelog <https://github.com/sosy-lab/benchexec/tree/master/CHANGELOG.md>`__
-  `BenchExec GitHub
   Repository <https://github.com/sosy-lab/benchexec>`__, use this for
   `reporting issues and asking
   questions <https://github.com/sosy-lab/benchexec/issues>`__
-  `BenchExec at PyPI <https://pypi.python.org/pypi/BenchExec>`__
-  Paper `Benchmarking and Resource
   Measurement <http://www.sosy-lab.org/~dbeyer/Publications/2015-SPIN.Benchmarking_and_Resource_Measurement.pdf>`__
   about BenchExec (`supplementary
   webpage <http://www.sosy-lab.org/~dbeyer/benchmarking/>`__)

Users of BenchExec
~~~~~~~~~~~~~~~~~~

BenchExec was successfully used for benchmarking in all four instances
of the `International Competition on Software
Verification <http://sv-comp.sosy-lab.org>`__ with a wide variety of
benchmarked tools and hundreds of thousands benchmark runs.

The developers of the following tools use BenchExec:

-  `CPAchecker <http://cpachecker.sosy-lab.org>`__, also for regression
   testing
-  `SMACK <https://github.com/smackers/smack>`__

If you would like to be listed here, `contact
us <https://github.com/sosy-lab/benchexec/issues/new>`__.

.. |Build Status| image:: https://travis-ci.org/sosy-lab/benchexec.svg?branch=master
   :target: https://travis-ci.org/sosy-lab/benchexec
.. |Code Quality| image:: https://api.codacy.com/project/badge/grade/d9926a7a5cb04bcaa8d43caae38a9c36
   :target: https://www.codacy.com/app/PhilippWendler/benchexec
.. |Test Coverage| image:: https://api.codacy.com/project/badge/coverage/d9926a7a5cb04bcaa8d43caae38a9c36
   :target: https://www.codacy.com/app/PhilippWendler/benchexec
.. |PyPI version| image:: https://badge.fury.io/py/benchexec.svg
   :target: https://badge.fury.io/py/benchexec
.. |Apache 2.0 License| image:: https://img.shields.io/badge/license-Apache--2-brightgreen.svg?style=flat
   :target: http://www.apache.org/licenses/LICENSE-2.0


