Merge pull request #12 from paritytech/add-fixed-hash

Add fixed-hash and uint crates to parity-common
This commit is contained in:
David 2018-08-03 16:07:53 +02:00 committed by GitHub
commit ae80aff497
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 3547 additions and 1 deletions

View File

@ -7,4 +7,5 @@ matrix:
- rust: nightly
script:
- cargo build
- cargo test
- cargo test --all --exclude uint
- cd uint/ && cargo test --features=std,impl_quickcheck_arbitrary

View File

@ -1,5 +1,6 @@
[workspace]
members = [
"fixed-hash",
"hashdb",
"keccak-hash",
"kvdb",
@ -14,4 +15,5 @@ members = [
"rlp",
"trie-standardmap",
"triehash",
"uint"
]

22
fixed-hash/Cargo.toml Normal file
View File

@ -0,0 +1,22 @@
[package]
name = "fixed-hash"
version = "0.2.2"
authors = ["Parity Technologies <admin@parity.io>"]
license = "MIT"
homepage = "https://github.com/paritytech/parity-common"
description = "Fixed-size hashes"
[dependencies]
heapsize = { version = "0.4", optional = true }
rand = { version = "0.4", optional = true }
rustc-hex = { version = "1.0", optional = true }
quickcheck = { version = "0.6", optional = true }
[target.'cfg(not(target_os = "unknown"))'.dependencies]
libc = { version = "0.2", optional = true, default-features = false }
[features]
default = ["libc"]
std = ["rustc-hex", "rand"]
heapsizeof = ["heapsize"]
impl_quickcheck_arbitrary = ["quickcheck"]

531
fixed-hash/src/hash.rs Normal file
View File

@ -0,0 +1,531 @@
// Copyright 2015-2017 Parity Technologies
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
/// Return `s` without the `0x` at the beginning of it, if any.
pub fn clean_0x(s: &str) -> &str {
if s.starts_with("0x") {
&s[2..]
} else {
s
}
}
#[macro_export]
macro_rules! construct_hash {
($from: ident, $size: expr) => {
#[repr(C)]
/// Unformatted binary data of fixed length.
pub struct $from (pub [u8; $size]);
impl From<[u8; $size]> for $from {
fn from(bytes: [u8; $size]) -> Self {
$from(bytes)
}
}
impl From<$from> for [u8; $size] {
fn from(s: $from) -> Self {
s.0
}
}
impl ::core::ops::Deref for $from {
type Target = [u8];
#[inline]
fn deref(&self) -> &[u8] {
&self.0
}
}
impl AsRef<[u8]> for $from {
#[inline]
fn as_ref(&self) -> &[u8] {
&self.0
}
}
impl AsMut<[u8]> for $from {
#[inline]
fn as_mut(&mut self) -> &mut [u8] {
&mut self.0
}
}
impl AsRef<$from> for $from {
#[inline]
fn as_ref(&self) -> &$from {
&self
}
}
impl ::core::ops::DerefMut for $from {
#[inline]
fn deref_mut(&mut self) -> &mut [u8] {
&mut self.0
}
}
impl $from {
/// Create a new, zero-initialised, instance.
pub fn new() -> $from {
$from([0; $size])
}
/// Synonym for `new()`. Prefer to new as it's more readable.
pub fn zero() -> $from {
$from([0; $size])
}
/// Get the size of this object in bytes.
pub fn len() -> usize {
$size
}
#[inline]
/// Assign self to be of the same value as a slice of bytes of length `len()`.
pub fn clone_from_slice(&mut self, src: &[u8]) -> usize {
let min = ::core::cmp::min($size, src.len());
self.0[..min].copy_from_slice(&src[..min]);
min
}
/// Convert a slice of bytes of length `len()` to an instance of this type.
pub fn from_slice(src: &[u8]) -> Self {
let mut r = Self::new();
r.clone_from_slice(src);
r
}
/// Copy the data of this object into some mutable slice of length `len()`.
pub fn copy_to(&self, dest: &mut[u8]) {
let min = ::core::cmp::min($size, dest.len());
dest[..min].copy_from_slice(&self.0[..min]);
}
/// Returns `true` if all bits set in `b` are also set in `self`.
pub fn contains<'a>(&'a self, b: &'a Self) -> bool {
&(b & self) == b
}
/// Returns `true` if no bits are set.
pub fn is_zero(&self) -> bool {
self.eq(&Self::new())
}
/// Returns the lowest 8 bytes interpreted as a BigEndian integer.
pub fn low_u64(&self) -> u64 {
let mut ret = 0u64;
for i in 0..::core::cmp::min($size, 8) {
ret |= (self.0[$size - 1 - i] as u64) << (i * 8);
}
ret
}
impl_std_for_hash_internals!($from, $size);
}
impl ::core::fmt::Debug for $from {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "{:#x}", self)
}
}
impl ::core::fmt::Display for $from {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "0x")?;
for i in &self.0[0..2] {
write!(f, "{:02x}", i)?;
}
write!(f, "")?;
for i in &self.0[$size - 2..$size] {
write!(f, "{:02x}", i)?;
}
Ok(())
}
}
impl ::core::fmt::LowerHex for $from {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
if f.alternate() {
write!(f, "0x")?;
}
for i in &self.0[..] {
write!(f, "{:02x}", i)?;
}
Ok(())
}
}
impl Copy for $from {}
#[cfg_attr(feature="dev", allow(expl_impl_clone_on_copy))]
impl Clone for $from {
fn clone(&self) -> $from {
let mut ret = $from::new();
ret.0.copy_from_slice(&self.0);
ret
}
}
impl Eq for $from {}
impl PartialOrd for $from {
fn partial_cmp(&self, other: &Self) -> Option<::core::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl ::core::hash::Hash for $from {
fn hash<H>(&self, state: &mut H) where H: ::core::hash::Hasher {
state.write(&self.0);
state.finish();
}
}
impl ::core::ops::Index<usize> for $from {
type Output = u8;
fn index(&self, index: usize) -> &u8 {
&self.0[index]
}
}
impl ::core::ops::IndexMut<usize> for $from {
fn index_mut(&mut self, index: usize) -> &mut u8 {
&mut self.0[index]
}
}
impl ::core::ops::Index<::core::ops::Range<usize>> for $from {
type Output = [u8];
fn index(&self, index: ::core::ops::Range<usize>) -> &[u8] {
&self.0[index]
}
}
impl ::core::ops::IndexMut<::core::ops::Range<usize>> for $from {
fn index_mut(&mut self, index: ::core::ops::Range<usize>) -> &mut [u8] {
&mut self.0[index]
}
}
impl ::core::ops::Index<::core::ops::RangeFull> for $from {
type Output = [u8];
fn index(&self, _index: ::core::ops::RangeFull) -> &[u8] {
&self.0
}
}
impl ::core::ops::IndexMut<::core::ops::RangeFull> for $from {
fn index_mut(&mut self, _index: ::core::ops::RangeFull) -> &mut [u8] {
&mut self.0
}
}
/// `BitOr` on references
impl<'a> ::core::ops::BitOr for &'a $from {
type Output = $from;
fn bitor(self, rhs: Self) -> Self::Output {
let mut ret: $from = $from::default();
for i in 0..$size {
ret.0[i] = self.0[i] | rhs.0[i];
}
ret
}
}
/// Moving `BitOr`
impl ::core::ops::BitOr for $from {
type Output = $from;
fn bitor(self, rhs: Self) -> Self::Output {
&self | &rhs
}
}
/// `BitAnd` on references
impl <'a> ::core::ops::BitAnd for &'a $from {
type Output = $from;
fn bitand(self, rhs: Self) -> Self::Output {
let mut ret: $from = $from::default();
for i in 0..$size {
ret.0[i] = self.0[i] & rhs.0[i];
}
ret
}
}
/// Moving `BitAnd`
impl ::core::ops::BitAnd for $from {
type Output = $from;
fn bitand(self, rhs: Self) -> Self::Output {
&self & &rhs
}
}
/// `BitXor` on references
impl <'a> ::core::ops::BitXor for &'a $from {
type Output = $from;
fn bitxor(self, rhs: Self) -> Self::Output {
let mut ret: $from = $from::default();
for i in 0..$size {
ret.0[i] = self.0[i] ^ rhs.0[i];
}
ret
}
}
/// Moving `BitXor`
impl ::core::ops::BitXor for $from {
type Output = $from;
fn bitxor(self, rhs: Self) -> Self::Output {
&self ^ &rhs
}
}
impl Default for $from {
fn default() -> Self { $from::new() }
}
impl From<u64> for $from {
fn from(mut value: u64) -> $from {
let mut ret = $from::new();
for i in 0..8 {
if i < $size {
ret.0[$size - i - 1] = (value & 0xff) as u8;
value >>= 8;
}
}
ret
}
}
impl<'a> From<&'a [u8]> for $from {
fn from(s: &'a [u8]) -> $from {
$from::from_slice(s)
}
}
impl_std_for_hash!($from, $size);
impl_heapsize_for_hash!($from);
impl_libc_for_hash!($from, $size);
impl_quickcheck_arbitrary_for_hash!($from, $size);
}
}
#[cfg(all(feature="heapsizeof", feature="libc", not(target_os = "unknown")))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_heapsize_for_hash {
($name: ident) => {
impl $crate::heapsize::HeapSizeOf for $name {
fn heap_size_of_children(&self) -> usize {
0
}
}
}
}
#[cfg(any(not(feature="heapsizeof"), not(feature="libc"), target_os = "unknown"))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_heapsize_for_hash {
($name: ident) => {}
}
#[cfg(feature="std")]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_std_for_hash {
($from: ident, $size: tt) => {
impl $from {
/// Get a hex representation.
#[deprecated(note="Use LowerHex or Debug formatting instead.")]
pub fn hex(&self) -> String {
format!("{:?}", self)
}
}
impl $crate::rand::Rand for $from {
fn rand<R: $crate::rand::Rng>(r: &mut R) -> Self {
let mut hash = $from::new();
r.fill_bytes(&mut hash.0);
hash
}
}
impl ::core::str::FromStr for $from {
type Err = $crate::rustc_hex::FromHexError;
fn from_str(s: &str) -> Result<$from, $crate::rustc_hex::FromHexError> {
use $crate::rustc_hex::FromHex;
let a = s.from_hex()?;
if a.len() != $size {
return Err($crate::rustc_hex::FromHexError::InvalidHexLength);
}
let mut ret = [0; $size];
ret.copy_from_slice(&a);
Ok($from(ret))
}
}
impl From<&'static str> for $from {
fn from(s: &'static str) -> $from {
let s = $crate::clean_0x(s);
if s.len() % 2 == 1 {
("0".to_owned() + s).parse().unwrap()
} else {
s.parse().unwrap()
}
}
}
}
}
#[cfg(not(feature="std"))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_std_for_hash {
($from: ident, $size: tt) => {}
}
#[cfg(feature="std")]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_std_for_hash_internals {
($from: ident, $size: tt) => {
/// Create a new, cryptographically random, instance.
pub fn random() -> $from {
let mut hash = $from::new();
hash.randomize();
hash
}
/// Assign self have a cryptographically random value.
pub fn randomize(&mut self) {
let mut rng = $crate::rand::OsRng::new().unwrap();
*self = $crate::rand::Rand::rand(&mut rng);
}
}
}
#[cfg(not(feature="std"))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_std_for_hash_internals {
($from: ident, $size: tt) => {}
}
#[cfg(all(feature="libc", not(target_os = "unknown")))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_libc_for_hash {
($from: ident, $size: expr) => {
impl PartialEq for $from {
fn eq(&self, other: &Self) -> bool {
unsafe { $crate::libc::memcmp(self.0.as_ptr() as *const $crate::libc::c_void, other.0.as_ptr() as *const $crate::libc::c_void, $size) == 0 }
}
}
impl Ord for $from {
fn cmp(&self, other: &Self) -> ::core::cmp::Ordering {
let r = unsafe { $crate::libc::memcmp(self.0.as_ptr() as *const $crate::libc::c_void, other.0.as_ptr() as *const $crate::libc::c_void, $size) };
if r < 0 { return ::core::cmp::Ordering::Less }
if r > 0 { return ::core::cmp::Ordering::Greater }
return ::core::cmp::Ordering::Equal;
}
}
}
}
#[cfg(any(not(feature="libc"), target_os = "unknown"))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_libc_for_hash {
($from: ident, $size: expr) => {
impl PartialEq for $from {
fn eq(&self, other: &Self) -> bool {
&self.0[..] == &other.0[..]
}
}
impl Ord for $from {
fn cmp(&self, other: &Self) -> ::core::cmp::Ordering {
self.0[..].cmp(&other.0[..])
}
}
}
}
#[cfg(feature="impl_quickcheck_arbitrary")]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_quickcheck_arbitrary_for_hash {
($name: ty, $n_bytes: tt) => {
impl $crate::quickcheck::Arbitrary for $name {
fn arbitrary<G: $crate::quickcheck::Gen>(g: &mut G) -> Self {
let mut res = [0u8; $n_bytes];
g.fill_bytes(&mut res[..$n_bytes]);
res.as_ref().into()
}
}
}
}
#[cfg(not(feature="impl_quickcheck_arbitrary"))]
#[macro_export]
#[doc(hidden)]
macro_rules! impl_quickcheck_arbitrary_for_hash {
($name: ty, $n_bytes: tt) => {}
}
#[cfg(test)]
mod tests {
construct_hash!(H128, 16);
#[test]
fn test_construct_hash() {
assert_eq!(H128::default(), H128::new());
assert_eq!(H128::new(), H128::zero());
assert_eq!(H128::len(), 16);
}
#[cfg(feature="heapsizeof")]
#[test]
fn test_heapsizeof() {
use heapsize::HeapSizeOf;
let h = H128::zero();
assert_eq!(h.heap_size_of_children(),0);
}
#[cfg(feature="std")]
#[test]
fn should_format_and_debug_correctly() {
let test = |x: u64, hex: &'static str, display: &'static str| {
let hash = H128::from(x);
assert_eq!(format!("{}", hash), format!("0x{}", display));
assert_eq!(format!("{:?}", hash), format!("0x{}", hex));
assert_eq!(format!("{:x}", hash), hex);
assert_eq!(format!("{:#x}", hash), format!("0x{}", hex));
};
test(0x1, "00000000000000000000000000000001", "0000…0001");
test(0xf, "0000000000000000000000000000000f", "0000…000f");
test(0x10, "00000000000000000000000000000010", "0000…0010");
test(0xff, "000000000000000000000000000000ff", "0000…00ff");
test(0x100, "00000000000000000000000000000100", "0000…0100");
test(0xfff, "00000000000000000000000000000fff", "0000…0fff");
test(0x1000, "00000000000000000000000000001000", "0000…1000");
}
}

