rscrypto 0.1.1

Pure Rust cryptography, hardware-accelerated: BLAKE3, SHA-2/3, AES-GCM, ChaCha20-Poly1305, Ed25519, X25519, HMAC, HKDF, Argon2, CRC. no_std, WASM, ten CPU architectures.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

//! Static kernel name tables and selection helpers for CRC64.
//!
//! This module centralizes all CRC64 kernel names and dispatch logic to reduce
//! code duplication across architectures. The same pattern applies to both
//! kernel name selection (for introspection) and actual dispatch.
//!
//! # Kernel Tiers
//!
//! CRC-64 supports Tiers 0, 1, 3, and 4 (no HW CRC instructions exist):
//! - Tier 0 (Reference): Bitwise implementation
//! - Tier 1 (Portable): Slice-by-16 table lookup
//! - Tier 3 (Folding): PCLMUL (x86_64), PMULL (aarch64), VPMSUM (Power), VGFM (s390x), Zbc
//!   (riscv64)
//! - Tier 4 (Wide): VPCLMUL (x86_64), PMULL+EOR3/SVE2 (aarch64), Zvbc (riscv64)
//!
//! # Design
//!
//! - Static arrays for kernel names per tier per architecture
//! - Delegates to `common::kernels` for stream-to-index mapping
//! - CRC64-specific dispatch functions generated via macro

/// Portable fallback kernel name.
pub use kernels::PORTABLE_SLICE16 as PORTABLE;
/// Reference (bitwise) kernel name - always available for force mode.
pub use kernels::REFERENCE;

use crate::checksum::common::kernels;

// ─────────────────────────────────────────────────────────────────────────────
// Kernel Name Tables (per architecture)
// ─────────────────────────────────────────────────────────────────────────────

#[cfg(target_arch = "x86_64")]
pub mod x86_64 {
  use super::super::x86_64 as arch;
  use crate::checksum::dispatchers::Crc64Fn;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-XZ Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// XZ PCLMUL kernels: [1-way, 2-way, 4-way, 7-way, 8-way]
  pub const XZ_PCLMUL: [Crc64Fn; 5] = [
    arch::crc64_xz_pclmul_safe,
    arch::crc64_xz_pclmul_2way_safe,
    arch::crc64_xz_pclmul_4way_safe,
    arch::crc64_xz_pclmul_7way_safe,
    arch::crc64_xz_pclmul_8way_safe,
  ];
  /// XZ PCLMUL small buffer kernel.
  pub const XZ_PCLMUL_SMALL: Crc64Fn = arch::crc64_xz_pclmul_small_safe;

  /// XZ VPCLMUL kernels: [1-way, 2-way, 4-way, 7-way, 8-way]
  pub const XZ_VPCLMUL: [Crc64Fn; 5] = [
    arch::crc64_xz_vpclmul_safe,
    arch::crc64_xz_vpclmul_2way_safe,
    arch::crc64_xz_vpclmul_4way_safe,
    arch::crc64_xz_vpclmul_7way_safe,
    arch::crc64_xz_vpclmul_8way_safe,
  ];
  /// XZ VPCLMUL 4×512-bit kernel.
  pub const XZ_VPCLMUL_4X512: Crc64Fn = arch::crc64_xz_vpclmul_4x512_safe;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-NVME Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// NVME PCLMUL kernels: [1-way, 2-way, 4-way, 7-way, 8-way]
  pub const NVME_PCLMUL: [Crc64Fn; 5] = [
    arch::crc64_nvme_pclmul_safe,
    arch::crc64_nvme_pclmul_2way_safe,
    arch::crc64_nvme_pclmul_4way_safe,
    arch::crc64_nvme_pclmul_7way_safe,
    arch::crc64_nvme_pclmul_8way_safe,
  ];
  /// NVME PCLMUL small buffer kernel.
  pub const NVME_PCLMUL_SMALL: Crc64Fn = arch::crc64_nvme_pclmul_small_safe;

  /// NVME VPCLMUL kernels: [1-way, 2-way, 4-way, 7-way, 8-way]
  pub const NVME_VPCLMUL: [Crc64Fn; 5] = [
    arch::crc64_nvme_vpclmul_safe,
    arch::crc64_nvme_vpclmul_2way_safe,
    arch::crc64_nvme_vpclmul_4way_safe,
    arch::crc64_nvme_vpclmul_7way_safe,
    arch::crc64_nvme_vpclmul_8way_safe,
  ];
}

#[cfg(target_arch = "aarch64")]
pub mod aarch64 {
  #![cfg_attr(not(any(test, feature = "std")), allow(dead_code))]
  #![cfg_attr(not(any(target_os = "linux", target_os = "android")), allow(dead_code))]

  use super::super::aarch64 as arch;
  use crate::checksum::dispatchers::Crc64Fn;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-XZ Kernel Function Arrays
  // Note: aarch64 only supports up to 3-way, slots 3-4 are duplicates
  // ─────────────────────────────────────────────────────────────────────────

