578 lines
16 KiB
Rust
578 lines
16 KiB
Rust
//! Rlp serialization module
|
|
|
|
use std::fmt;
|
|
use std::cell::Cell;
|
|
use std::error::Error as StdError;
|
|
use bytes::{ToBytes, FromBytes, FromBytesError};
|
|
|
|
/// rlp container
|
|
#[derive(Debug)]
|
|
pub struct Rlp<'a>{
|
|
bytes: &'a [u8],
|
|
cache: Cell<OffsetCache>
|
|
}
|
|
|
|
/// rlp offset
|
|
#[derive(Copy, Clone, Debug)]
|
|
struct OffsetCache {
|
|
index: usize,
|
|
offset: usize
|
|
}
|
|
|
|
impl OffsetCache {
|
|
fn new(index: usize, offset: usize) -> OffsetCache {
|
|
OffsetCache { index: index, offset: offset }
|
|
}
|
|
}
|
|
|
|
/// stores basic information about item
|
|
struct ItemInfo {
|
|
prefix_len: usize,
|
|
value_len: usize
|
|
}
|
|
|
|
impl ItemInfo {
|
|
fn new(prefix_len: usize, value_len: usize) -> ItemInfo {
|
|
ItemInfo { prefix_len: prefix_len, value_len: value_len }
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, PartialEq, Eq)]
|
|
pub enum DecoderError {
|
|
FromBytesError(FromBytesError),
|
|
RlpIsTooShort,
|
|
RlpExpectedToBeList,
|
|
BadRlp,
|
|
}
|
|
impl StdError for DecoderError {
|
|
fn description(&self) -> &str { "builder error" }
|
|
}
|
|
|
|
impl fmt::Display for DecoderError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
fmt::Debug::fmt(&self, f)
|
|
}
|
|
}
|
|
|
|
impl From<FromBytesError> for DecoderError {
|
|
fn from(err: FromBytesError) -> DecoderError { DecoderError::FromBytesError(err) }
|
|
}
|
|
|
|
impl <'a>Rlp<'a> {
|
|
/// returns new instance of `Rlp`
|
|
pub fn new(bytes: &'a[u8]) -> Rlp<'a> {
|
|
Rlp {
|
|
bytes: bytes,
|
|
cache: Cell::new(OffsetCache::new(usize::max_value(), 0))
|
|
}
|
|
}
|
|
|
|
/// get container subset at given index
|
|
///
|
|
/// paren container caches searched position
|
|
pub fn at(&self, index: usize) -> Result<Rlp<'a>, DecoderError> {
|
|
if !self.is_list() {
|
|
return Err(DecoderError::RlpExpectedToBeList);
|
|
}
|
|
|
|
// move to cached position if it's index is less or equal to
|
|
// current search index, otherwise move to beginning of list
|
|
let c = self.cache.get();
|
|
let (mut bytes, to_skip) = match c.index <= index {
|
|
true => (try!(Rlp::consume(self.bytes, c.offset)), index - c.index),
|
|
false => (try!(self.consume_list_prefix()), index)
|
|
};
|
|
|
|
// skip up to x items
|
|
bytes = try!(Rlp::consume_items(bytes, to_skip));
|
|
|
|
// update the cache
|
|
self.cache.set(OffsetCache::new(index, self.bytes.len() - bytes.len()));
|
|
|
|
// construct new rlp
|
|
let found = try!(Rlp::item_info(bytes));
|
|
Ok(Rlp::new(&bytes[0..found.prefix_len + found.value_len]))
|
|
}
|
|
|
|
/// returns true if rlp is an list
|
|
pub fn is_list(&self) -> bool {
|
|
self.bytes.len() > 0 && self.bytes[0] >= 0xc0
|
|
}
|
|
|
|
/// returns true if rlp is a value
|
|
pub fn is_value(&self) -> bool {
|
|
self.bytes.len() > 0 && self.bytes[0] <= 0xbf
|
|
}
|
|
|
|
/// returns rlp iterator
|
|
pub fn iter(&'a self) -> RlpIterator<'a> {
|
|
self.into_iter()
|
|
}
|
|
|
|
/// consumes first found prefix
|
|
fn consume_list_prefix(&self) -> Result<&'a [u8], DecoderError> {
|
|
let item = try!(Rlp::item_info(self.bytes));
|
|
let bytes = try!(Rlp::consume(self.bytes, item.prefix_len));
|
|
Ok(bytes)
|
|
}
|
|
|
|
/// consumes fixed number of items
|
|
fn consume_items(bytes: &'a [u8], items: usize) -> Result<&'a [u8], DecoderError> {
|
|
let mut result = bytes;
|
|
for _ in 0..items {
|
|
let i = try!(Rlp::item_info(result));
|
|
result = try!(Rlp::consume(result, (i.prefix_len + i.value_len)));
|
|
}
|
|
Ok(result)
|
|
}
|
|
|
|
/// return first item info
|
|
fn item_info(bytes: &[u8]) -> Result<ItemInfo, DecoderError> {
|
|
let item = match bytes.first().map(|&x| x) {
|
|
None => return Err(DecoderError::RlpIsTooShort),
|
|
Some(0...0x7f) => ItemInfo::new(0, 1),
|
|
Some(l @ 0x80...0xb7) => ItemInfo::new(1, l as usize - 0x80),
|
|
Some(l @ 0xb8...0xbf) => {
|
|
let len_of_len = l as usize - 0xb7;
|
|
let prefix_len = 1 + len_of_len;
|
|
let value_len = try!(usize::from_bytes(&bytes[1..prefix_len]));
|
|
ItemInfo::new(prefix_len, value_len)
|
|
}
|
|
Some(l @ 0xc0...0xf7) => ItemInfo::new(1, l as usize - 0xc0),
|
|
Some(l @ 0xf8...0xff) => {
|
|
let len_of_len = l as usize - 0xf7;
|
|
let prefix_len = 1 + len_of_len;
|
|
let value_len = try!(usize::from_bytes(&bytes[1..prefix_len]));
|
|
ItemInfo::new(prefix_len, value_len)
|
|
},
|
|
_ => return Err(DecoderError::BadRlp)
|
|
};
|
|
|
|
match item.prefix_len + item.value_len <= bytes.len() {
|
|
true => Ok(item),
|
|
false => Err(DecoderError::RlpIsTooShort)
|
|
}
|
|
}
|
|
|
|
/// consumes slice prefix of length `len`
|
|
fn consume(bytes: &'a [u8], len: usize) -> Result<&'a [u8], DecoderError> {
|
|
match bytes.len() >= len {
|
|
true => Ok(&bytes[len..]),
|
|
false => Err(DecoderError::RlpIsTooShort)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// non-consuming rlp iterator
|
|
pub struct RlpIterator<'a> {
|
|
rlp: &'a Rlp<'a>,
|
|
index: usize
|
|
}
|
|
|
|
impl <'a> IntoIterator for &'a Rlp<'a> {
|
|
type Item = Rlp<'a>;
|
|
type IntoIter = RlpIterator<'a>;
|
|
|
|
fn into_iter(self) -> Self::IntoIter {
|
|
RlpIterator { rlp: self, index: 0 }
|
|
}
|
|
}
|
|
|
|
impl <'a> Iterator for RlpIterator<'a> {
|
|
type Item = Rlp<'a>;
|
|
|
|
fn next(&mut self) -> Option<Rlp<'a>> {
|
|
let index = self.index;
|
|
let result = self.rlp.at(index).ok();
|
|
self.index += 1;
|
|
result
|
|
}
|
|
}
|
|
|
|
/// container that should be used to encode rlp
|
|
pub struct RlpStream {
|
|
len: usize,
|
|
max_len: usize,
|
|
bytes: Vec<u8>,
|
|
last_err: Option<EncoderError>
|
|
}
|
|
|
|
impl RlpStream {
|
|
/// create new container for values appended one after another,
|
|
/// but not being part of the same list
|
|
pub fn new() -> RlpStream {
|
|
RlpStream::new_list(0)
|
|
}
|
|
|
|
/// create new container for list of size `max_len`
|
|
pub fn new_list(max_len: usize) -> RlpStream {
|
|
RlpStream {
|
|
len: 0,
|
|
max_len: max_len,
|
|
bytes: vec![],
|
|
last_err: None
|
|
}
|
|
}
|
|
|
|
/// apends value to the end of stream, chainable
|
|
pub fn append<'a, E>(&'a mut self, object: &E) -> &'a mut RlpStream where E: Encodable {
|
|
// if there was an error, stop appending
|
|
if !self.last_err.is_none() {
|
|
return self
|
|
}
|
|
|
|
// encode given value and add it at the end of the stream
|
|
self.bytes.extend(encode(object));
|
|
self.len += 1;
|
|
|
|
// if list is finished, prepend the length
|
|
if self.is_finished() {
|
|
self.prepend_the_length();
|
|
}
|
|
|
|
// allow chaining calls
|
|
self
|
|
}
|
|
|
|
/// return true if stream is ready
|
|
pub fn is_finished(&self) -> bool {
|
|
self.len == self.max_len
|
|
}
|
|
|
|
/// streams out encoded bytes
|
|
pub fn out(self) -> Result<Vec<u8>, EncoderError> {
|
|
match self.last_err {
|
|
None if self.is_finished() => Ok(self.bytes),
|
|
Some(e) => Err(e),
|
|
_ => Err(EncoderError::StreamIsUnfinished)
|
|
}
|
|
}
|
|
|
|
/// prepend the length of the bytes to the beginning of the vector
|
|
fn prepend_the_length(&mut self) -> () {
|
|
let mut v = match self.bytes.len() {
|
|
len @ 0...55 => vec![0xc0u8 + len as u8],
|
|
len => {
|
|
let mut res = vec![0x7fu8 + len.to_bytes_len() as u8];
|
|
let mut b = len.to_bytes();
|
|
res.append(&mut b);
|
|
res
|
|
}
|
|
};
|
|
|
|
v.append(&mut self.bytes);
|
|
self.bytes = v;
|
|
}
|
|
}
|
|
|
|
/// shortcut function to encode a `T: Encodable` into a Rlp `Vec<u8>`
|
|
fn encode<E>(object: &E) -> Vec<u8> where E: Encodable {
|
|
let mut encoder = BasicEncoder::new();
|
|
object.encode(&mut encoder);
|
|
encoder.out()
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub enum EncoderError {
|
|
StreamIsUnfinished
|
|
}
|
|
|
|
impl StdError for EncoderError {
|
|
fn description(&self) -> &str { "encoder error" }
|
|
}
|
|
|
|
impl fmt::Display for EncoderError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
fmt::Debug::fmt(&self, f)
|
|
}
|
|
}
|
|
|
|
pub trait Encodable {
|
|
fn encode<E>(&self, encoder: &mut E) -> () where E: Encoder;
|
|
}
|
|
|
|
pub trait Encoder {
|
|
fn emit_value(&mut self, bytes: &[u8]) -> ();
|
|
fn emit_list<F>(&mut self, f: F) -> () where F: FnOnce(&mut Self) -> ();
|
|
}
|
|
|
|
impl <T> Encodable for T where T: ToBytes {
|
|
fn encode<E>(&self, encoder: &mut E) -> () where E: Encoder {
|
|
encoder.emit_value(&self.to_bytes())
|
|
}
|
|
}
|
|
|
|
impl <'a, T> Encodable for &'a [T] where T: Encodable + 'a {
|
|
fn encode<E>(&self, encoder: &mut E) -> () where E: Encoder {
|
|
encoder.emit_list(|e| {
|
|
// insert all list elements
|
|
for el in self.iter() {
|
|
el.encode(e);
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
impl <T> Encodable for Vec<T> where T: Encodable {
|
|
fn encode<E>(&self, encoder: &mut E) -> () where E: Encoder {
|
|
let r: &[T] = self.as_ref();
|
|
r.encode(encoder)
|
|
}
|
|
}
|
|
|
|
struct BasicEncoder {
|
|
bytes: Vec<u8>
|
|
}
|
|
|
|
impl BasicEncoder {
|
|
fn new() -> BasicEncoder {
|
|
BasicEncoder { bytes: vec![] }
|
|
}
|
|
|
|
/// inserts list prefix at given position
|
|
fn insert_list_len_at_pos(&mut self, len: usize, pos: usize) -> () {
|
|
// new bytes
|
|
let mut res: Vec<u8> = vec![];
|
|
{
|
|
let (before_slice, after_slice) = self.bytes.split_at(pos);
|
|
res.extend(before_slice);
|
|
|
|
match len {
|
|
0...55 => res.push(0xc0u8 + len as u8),
|
|
_ => {
|
|
res.push(0x7fu8 + len.to_bytes_len() as u8);
|
|
res.extend(len.to_bytes());
|
|
}
|
|
};
|
|
|
|
res.extend(after_slice);
|
|
}
|
|
self.bytes = res;
|
|
}
|
|
|
|
/// get encoded value
|
|
fn out(self) -> Vec<u8> {
|
|
self.bytes
|
|
}
|
|
}
|
|
|
|
impl Encoder for BasicEncoder {
|
|
fn emit_value(&mut self, bytes: &[u8]) -> () {
|
|
match bytes.len() {
|
|
// just 0
|
|
0 => self.bytes.push(0x80u8),
|
|
// byte is its own encoding
|
|
1 if bytes[0] < 0x80 => self.bytes.extend(bytes),
|
|
// (prefix + length), followed by the string
|
|
len @ 1 ... 55 => {
|
|
self.bytes.push(0x80u8 + len as u8);
|
|
self.bytes.extend(bytes);
|
|
}
|
|
// (prefix + length of length), followed by the length, followd by the string
|
|
len => {
|
|
self.bytes.push(0xb7 + len.to_bytes_len() as u8);
|
|
self.bytes.extend(len.to_bytes());
|
|
self.bytes.extend(bytes);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn emit_list<F>(&mut self, f: F) -> () where F: FnOnce(&mut Self) -> () {
|
|
// get len before inserting an list
|
|
let before_len = self.bytes.len();
|
|
|
|
// insert all list elements
|
|
f(self);
|
|
|
|
// get len after inserting an list
|
|
let after_len = self.bytes.len();
|
|
|
|
// diff is list len
|
|
let list_len = after_len - before_len;
|
|
self.insert_list_len_at_pos(list_len, before_len);
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use rlp;
|
|
use rlp::{Rlp, RlpStream};
|
|
|
|
#[test]
|
|
fn rlp_at() {
|
|
let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g'];
|
|
{
|
|
let rlp = Rlp::new(&data);
|
|
assert!(rlp.is_list());
|
|
|
|
let cat = rlp.at(0).unwrap();
|
|
assert!(cat.is_value());
|
|
assert_eq!(cat.bytes, &[0x83, b'c', b'a', b't']);
|
|
|
|
let dog = rlp.at(1).unwrap();
|
|
assert!(dog.is_value());
|
|
assert_eq!(dog.bytes, &[0x83, b'd', b'o', b'g']);
|
|
|
|
let cat_again = rlp.at(0).unwrap();
|
|
assert!(cat_again.is_value());
|
|
assert_eq!(cat_again.bytes, &[0x83, b'c', b'a', b't']);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn rlp_at_err() {
|
|
let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o'];
|
|
{
|
|
let rlp = Rlp::new(&data);
|
|
assert!(rlp.is_list());
|
|
|
|
let cat_err = rlp.at(0).unwrap_err();
|
|
assert_eq!(cat_err, rlp::DecoderError::RlpIsTooShort);
|
|
|
|
let dog_err = rlp.at(1).unwrap_err();
|
|
assert_eq!(dog_err, rlp::DecoderError::RlpIsTooShort);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn rlp_iter() {
|
|
let data = vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g'];
|
|
{
|
|
let rlp = Rlp::new(&data);
|
|
let mut iter = rlp.iter();
|
|
|
|
let cat = iter.next().unwrap();
|
|
assert!(cat.is_value());
|
|
assert_eq!(cat.bytes, &[0x83, b'c', b'a', b't']);
|
|
|
|
let dog = iter.next().unwrap();
|
|
assert!(dog.is_value());
|
|
assert_eq!(dog.bytes, &[0x83, b'd', b'o', b'g']);
|
|
|
|
let none = iter.next();
|
|
assert!(none.is_none());
|
|
|
|
let cat_again = rlp.at(0).unwrap();
|
|
assert!(cat_again.is_value());
|
|
assert_eq!(cat_again.bytes, &[0x83, b'c', b'a', b't']);
|
|
}
|
|
}
|
|
|
|
struct ETestPair<T>(T, Vec<u8>) where T: rlp::Encodable;
|
|
|
|
fn run_encode_tests<T>(tests: Vec<ETestPair<T>>) where T: rlp::Encodable {
|
|
for t in &tests {
|
|
let res = rlp::encode(&t.0);
|
|
assert_eq!(res, &t.1[..]);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn encode_u8() {
|
|
let tests = vec![
|
|
ETestPair(0u8, vec![0x80u8]),
|
|
ETestPair(15, vec![15]),
|
|
ETestPair(55, vec![55]),
|
|
ETestPair(56, vec![56]),
|
|
ETestPair(0x7f, vec![0x7f]),
|
|
ETestPair(0x80, vec![0x81, 0x80]),
|
|
ETestPair(0xff, vec![0x81, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_u16() {
|
|
let tests = vec![
|
|
ETestPair(0u16, vec![0x80u8]),
|
|
ETestPair(0x100, vec![0x82, 0x01, 0x00]),
|
|
ETestPair(0xffff, vec![0x82, 0xff, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_u32() {
|
|
let tests = vec![
|
|
ETestPair(0u32, vec![0x80u8]),
|
|
ETestPair(0x10000, vec![0x83, 0x01, 0x00, 0x00]),
|
|
ETestPair(0xffffff, vec![0x83, 0xff, 0xff, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_u64() {
|
|
let tests = vec![
|
|
ETestPair(0u64, vec![0x80u8]),
|
|
ETestPair(0x1000000, vec![0x84, 0x01, 0x00, 0x00, 0x00]),
|
|
ETestPair(0xFFFFFFFF, vec![0x84, 0xff, 0xff, 0xff, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_str() {
|
|
let tests = vec![
|
|
ETestPair("cat", vec![0x83, b'c', b'a', b't']),
|
|
ETestPair("dog", vec![0x83, b'd', b'o', b'g']),
|
|
ETestPair("Marek", vec![0x85, b'M', b'a', b'r', b'e', b'k']),
|
|
ETestPair("", vec![0x80]),
|
|
ETestPair("Lorem ipsum dolor sit amet, consectetur adipisicing elit",
|
|
vec![0xb8, 0x38, b'L', b'o', b'r', b'e', b'm', b' ', b'i',
|
|
b'p', b's', b'u', b'm', b' ', b'd', b'o', b'l', b'o', b'r',
|
|
b' ', b's', b'i', b't', b' ', b'a', b'm', b'e', b't', b',',
|
|
b' ', b'c', b'o', b'n', b's', b'e', b'c', b't', b'e', b't',
|
|
b'u', b'r', b' ', b'a', b'd', b'i', b'p', b'i', b's', b'i',
|
|
b'c', b'i', b'n', b'g', b' ', b'e', b'l', b'i', b't'])
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_vector_u8() {
|
|
let tests = vec![
|
|
ETestPair(vec![], vec![0xc0]),
|
|
ETestPair(vec![15u8], vec![0xc1, 0x0f]),
|
|
ETestPair(vec![1, 2, 3, 7, 0xff], vec![0xc6, 1, 2, 3, 7, 0x81, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_vector_u64() {
|
|
let tests = vec![
|
|
ETestPair(vec![], vec![0xc0]),
|
|
ETestPair(vec![15u64], vec![0xc1, 0x0f]),
|
|
ETestPair(vec![1, 2, 3, 7, 0xff], vec![0xc6, 1, 2, 3, 7, 0x81, 0xff]),
|
|
ETestPair(vec![0xffffffff, 1, 2, 3, 7, 0xff], vec![0xcb, 0x84, 0xff, 0xff, 0xff, 0xff, 1, 2, 3, 7, 0x81, 0xff]),
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_vector_str() {
|
|
let tests = vec![
|
|
ETestPair(vec!["cat", "dog"], vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g'])
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn encode_vector_of_vectors_str() {
|
|
let tests = vec![
|
|
ETestPair(vec![vec!["cat"]], vec![0xc5, 0xc4, 0x83, b'c', b'a', b't'])
|
|
];
|
|
run_encode_tests(tests);
|
|
}
|
|
|
|
#[test]
|
|
fn rlp_stream() {
|
|
let mut stream = RlpStream::new_list(2);
|
|
stream.append(&"cat").append(&"dog");
|
|
let out = stream.out().unwrap();
|
|
assert_eq!(out, vec![0xc8, 0x83, b'c', b'a', b't', 0x83, b'd', b'o', b'g']);
|
|
}
|
|
}
|
|
|