adler32-1.2.0/.cargo_vcs_info.json0000644000000001121371061475400123700ustar00{ "git": { "sha1": "2ff95ca1db58c9db85ddaf59e4755e4ae94ac49d" } } adler32-1.2.0/.github/workflows/test.yml010064400017500001750000000037311371061211100162630ustar0000000000000000name: Test on: - push - pull_request jobs: build: strategy: matrix: os: [ubuntu-latest] rust-version: [1.33.0, stable, nightly] mode: [native] include: - os: macos-latest rust-version: 1.33.0 mode: native - os: windows-latest rust-version: 1.33.0 mode: native - os: ubuntu-latest rust-version: stable mode: wasm runs-on: ${{ matrix.os }} env: TARGET: "" steps: - uses: actions/checkout@v2 - name: Set up Rust ${{ matrix.rust-version }} uses: actions-rs/toolchain@v1 id: rustup with: toolchain: ${{ matrix.rust-version }} override: true - name: Cache wasm binaries if: matrix.mode == 'wasm' uses: actions/cache@v2 id: wasm-binaries with: path: | ~/.cargo/bin ~/.cargo/.crates.toml ~/.cargo/.crates2.json key: rust-${{ steps.rustup.outputs.rustc_hash }}-bindgen-0.2.63-pack-0.9.1 - name: Set up wasm if: matrix.mode == 'wasm' run: | rustup target add wasm32-unknown-unknown echo "::set-env name=TARGET::--target wasm32-unknown-unknown" cargo install --version 0.2.63 wasm-bindgen-cli cargo install --version 0.9.1 wasm-pack - name: Build run: cargo build --verbose $TARGET - name: Disable benchmarking dependencies if: matrix.mode != 'native' || matrix.rust-version != 'stable' run: "mv Cargo.toml Cargo.toml.bak && sed '/ # benchmark only$/d' Cargo.toml.bak > Cargo.toml" - name: Run tests if: matrix.mode == 'native' run: cargo test --verbose - name: Test benchmarks if: matrix.mode == 'native' && matrix.rust-version == 'stable' run: cargo test --benches --verbose - name: Run wasm tests if: matrix.mode == 'wasm' run: wasm-pack test --node - name: Build doc if: matrix.mode == 'native' run: cargo doc adler32-1.2.0/.gitignore010064400017500001750000000000221355641251200131550ustar0000000000000000target Cargo.lock adler32-1.2.0/Cargo.toml0000644000000030671371061475400104020ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] edition = "2018" name = "adler32" version = "1.2.0" authors = ["Remi Rampin "] description = "Minimal Adler32 implementation for Rust." documentation = "https://docs.rs/adler32/" readme = "README.md" keywords = ["adler32", "hash", "rolling"] license = "Zlib" repository = "https://github.com/remram44/adler32-rs" [lib] bench = false [[bench]] name = "bench" path = "src/bench.rs" harness = false [dependencies.compiler_builtins] version = "0.1.2" optional = true [dependencies.core] version = "1.0.0" optional = true package = "rustc-std-workspace-core" [dev-dependencies.criterion] version = "0.3" [dev-dependencies.getrandom] version = "0.1" features = ["wasm-bindgen"] [dev-dependencies.humansize] version = "1.1" [dev-dependencies.rand] version = "0.7" [features] default = ["std"] rustc-dep-of-std = ["core", "compiler_builtins"] std = [] [target."cfg(target_arch = \"wasm32\")".dev-dependencies.wasm-bindgen] version = "0.2.63" [target."cfg(target_arch = \"wasm32\")".dev-dependencies.wasm-bindgen-test] version = "0.3" adler32-1.2.0/Cargo.toml.orig010064400017500001750000000030121371061227400140550ustar0000000000000000[package] name = "adler32" version = "1.2.0" authors = ["Remi Rampin "] edition = "2018" description = "Minimal Adler32 implementation for Rust." documentation = "https://docs.rs/adler32/" repository = "https://github.com/remram44/adler32-rs" readme = "README.md" keywords = ["adler32", "hash", "rolling"] license = "Zlib" [dependencies] # Internal features, only used when building as part of libstd, not part of the # stable interface of this crate. core = { version = '1.0.0', optional = true, package = 'rustc-std-workspace-core' } compiler_builtins = { version = '0.1.2', optional = true } [features] default = ['std'] std = [] # Internal feature, only used when building as part of libstd, not part of the # stable interface of this crate. rustc-dep-of-std = ['core', 'compiler_builtins'] [dev-dependencies] # The lines marked 'benchmark only' get removed on CI for platforms/versions # where we don't run the benchmarks (e.g. versions not supported by criterion) criterion = "0.3" # benchmark only humansize = "1.1" # benchmark only rand = "0.7" getrandom = { version = "0.1", features = ["wasm-bindgen"] } [target.'cfg(target_arch = "wasm32")'.dev-dependencies] wasm-bindgen = "0.2.63" wasm-bindgen-test = "0.3" [[bench]] path = "src/bench.rs" name = "bench" harness = false [lib] # Disable `libtest` so Criterion-only parameters like `--save-baseline` work. # See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options bench = false adler32-1.2.0/LICENSE010064400017500001750000000036771371061171200122100ustar0000000000000000Copyright notice for the Rust port: (C) 2016 Remi Rampin and adler32-rs contributors This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Copyright notice for the original C code from the zlib project: (C) 1995-2017 Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly Mark Adler jloup@gzip.org madler@alumni.caltech.edu adler32-1.2.0/README.md010064400017500001750000000022071367417160500124610ustar0000000000000000[![Build Status](https://github.com/remram44/adler32-rs/workflows/Test/badge.svg)](https://github.com/remram44/adler32-rs/actions) [![Win Build](https://ci.appveyor.com/api/projects/status/ekyg20rd6rwrus64/branch/master?svg=true)](https://ci.appveyor.com/project/remram44/adler32-rs) [![Crates.io](https://img.shields.io/crates/v/adler32.svg)](https://crates.io/crates/adler32) [![Documentation](https://docs.rs/adler32/badge.svg)](https://docs.rs/adler32) [![License](https://img.shields.io/crates/l/adler32.svg)](https://github.com/remram44/adler32-rs/blob/master/LICENSE) What is this? ============= It is an implementation of the [Adler32 rolling hash algorithm](https://en.wikipedia.org/wiki/Adler-32) in the [Rust programming language](https://www.rust-lang.org/). It is adapted from Jean-Loup Gailly's and Mark Adler's [original implementation in zlib](https://github.com/madler/zlib/blob/2fa463bacfff79181df1a5270fb67cc679a53e71/adler32.c). #### Minimum Supported Version of Rust (MSRV) `adler32-rs` can be built with Rust version 1.33 or later. This version may be raised in the future but that will be accompanied by a minor version increase. adler32-1.2.0/src/bench.rs010064400017500001750000000017451370337725500134260ustar0000000000000000use adler32::RollingAdler32; use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion, Throughput}; use humansize::{file_size_opts, FileSize}; use rand::Rng; fn bench_update_buffer(c: &mut Criterion) { let mut rng = rand::thread_rng(); let mut group = c.benchmark_group("update_buffer"); for &size in [512, 100 * 1024].iter() { let mut adler = RollingAdler32::new(); let formatted_size = size.file_size(file_size_opts::BINARY).unwrap(); let in_bytes = { let mut in_bytes = vec![0u8; size]; rng.fill(&mut in_bytes[..]); in_bytes }; group.throughput(Throughput::Bytes(size as u64)); group.bench_with_input( BenchmarkId::from_parameter(formatted_size), &in_bytes, |b, data| { b.iter(|| adler.update_buffer(data)); }, ); } } criterion_group!(bench_default, bench_update_buffer); criterion_main!(bench_default); adler32-1.2.0/src/lib.rs010064400017500001750000000234401370341226100130740ustar0000000000000000//! A minimal implementation of Adler32 for Rust. //! //! This provides the simple method adler32(), that exhausts a Read and //! computes the Adler32 hash, as well as the RollingAdler32 struct, that can //! build a hash byte-by-byte, allowing to 'forget' past bytes in a rolling //! fashion. //! //! The adler32 code has been translated (as accurately as I could manage) from //! the zlib implementation. #![forbid(unsafe_code)] #![cfg_attr(not(feature = "std"), no_std)] // adler32 algorithm and implementation taken from zlib; http://www.zlib.net/ // It was translated into Rust as accurately as I could manage // The (slow) reference was taken from Wikipedia; https://en.wikipedia.org/ /* zlib.h -- interface of the 'zlib' general purpose compression library version 1.2.8, April 28th, 2013 Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly Mark Adler jloup@gzip.org madler@alumni.caltech.edu */ // largest prime smaller than 65536 const BASE: u32 = 65521; // NMAX is the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1 const NMAX: usize = 5552; #[inline(always)] fn do1(adler: &mut u32, sum2: &mut u32, buf: &[u8]) { *adler += u32::from(buf[0]); *sum2 += *adler; } #[inline(always)] fn do2(adler: &mut u32, sum2: &mut u32, buf: &[u8]) { do1(adler, sum2, &buf[0..1]); do1(adler, sum2, &buf[1..2]); } #[inline(always)] fn do4(adler: &mut u32, sum2: &mut u32, buf: &[u8]) { do2(adler, sum2, &buf[0..2]); do2(adler, sum2, &buf[2..4]); } #[inline(always)] fn do8(adler: &mut u32, sum2: &mut u32, buf: &[u8]) { do4(adler, sum2, &buf[0..4]); do4(adler, sum2, &buf[4..8]); } #[inline(always)] fn do16(adler: &mut u32, sum2: &mut u32, buf: &[u8]) { do8(adler, sum2, &buf[0..8]); do8(adler, sum2, &buf[8..16]); } /// A rolling version of the Adler32 hash, which can 'forget' past bytes. /// /// Calling remove() will update the hash to the value it would have if that /// past byte had never been fed to the algorithm. This allows you to get the /// hash of a rolling window very efficiently. #[derive(Clone)] pub struct RollingAdler32 { a: u32, b: u32, } impl Default for RollingAdler32 { fn default() -> RollingAdler32 { RollingAdler32::new() } } impl RollingAdler32 { /// Creates an empty Adler32 context (with hash 1). pub fn new() -> RollingAdler32 { Self::from_value(1) } /// Creates an Adler32 context with the given initial value. pub fn from_value(adler32: u32) -> RollingAdler32 { let a = adler32 & 0xFFFF; let b = adler32 >> 16; RollingAdler32 { a, b } } /// Convenience function initializing a context from the hash of a buffer. pub fn from_buffer(buffer: &[u8]) -> RollingAdler32 { let mut hash = RollingAdler32::new(); hash.update_buffer(buffer); hash } /// Returns the current hash. pub fn hash(&self) -> u32 { (self.b << 16) | self.a } /// Removes the given `byte` that was fed to the algorithm `size` bytes ago. pub fn remove(&mut self, size: usize, byte: u8) { let byte = u32::from(byte); self.a = (self.a + BASE - byte) % BASE; self.b = ((self.b + BASE - 1) .wrapping_add(BASE.wrapping_sub(size as u32).wrapping_mul(byte))) % BASE; } /// Feeds a new `byte` to the algorithm to update the hash. pub fn update(&mut self, byte: u8) { let byte = u32::from(byte); self.a = (self.a + byte) % BASE; self.b = (self.b + self.a) % BASE; } /// Feeds a vector of bytes to the algorithm to update the hash. pub fn update_buffer(&mut self, buffer: &[u8]) { let len = buffer.len(); // in case user likes doing a byte at a time, keep it fast if len == 1 { self.update(buffer[0]); return; } // in case short lengths are provided, keep it somewhat fast if len < 16 { for byte in buffer.iter().take(len) { self.a += u32::from(*byte); self.b += self.a; } if self.a >= BASE { self.a -= BASE; } self.b %= BASE; return; } let mut pos = 0; // do length NMAX blocks -- requires just one modulo operation; while pos + NMAX <= len { let end = pos + NMAX; while pos < end { // 16 sums unrolled do16(&mut self.a, &mut self.b, &buffer[pos..pos + 16]); pos += 16; } self.a %= BASE; self.b %= BASE; } // do remaining bytes (less than NMAX, still just one modulo) if pos < len { // avoid modulos if none remaining while len - pos >= 16 { do16(&mut self.a, &mut self.b, &buffer[pos..pos + 16]); pos += 16; } while len - pos > 0 { self.a += u32::from(buffer[pos]); self.b += self.a; pos += 1; } self.a %= BASE; self.b %= BASE; } } } /// Consume a Read object and returns the Adler32 hash. #[cfg(feature = "std")] pub fn adler32(mut reader: R) -> std::io::Result { let mut hash = RollingAdler32::new(); let mut buffer = [0u8; NMAX]; let mut read = reader.read(&mut buffer)?; while read > 0 { hash.update_buffer(&buffer[..read]); read = reader.read(&mut buffer)?; } Ok(hash.hash()) } #[cfg(test)] mod test { use rand::Rng; use std::io; #[cfg(target_arch = "wasm32")] use wasm_bindgen_test::wasm_bindgen_test; use super::{adler32, RollingAdler32, BASE}; fn adler32_slow(reader: R) -> io::Result { let mut a: u32 = 1; let mut b: u32 = 0; for byte in reader.bytes() { let byte = byte? as u32; a = (a + byte) % BASE; b = (b + a) % BASE; } Ok((b << 16) | a) } #[test] #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)] fn testvectors() { fn do_test(v: u32, bytes: &[u8]) { let mut hash = RollingAdler32::new(); hash.update_buffer(&bytes); assert_eq!(hash.hash(), v); let r = io::Cursor::new(bytes); assert_eq!(adler32(r).unwrap(), v); } do_test(0x00000001, b""); do_test(0x00620062, b"a"); do_test(0x024d0127, b"abc"); do_test(0x29750586, b"message digest"); do_test(0x90860b20, b"abcdefghijklmnopqrstuvwxyz"); do_test( 0x8adb150c, b"ABCDEFGHIJKLMNOPQRSTUVWXYZ\ abcdefghijklmnopqrstuvwxyz\ 0123456789", ); do_test( 0x97b61069, b"1234567890123456789012345678901234567890\ 1234567890123456789012345678901234567890", ); do_test(0xD6251498, &[255; 64000]); } #[test] #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)] fn compare() { let mut rng = rand::thread_rng(); let mut data = vec![0u8; 5589]; for size in [ 0, 1, 3, 4, 5, 31, 32, 33, 67, 5550, 5552, 5553, 5568, 5584, 5589, ] .iter() .cloned() { rng.fill(&mut data[..size]); let r1 = io::Cursor::new(&data[..size]); let r2 = r1.clone(); if adler32_slow(r1).unwrap() != adler32(r2).unwrap() { panic!("Comparison failed, size={}", size); } } } #[test] #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)] fn rolling() { assert_eq!(RollingAdler32::from_value(0x01020304).hash(), 0x01020304); fn do_test(a: &[u8], b: &[u8]) { let mut total = Vec::with_capacity(a.len() + b.len()); total.extend(a); total.extend(b); let mut h = RollingAdler32::from_buffer(&total[..(b.len())]); for i in 0..(a.len()) { h.remove(b.len(), a[i]); h.update(total[b.len() + i]); } assert_eq!(h.hash(), adler32(b).unwrap()); } do_test(b"a", b"b"); do_test(b"", b"this a test"); do_test(b"th", b"is a test"); do_test(b"this a ", b"test"); } #[test] #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)] fn long_window_remove() { let mut hash = RollingAdler32::new(); let w = 65536; assert!(w as u32 > BASE); let mut bytes = vec![0; w * 3]; for (i, b) in bytes.iter_mut().enumerate() { *b = i as u8; } for (i, b) in bytes.iter().enumerate() { if i >= w { hash.remove(w, bytes[i - w]); } hash.update(*b); if i > 0 && i % w == 0 { assert_eq!(hash.hash(), 0x433a8772); } } assert_eq!(hash.hash(), 0xbbba8772); } }