Add: Benchmarking suite

Author: mberry

Cargo.toml

@@ -17,6 +17,13 @@ rand = "0.8.5"
 [dev-dependencies]
 pqc_core = {version = "0.1.0", features = ["load"]}
 
+[target.'cfg(bench)'.dev-dependencies.criterion]
+criterion = "0.4.0"
+
+[[bench]]
+name = "api"
+harness = false
+
 [features]
 # By default this library uses mode3, also called Dilithium3
 mode2 = []

README.md

@@ -88,7 +88,7 @@ By default this library uses Dilithium3
 
 ## Testing 
 
-To run the known answer tests, you'll need to enable the `dilithium_kat` config flag eg.
+To run the known answer tests, you'll need to enable the `dilithium_kat` in `RUSTFLAGS` eg.
 
 ```shell
 RUSTFLAGS="--cfg dilithium_kat" cargo test
@@ -98,6 +98,17 @@ To run through all possible features use the [`test_matrix.sh`](./tests/test_mat
 
 ---
 
+# Benchmarking
+
+This library uses the criterion benchmarking suite. To use you must enable
+`bench` eg.
+
+```shell
+RUSTFLAGS="--cfg bench" cargo bench
+```
+
+---
+
 ## Alternatives
 
 The PQClean project has rust bindings for their C post quantum libraries. 

benches/README.md

@@ -0,0 +1,8 @@
+# Benchmarking
+
+This library uses the criterion benchmarking suite. To use you must enable
+`bench` in `RUSTFLAGS` eg.
+
+```shell
+RUSTFLAGS="--cfg bench" cargo bench
+```

benches/api.rs

@@ -0,0 +1,24 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use pqc_dilithium::*;
+
+fn sign_small_msg(c: &mut Criterion)
+{
+  let keys = Keypair::generate();
+  let msg = "Hello".as_bytes();
+  c.bench_function("Sign Small Message", |b| {
+    b.iter(|| keys.sign(black_box(msg)))
+  });
+}
+
+fn verify_small_msg(c: &mut Criterion)
+{
+  let keys = Keypair::generate();
+  let msg = "Hello".as_bytes();
+  let sig = keys.sign(msg);
+  c.bench_function("Verify Small Message", |b| {
+    b.iter(|| verify(black_box(sig), black_box(msg), black_box(&keys.public)))
+  });
+}
+
+criterion_group!(benches, sign_small_msg, verify_small_msg);
+criterion_main!(benches);