  /// XZ PMULL kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const XZ_PMULL: [Crc64Fn; 5] = [
    arch::crc64_xz_pmull_safe,
    arch::crc64_xz_pmull_2way_safe,
    arch::crc64_xz_pmull_3way_safe,
    arch::crc64_xz_pmull_3way_safe, // dup for index consistency
    arch::crc64_xz_pmull_3way_safe, // dup for index consistency
  ];
  /// XZ PMULL small buffer kernel.
  pub const XZ_PMULL_SMALL: Crc64Fn = arch::crc64_xz_pmull_small_safe;

  /// XZ PMULL+EOR3 kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const XZ_PMULL_EOR3: [Crc64Fn; 5] = [
    arch::crc64_xz_pmull_eor3_safe,
    arch::crc64_xz_pmull_eor3_2way_safe,
    arch::crc64_xz_pmull_eor3_3way_safe,
    arch::crc64_xz_pmull_eor3_3way_safe, // dup for index consistency
    arch::crc64_xz_pmull_eor3_3way_safe, // dup for index consistency
  ];

  /// XZ SVE2 PMULL kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const XZ_SVE2_PMULL: [Crc64Fn; 5] = [
    arch::crc64_xz_sve2_pmull_safe,
    arch::crc64_xz_sve2_pmull_2way_safe,
    arch::crc64_xz_sve2_pmull_3way_safe,
    arch::crc64_xz_sve2_pmull_3way_safe, // dup for index consistency
    arch::crc64_xz_sve2_pmull_3way_safe, // dup for index consistency
  ];
  /// XZ SVE2 PMULL small buffer kernel.
  pub const XZ_SVE2_PMULL_SMALL: Crc64Fn = arch::crc64_xz_sve2_pmull_small_safe;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-NVME Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// NVME PMULL kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const NVME_PMULL: [Crc64Fn; 5] = [
    arch::crc64_nvme_pmull_safe,
    arch::crc64_nvme_pmull_2way_safe,
    arch::crc64_nvme_pmull_3way_safe,
    arch::crc64_nvme_pmull_3way_safe, // dup for index consistency
    arch::crc64_nvme_pmull_3way_safe, // dup for index consistency
  ];
  /// NVME PMULL small buffer kernel.
  pub const NVME_PMULL_SMALL: Crc64Fn = arch::crc64_nvme_pmull_small_safe;

  /// NVME PMULL+EOR3 kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const NVME_PMULL_EOR3: [Crc64Fn; 5] = [
    arch::crc64_nvme_pmull_eor3_safe,
    arch::crc64_nvme_pmull_eor3_2way_safe,
    arch::crc64_nvme_pmull_eor3_3way_safe,
    arch::crc64_nvme_pmull_eor3_3way_safe, // dup for index consistency
    arch::crc64_nvme_pmull_eor3_3way_safe, // dup for index consistency
  ];

  /// NVME SVE2 PMULL kernels: [1-way, 2-way, 3-way, 3-way(dup), 3-way(dup)]
  pub const NVME_SVE2_PMULL: [Crc64Fn; 5] = [
    arch::crc64_nvme_sve2_pmull_safe,
    arch::crc64_nvme_sve2_pmull_2way_safe,
    arch::crc64_nvme_sve2_pmull_3way_safe,
    arch::crc64_nvme_sve2_pmull_3way_safe, // dup for index consistency
    arch::crc64_nvme_sve2_pmull_3way_safe, // dup for index consistency
  ];
  /// NVME SVE2 PMULL small buffer kernel.
  pub const NVME_SVE2_PMULL_SMALL: Crc64Fn = arch::crc64_nvme_sve2_pmull_small_safe;
}

#[cfg(target_arch = "powerpc64")]
pub mod power {
  use super::super::power as arch;
  use crate::checksum::dispatchers::Crc64Fn;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-XZ Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// XZ VPMSUM kernels: [1-way, 2-way, 4-way, 8-way, 8-way(dup)]
  pub const XZ_VPMSUM: [Crc64Fn; 5] = [
    arch::crc64_xz_vpmsum_safe,
    arch::crc64_xz_vpmsum_2way_safe,
    arch::crc64_xz_vpmsum_4way_safe,
    arch::crc64_xz_vpmsum_8way_safe,
    arch::crc64_xz_vpmsum_8way_safe, // dup for index consistency
  ];

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-NVME Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// NVME VPMSUM kernels: [1-way, 2-way, 4-way, 8-way, 8-way(dup)]
  pub const NVME_VPMSUM: [Crc64Fn; 5] = [
    arch::crc64_nvme_vpmsum_safe,
    arch::crc64_nvme_vpmsum_2way_safe,
    arch::crc64_nvme_vpmsum_4way_safe,
    arch::crc64_nvme_vpmsum_8way_safe,
    arch::crc64_nvme_vpmsum_8way_safe, // dup for index consistency
  ];
}

