logos-blockchain/sponges
1
0
Fork 0
mirror of https://github.com/logos-blockchain/sponges.git synced 2026-07-29 18:13:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

keccak: replace keccak_soft_compact with keccak_backend_soft="compact" (#116)

Browse Source 
This would allow to extend configuration knobs for the software backend
in future and would be more consisted with potential similar knobs for
other backends.
This commit is contained in:
Artyom Pavlov 2026-03-16 00:00:06 +03:00 committed by GitHub
parent d96c7f3733
commit 609b63ecbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/keccak.yml vendored
View File

@ -84,7 +84,7 @@ jobs:
- run: cargo test --target ${{ matrix.target }} --features parallel
- run: cargo test --release --target ${{ matrix.target }} --features parallel
- env:
RUSTFLAGS: '-Dwarnings --cfg keccak_soft_compact'
RUSTFLAGS: '-Dwarnings --cfg keccak_backend_soft="compact"'
run: cargo test --release --target ${{ matrix.target }}
- env:
RUSTFLAGS: '-Dwarnings --cfg keccak_backend="soft"'
@ -131,7 +131,7 @@ jobs:
- run: cargo miri test --target ${{ matrix.target }}
- run: cargo miri test --target ${{ matrix.target }} --features parallel
- env:
RUSTFLAGS: '-Dwarnings --cfg keccak_soft_compact'
RUSTFLAGS: '-Dwarnings --cfg keccak_backend_soft="compact"'
run: cargo miri test --release --target ${{ matrix.target }} --features parallel
- env:
RUSTFLAGS: '-Dwarnings --cfg keccak_backend="simd128"'

2
keccak/Cargo.toml
View File

@ -33,7 +33,7 @@ unused_qualifications = "warn"
[lints.rust.unexpected_cfgs]
level = "warn"
check-cfg = [
'cfg(keccak_soft_compact)',
'cfg(keccak_backend_soft, values("compact"))',
'cfg(keccak_backend, values("aarch64_sha3", "simd128", "simd256", "simd512", "soft"))',
]

10
keccak/README.md
View File

@ -54,12 +54,14 @@ keccak::Keccak::new().with_f1600(|f1600| {
You can modify crate using the following configuration flags:
- `keccak_backend`: select the specified backend. Supported values:
`aarch64_sha3`, `simd128`, `simd256`, `simd512`, `soft`.
- `keccak_soft_compact`: do not unroll loops in the software backend.
Reduces performance, but results in a more compact binary code.
- `aarch64_sha3`: AArch64-specific backend based on the `sha3` extension.
- `simd128/256/512`: backend based on the portable SIMD API. Requires Nightly compiler.
- `soft`: portable software backend.
- `keccak_backend_soft="compact"`: control software backend implementation. Supported values:
- `compact`: do not unroll loops. Reduces performance, but results in a more compact binary code.
The flags can be enabled using `RUSTFLAGS` environment variable
(e.g. `RUSTFLAGS="--cfg aes_compact"`) or by modifying `.cargo/config`.
(e.g. `RUSTFLAGS='--cfg keccak_backend="soft"'`) or by modifying `.cargo/config.toml`.
## License

8
keccak/src/backends/soft.rs
View File

@ -52,7 +52,7 @@ impl_lanesize!(u64, F1600_ROUNDS);
#[rustfmt::skip]
macro_rules! unroll5 {
($var: ident, $body: block) => {
#[cfg(not(keccak_soft_compact))]
#[cfg(not(keccak_backend_soft = "compact"))]
{
{ const $var: usize = 0; $body; }
{ const $var: usize = 1; $body; }
@ -60,7 +60,7 @@ macro_rules! unroll5 {
{ const $var: usize = 3; $body; }
{ const $var: usize = 4; $body; }
}
#[cfg(keccak_soft_compact)]
#[cfg(keccak_backend_soft = "compact")]
{
for $var in 0..5 $body
}
@ -70,7 +70,7 @@ macro_rules! unroll5 {
#[rustfmt::skip]
macro_rules! unroll24 {
($var: ident, $body: block) => {
#[cfg(not(keccak_soft_compact))]
#[cfg(not(keccak_backend_soft = "compact"))]
{
{ const $var: usize = 0; $body; }
{ const $var: usize = 1; $body; }
@ -97,7 +97,7 @@ macro_rules! unroll24 {
{ const $var: usize = 22; $body; }
{ const $var: usize = 23; $body; }
}
#[cfg(keccak_soft_compact)]
#[cfg(keccak_backend_soft = "compact")]
{
for $var in 0..24 $body
}