2019-08-02 15:53:42 -07:00
|
|
|
//! The `shred` module defines data structures and methods to pull MTU sized data frames from the network.
|
2019-08-05 16:32:34 -07:00
|
|
|
use crate::erasure::Session;
|
2019-08-02 15:53:42 -07:00
|
|
|
use bincode::serialized_size;
|
|
|
|
use core::borrow::BorrowMut;
|
|
|
|
use serde::{Deserialize, Serialize};
|
2019-08-05 16:32:34 -07:00
|
|
|
use solana_sdk::packet::PACKET_DATA_SIZE;
|
2019-08-02 15:53:42 -07:00
|
|
|
use solana_sdk::signature::{Keypair, KeypairUtil, Signature};
|
|
|
|
use std::io::Write;
|
2019-08-05 16:32:34 -07:00
|
|
|
use std::sync::Arc;
|
2019-08-02 15:53:42 -07:00
|
|
|
use std::{cmp, io};
|
|
|
|
|
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
|
|
pub enum Shred {
|
|
|
|
FirstInSlot(FirstDataShred),
|
|
|
|
FirstInFECSet(DataShred),
|
|
|
|
Data(DataShred),
|
2019-08-05 16:32:34 -07:00
|
|
|
LastInFECSet(DataShred),
|
|
|
|
LastInSlot(DataShred),
|
2019-08-02 15:53:42 -07:00
|
|
|
Coding(CodingShred),
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// A common header that is present at start of every shred
|
2019-08-02 15:53:42 -07:00
|
|
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
|
|
|
pub struct ShredCommonHeader {
|
2019-08-05 16:32:34 -07:00
|
|
|
pub signature: Signature,
|
2019-08-02 15:53:42 -07:00
|
|
|
pub slot: u64,
|
|
|
|
pub index: u32,
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// A common header that is present at start of every data shred
|
2019-08-02 15:53:42 -07:00
|
|
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
|
|
|
pub struct DataShredHeader {
|
|
|
|
_reserved: CodingShredHeader,
|
|
|
|
pub common_header: ShredCommonHeader,
|
2019-08-05 16:32:34 -07:00
|
|
|
pub data_type: u8,
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// The first data shred also has parent slot value in it
|
2019-08-02 15:53:42 -07:00
|
|
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
|
|
|
pub struct FirstDataShredHeader {
|
|
|
|
pub data_header: DataShredHeader,
|
|
|
|
pub parent: u64,
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// The coding shred header has FEC information
|
2019-08-02 15:53:42 -07:00
|
|
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
|
|
|
pub struct CodingShredHeader {
|
|
|
|
pub common_header: ShredCommonHeader,
|
|
|
|
pub num_data_shreds: u8,
|
|
|
|
pub num_coding_shreds: u8,
|
|
|
|
pub position: u8,
|
2019-08-05 16:32:34 -07:00
|
|
|
pub payload: Vec<u8>,
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
|
|
pub struct FirstDataShred {
|
|
|
|
pub header: FirstDataShredHeader,
|
|
|
|
pub payload: Vec<u8>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
|
|
pub struct DataShred {
|
|
|
|
pub header: DataShredHeader,
|
|
|
|
pub payload: Vec<u8>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
|
|
pub struct CodingShred {
|
|
|
|
pub header: CodingShredHeader,
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Default shred is sized correctly to meet MTU/Packet size requirements
|
2019-08-02 15:53:42 -07:00
|
|
|
impl Default for FirstDataShred {
|
|
|
|
fn default() -> Self {
|
2019-08-05 16:32:34 -07:00
|
|
|
let size = PACKET_DATA_SIZE
|
|
|
|
- serialized_size(&Shred::FirstInSlot(Self::empty_shred())).unwrap() as usize;
|
2019-08-02 15:53:42 -07:00
|
|
|
FirstDataShred {
|
|
|
|
header: FirstDataShredHeader::default(),
|
|
|
|
payload: vec![0; size],
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Default shred is sized correctly to meet MTU/Packet size requirements
|
2019-08-02 15:53:42 -07:00
|
|
|
impl Default for DataShred {
|
|
|
|
fn default() -> Self {
|
|
|
|
let size =
|
2019-08-05 16:32:34 -07:00
|
|
|
PACKET_DATA_SIZE - serialized_size(&Shred::Data(Self::empty_shred())).unwrap() as usize;
|
2019-08-02 15:53:42 -07:00
|
|
|
DataShred {
|
|
|
|
header: DataShredHeader::default(),
|
|
|
|
payload: vec![0; size],
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Common trait implemented by all types of shreds
|
|
|
|
pub trait ShredCommon {
|
|
|
|
/// Write at a particular offset in the shred
|
2019-08-02 15:53:42 -07:00
|
|
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize;
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Overhead of shred enum and headers
|
|
|
|
fn overhead() -> usize;
|
|
|
|
/// Utility function to create an empty shred
|
|
|
|
fn empty_shred() -> Self;
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
impl ShredCommon for FirstDataShred {
|
2019-08-02 15:53:42 -07:00
|
|
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize {
|
|
|
|
let slice_len = cmp::min(self.payload.len().saturating_sub(offset), buf.len());
|
|
|
|
if slice_len > 0 {
|
|
|
|
self.payload[offset..offset + slice_len].copy_from_slice(&buf[..slice_len]);
|
|
|
|
}
|
|
|
|
slice_len
|
|
|
|
}
|
2019-08-05 16:32:34 -07:00
|
|
|
|
|
|
|
fn overhead() -> usize {
|
|
|
|
(bincode::serialized_size(&Shred::FirstInSlot(Self::empty_shred())).unwrap()
|
|
|
|
- bincode::serialized_size(&vec![0u8; 0]).unwrap()) as usize
|
|
|
|
}
|
|
|
|
|
|
|
|
fn empty_shred() -> Self {
|
|
|
|
FirstDataShred {
|
|
|
|
header: FirstDataShredHeader::default(),
|
|
|
|
payload: vec![],
|
|
|
|
}
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
impl ShredCommon for DataShred {
|
2019-08-02 15:53:42 -07:00
|
|
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize {
|
|
|
|
let slice_len = cmp::min(self.payload.len().saturating_sub(offset), buf.len());
|
|
|
|
if slice_len > 0 {
|
|
|
|
self.payload[offset..offset + slice_len].copy_from_slice(&buf[..slice_len]);
|
|
|
|
}
|
|
|
|
slice_len
|
|
|
|
}
|
2019-08-05 16:32:34 -07:00
|
|
|
|
|
|
|
fn overhead() -> usize {
|
|
|
|
(bincode::serialized_size(&Shred::Data(Self::empty_shred())).unwrap()
|
|
|
|
- bincode::serialized_size(&vec![0u8; 0]).unwrap()) as usize
|
|
|
|
}
|
|
|
|
|
|
|
|
fn empty_shred() -> Self {
|
|
|
|
DataShred {
|
|
|
|
header: DataShredHeader::default(),
|
|
|
|
payload: vec![],
|
|
|
|
}
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
impl ShredCommon for CodingShred {
|
2019-08-02 15:53:42 -07:00
|
|
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize {
|
2019-08-05 16:32:34 -07:00
|
|
|
let slice_len = cmp::min(self.header.payload.len().saturating_sub(offset), buf.len());
|
2019-08-02 15:53:42 -07:00
|
|
|
if slice_len > 0 {
|
2019-08-05 16:32:34 -07:00
|
|
|
self.header.payload[offset..offset + slice_len].copy_from_slice(&buf[..slice_len]);
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
slice_len
|
|
|
|
}
|
2019-08-05 16:32:34 -07:00
|
|
|
|
|
|
|
fn overhead() -> usize {
|
|
|
|
bincode::serialized_size(&Shred::Coding(Self::empty_shred())).unwrap() as usize
|
|
|
|
}
|
|
|
|
|
|
|
|
fn empty_shred() -> Self {
|
|
|
|
CodingShred {
|
|
|
|
header: CodingShredHeader::default(),
|
|
|
|
}
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Default)]
|
|
|
|
pub struct Shredder {
|
|
|
|
slot: u64,
|
|
|
|
index: u32,
|
|
|
|
parent: Option<u64>,
|
2019-08-05 16:32:34 -07:00
|
|
|
fec_rate: f32,
|
2019-08-02 15:53:42 -07:00
|
|
|
signer: Arc<Keypair>,
|
2019-08-05 16:32:34 -07:00
|
|
|
pub shreds: Vec<Vec<u8>>,
|
|
|
|
pub active_shred: Option<Shred>,
|
2019-08-02 15:53:42 -07:00
|
|
|
pub active_offset: usize,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Write for Shredder {
|
|
|
|
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
|
|
|
|
let mut current_shred = self
|
|
|
|
.active_shred
|
|
|
|
.take()
|
|
|
|
.or_else(|| {
|
|
|
|
Some(
|
|
|
|
self.parent
|
|
|
|
.take()
|
|
|
|
.map(|parent| {
|
|
|
|
// If parent slot is provided, assume it's first shred in slot
|
2019-08-05 16:32:34 -07:00
|
|
|
Shred::FirstInSlot(self.new_first_shred(parent))
|
2019-08-02 15:53:42 -07:00
|
|
|
})
|
|
|
|
.unwrap_or_else(||
|
|
|
|
// If parent slot is not provided, and since there's no existing shred,
|
|
|
|
// assume it's first shred in FEC block
|
2019-08-05 16:32:34 -07:00
|
|
|
Shred::FirstInFECSet(self.new_data_shred())),
|
2019-08-02 15:53:42 -07:00
|
|
|
)
|
|
|
|
})
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
let written = self.active_offset;
|
2019-08-05 16:32:34 -07:00
|
|
|
let slice_len = match current_shred.borrow_mut() {
|
2019-08-02 15:53:42 -07:00
|
|
|
Shred::FirstInSlot(s) => s.write_at(written, buf),
|
2019-08-05 16:32:34 -07:00
|
|
|
Shred::FirstInFECSet(s)
|
|
|
|
| Shred::Data(s)
|
|
|
|
| Shred::LastInFECSet(s)
|
|
|
|
| Shred::LastInSlot(s) => s.write_at(written, buf),
|
2019-08-02 15:53:42 -07:00
|
|
|
Shred::Coding(s) => s.write_at(written, buf),
|
|
|
|
};
|
|
|
|
|
|
|
|
let active_shred = if buf.len() > slice_len {
|
2019-08-05 16:32:34 -07:00
|
|
|
self.finalize_data_shred(current_shred);
|
2019-08-02 15:53:42 -07:00
|
|
|
// Continue generating more data shreds.
|
|
|
|
// If the caller decides to finalize the FEC block or Slot, the data shred will
|
|
|
|
// morph into appropriate shred accordingly
|
2019-08-05 16:32:34 -07:00
|
|
|
Shred::Data(DataShred::default())
|
2019-08-02 15:53:42 -07:00
|
|
|
} else {
|
|
|
|
self.active_offset += slice_len;
|
|
|
|
current_shred
|
|
|
|
};
|
|
|
|
|
|
|
|
self.active_shred = Some(active_shred);
|
|
|
|
|
|
|
|
Ok(slice_len)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn flush(&mut self) -> io::Result<()> {
|
|
|
|
if self.active_shred.is_none() {
|
|
|
|
return Ok(());
|
|
|
|
}
|
|
|
|
let current_shred = self.active_shred.take().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
self.finalize_data_shred(current_shred);
|
2019-08-02 15:53:42 -07:00
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Shredder {
|
|
|
|
pub fn new(
|
|
|
|
slot: u64,
|
|
|
|
parent: Option<u64>,
|
2019-08-05 16:32:34 -07:00
|
|
|
fec_rate: f32,
|
2019-08-02 15:53:42 -07:00
|
|
|
signer: &Arc<Keypair>,
|
|
|
|
index: u32,
|
|
|
|
) -> Self {
|
|
|
|
Shredder {
|
|
|
|
slot,
|
|
|
|
index,
|
|
|
|
parent,
|
2019-08-05 16:32:34 -07:00
|
|
|
fec_rate,
|
2019-08-02 15:53:42 -07:00
|
|
|
signer: signer.clone(),
|
|
|
|
..Shredder::default()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Serialize the payload, sign it and store the signature in the shred
|
|
|
|
/// Store the signed shred in the vector of shreds
|
|
|
|
fn finalize_shred(&mut self, mut shred: Vec<u8>, signature_offset: usize) {
|
|
|
|
let data_offset =
|
|
|
|
signature_offset + bincode::serialized_size(&Signature::default()).unwrap() as usize;
|
|
|
|
let signature = bincode::serialize(&self.signer.sign_message(&shred[data_offset..]))
|
|
|
|
.expect("Failed to generate serialized signature");
|
|
|
|
shred[signature_offset..signature_offset + signature.len()].copy_from_slice(&signature);
|
2019-08-02 15:53:42 -07:00
|
|
|
self.shreds.push(shred);
|
2019-08-05 16:32:34 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Finalize a data shred. Update the shred index for the next shred
|
|
|
|
fn finalize_data_shred(&mut self, shred: Shred) {
|
|
|
|
let data = bincode::serialize(&shred).expect("Failed to serialize shred");
|
|
|
|
|
|
|
|
self.finalize_shred(data, CodingShred::overhead());
|
2019-08-02 15:53:42 -07:00
|
|
|
self.active_offset = 0;
|
|
|
|
self.index += 1;
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Creates a new data shred
|
|
|
|
fn new_data_shred(&self) -> DataShred {
|
2019-08-02 15:53:42 -07:00
|
|
|
let mut data_shred = DataShred::default();
|
|
|
|
data_shred.header.common_header.slot = self.slot;
|
|
|
|
data_shred.header.common_header.index = self.index;
|
|
|
|
data_shred
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Create a new data shred that's also first in the slot
|
|
|
|
fn new_first_shred(&self, parent: u64) -> FirstDataShred {
|
2019-08-02 15:53:42 -07:00
|
|
|
let mut first_shred = FirstDataShred::default();
|
|
|
|
first_shred.header.parent = parent;
|
|
|
|
first_shred.header.data_header.common_header.slot = self.slot;
|
|
|
|
first_shred.header.data_header.common_header.index = self.index;
|
|
|
|
first_shred
|
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Generates coding shreds for the data shreds in the current FEC set
|
|
|
|
fn generate_coding_shreds(&mut self) {
|
|
|
|
if self.fec_rate != 0.0 {
|
|
|
|
let num_data = self.shreds.len();
|
|
|
|
let num_coding = (self.fec_rate * num_data as f32) as usize;
|
|
|
|
let session =
|
|
|
|
Session::new(num_data, num_coding).expect("Failed to create erasure session");
|
|
|
|
let start_index = self.index - num_data as u32;
|
|
|
|
|
|
|
|
// All information after "reserved" field (coding shred header) in a data shred is encoded
|
|
|
|
let coding_block_offset = CodingShred::overhead();
|
|
|
|
let data_ptrs: Vec<_> = self
|
|
|
|
.shreds
|
|
|
|
.iter()
|
|
|
|
.map(|data| &data[coding_block_offset..])
|
|
|
|
.collect();
|
|
|
|
|
|
|
|
// Create empty coding shreds, with correctly populated headers
|
|
|
|
let mut coding_shreds = Vec::with_capacity(num_coding);
|
|
|
|
(0..num_coding).for_each(|i| {
|
|
|
|
let header = CodingShredHeader {
|
|
|
|
common_header: ShredCommonHeader {
|
|
|
|
signature: Signature::default(),
|
|
|
|
slot: self.slot,
|
|
|
|
index: start_index + i as u32,
|
|
|
|
},
|
|
|
|
num_data_shreds: num_data as u8,
|
|
|
|
num_coding_shreds: num_coding as u8,
|
|
|
|
position: i as u8,
|
|
|
|
payload: vec![],
|
|
|
|
};
|
|
|
|
|
|
|
|
let mut shred = bincode::serialize(&Shred::Coding(CodingShred { header })).unwrap();
|
|
|
|
shred.resize_with(PACKET_DATA_SIZE, || 0);
|
|
|
|
coding_shreds.push(shred);
|
|
|
|
});
|
|
|
|
|
|
|
|
// Grab pointers for the coding blocks
|
|
|
|
let mut coding_ptrs: Vec<_> = coding_shreds
|
|
|
|
.iter_mut()
|
|
|
|
.map(|buffer| &mut buffer[coding_block_offset..])
|
|
|
|
.collect();
|
|
|
|
|
|
|
|
// Create coding blocks
|
|
|
|
session
|
|
|
|
.encode(&data_ptrs, coding_ptrs.as_mut_slice())
|
|
|
|
.expect("Failed in erasure encode");
|
|
|
|
|
|
|
|
// Offset of coding shred header in the Coding Shred (i.e. overhead of enum variant)
|
|
|
|
let coding_header_offset = (serialized_size(&Shred::Coding(CodingShred::empty_shred()))
|
|
|
|
.unwrap()
|
|
|
|
- serialized_size(&CodingShred::empty_shred()).unwrap())
|
|
|
|
as usize;
|
|
|
|
|
|
|
|
// Finalize the coding blocks (sign and append to the shred list)
|
|
|
|
coding_shreds
|
|
|
|
.into_iter()
|
|
|
|
.for_each(|code| self.finalize_shred(code, coding_header_offset))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Create the final data shred for the current FEC set or slot
|
|
|
|
/// If there's an active data shred, morph it into the final shred
|
|
|
|
/// If the current active data shred is first in slot, finalize it and create a new shred
|
2019-08-02 15:53:42 -07:00
|
|
|
fn make_final_data_shred(&mut self) -> DataShred {
|
2019-08-05 16:32:34 -07:00
|
|
|
self.active_shred.take().map_or(
|
|
|
|
self.new_data_shred(),
|
|
|
|
|current_shred| match current_shred {
|
|
|
|
Shred::FirstInSlot(s) => {
|
|
|
|
self.finalize_data_shred(Shred::FirstInSlot(s));
|
|
|
|
self.new_data_shred()
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
2019-08-05 16:32:34 -07:00
|
|
|
Shred::FirstInFECSet(s)
|
|
|
|
| Shred::Data(s)
|
|
|
|
| Shred::LastInFECSet(s)
|
|
|
|
| Shred::LastInSlot(s) => s,
|
|
|
|
Shred::Coding(_) => self.new_data_shred(),
|
|
|
|
},
|
|
|
|
)
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Finalize the current FEC block, and generate coding shreds
|
2019-08-02 15:53:42 -07:00
|
|
|
pub fn finalize_fec_block(&mut self) {
|
|
|
|
let final_shred = self.make_final_data_shred();
|
2019-08-05 16:32:34 -07:00
|
|
|
self.finalize_data_shred(Shred::LastInFECSet(final_shred));
|
|
|
|
self.generate_coding_shreds();
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
/// Finalize the current slot (i.e. add last slot shred) and generate coding shreds
|
2019-08-02 15:53:42 -07:00
|
|
|
pub fn finalize_slot(&mut self) {
|
|
|
|
let final_shred = self.make_final_data_shred();
|
2019-08-05 16:32:34 -07:00
|
|
|
self.finalize_data_shred(Shred::LastInSlot(final_shred));
|
|
|
|
self.generate_coding_shreds();
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_data_shredder() {
|
|
|
|
let keypair = Arc::new(Keypair::new());
|
2019-08-05 16:32:34 -07:00
|
|
|
let mut shredder = Shredder::new(0x123456789abcdef0, Some(5), 0.0, &keypair, 0);
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
assert!(shredder.shreds.is_empty());
|
|
|
|
assert_eq!(shredder.active_shred, None);
|
|
|
|
assert_eq!(shredder.active_offset, 0);
|
|
|
|
|
|
|
|
// Test0: Write some data to shred. Not enough to create a signed shred
|
|
|
|
let data: Vec<u8> = (0..25).collect();
|
|
|
|
assert_eq!(shredder.write(&data).unwrap(), data.len());
|
|
|
|
assert!(shredder.shreds.is_empty());
|
|
|
|
assert_ne!(shredder.active_shred, None);
|
|
|
|
assert_eq!(shredder.active_offset, 25);
|
|
|
|
|
|
|
|
// Test1: Write some more data to shred. Not enough to create a signed shred
|
|
|
|
assert_eq!(shredder.write(&data).unwrap(), data.len());
|
|
|
|
assert!(shredder.shreds.is_empty());
|
|
|
|
assert_eq!(shredder.active_offset, 50);
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
// Test2: Write enough data to create a shred (> PACKET_DATA_SIZE)
|
|
|
|
let data: Vec<_> = (0..PACKET_DATA_SIZE).collect();
|
2019-08-02 15:53:42 -07:00
|
|
|
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
|
|
|
let offset = shredder.write(&data).unwrap();
|
|
|
|
assert_ne!(offset, data.len());
|
|
|
|
// Assert that we have atleast one signed shred
|
|
|
|
assert!(!shredder.shreds.is_empty());
|
|
|
|
// Assert that a new active shred was also created
|
|
|
|
assert_ne!(shredder.active_shred, None);
|
|
|
|
// Assert that the new active shred was not populated
|
|
|
|
assert_eq!(shredder.active_offset, 0);
|
|
|
|
|
2019-08-05 16:32:34 -07:00
|
|
|
let data_offset = CodingShred::overhead()
|
|
|
|
+ bincode::serialized_size(&Signature::default()).unwrap() as usize;
|
|
|
|
|
2019-08-02 15:53:42 -07:00
|
|
|
// Test3: Assert that the first shred in slot was created (since we gave a parent to shredder)
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
info!("Len: {}", shred.len());
|
|
|
|
info!("{:?}", shred);
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
// Test4: Try deserialize the PDU and assert that it matches the original shred
|
2019-08-05 16:32:34 -07:00
|
|
|
let deserialized_shred: Shred =
|
|
|
|
bincode::deserialize(&shred).expect("Failed in deserializing the PDU");
|
|
|
|
assert_matches!(deserialized_shred, Shred::FirstInSlot(_));
|
|
|
|
if let Shred::FirstInSlot(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.data_header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
// Test5: Write left over data, and assert that a data shred is being created
|
|
|
|
shredder.write(&data[offset..]).unwrap();
|
|
|
|
|
|
|
|
// It shouldn't generate a signed shred
|
|
|
|
assert!(shredder.shreds.is_empty());
|
|
|
|
|
|
|
|
// Test6: Let's finalize the FEC block. That should result in the current shred to morph into
|
|
|
|
// a signed LastInFECSetData shred
|
|
|
|
shredder.finalize_fec_block();
|
|
|
|
|
|
|
|
// We should have a new signed shred
|
|
|
|
assert!(!shredder.shreds.is_empty());
|
|
|
|
|
|
|
|
// Must be Last in FEC Set
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::LastInFECSet(_));
|
|
|
|
if let Shred::LastInFECSet(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
// Test7: Let's write some more data to the shredder.
|
|
|
|
// Now we should get a new FEC block
|
2019-08-05 16:32:34 -07:00
|
|
|
let data: Vec<_> = (0..PACKET_DATA_SIZE).collect();
|
2019-08-02 15:53:42 -07:00
|
|
|
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
|
|
|
let offset = shredder.write(&data).unwrap();
|
|
|
|
assert_ne!(offset, data.len());
|
|
|
|
|
|
|
|
// We should have a new signed shred
|
|
|
|
assert!(!shredder.shreds.is_empty());
|
|
|
|
|
|
|
|
// Must be FirstInFECSet
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::FirstInFECSet(_));
|
|
|
|
if let Shred::FirstInFECSet(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
// Test8: Write more data to generate an intermediate data shred
|
|
|
|
let offset = shredder.write(&data).unwrap();
|
|
|
|
assert_ne!(offset, data.len());
|
|
|
|
|
|
|
|
// We should have a new signed shred
|
|
|
|
assert!(!shredder.shreds.is_empty());
|
|
|
|
|
|
|
|
// Must be a Data shred
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::Data(_));
|
|
|
|
if let Shred::Data(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
|
|
|
|
// Test9: Write some data to shredder
|
|
|
|
let data: Vec<u8> = (0..25).collect();
|
|
|
|
assert_eq!(shredder.write(&data).unwrap(), data.len());
|
|
|
|
|
|
|
|
// And, finish the slot
|
|
|
|
shredder.finalize_slot();
|
|
|
|
|
|
|
|
// We should have a new signed shred
|
|
|
|
assert!(!shredder.shreds.is_empty());
|
|
|
|
|
|
|
|
// Must be LastInSlot
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
2019-08-05 16:32:34 -07:00
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::LastInSlot(_));
|
|
|
|
if let Shred::LastInSlot(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_data_and_code_shredder() {
|
|
|
|
let keypair = Arc::new(Keypair::new());
|
|
|
|
let mut shredder = Shredder::new(0x123456789abcdef0, Some(5), 1.0, &keypair, 0);
|
|
|
|
|
|
|
|
assert!(shredder.shreds.is_empty());
|
|
|
|
assert_eq!(shredder.active_shred, None);
|
|
|
|
assert_eq!(shredder.active_offset, 0);
|
|
|
|
|
|
|
|
// Write enough data to create a shred (> PACKET_DATA_SIZE)
|
|
|
|
let data: Vec<_> = (0..PACKET_DATA_SIZE).collect();
|
|
|
|
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
|
|
|
let _ = shredder.write(&data).unwrap();
|
|
|
|
let _ = shredder.write(&data).unwrap();
|
|
|
|
|
|
|
|
// We should have 2 shreds now
|
|
|
|
assert_eq!(shredder.shreds.len(), 2);
|
|
|
|
|
|
|
|
shredder.finalize_fec_block();
|
|
|
|
|
|
|
|
let data_offset = CodingShred::overhead()
|
|
|
|
+ bincode::serialized_size(&Signature::default()).unwrap() as usize;
|
|
|
|
|
|
|
|
// Finalize must have created 1 final data shred and 3 coding shreds
|
|
|
|
// assert_eq!(shredder.shreds.len(), 6);
|
|
|
|
let shred = shredder.shreds.remove(0);
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::FirstInSlot(_));
|
|
|
|
if let Shred::FirstInSlot(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.data_header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
|
|
|
|
|
|
|
let shred = shredder.shreds.remove(0);
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::Data(_));
|
|
|
|
if let Shred::Data(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
|
|
|
|
|
|
|
let shred = shredder.shreds.remove(0);
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::LastInFECSet(_));
|
|
|
|
if let Shred::LastInFECSet(data) = deserialized_shred {
|
|
|
|
assert!(data
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[data_offset..]));
|
|
|
|
}
|
|
|
|
|
|
|
|
let coding_data_offset =
|
|
|
|
(serialized_size(&Shred::Coding(CodingShred::empty_shred())).unwrap()
|
|
|
|
- serialized_size(&CodingShred::empty_shred()).unwrap()
|
|
|
|
+ serialized_size(&Signature::default()).unwrap()) as usize as usize;
|
|
|
|
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::Coding(_));
|
|
|
|
if let Shred::Coding(code) = deserialized_shred {
|
|
|
|
assert!(code
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[coding_data_offset..]));
|
|
|
|
}
|
|
|
|
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::Coding(_));
|
|
|
|
if let Shred::Coding(code) = deserialized_shred {
|
|
|
|
assert!(code
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[coding_data_offset..]));
|
|
|
|
}
|
|
|
|
|
|
|
|
let shred = shredder.shreds.pop().unwrap();
|
|
|
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
|
|
|
let deserialized_shred: Shred = bincode::deserialize(&shred).unwrap();
|
|
|
|
assert_matches!(deserialized_shred, Shred::Coding(_));
|
|
|
|
if let Shred::Coding(code) = deserialized_shred {
|
|
|
|
assert!(code
|
|
|
|
.header
|
|
|
|
.common_header
|
|
|
|
.signature
|
|
|
|
.verify(keypair.pubkey().as_ref(), &shred[coding_data_offset..]));
|
|
|
|
}
|
2019-08-02 15:53:42 -07:00
|
|
|
}
|
|
|
|
}
|