40
fixed-hash/src/lib.rs Normal file
View File

@ -0,0 +1,40 @@
// Copyright 2015-2017 Parity Technologies
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#![cfg_attr(not(feature = "std"), no_std)]
#[cfg(all(feature="libc", not(target_os = "unknown")))]
#[doc(hidden)]
pub extern crate libc;
#[cfg(not(feature="libc"))]
#[doc(hidden)]
pub mod libc { }
#[cfg(feature="heapsizeof")]
#[doc(hidden)]
pub extern crate heapsize;
#[cfg(feature="std")]
#[doc(hidden)]
pub extern crate core;
#[cfg(feature="std")]
#[doc(hidden)]
pub extern crate rustc_hex;
#[cfg(feature="std")]
#[doc(hidden)]
pub extern crate rand;
#[cfg(feature="impl_quickcheck_arbitrary")]
#[doc(hidden)]
pub extern crate quickcheck;
mod hash;
pub use hash::*;

32
uint/Cargo.toml Normal file
View File

@ -0,0 +1,32 @@
[package]
description = "Large fixed-size integers arithmetics"
homepage = "http://parity.io"
repository = "https://github.com/paritytech/primitives"
license = "MIT/Apache-2.0"
name = "uint"
version = "0.2.2"
authors = ["Parity Technologies <admin@parity.io>"]
build = "build.rs"
[build-dependencies]
rustc_version = "0.2"
[dependencies]
byteorder = { version = "1", default-features = false }
heapsize = { version = "0.4.2", optional = true }
rustc-hex = { version = "1.0", optional = true }
quickcheck = { version = "0.6", optional = true }
[dev-dependencies]
crunchy = "0.1.5"
quickcheck = "0.6"
[features]
std = ["rustc-hex", "byteorder/std"]
heapsizeof = ["heapsize"]
use_asm = []
impl_quickcheck_arbitrary = ["quickcheck"]
[[example]]
name = "modular"
required-features = ["std"]

