Skip to content

Latest commit

 

History

History
179 lines (151 loc) · 10.9 KB

README.md

File metadata and controls

179 lines (151 loc) · 10.9 KB
Raw

BenchExec

A Framework for Reliable Benchmarking and Resource Measurement

Build Status Apache 2.0 License PyPI version DOI

News and Updates:

  • Two projects accepted for BenchExec as part of Google Summer of Code! We are happy that Haoran Yang and Eshaan Aggarwal will work to improve BenchExec (click on their names for more information about their projects) and are thankful to them and to Google for providing the opportunity.
  • BenchExec 3.18 brings support for systems with cgroups v2!
  • Linux kernel 5.11 finally makes it possible to use all BenchExec features on distributions other than Ubuntu!
  • We now provide an Ubuntu PPA that makes installing and upgrading BenchExec easier (docs).
  • 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 online. We also provide a set of overview slides.

To help new or inexperienced users get started with reliable benchmarking right away, we offer a quickstart guide that contains a brief explanation of the issues of common setups as well as the (few) steps necessary to setup and use BenchExec instead.

BenchExec is a framework for reliable benchmarking and resource measurement and provides a standalone solution for benchmarking that takes care of important low-level details for accurate, precise, and reproducible measurements as well as result handling and analysis for large sets of benchmark runs. However, even users of other benchmarking frameworks or scripts can benefit from BenchExec by letting it perform the resource measurements and limits instead of less reliable tools and techniques like time or ulimit, and results produced by BenchExec can easily be exported for use with other tools.

In particular, 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
    (provided by runexec, a replacement for time and similar tools)
  • an easy way to define benchmarks with specific tool configurations and resource limits, and automatically executing them on large sets of input files
    (provided by benchexec on top of runexec)
  • generation of interactive tables and plots for the results
    (provided by table-generator for results produced with benchexec)

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 of the Linux kernel to correctly handle groups of processes. For proper isolation of the benchmarks, it uses (if available) Linux user namespaces and an overlay filesystem to create a container that restricts interference of the executed tool with the benchmarking host. More information on why this is necessary and the problems with other tools can be found in our paper Reliable Benchmarking: Requirements and Solutions (open access) and our slides (starting with slide "Checklist").

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 optionally 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).

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 and is now developed as an independent project at the Software Systems Lab of the Ludwig-Maximilians-Universität München (LMU Munich).

Links

Literature

License and Copyright

BenchExec is licensed under the Apache 2.0 License, copyright Dirk 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).

Authors

Maintainer: Philipp Wendler

Contributors:

Users of BenchExec

BenchExec was successfully used for benchmarking in all instances of the international competitions on Software Verification and Software Testing with a wide variety of benchmarked tools and hundreds of thousands benchmark runs. It is integrated into the cluster-based logic-solving service StarExec (GitHub).

The developers of the following tools use BenchExec:

If you would like to be listed here, contact us.