BenchExec


NameBenchExec JSON
Version 3.21 PyPI version JSON
download
home_pagehttps://github.com/sosy-lab/benchexec/
SummaryA Framework for Reliable Benchmarking and Resource Measurement.
upload_time2024-02-16 13:35:24
maintainer
docs_urlNone
authorDirk Beyer
requires_python
licenseApache-2.0 AND BSD-3-Clause AND CC-BY-4.0 AND MIT AND ISC AND LicenseRef-BSD-3-Clause-CMU
keywords benchmarking resource measurement
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            <!--
This file is part of BenchExec, a framework for reliable benchmarking:
https://github.com/sosy-lab/benchexec

SPDX-FileCopyrightText: 2007-2020 Dirk Beyer <https://www.sosy-lab.org>

SPDX-License-Identifier: Apache-2.0
-->

# BenchExec
## A Framework for Reliable Benchmarking and Resource Measurement

[![Build Status](https://gitlab.com/sosy-lab/software/benchexec/badges/main/pipeline.svg)](https://gitlab.com/sosy-lab/software/benchexec/pipelines)
[![Apache 2.0 License](https://img.shields.io/badge/license-Apache--2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![PyPI version](https://img.shields.io/pypi/v/BenchExec.svg)](https://pypi.python.org/pypi/BenchExec)
[![DOI](https://zenodo.org/badge/30758422.svg)](https://zenodo.org/badge/latestdoi/30758422)


**News and Updates**:
- BenchExec 3.18 brings support for systems with cgroups v2!
- Linux kernel 5.11 finally [makes it possible](https://github.com/sosy-lab/benchexec/blob/main/doc/INSTALL.md#kernel-requirements) to use all BenchExec features on distributions other than Ubuntu!
- We now provide an [Ubuntu PPA](https://launchpad.net/~sosy-lab/+archive/ubuntu/benchmarking) that makes installing and upgrading BenchExec easier ([docs](https://github.com/sosy-lab/benchexec/blob/main/doc/INSTALL.md#debianubuntu)).
- An extended version of our paper on BenchExec and its background was published as open access in the journal STTT,
  you can read [Reliable Benchmarking: Requirements and Solutions](https://doi.org/10.1007/s10009-017-0469-y) online.
  We also provide a set of [overview slides](https://www.sosy-lab.org/research/prs/Latest_ReliableBenchmarking.pdf).

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),
  and isolation against other running processes
- 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


Unlike other benchmarking frameworks,
BenchExec is able to reliably measure and limit resource usage
of the benchmarked tool even if the latter spawns subprocesses.
In order to achieve this,
it uses the [cgroups feature](https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt)
of the Linux kernel to correctly handle groups of processes.
For proper isolation of the benchmarks, it uses (if available)
Linux [user namespaces](http://man7.org/linux/man-pages/man7/namespaces.7.html)
and an [overlay filesystem](https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt)
to create a [container](https://github.com/sosy-lab/benchexec/blob/main/doc/container.md)
that restricts interference of the executed tool with the benchmarking host.
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,
and the container mode allows to restrict filesystem and network access.
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](https://cpachecker.sosy-lab.org)
and is now developed as an independent project
at the [Software Systems Lab](https://www.sosy-lab.org)
of the [Ludwig-Maximilians-Universität München (LMU Munich)](https://www.uni-muenchen.de).

### Links

- [Documentation](https://github.com/sosy-lab/benchexec/tree/main/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/main/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)
- [BenchExec at Zenodo](https://doi.org/10.5281/zenodo.1163552): Each release gets a DOI such that you can reference it from your publications and artifacts.

### Literature

- [Reliable Benchmarking: Requirements and Solutions](https://doi.org/10.1007/s10009-017-0469-y), by D. Beyer, S. Löwe, and P. Wendler.  International Journal on Software Tools for Technology Transfer (STTT), 21(1):1-29, 2019. [doi:10.1007/s10009-017-0469-y](https://doi.org/10.1007/s10009-017-0469-y). Journal paper about BenchExec (open access, also with a [supplementary webpage](https://www.sosy-lab.org/research/benchmarking/) and [overview slides](https://www.sosy-lab.org/research/prs/Latest_ReliableBenchmarking.pdf))
- [CPU Energy Meter: A Tool for Energy-Aware Algorithms Engineering](https://doi.org/10.1007/978-3-030-45237-7_8), by D. Beyer and P. Wendler. In Proc. TACAS 2020, part 2, LNCS 12079, pages 126-133, 2020. Springer. [doi:10.1007/978-3-030-45237-7_8](https://doi.org/10.1007/978-3-030-45237-7_8)
- [Benchmarking and Resource Measurement](https://doi.org/10.1007/978-3-319-23404-5_12), by D. Beyer, S. Löwe, and P. Wendler. In Proc. SPIN 2015, LNCS 9232, pages 160-178, 2015. Springer. [doi:10.1007/978-3-319-23404-5_12](https://doi.org/10.1007/978-3-319-23404-5_12)

### License and Copyright

BenchExec is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0),
copyright [Dirk Beyer](https://www.sosy-lab.org/people/beyer/).
Exceptions are some tool-info modules
and third-party code that is bundled in the HTML tables,
which are available under several other free licenses
(cf. [folder `LICENSES`](https://github.com/sosy-lab/benchexec/tree/main/LICENSES)).

### Authors
Maintainer: [Philipp Wendler](https://www.philippwendler.de)

Contributors:
- [Aditya Arora](https://github.com/alohamora)
- [Dirk Beyer](https://www.sosy-lab.org/people/beyer/)
- [Laura Bschor](https://github.com/laurabschor)
- [Thomas Bunk](https://github.com/TBunk)
- [Montgomery Carter](https://github.com/MontyCarter)
- [Andreas Donig](https://github.com/adonig)
- [Karlheinz Friedberger](https://www.sosy-lab.org/people/friedberger)
- [Robin Gloster](https://github.com/globin)
- Peter Häring
- [Florian Heck](https://github.com/fheck)
- [Hugo](https://github.com/hugovk)
- [George Karpenkov](http://metaworld.me/)
- [Mike Kazantsev](http://fraggod.net/)
- [Michael Lachner](https://github.com/lachnerm)
- [Thomas Lemberger](https://www.sosy-lab.org/people/lemberger/)
- [Sebastian Ott](https://github.com/ottseb)
- Stefan Löwe
- [Stephan Lukasczyk](https://github.com/stephanlukasczyk)
- [Alexander von Rhein](http://www.infosun.fim.uni-passau.de/se/people-rhein.php)
- [Alexander Schremmer](https://www.xing.com/profile/Alexander_Schremmer)
- [Dennis Simon](https://github.com/DennisSimon)
- [Andreas Stahlbauer](http://stahlbauer.net/)
- [Thomas Stieglmaier](https://stieglmaier.me/)
- [Martin Yankov](https://github.com/marto97)
- [Ilja Zakharov](https://github.com/IljaZakharov)
- and [lots of more people who integrated tools into BenchExec](https://github.com/sosy-lab/benchexec/graphs/contributors)

### Users of BenchExec

BenchExec was successfully used for benchmarking in all instances
of the international competitions on [Software Verification](https://sv-comp.sosy-lab.org)
and [Software Testing](https://test-comp.sosy-lab.org)
with a wide variety of benchmarked tools and hundreds of thousands benchmark runs.
It is integrated into the cluster-based logic-solving service
[StarExec](https://www.starexec.org/starexec/public/about.jsp) ([GitHub](https://github.com/StarExec/StarExec)).

The developers of the following tools use BenchExec:

- [CPAchecker](https://cpachecker.sosy-lab.org), also for regression testing
- [Dartagnan](https://github.com/hernanponcedeleon/Dat3M)
- [ESBMC](https://github.com/esbmc/esbmc), also for regression testing and even with a [GitHub action](https://github.com/esbmc/esbmc/blob/master/.github/workflows/benchexec.yml) for BenchExec
- [SMACK](https://github.com/smackers/smack)
- [SMTInterpol](https://github.com/ultimate-pa/smtinterpol)
- [TriCera](https://github.com/uuverifiers/tricera)
- [Ultimate](https://github.com/ultimate-pa/ultimate)

If you would like to be listed here, [contact us](https://github.com/sosy-lab/benchexec/issues/new).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sosy-lab/benchexec/",
    "name": "BenchExec",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "benchmarking,resource measurement",
    "author": "Dirk Beyer",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/5d/3a/db87b769a70fa19e480b9a84427ed84b7fdae4d886df77133e1996f82e43/BenchExec-3.21.tar.gz",
    "platform": "Linux",
    "description": "<!--\nThis file is part of BenchExec, a framework for reliable benchmarking:\nhttps://github.com/sosy-lab/benchexec\n\nSPDX-FileCopyrightText: 2007-2020 Dirk Beyer <https://www.sosy-lab.org>\n\nSPDX-License-Identifier: Apache-2.0\n-->\n\n# BenchExec\n## A Framework for Reliable Benchmarking and Resource Measurement\n\n[![Build Status](https://gitlab.com/sosy-lab/software/benchexec/badges/main/pipeline.svg)](https://gitlab.com/sosy-lab/software/benchexec/pipelines)\n[![Apache 2.0 License](https://img.shields.io/badge/license-Apache--2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n[![PyPI version](https://img.shields.io/pypi/v/BenchExec.svg)](https://pypi.python.org/pypi/BenchExec)\n[![DOI](https://zenodo.org/badge/30758422.svg)](https://zenodo.org/badge/latestdoi/30758422)\n\n\n**News and Updates**:\n- BenchExec 3.18 brings support for systems with cgroups v2!\n- Linux kernel 5.11 finally [makes it possible](https://github.com/sosy-lab/benchexec/blob/main/doc/INSTALL.md#kernel-requirements) to use all BenchExec features on distributions other than Ubuntu!\n- We now provide an [Ubuntu PPA](https://launchpad.net/~sosy-lab/+archive/ubuntu/benchmarking) that makes installing and upgrading BenchExec easier ([docs](https://github.com/sosy-lab/benchexec/blob/main/doc/INSTALL.md#debianubuntu)).\n- An extended version of our paper on BenchExec and its background was published as open access in the journal STTT,\n  you can read [Reliable Benchmarking: Requirements and Solutions](https://doi.org/10.1007/s10009-017-0469-y) online.\n  We also provide a set of [overview slides](https://www.sosy-lab.org/research/prs/Latest_ReliableBenchmarking.pdf).\n\nBenchExec provides three major features:\n\n- execution of arbitrary commands with precise and reliable measurement\n  and limitation of resource usage (e.g., CPU time and memory),\n  and isolation against other running processes\n- an easy way to define benchmarks with specific tool configurations\n  and resource limits,\n  and automatically executing them on large sets of input files\n- generation of interactive tables and plots for the results\n\n\nUnlike other benchmarking frameworks,\nBenchExec is able to reliably measure and limit resource usage\nof the benchmarked tool even if the latter spawns subprocesses.\nIn order to achieve this,\nit uses the [cgroups feature](https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt)\nof the Linux kernel to correctly handle groups of processes.\nFor proper isolation of the benchmarks, it uses (if available)\nLinux [user namespaces](http://man7.org/linux/man-pages/man7/namespaces.7.html)\nand an [overlay filesystem](https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt)\nto create a [container](https://github.com/sosy-lab/benchexec/blob/main/doc/container.md)\nthat restricts interference of the executed tool with the benchmarking host.\nBenchExec is intended for benchmarking non-interactive tools on Linux systems.\nIt measures CPU time, wall time, and memory usage of a tool,\nand allows to specify limits for these resources.\nIt also allows to limit the CPU cores and (on NUMA systems) memory regions,\nand the container mode allows to restrict filesystem and network access.\nIn addition to measuring resource usage,\nBenchExec can verify that the result of the tool was as expected,\nand extract further statistical data from the output.\nResults from multiple runs can be combined into CSV and interactive HTML tables,\nof which the latter provide scatter and quantile plots\n(have a look at our [demo table](https://sosy-lab.github.io/benchexec/example-table/svcomp-simple-cbmc-cpachecker.table.html)).\n\nBenchExec works only on Linux and needs a one-time setup of cgroups by the machine's administrator.\nThe actual benchmarking can be done by any user and does not need root access.\n\nBenchExec was originally developed for use with the software verification framework\n[CPAchecker](https://cpachecker.sosy-lab.org)\nand is now developed as an independent project\nat the [Software Systems Lab](https://www.sosy-lab.org)\nof the [Ludwig-Maximilians-Universit\u00e4t M\u00fcnchen (LMU Munich)](https://www.uni-muenchen.de).\n\n### Links\n\n- [Documentation](https://github.com/sosy-lab/benchexec/tree/main/doc/INDEX.md)\n- [Demo](https://sosy-lab.github.io/benchexec/example-table/svcomp-simple-cbmc-cpachecker.table.html) of a result table\n- [Downloads](https://github.com/sosy-lab/benchexec/releases)\n- [Changelog](https://github.com/sosy-lab/benchexec/tree/main/CHANGELOG.md)\n- [BenchExec GitHub Repository](https://github.com/sosy-lab/benchexec),\n  use this for [reporting issues and asking questions](https://github.com/sosy-lab/benchexec/issues)\n- [BenchExec at PyPI](https://pypi.python.org/pypi/BenchExec)\n- [BenchExec at Zenodo](https://doi.org/10.5281/zenodo.1163552): Each release gets a DOI such that you can reference it from your publications and artifacts.\n\n### Literature\n\n- [Reliable Benchmarking: Requirements and Solutions](https://doi.org/10.1007/s10009-017-0469-y), by D. Beyer, S. L\u00f6we, and P. Wendler.  International Journal on Software Tools for Technology Transfer (STTT), 21(1):1-29, 2019. [doi:10.1007/s10009-017-0469-y](https://doi.org/10.1007/s10009-017-0469-y). Journal paper about BenchExec (open access, also with a [supplementary webpage](https://www.sosy-lab.org/research/benchmarking/) and [overview slides](https://www.sosy-lab.org/research/prs/Latest_ReliableBenchmarking.pdf))\n- [CPU Energy Meter: A Tool for Energy-Aware Algorithms Engineering](https://doi.org/10.1007/978-3-030-45237-7_8), by D. Beyer and P. Wendler. In Proc. TACAS 2020, part 2, LNCS 12079, pages 126-133, 2020. Springer. [doi:10.1007/978-3-030-45237-7_8](https://doi.org/10.1007/978-3-030-45237-7_8)\n- [Benchmarking and Resource Measurement](https://doi.org/10.1007/978-3-319-23404-5_12), by D. Beyer, S. L\u00f6we, and P. Wendler. In Proc. SPIN 2015, LNCS 9232, pages 160-178, 2015. Springer. [doi:10.1007/978-3-319-23404-5_12](https://doi.org/10.1007/978-3-319-23404-5_12)\n\n### License and Copyright\n\nBenchExec is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0),\ncopyright [Dirk Beyer](https://www.sosy-lab.org/people/beyer/).\nExceptions are some tool-info modules\nand third-party code that is bundled in the HTML tables,\nwhich are available under several other free licenses\n(cf. [folder `LICENSES`](https://github.com/sosy-lab/benchexec/tree/main/LICENSES)).\n\n### Authors\nMaintainer: [Philipp Wendler](https://www.philippwendler.de)\n\nContributors:\n- [Aditya Arora](https://github.com/alohamora)\n- [Dirk Beyer](https://www.sosy-lab.org/people/beyer/)\n- [Laura Bschor](https://github.com/laurabschor)\n- [Thomas Bunk](https://github.com/TBunk)\n- [Montgomery Carter](https://github.com/MontyCarter)\n- [Andreas Donig](https://github.com/adonig)\n- [Karlheinz Friedberger](https://www.sosy-lab.org/people/friedberger)\n- [Robin Gloster](https://github.com/globin)\n- Peter H\u00e4ring\n- [Florian Heck](https://github.com/fheck)\n- [Hugo](https://github.com/hugovk)\n- [George Karpenkov](http://metaworld.me/)\n- [Mike Kazantsev](http://fraggod.net/)\n- [Michael Lachner](https://github.com/lachnerm)\n- [Thomas Lemberger](https://www.sosy-lab.org/people/lemberger/)\n- [Sebastian Ott](https://github.com/ottseb)\n- Stefan L\u00f6we\n- [Stephan Lukasczyk](https://github.com/stephanlukasczyk)\n- [Alexander von Rhein](http://www.infosun.fim.uni-passau.de/se/people-rhein.php)\n- [Alexander Schremmer](https://www.xing.com/profile/Alexander_Schremmer)\n- [Dennis Simon](https://github.com/DennisSimon)\n- [Andreas Stahlbauer](http://stahlbauer.net/)\n- [Thomas Stieglmaier](https://stieglmaier.me/)\n- [Martin Yankov](https://github.com/marto97)\n- [Ilja Zakharov](https://github.com/IljaZakharov)\n- and [lots of more people who integrated tools into BenchExec](https://github.com/sosy-lab/benchexec/graphs/contributors)\n\n### Users of BenchExec\n\nBenchExec was successfully used for benchmarking in all instances\nof the international competitions on [Software Verification](https://sv-comp.sosy-lab.org)\nand [Software Testing](https://test-comp.sosy-lab.org)\nwith a wide variety of benchmarked tools and hundreds of thousands benchmark runs.\nIt is integrated into the cluster-based logic-solving service\n[StarExec](https://www.starexec.org/starexec/public/about.jsp) ([GitHub](https://github.com/StarExec/StarExec)).\n\nThe developers of the following tools use BenchExec:\n\n- [CPAchecker](https://cpachecker.sosy-lab.org), also for regression testing\n- [Dartagnan](https://github.com/hernanponcedeleon/Dat3M)\n- [ESBMC](https://github.com/esbmc/esbmc), also for regression testing and even with a [GitHub action](https://github.com/esbmc/esbmc/blob/master/.github/workflows/benchexec.yml) for BenchExec\n- [SMACK](https://github.com/smackers/smack)\n- [SMTInterpol](https://github.com/ultimate-pa/smtinterpol)\n- [TriCera](https://github.com/uuverifiers/tricera)\n- [Ultimate](https://github.com/ultimate-pa/ultimate)\n\nIf you would like to be listed here, [contact us](https://github.com/sosy-lab/benchexec/issues/new).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0 AND BSD-3-Clause AND CC-BY-4.0 AND MIT AND ISC AND LicenseRef-BSD-3-Clause-CMU",
    "summary": "A Framework for Reliable Benchmarking and Resource Measurement.",
    "version": "3.21",
    "project_urls": {
        "Changelog": "https://github.com/sosy-lab/benchexec/blob/main/CHANGELOG.md",
        "Documentation": "https://github.com/sosy-lab/benchexec/blob/main/doc/INDEX.md",
        "Homepage": "https://github.com/sosy-lab/benchexec/",
        "Issue Tracker": "https://github.com/sosy-lab/benchexec/issues"
    },
    "split_keywords": [
        "benchmarking",
        "resource measurement"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2124f3297aa9a6b24b1be50f1045f73fab149463047b74831edfdbb3db600048",
                "md5": "ae06abb3f161f52b6f2b735cd2bc0599",
                "sha256": "d986e02b0877919c5f7d605bc1ba3687225e0090c3527ec76557bfef2f3d2d80"
            },
            "downloads": -1,
            "filename": "BenchExec-3.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ae06abb3f161f52b6f2b735cd2bc0599",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 706217,
            "upload_time": "2024-02-16T13:35:21",
            "upload_time_iso_8601": "2024-02-16T13:35:21.394212Z",
            "url": "https://files.pythonhosted.org/packages/21/24/f3297aa9a6b24b1be50f1045f73fab149463047b74831edfdbb3db600048/BenchExec-3.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5d3adb87b769a70fa19e480b9a84427ed84b7fdae4d886df77133e1996f82e43",
                "md5": "66d5c1a2026f85c27ed986268aadd710",
                "sha256": "60b5e5a512be4c9977a753a98935dd662c7a748f4360d1d18427154f339a063c"
            },
            "downloads": -1,
            "filename": "BenchExec-3.21.tar.gz",
            "has_sig": false,
            "md5_digest": "66d5c1a2026f85c27ed986268aadd710",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1163345,
            "upload_time": "2024-02-16T13:35:24",
            "upload_time_iso_8601": "2024-02-16T13:35:24.224114Z",
            "url": "https://files.pythonhosted.org/packages/5d/3a/db87b769a70fa19e480b9a84427ed84b7fdae4d886df77133e1996f82e43/BenchExec-3.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-16 13:35:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sosy-lab",
    "github_project": "benchexec",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "appveyor": true,
    "lcname": "benchexec"
}
        
Elapsed time: 0.19359s