winter_utils/lib.rs
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
// Copyright (c) Facebook, Inc. and its affiliates.
//
// This source code is licensed under the MIT license found in the
// LICENSE file in the root directory of this source tree.
//! This crate contains utility traits, functions, and macros used by other crates of Winterfell
//! STARK prover and verifier.
#![no_std]
#[macro_use]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;
pub mod iterators;
use alloc::vec::Vec;
use core::{mem, slice};
mod serde;
#[cfg(feature = "std")]
pub use serde::ReadAdapter;
pub use serde::{ByteReader, ByteWriter, Deserializable, Serializable, SliceReader};
mod errors;
pub use errors::DeserializationError;
#[cfg(test)]
mod tests;
// FEATURE-BASED RE-EXPORTS
// ================================================================================================
#[cfg(feature = "concurrent")]
use iterators::*;
#[cfg(feature = "concurrent")]
pub use rayon;
// AS BYTES
// ================================================================================================
/// Defines a zero-copy representation of `Self` as a sequence of bytes.
pub trait AsBytes {
/// Returns a byte representation of `self`.
///
/// This method is intended to re-interpret the underlying memory as a sequence of bytes, and
/// thus, should be zero-copy.
fn as_bytes(&self) -> &[u8];
}
impl<const N: usize, const M: usize> AsBytes for [[u8; N]; M] {
/// Flattens a two-dimensional array of bytes into a slice of bytes.
fn as_bytes(&self) -> &[u8] {
let p = self.as_ptr();
let len = N * M;
unsafe { slice::from_raw_parts(p as *const u8, len) }
}
}
impl<const N: usize> AsBytes for [[u8; N]] {
/// Flattens a slice of byte arrays into a slice of bytes.
fn as_bytes(&self) -> &[u8] {
let p = self.as_ptr();
let len = self.len() * N;
unsafe { slice::from_raw_parts(p as *const u8, len) }
}
}
// VECTOR FUNCTIONS
// ================================================================================================
/// Returns a vector of the specified length with un-initialized memory.
///
/// This is usually faster than requesting a vector with initialized memory and is useful when we
/// overwrite all contents of the vector immediately after memory allocation.
///
/// # Safety
/// Using values from the returned vector before initializing them will lead to undefined behavior.
#[allow(clippy::uninit_vec)]
pub unsafe fn uninit_vector<T>(length: usize) -> Vec<T> {
let mut vector = Vec::with_capacity(length);
vector.set_len(length);
vector
}
// GROUPING / UN-GROUPING FUNCTIONS
// ================================================================================================
/// Transmutes a slice of `n` elements into a slice of `n` / `N` elements, each of which is
/// an array of `N` elements.
///
/// This function just re-interprets the underlying memory and is thus zero-copy.
/// # Panics
/// Panics if `n` is not divisible by `N`.
///
/// # Example
/// ```
/// # use winter_utils::group_slice_elements;
/// let a = [0_u32, 1, 2, 3, 4, 5, 6, 7];
/// let b: &[[u32; 2]] = group_slice_elements(&a);
///
/// assert_eq!(&[[0, 1], [2, 3], [4, 5], [6, 7]], b);
/// ```
pub fn group_slice_elements<T, const N: usize>(source: &[T]) -> &[[T; N]] {
assert_eq!(source.len() % N, 0, "source length must be divisible by {N}");
let p = source.as_ptr();
let len = source.len() / N;
unsafe { slice::from_raw_parts(p as *const [T; N], len) }
}
/// Transmutes a slice of `n` arrays each of length `N`, into a slice of `N` * `n` elements.
///
/// This function just re-interprets the underlying memory and is thus zero-copy.
/// # Example
/// ```
/// # use winter_utils::flatten_slice_elements;
/// let a = vec![[1, 2, 3, 4], [5, 6, 7, 8]];
///
/// let b = flatten_slice_elements(&a);
/// assert_eq!(&[1, 2, 3, 4, 5, 6, 7, 8], b);
/// ```
pub fn flatten_slice_elements<T, const N: usize>(source: &[[T; N]]) -> &[T] {
let p = source.as_ptr();
let len = source.len() * N;
unsafe { slice::from_raw_parts(p as *const T, len) }
}
/// Transmutes a vector of `n` arrays each of length `N`, into a vector of `N` * `n` elements.
///
/// This function just re-interprets the underlying memory and is thus zero-copy.
/// # Example
/// ```
/// # use winter_utils::flatten_vector_elements;
/// let a = vec![[1, 2, 3, 4], [5, 6, 7, 8]];
///
/// let b = flatten_vector_elements(a);
/// assert_eq!(vec![1, 2, 3, 4, 5, 6, 7, 8], b);
/// ```
pub fn flatten_vector_elements<T, const N: usize>(source: Vec<[T; N]>) -> Vec<T> {
let v = mem::ManuallyDrop::new(source);
let p = v.as_ptr();
let len = v.len() * N;
let cap = v.capacity() * N;
unsafe { Vec::from_raw_parts(p as *mut T, len, cap) }
}
// TRANSPOSING
// ================================================================================================
/// Transposes a slice of `n` elements into a matrix with `N` columns and `n`/`N` rows.
///
/// When `concurrent` feature is enabled, the slice will be transposed using multiple threads.
///
/// # Panics
/// Panics if `n` is not divisible by `N`.
///
/// # Example
/// ```
/// # use winter_utils::transpose_slice;
/// let a = [0_u32, 1, 2, 3, 4, 5, 6, 7];
/// let b: Vec<[u32; 2]> = transpose_slice(&a);
///
/// assert_eq!(vec![[0, 4], [1, 5], [2, 6], [3, 7]], b);
/// ```
pub fn transpose_slice<T: Copy + Send + Sync, const N: usize>(source: &[T]) -> Vec<[T; N]> {
let row_count = source.len() / N;
assert_eq!(
row_count * N,
source.len(),
"source length must be divisible by {}, but was {}",
N,
source.len()
);
let mut result: Vec<[T; N]> = unsafe { uninit_vector(row_count) };
iter_mut!(result, 1024).enumerate().for_each(|(i, element)| {
for j in 0..N {
element[j] = source[i + j * row_count]
}
});
result
}
// RANDOMNESS
// ================================================================================================
/// Defines how `Self` can be read from a sequence of random bytes.
pub trait Randomizable: Sized {
/// Size of `Self` in bytes.
///
/// This is used to determine how many bytes should be passed to the
/// [from_random_bytes()](Self::from_random_bytes) function.
const VALUE_SIZE: usize;
/// Returns `Self` if the set of bytes forms a valid value, otherwise returns None.
fn from_random_bytes(source: &[u8]) -> Option<Self>;
}
impl Randomizable for u128 {
const VALUE_SIZE: usize = 16;
fn from_random_bytes(source: &[u8]) -> Option<Self> {
if let Ok(bytes) = source[..Self::VALUE_SIZE].try_into() {
Some(u128::from_le_bytes(bytes))
} else {
None
}
}
}
impl Randomizable for u64 {
const VALUE_SIZE: usize = 8;
fn from_random_bytes(source: &[u8]) -> Option<Self> {
if let Ok(bytes) = source[..Self::VALUE_SIZE].try_into() {
Some(u64::from_le_bytes(bytes))
} else {
None
}
}
}
impl Randomizable for u32 {
const VALUE_SIZE: usize = 4;
fn from_random_bytes(source: &[u8]) -> Option<Self> {
if let Ok(bytes) = source[..Self::VALUE_SIZE].try_into() {
Some(u32::from_le_bytes(bytes))
} else {
None
}
}
}
impl Randomizable for u16 {
const VALUE_SIZE: usize = 2;
fn from_random_bytes(source: &[u8]) -> Option<Self> {
if let Ok(bytes) = source[..Self::VALUE_SIZE].try_into() {
Some(u16::from_le_bytes(bytes))
} else {
None
}
}
}
impl Randomizable for u8 {
const VALUE_SIZE: usize = 1;
fn from_random_bytes(source: &[u8]) -> Option<Self> {
Some(source[0])
}
}