Compute differential coverage for fuzzer runs.
Project description
Differential Coverage
Absolute coverage numbers aren't painting the whole picture: Different fuzzers may reach the same total coverage, but cover different parts of the program. Or, fuzzer (A) may reach more coverage than fuzzer (B), but (B) may reach coverage that (A) doesn't reach — so it's still valuable.
Definition
There are different ways of measuring differential coverage:
- Leonelli et al. introduced
relcovin their paper on TwinFuzz1. It allows comparing the relative performance of one fuzzer against another and provides values $0\leq x\leq 1$. - Alternatively,
relscorewas proposed in the SBFT’25 Competition Report2 by Crump et al. It provides a total ordering of a list of fuzzers.
relcov
relcov was defined as the following1:
$$ \text{upper}(f)=\bigcup\text{cov}(t)\quad\forall t\in \text{trials}(f)\ $$
$$ \text{lower}(f)=\bigcap\text{cov}(t)\quad\forall t\in \text{trials}(f)\ $$
$$ \text{relcov}(c,f)=\frac{\left|c\cap\text{upper}(f)\right|}{\left|\text{upper}(f)\right|} $$
This can be used in various ways, such as:
Reliability of a Fuzzer
The reliability of a fuzzer $f$ is its ability to always reach its full potential across a set of trials of $f$ $T_f$. It is calculated as the median of the relcov values between each trial $t$ and the union of all reached coverage. Or, in a formula:
$$ \text{reliability}(f)=\text{med}({\text{relcov}(\text{cov}(t),f)})\quad\forall t\in T_f $$
Performance over Input Corpus
The performance of a fuzzer $f$ over its input corpus is how much extra coverage it can reach past what is already reached in the input corpus. It is calculated as relcov of the coverage of the input corpus $c_\text{input-corpus}$ and the fuzzer. As a formula:
$$ \text{performance-over-input-corpus}(f)=\text{relcov}(c_\text{input-corpus},f) $$
Performance over other fuzzers
The relative performance of a fuzzer $f_1$ relative to another fuzzer $f_2$ (or another configuration of the same fuzzer, or the same fuzzer with the same configuration but a different input corpus, or whatever else you want to test against) is how much extra coverage can be reached by $f_1$ over $f_2$. It is calculated as the median of the relcov values between each trial $t$ from a set of trials $T_{f_1}$ of $f_1$ against the union of all coverage reached by $f_2$ across different trials. Or, in a formula:
$$ \text{performance-over-fuzzer}(f_1, f_2)=\text{med}({\text{relcov}(\text{cov}(t),f_2)})\quad\forall t\in T_{f_1} $$
relscore
relscore was defined as the following2:
$$ relscore(f,b,s,e) = \left|f_0\in F|e\notin \text{cov}(b,t,s)\forall t\in \text{trials}(f_0,b)\right| \times\frac {\left|{t\in \text{trials}(f,b)\ |\ e \in \text{cov}(b,t,s)}\right|} {\left|{t\in \text{trials}(f,b)\ |\ \text{cov}(b,t,s)\neq \emptyset}\right|} $$
The score of a fuzzer is then
$$ \text{score}(f,b,s)=\sum_{e\in E}\text{relscore}(f,b,s,e) $$
This can be simplified to the following:
$$ \text{differential coverage}(f,e) = \text{number of fuzzers that never hit }e \times\frac {\text{number of trials of }f\text{ that hit }e} {\text{number of trials of }f\text{ with non-empty cov}} $$
$$ \text{score}(f) = \text{sum of differential coverage}(f,e)\text{ over all edges e} $$
Usage
Disclaimer: This is subject to change.
Assume <campaign_dir> is a directory of subdirectories for each fuzzer, where each fuzzer subdirectory contains coverage files for each trial. Currently, the output format of afl-showmap is supported (lines with edge_id:count, where we only care if count > 0).
PRs for other data formats welcome :)
Command Line Interface
All commands take the same campaign directory layout: one subdirectory per fuzzer, each with afl-showmap coverage files. Use -o csv for machine-readable output.
differential-coverage --help
usage: differential-coverage [-h] [-x FUZZER] [--output FORMAT] command ...
Compute differential coverage relscore and relcov-based measures from afl-showmap coverage. All commands take one campaign directory: one subdir per fuzzer, each with coverage files.
options:
-h, --help show this help message and exit
-x, --exclude-fuzzer FUZZER
Exclude a fuzzer (subdirectory name) from the analysis. Can be specified multiple times.
--output, -o FORMAT Output format: csv for CSV (default: print to stdout).
subcommands:
command
relscore Compute relscore (SBFT'25) from a campaign directory containing one subdirectory per fuzzer with afl-showmap files.
relcov-reliability Compute relcov-based reliability for each fuzzer.
relcov-performance-fuzzer
Compute relcov-based performance of each fuzzer relative to reference fuzzers. By default prints a table (all fuzzers × all fuzzers as reference). Use --single to get scores for one reference only.
relcov-performance-corpus
Compute relcov-based performance of each fuzzer relative to input corpora. By default prints a table (all fuzzers × all single-trial corpus fuzzers). Use --single to get scores for one corpus only.
API
Load a campaign from disk and run the same computations programmatically. The API lives in differential_coverage.api:
from pathlib import Path
from differential_coverage.api import (
read_campaign,
run_relscore,
run_relcov_reliability,
run_relcov_performance_fuzzer,
run_relcov_performance_fuzzer_all,
run_relcov_performance_corpus,
run_relcov_performance_corpus_all,
)
path = Path("path/to/campaign_dir")
campaign = read_campaign(path) # dict[fuzzer_name, dict[trial_id, dict[edge_id, count]]]
# Relscore (SBFT'25): fuzzer -> score
scores = run_relscore(campaign)
# Relcov reliability: fuzzer -> value in [0, 1]
reliability = run_relcov_reliability(campaign)
# Relcov performance vs a reference fuzzer (reference excluded from result)
perf = run_relcov_performance_fuzzer(campaign, against="fuzzer_c")
# Relcov performance vs every fuzzer as reference: (ref_fuzzers, table[row][col])
ref_fuzzers, table = run_relcov_performance_fuzzer_all(campaign)
# Relcov performance over input corpus (corpus fuzzer must have exactly one trial)
perf_corpus = run_relcov_performance_corpus(campaign, input_corpus_fuzzer="seeds")
# Relcov performance over every single-trial corpus: (corpus_fuzzers, table[row][col])
corpus_fuzzers, corpus_table = run_relcov_performance_corpus_all(campaign)
All run_* functions take a campaign (in-memory map: fuzzer name → trial id → edge id → count). Use read_campaign(path) to build it from a directory. The single-reference functions return dict[str, float] (fuzzer name → value). The *_all functions return (list_of_refs, table) where table[row_fuzzer][ref_fuzzer] is the score (1.0 on the diagonal). run_relcov_performance_fuzzer and run_relcov_performance_corpus raise ValueError if the reference or input-corpus fuzzer is missing or (for corpus) has more than one trial.
Installation
pip install .
Development
Install dev dependencies and set up the pre-commit hook (runs a couple of checks before committing):
pip install -e ".[dev]"
pre-commit install
-
TWINFUZZ: Differential Testing of Video Hardware Acceleration Stacks, https://www.ndss-symposium.org/ndss-paper/twinfuzz-differential-testing-of-video-hardware-acceleration-stacks/ ↩ ↩2
-
SBFT’25 Competition Report — Fuzzing Track, https://ieeexplore.ieee.org/document/11086561 ↩ ↩2
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file differential_coverage-0.2.4.tar.gz.
File metadata
- Download URL: differential_coverage-0.2.4.tar.gz
- Upload date:
- Size: 15.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7754f03256564d8e1310de34f60b98621f19d97fe1e4a396708b4b8cf98d691c
|
|
| MD5 |
d11bfc87b8149bfa31e54a48f357290c
|
|
| BLAKE2b-256 |
9415ad3d9cbe9355bedf94f80e352dd1e9cb2a5b3b18ad3e190823c144a66afc
|
Provenance
The following attestation bundles were made for differential_coverage-0.2.4.tar.gz:
Publisher:
ci.yml on riesentoaster/differential-coverage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
differential_coverage-0.2.4.tar.gz -
Subject digest:
7754f03256564d8e1310de34f60b98621f19d97fe1e4a396708b4b8cf98d691c - Sigstore transparency entry: 919878579
- Sigstore integration time:
-
Permalink:
riesentoaster/differential-coverage@970f2f38cfb0137695660e407f15d779730e2587 -
Branch / Tag:
refs/tags/v0.2.4 - Owner: https://github.com/riesentoaster
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@970f2f38cfb0137695660e407f15d779730e2587 -
Trigger Event:
push
-
Statement type:
File details
Details for the file differential_coverage-0.2.4-py3-none-any.whl.
File metadata
- Download URL: differential_coverage-0.2.4-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c30a8fcd95aaa063c51f1034c5d71c42d45d9c5d2c645660ab00905970d8795
|
|
| MD5 |
a1af203659466f7e2ea7ec2d641bc246
|
|
| BLAKE2b-256 |
e0d0a331cc3335249dbe163e559f7700c207608a7e988ada0c253a6b32dd088b
|
Provenance
The following attestation bundles were made for differential_coverage-0.2.4-py3-none-any.whl:
Publisher:
ci.yml on riesentoaster/differential-coverage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
differential_coverage-0.2.4-py3-none-any.whl -
Subject digest:
4c30a8fcd95aaa063c51f1034c5d71c42d45d9c5d2c645660ab00905970d8795 - Sigstore transparency entry: 919878599
- Sigstore integration time:
-
Permalink:
riesentoaster/differential-coverage@970f2f38cfb0137695660e407f15d779730e2587 -
Branch / Tag:
refs/tags/v0.2.4 - Owner: https://github.com/riesentoaster
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@970f2f38cfb0137695660e407f15d779730e2587 -
Trigger Event:
push
-
Statement type: