Merge pull request #68 from RustCrypto/chacha20poly1305/benchmark-fixups

chacha20poly1305: benchmark fixups
RustCrypto · Jan 16, 2020 · 82340e5 · 82340e5
2 parents a1e3dfd + 9c60197
commit 82340e5
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/chacha20poly1305/Cargo.toml b/chacha20poly1305/Cargo.toml
@@ -35,7 +35,7 @@ heapless = ["aead/heapless"]
 xchacha20poly1305 = ["chacha20/xchacha20"]
 
 [[bench]]
-name = "aes-gcm"
+name = "chacha20poly1305"
 harness = false
 
 [package.metadata.docs.rs]

diff --git a/chacha20poly1305/benches/aes-gcm.rs → chacha20poly1305/benches/chacha20poly1305.rs b/chacha20poly1305/benches/aes-gcm.rs → chacha20poly1305/benches/chacha20poly1305.rs
diff --git a/chacha20poly1305/src/lib.rs b/chacha20poly1305/src/lib.rs
@@ -6,6 +6,24 @@
 //! This crate also contains an implementation of [`XChaCha20Poly1305`] -
 //! a variant of ChaCha20Poly1305 with an extended 192-bit (24-byte) nonce.
 //!
+//! ## Performance Notes
+//!
+//! By default this crate will use portable software implementations of the
+//! underlying ChaCha20 and Poly1305 ciphers it's based on.
+//!
+//! When targeting modern x86/x86_64 CPUs, use the following `RUSTFLAGS` to
+//! take advantage of AVX2 acceleration:
+//!
+//! ```text
+//! RUSTFLAGS="-Ctarget-feature=+avx2"
+//! ```
+//!
+//! Ideally target the `haswell` or `skylake` architectures as a baseline:
+//!
+//! ```text
+//! RUSTFLAGS="-Ctarget-cpu=haswell -Ctarget-feature=+avx2"
+//! ```
+//!
 //! ## Security Warning
 //!
 //! No security audits of this crate have ever been performed, and it has not been