8
uint/README.md Normal file
View File

@ -0,0 +1,8 @@
# Big unsigned integer types
Implementation of a various large-but-fixed sized unsigned integer types.
The functions here are designed to be fast. There are optional `x86_64`
implementations for even more speed, hidden behind the `x64_arithmetic`
feature flag.
Run tests with `cargo test --features=std,impl_quickcheck_arbitrary`.

19
uint/build.rs Normal file
View File

@ -0,0 +1,19 @@
// Copyright 2015-2017 Parity Technologies
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
extern crate rustc_version;
use rustc_version::{version_meta, Channel};
fn main() {
if cfg!(feature = "use_asm") {
if let Channel::Nightly = version_meta().unwrap().channel {
println!("cargo:rustc-cfg=asm_available");
}
}
}

62
uint/examples/modular.rs Normal file
View File

@ -0,0 +1,62 @@
// Copyright 2015-2017 Parity Technologies
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#[cfg(feature="std")]
extern crate core;
#[macro_use]
extern crate crunchy;
#[macro_use]
extern crate uint;
construct_uint!(U256, 4);
fn main() {
// Example modular arithmetic using bigint U256 primitives
// imagine the field 0..p
// where the p is defined below
// (it's a prime!)
let p = U256::from_dec_str(
"38873241744847760218045702002058062581688990428170398542849190507947196700873"
).expect("p to be a good number in the example");
// then, on this field,
// (p-1) + (p+1) = 0
// (p - 1) mod p
let p_minus_1 = (p - 1) % p;
// (p + 1) mod p
let p_plus_1 = (p + 1) % p;
// ((p - 1) mod p + (p + 1) mod p) mod p
let sum = (p_minus_1 + p_plus_1) % p;
assert_eq!(sum, 0.into());
// on this field,
// (p-1) + (p-1) = p-2
let p_minus_1 = (p - 1) % p;
let sum = (p_minus_1 + p_minus_1) % p;
assert_eq!(sum, p - 2);
// on this field,
// (p-1) * 3 = p-3
let p_minus_1 = (p - 1) % p;
// multiplication is a series of additions
let multiplicator = 3;
let mul = {
let mut result = p_minus_1;
for _ in 0..multiplicator-1 {
result = (p_minus_1 + result) % p;
}
result
};
assert_eq!(mul, p - 3);
}

34
uint/src/lib.rs Normal file
View File

@ -0,0 +1,34 @@
// Copyright 2015-2017 Parity Technologies
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! Efficient large, fixed-size big integers and hashes.
#![cfg_attr(asm_available, feature(asm))]
#![cfg_attr(not(feature = "std"), no_std)]
#[doc(hidden)]
pub extern crate byteorder;
#[cfg(feature="heapsizeof")]
#[doc(hidden)]
pub extern crate heapsize;
#[cfg(feature="std")]
#[doc(hidden)]
pub extern crate core;
#[cfg(feature = "std")]
#[doc(hidden)]
pub extern crate rustc_hex;
#[cfg(feature="impl_quickcheck_arbitrary")]
#[doc(hidden)]
pub extern crate quickcheck;
mod uint;
pub use uint::*;

1621
uint/src/uint.rs Normal file

File diff suppressed because it is too large Load Diff

1174
uint/tests/uint_tests.rs Normal file

File diff suppressed because it is too large Load Diff