#[cfg(target_arch = "s390x")]
pub mod s390x {
  use super::super::s390x as arch;
  use crate::checksum::dispatchers::Crc64Fn;

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-XZ Kernel Function Arrays
  // Note: s390x only supports up to 4-way, slots 3-4 are duplicates
  // ─────────────────────────────────────────────────────────────────────────

  /// XZ VGFM kernels: [1-way, 2-way, 4-way, 4-way(dup), 4-way(dup)]
  pub const XZ_VGFM: [Crc64Fn; 5] = [
    arch::crc64_xz_vgfm_safe,
    arch::crc64_xz_vgfm_2way_safe,
    arch::crc64_xz_vgfm_4way_safe,
    arch::crc64_xz_vgfm_4way_safe, // dup for index consistency
    arch::crc64_xz_vgfm_4way_safe, // dup for index consistency
  ];

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-NVME Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// NVME VGFM kernels: [1-way, 2-way, 4-way, 4-way(dup), 4-way(dup)]
  pub const NVME_VGFM: [Crc64Fn; 5] = [
    arch::crc64_nvme_vgfm_safe,
    arch::crc64_nvme_vgfm_2way_safe,
    arch::crc64_nvme_vgfm_4way_safe,
    arch::crc64_nvme_vgfm_4way_safe, // dup for index consistency
    arch::crc64_nvme_vgfm_4way_safe, // dup for index consistency
  ];
}

#[cfg(target_arch = "riscv64")]
#[allow(dead_code)]
pub mod riscv64 {
  use super::super::riscv64 as arch;
  use crate::checksum::dispatchers::Crc64Fn;

  /// Zbc kernel names: [1-way, 2-way, 4-way, 8-way, 8-way(dup)]
  pub const ZBC_NAMES: &[&str] = &[
    "riscv64/zbc",
    "riscv64/zbc-2way",
    "riscv64/zbc-4way",
    "riscv64/zbc-8way",
    "riscv64/zbc-8way",
  ];

  /// Zvbc kernel names: [1-way, 2-way, 4-way, 4-way(dup), 4-way(dup)]
  pub const ZVBC_NAMES: &[&str] = &[
    "riscv64/zvbc",
    "riscv64/zvbc-2way",
    "riscv64/zvbc-4way",
    "riscv64/zvbc-4way",
    "riscv64/zvbc-4way",
  ];

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-XZ Kernel Function Arrays
  // Note: riscv64 Zbc exposes up to 8-way; slot 4 is duplicated for index consistency.
  // ─────────────────────────────────────────────────────────────────────────

  /// XZ Zbc kernels: [1-way, 2-way, 4-way, 8-way, 8-way(dup)]
  pub const XZ_ZBC: [Crc64Fn; 5] = [
    arch::crc64_xz_zbc_safe,
    arch::crc64_xz_zbc_2way_safe,
    arch::crc64_xz_zbc_4way_safe,
    arch::crc64_xz_zbc_8way_safe,
    arch::crc64_xz_zbc_8way_safe, // dup for index consistency
  ];

  /// XZ Zvbc kernels: [1-way, 2-way, 4-way, 4-way(dup), 4-way(dup)]
  pub const XZ_ZVBC: [Crc64Fn; 5] = [
    arch::crc64_xz_zvbc_safe,
    arch::crc64_xz_zvbc_2way_safe,
    arch::crc64_xz_zvbc_4way_safe,
    arch::crc64_xz_zvbc_4way_safe, // dup for index consistency
    arch::crc64_xz_zvbc_4way_safe, // dup for index consistency
  ];

  // ─────────────────────────────────────────────────────────────────────────
  // CRC64-NVME Kernel Function Arrays
  // ─────────────────────────────────────────────────────────────────────────

  /// NVME Zbc kernels: [1-way, 2-way, 4-way, 8-way, 8-way(dup)]
  pub const NVME_ZBC: [Crc64Fn; 5] = [
    arch::crc64_nvme_zbc_safe,
    arch::crc64_nvme_zbc_2way_safe,
    arch::crc64_nvme_zbc_4way_safe,
    arch::crc64_nvme_zbc_8way_safe,
    arch::crc64_nvme_zbc_8way_safe, // dup for index consistency
  ];

  /// NVME Zvbc kernels: [1-way, 2-way, 4-way, 4-way(dup), 4-way(dup)]
  pub const NVME_ZVBC: [Crc64Fn; 5] = [
    arch::crc64_nvme_zvbc_safe,
    arch::crc64_nvme_zvbc_2way_safe,
    arch::crc64_nvme_zvbc_4way_safe,
    arch::crc64_nvme_zvbc_4way_safe, // dup for index consistency
    arch::crc64_nvme_zvbc_4way_safe, // dup for index consistency
  ];
}