crc16-genibus-fast

Crates.iocrc16-genibus-fast
lib.rscrc16-genibus-fast
version0.4.0
sourcesrc
created_at2024-10-20 22:09:34.163695
updated_at2024-11-07 23:13:27.854974
descriptionSIMD-powered implementation of CRC-16/GENIBUS (CRC-16/DARC CRC-16/EPC CRC-16/EPC-C1G2 CRC-16/I-CODE)
homepage
repositoryhttps://github.com/TobiasBengtsson/crc-fast-rs
max_upload_size
id1416685
size8,188
Tobias Bengtsson (TobiasBengtsson)

documentation

README

crc16-genibus-fast

SIMD implementation of CRC-16/GENIBUS (CRC-16/DARC CRC-16/EPC CRC-16/EPC-C1G2 CRC-16/I-CODE), with table and loop fallbacks.

This crate was generated by crc-fast-rs.

Principle of operation

TL;DR: uses SIMD if available, otherwise falls back seamlessly to a lookup table algorithm.

  • If using hash, will use SIMD if the CPU is capable
    • x86-64 CPU:s with the following CPU flags are supported (runtime detection):
      • pclmulqdq
      • sse4.1
    • aarch64 CPU:s with the following CPU flags are supported:
      • nano
      • aes
    • IMPORTANT: aarch64 does not use runtime feature detection and has to be built with a compatible target-cpu to use SIMD, unlike x86-64.
  • If using hash with an incompatible CPU the fallback algorithm will be invoked. If the table-fallback feature is active the fallback is based on a lookup table, otherwise a simple loop (slowest option). Deactivating table-fallback (default enabled) can be useful when memory is very scarce, as the lookup table requires a small amount of extra RAM.
  • If table-fallback feature is enabled, it can be manually invoked by hash_table (not recommended in the typical case).
  • Similarly, hash_simple can be used to force the loop algorithm (also not recommended in the typical case).

Usage

let res: u32 = crc16_genibus_fast::hash(&my_binary_slice);

There is no "update"-like functionality yet, since doing this with arbitrarily lengths can be tricky with SIMD and destroy performance.

Commit count: 75

cargo fmt