Google Git
Sign in
android / platform / external / rust / crates / crc32fast / 73fdf1d3cd028027565e6b7d0e7294aae9afa2fa
commit73fdf1d3cd028027565e6b7d0e7294aae9afa2fa[log] [tgz]
authorYi Kong <yikong@google.com>Fri Feb 26 22:20:50 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Feb 26 22:20:50 2021 +0000
treeba244353cf43036e252ff3b150c03049b09c8229
parent8f45fd47442d95a14a8694054b5060c816c87e11 [diff]
parentf77f0ec2bc391138ece17f007a52baee80134795 [diff]
Import crc32fast-1.2.1 am: 9f04d26dc4 am: 43aced41b9 am: 467ec3265a am: f77f0ec2bc

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/crc32fast/+/1587991

MUST ONLY BE SUBMITTED BY AUTOMERGER

Change-Id: Icf29c8fefa21552cebd5a3c9263ae93a27cde592
tree: ba244353cf43036e252ff3b150c03049b09c8229
  1. benches/
  2. src/
  3. LICENSE ⇨ LICENSE-APACHE
  4. .cargo_vcs_info.json
  5. .gitignore
  6. .travis.yml
  7. Android.bp
  8. build.rs
  9. Cargo.toml
  10. Cargo.toml.orig
  11. LICENSE-APACHE
  12. LICENSE-MIT
  13. METADATA
  14. MODULE_LICENSE_APACHE2
  15. OWNERS
  16. README.md
README.md

crc32fast Build Status Crates.io Documentation

Fast, SIMD-accelerated CRC32 (IEEE) checksum computation

Usage

extern crate crc32fast;

use crc32fast::Hasher;

let mut hasher = Hasher::new();
hasher.update(b"foo bar baz");
let checksum = hasher.finalize();

Performance

This crate contains multiple CRC32 implementations:

  • A fast baseline implementation which processes up to 16 bytes per iteration
  • An optimized implementation for modern x86 using sse and pclmulqdq instructions
  • An optimized implementation for aarch64 using crc32 instructions

Calling the Hasher::new constructor at runtime will perform a feature detection to select the most optimal implementation for the current CPU feature set.

crateversionvariantns/iterMB/s
crc1.8.1n/a4,926207
crc32fast (this crate)1.0.0baseline6831499
crc32fast (this crate)1.0.0pclmulqdq1407314

Memory Safety

Due to the use of SIMD intrinsics for the optimized implementations, this crate contains some amount of unsafe code.

In order to ensure memory safety, the relevant code has been fuzz tested using afl.rs with millions of iterations in both debug and release build settings. You can inspect the test setup in the fuzz sub-directory, which also has instructions on how to run the tests yourself.

On top of that, every commit is tested using an address sanitizer in CI to catch any out of bounds memory accesses.

Even though neither fuzzing nor sanitization has revealed any safety bugs yet, please don't hesitate to file an issue if you run into any crashes or other unexpected behaviour.

Available feature flags

std (default: enabled)

This library supports being built without the Rust std library, which is useful for low-level use-cases such as embedded where no operating system is available. To build the crate in a no_std context, disable the default std feature.

Note: Because runtime CPU feature detection requires OS support, the specialized SIMD implementations will be unavailable when the std feature is disabled.

nightly (default: disabled)

This feature flag enables unstable features that are only available on the nightly channel. Keep in mind that when enabling this feature flag, you might experience breaking changes when updating compiler versions.

Currently, enabling this feature flag will make the optimized aarch64 implementation available.

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.