From 87bc514ff08c22e22bc9868948bd0abb223fb624 Mon Sep 17 00:00:00 2001 From: widberg Date: Fri, 20 Oct 2023 15:18:44 -0400 Subject: [PATCH] Add BlackSheep CRC-32 aka IEEE 802.3 Finally, someone used a standard --- bff-cli/src/crc.rs | 45 ++++++++++++----------- bff-cli/src/main.rs | 5 ++- bff-derive/src/named_class.rs | 5 +++ bff/src/crc/blacksheep32.rs | 68 +++++++++++++++++++++++++++++++++++ bff/src/crc/kalisto32.rs | 5 +-- bff/src/crc/mod.rs | 2 ++ bff/src/macros/classes.rs | 1 + bff/src/names.rs | 10 +++++- 8 files changed, 112 insertions(+), 29 deletions(-) create mode 100644 bff/src/crc/blacksheep32.rs diff --git a/bff-cli/src/crc.rs b/bff-cli/src/crc.rs index 20026b1..6e89757 100644 --- a/bff-cli/src/crc.rs +++ b/bff-cli/src/crc.rs @@ -1,6 +1,6 @@ use std::io::{self, BufRead, Read}; -use bff::crc::{Asobo32, Asobo64, AsoboAlternate32, Kalisto32}; +use bff::crc::{Asobo32, Asobo64, AsoboAlternate32, Kalisto32, BlackSheep32}; use bff::traits::NameHashFunction; use clap::ValueEnum; @@ -14,6 +14,8 @@ pub enum CrcAlgorithm { AsoboAlternate, #[value(alias("k"))] Kalisto, + #[value(alias("bs"))] + BlackSheep, #[value(alias("a64"))] Asobo64, } @@ -62,37 +64,34 @@ fn format_hash64(hash: i64, format: &CrcFormat) -> String { fn hash( bytes: &[u8], - starting: &Option, + starting: &i64, algorithm: &CrcAlgorithm, format: &CrcFormat, ) -> String { let starting = *starting; - match starting { - None => match algorithm { - CrcAlgorithm::Asobo => format_hash(Asobo32::hash(bytes), format), - CrcAlgorithm::AsoboAlternate => format_hash(AsoboAlternate32::hash(bytes), format), - CrcAlgorithm::Kalisto => format_hash(Kalisto32::hash(bytes), format), - CrcAlgorithm::Asobo64 => format_hash64(Asobo64::hash(bytes), format), - }, - Some(starting) => match algorithm { - CrcAlgorithm::Asobo => { - format_hash(Asobo32::hash_options(bytes, starting as i32), format) - } - CrcAlgorithm::AsoboAlternate => format_hash( - AsoboAlternate32::hash_options(bytes, starting as i32), - format, - ), - CrcAlgorithm::Kalisto => { - format_hash(Kalisto32::hash_options(bytes, starting as i32), format) - } - CrcAlgorithm::Asobo64 => format_hash64(Asobo64::hash_options(bytes, starting), format), - }, + match algorithm { + CrcAlgorithm::Asobo => { + format_hash(Asobo32::hash_options(bytes, starting as i32), format) + } + CrcAlgorithm::AsoboAlternate => format_hash( + AsoboAlternate32::hash_options(bytes, starting as i32), + format, + ), + CrcAlgorithm::Kalisto => { + format_hash(Kalisto32::hash_options(bytes, starting as i32), format) + } + CrcAlgorithm::BlackSheep => { + format_hash(BlackSheep32::hash_options(bytes, starting as i32), format) + } + CrcAlgorithm::Asobo64 => { + format_hash64(Asobo64::hash_options(bytes, starting), format) + } } } pub fn crc( string: &Option, - starting: &Option, + starting: &i64, algorithm: &CrcAlgorithm, mode: &CrcMode, format: &CrcFormat, diff --git a/bff-cli/src/main.rs b/bff-cli/src/main.rs index f6038d7..0f49db3 100644 --- a/bff-cli/src/main.rs +++ b/bff-cli/src/main.rs @@ -39,11 +39,10 @@ enum Commands { RoundTrip { bigfile: PathBuf, }, - #[clap(alias = "crc32", alias = "crc64")] Crc { string: Option, - #[arg(short, long, help = "Starting value for the CRC calculation")] - starting: Option, + #[arg(short, long, default_value_t, help = "Starting value for the CRC calculation")] + starting: i64, #[clap(value_enum)] #[arg(short, long, default_value_t = CrcAlgorithm::Asobo)] algorithm: CrcAlgorithm, diff --git a/bff-derive/src/named_class.rs b/bff-derive/src/named_class.rs index 424b93d..3574b40 100644 --- a/bff-derive/src/named_class.rs +++ b/bff-derive/src/named_class.rs @@ -24,6 +24,11 @@ pub fn derive_named_class(input: DeriveInput) -> TokenStream { const NAME_LEGACY: crate::names::NameKalisto32 = crate::names::NameKalisto32::new(crate::crc::kalisto32(#class_name_legacy.as_bytes())); } + impl crate::traits::NamedClass for #name { + const NAME: crate::names::NameBlackSheep32 = crate::names::NameBlackSheep32::new(crate::crc::blacksheep32(#class_name.as_bytes())); + const NAME_LEGACY: crate::names::NameBlackSheep32 = crate::names::NameBlackSheep32::new(crate::crc::blacksheep32(#class_name_legacy.as_bytes())); + } + impl crate::traits::NamedClass for #name { const NAME: crate::names::NameAsobo64 = crate::names::NameAsobo64::new(crate::crc::asobo64(#class_name.as_bytes())); const NAME_LEGACY: crate::names::NameAsobo64 = crate::names::NameAsobo64::new(crate::crc::asobo64(#class_name_legacy.as_bytes())); diff --git a/bff/src/crc/blacksheep32.rs b/bff/src/crc/blacksheep32.rs new file mode 100644 index 0000000..5cafae2 --- /dev/null +++ b/bff/src/crc/blacksheep32.rs @@ -0,0 +1,68 @@ +use crate::traits::NameHashFunction; + +// IEEE 802.3 CRC32 Lookup Table +const CRC32_TABLE: [u32; 256] = [ + 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, + 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, + 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, + 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, + 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, + 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, + 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, + 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, + 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, + 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, + 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, + 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, + 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, + 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, + 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, + 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, + 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, + 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, + 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, + 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, + 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, + 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, + 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, + 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, + 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, + 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, + 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, + 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, + 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, + 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, + 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, + 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D, +]; + +pub const fn blacksheep32(bytes: &[u8]) -> i32 { + blacksheep32_options(bytes, 0) +} + +// IEEE 802.3 CRC32 +pub const fn blacksheep32_options(bytes: &[u8], starting: i32) -> i32 { + let mut hash = !starting as u32; + let mut i: usize = 0; + while i < bytes.len() { + let c = bytes[i]; + hash = (hash >> 8) ^ CRC32_TABLE[((c as u32 ^ hash) & 0xff) as usize]; + i += 1; + } + + !hash as i32 +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct BlackSheep32; +impl NameHashFunction for BlackSheep32 { + type Target = i32; + + fn hash(bytes: &[u8]) -> Self::Target { + blacksheep32(bytes) + } + + fn hash_options(bytes: &[u8], starting: Self::Target) -> Self::Target { + blacksheep32_options(bytes, starting) + } +} diff --git a/bff/src/crc/kalisto32.rs b/bff/src/crc/kalisto32.rs index f1fcc16..70a0da7 100644 --- a/bff/src/crc/kalisto32.rs +++ b/bff/src/crc/kalisto32.rs @@ -2,11 +2,12 @@ use super::asobo32_options; use crate::traits::NameHashFunction; pub const fn kalisto32(bytes: &[u8]) -> i32 { - kalisto32_options(bytes, -1) + kalisto32_options(bytes, 0) } pub const fn kalisto32_options(bytes: &[u8], starting: i32) -> i32 { - !asobo32_options(bytes, starting) + // Same as asobo32_options but negate the starting and result values + !asobo32_options(bytes, !starting) } #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] diff --git a/bff/src/crc/mod.rs b/bff/src/crc/mod.rs index 5157a15..b92d168 100644 --- a/bff/src/crc/mod.rs +++ b/bff/src/crc/mod.rs @@ -2,8 +2,10 @@ mod asobo32; mod asobo64; mod asobo_alternate32; mod kalisto32; +mod blacksheep32; pub use asobo32::*; pub use asobo64::*; pub use asobo_alternate32::*; pub use kalisto32::*; +pub use blacksheep32::*; diff --git a/bff/src/macros/classes.rs b/bff/src/macros/classes.rs index 7c60ec9..7cab94d 100644 --- a/bff/src/macros/classes.rs +++ b/bff/src/macros/classes.rs @@ -15,6 +15,7 @@ macro_rules! classes { $(crate::names::Name::Asobo32($class::NAME) | crate::names::Name::Asobo32($class::NAME_LEGACY) | crate::names::Name::AsoboAlternate32($class::NAME) | crate::names::Name::AsoboAlternate32($class::NAME_LEGACY) | crate::names::Name::Kalisto32($class::NAME) | crate::names::Name::Kalisto32($class::NAME_LEGACY) + | crate::names::Name::BlackSheep32($class::NAME) | crate::names::Name::BlackSheep32($class::NAME_LEGACY) | crate::names::Name::Asobo64($class::NAME) | crate::names::Name::Asobo64($class::NAME_LEGACY) => Ok(Box::new(<&crate::bigfile::resource::Resource as crate::traits::TryIntoVersionPlatform<$class>>::try_into_version_platform(object, version, platform)?).into()),)* _ => Err(crate::error::UnimplementedClassError::new(object.name, object.class_name, version, platform).into()), diff --git a/bff/src/names.rs b/bff/src/names.rs index 71b344c..3e9166a 100644 --- a/bff/src/names.rs +++ b/bff/src/names.rs @@ -11,7 +11,7 @@ use once_cell::sync::Lazy; use serde::{Deserialize, Deserializer, Serialize}; use crate::class::class_names; -use crate::crc::{Asobo32, Asobo64, AsoboAlternate32, Kalisto32}; +use crate::crc::{Asobo32, Asobo64, AsoboAlternate32, BlackSheep32, Kalisto32}; use crate::traits::NameHashFunction; use crate::BffResult; @@ -36,6 +36,7 @@ where pub type NameAsobo32 = NameVariant; pub type NameAsoboAlternate32 = NameVariant; pub type NameKalisto32 = NameVariant; +pub type NameBlackSheep32 = NameVariant; pub type NameAsobo64 = NameVariant; #[derive(From, PartialEq, Eq, Hash, Copy, Clone)] @@ -43,6 +44,7 @@ pub enum Name { Asobo32(NameAsobo32), AsoboAlternate32(NameAsoboAlternate32), Kalisto32(NameKalisto32), + BlackSheep32(NameBlackSheep32), Asobo64(NameAsobo64), } @@ -215,6 +217,7 @@ impl Display for Name { Name::Asobo32(name) => write!(f, "{}", name.0), Name::AsoboAlternate32(name) => write!(f, "{}", name.0), Name::Kalisto32(name) => write!(f, "{}", name.0), + Name::BlackSheep32(name) => write!(f, "{}", name.0), Name::Asobo64(name) => write!(f, "{}", name.0), } } @@ -230,6 +233,7 @@ impl Debug for Name { Name::Asobo32(name) => write!(f, "{}", name.0), Name::AsoboAlternate32(name) => write!(f, "{}", name.0), Name::Kalisto32(name) => write!(f, "{}", name.0), + Name::BlackSheep32(name) => write!(f, "{}", name.0), Name::Asobo64(name) => write!(f, "{}", name.0), } } @@ -250,6 +254,7 @@ impl Names { let asobo_alternate32_hash = ::hash(string.as_bytes()); let kalisto32_hash = ::hash(string.as_bytes()); + let blacksheep32_hash = ::hash(string.as_bytes()); let asobo64_hash = ::hash(string.as_bytes()); self.names @@ -261,6 +266,9 @@ impl Names { self.names .entry(NameKalisto32::new(kalisto32_hash).into()) .or_insert_with(|| string.to_string()); + self.names + .entry(NameBlackSheep32::new(blacksheep32_hash).into()) + .or_insert_with(|| string.to_string()); self.names .entry(NameAsobo64::new(asobo64_hash).into()) .or_insert_with(|| string.to_string());