Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Goblint benchmarking best practices #1160

Merged
merged 3 commits into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Documentation can be browsed on [Read the Docs](https://goblint.readthedocs.io/e

## Installing
Both for using an up-to-date version of Goblint or developing it, the best way is to install from source by cloning this repository.
For benchmarking Goblint, please follow the [Benchmarking guide on Read the Docs](https://goblint.readthedocs.io/en/latest/user-guide/benchmarking/).

### Linux
1. Install [opam](https://opam.ocaml.org/doc/Install.html).
Expand Down
27 changes: 26 additions & 1 deletion docs/user-guide/benchmarking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
# Benchmarking
The following best practices should be followed when benchmarking Goblint.
This is to ensure valid, reproducible and representative benchmarking results.

To achieve reproducible builds and the best performance for benchmarking, it is recommended to compile Goblint using the `release` option:
# External benchmarking
External users should choose the version of Goblint to evaluate or benchmark as follows:

1. Use the newest version release.

The version from git `master` branch or any other intermediate git commit come without any guarantees.
They are bleeding-edge and haven't gone through validation like the version releases.

SV-COMP releases are highly preferable since they've gone through rigorous validation in SV-COMP.

2. Download the corresponding version from a Zenodo artifact or by checking out the respective git tag. **Do not install directly from opam repository!**

Goblint pins optimized versions of some dependencies which cannot be done on the opam repository releases.
Thus, using the latter would yield unrepresentative results.

Zenodo artifacts come with DOIs, which make them ideal for citation.

3. Use OCaml 4.14. **Do not use OCaml 5!**

OCaml 5 has significant performance regressions, which yield unrepresentative benchmarking results.
Goblint's `make setup` installs the correct OCaml version into a new opam switch.

# Release build
To achieve the best performance for benchmarking, Goblint should be compiled using the `release` option:

```sh
make release
Expand Down