rscrypto 0.1.0

Rust crypto with zero default deps: BLAKE3, Ed25519/X25519, hashes, MACs, KDFs, AEADs, and checksums with SIMD/ASM acceleration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Optional diagnostics for kernel selection.
//!
//! This module is behind `cfg(feature = "diag")` and is intended for
//! explainable/debuggable kernel selection without affecting normal builds.

use crate::platform::Arch;

/// High-level reason for a selection outcome.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum SelectionReason {
  /// Below the algorithm's hard-coded tiny-size threshold (always portable).
  BelowSmallThreshold,
  /// A forced mode was active (kernel selection bypassed normal thresholds).
  Forced,
  /// Below the portable→SIMD transition threshold.
  BelowSimdThreshold,
  /// Normal auto selection.
  Auto,
}

/// CRC-32 polynomial variant (selection diagnostics).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum Crc32Polynomial {
  Ieee,
  Castagnoli,
}

/// CRC-64 polynomial variant (selection diagnostics).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum Crc64Polynomial {
  Xz,
  Nvme,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Crc32SelectionDiag {
  pub polynomial: Crc32Polynomial,
  pub len: usize,
  pub arch: Arch,
  pub reason: SelectionReason,
  pub effective_force: crate::checksum::config::Crc32Force,
  pub policy_family: &'static str,
  pub selected_kernel: &'static str,
  pub selected_streams: u8,
  pub portable_to_hwcrc: usize,
  pub hwcrc_to_fusion: usize,
  pub fusion_to_avx512: usize,
  pub fusion_to_vpclmul: usize,
  pub min_bytes_per_lane: usize,
  pub memory_bound: bool,
  pub has_hwcrc: bool,
  pub has_fusion: bool,
  pub has_vpclmul: bool,
  pub has_avx512: bool,
  pub has_eor3: bool,
  pub has_sve2: bool,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Crc64SelectionDiag {
  pub polynomial: Crc64Polynomial,
  pub len: usize,
  pub arch: Arch,
  pub reason: SelectionReason,
  pub effective_force: crate::checksum::config::Crc64Force,
  pub policy_family: &'static str,
  pub selected_kernel: &'static str,
  pub selected_streams: u8,
  pub portable_to_clmul: usize,
  pub pclmul_to_vpclmul: usize,
  pub small_kernel_max_bytes: usize,
  pub use_4x512: bool,
  pub min_bytes_per_lane: usize,
}

/// Diagnose CRC-32 (IEEE) selection for `len`.
#[inline]
#[must_use]
pub fn crc32_ieee(len: usize) -> Crc32SelectionDiag {
  crate::checksum::crc32::diag_crc32_ieee(len)
}

/// Diagnose CRC-32C (Castagnoli) selection for `len`.
#[inline]
#[must_use]
pub fn crc32c(len: usize) -> Crc32SelectionDiag {
  crate::checksum::crc32::diag_crc32c(len)
}

/// Diagnose CRC-64/XZ selection for `len`.
#[inline]
#[must_use]
pub fn crc64_xz(len: usize) -> Crc64SelectionDiag {
  crate::checksum::crc64::diag_crc64_xz(len)
}

/// Diagnose CRC-64/NVME selection for `len`.
#[inline]
#[must_use]
pub fn crc64_nvme(len: usize) -> Crc64SelectionDiag {
  crate::checksum::crc64::diag_crc64_nvme(len)
}