Implement coding shred generation (#5415)
* Implemenet coding shred generation * address review comments
This commit is contained in:
parent
dd4640e1ed
commit
c524d62ce0
|
@ -1,76 +1,55 @@
|
||||||
//! The `shred` module defines data structures and methods to pull MTU sized data frames from the network.
|
//! The `shred` module defines data structures and methods to pull MTU sized data frames from the network.
|
||||||
|
use crate::erasure::Session;
|
||||||
use bincode::serialized_size;
|
use bincode::serialized_size;
|
||||||
use core::borrow::BorrowMut;
|
use core::borrow::BorrowMut;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
use solana_sdk::packet::PACKET_DATA_SIZE;
|
||||||
use solana_sdk::signature::{Keypair, KeypairUtil, Signature};
|
use solana_sdk::signature::{Keypair, KeypairUtil, Signature};
|
||||||
use std::io::Write;
|
use std::io::Write;
|
||||||
use std::sync::{Arc, RwLock};
|
use std::sync::Arc;
|
||||||
use std::{cmp, io};
|
use std::{cmp, io};
|
||||||
|
|
||||||
pub type SharedShred = Arc<RwLock<SignedShred>>;
|
|
||||||
pub type SharedShreds = Vec<SharedShred>;
|
|
||||||
pub type Shreds = Vec<SignedShred>;
|
|
||||||
|
|
||||||
// Assume 1500 bytes MTU size
|
|
||||||
// (subtract 8 bytes of UDP header + 20 bytes ipv4 OR 40 bytes ipv6 header)
|
|
||||||
pub const MAX_DGRAM_SIZE: usize = (1500 - 48);
|
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
|
||||||
pub struct SignedShred {
|
|
||||||
pub signature: Signature,
|
|
||||||
pub shred: Shred,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SignedShred {
|
|
||||||
fn new(shred: Shred) -> Self {
|
|
||||||
SignedShred {
|
|
||||||
signature: Signature::default(),
|
|
||||||
shred,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn sign(&mut self, keypair: &Keypair) {
|
|
||||||
let data = bincode::serialize(&self.shred).expect("Failed to serialize shred");
|
|
||||||
self.signature = keypair.sign_message(&data);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
||||||
pub enum Shred {
|
pub enum Shred {
|
||||||
FirstInSlot(FirstDataShred),
|
FirstInSlot(FirstDataShred),
|
||||||
FirstInFECSet(DataShred),
|
FirstInFECSet(DataShred),
|
||||||
Data(DataShred),
|
Data(DataShred),
|
||||||
LastInFECSetData(DataShred),
|
LastInFECSet(DataShred),
|
||||||
LastInSlotData(DataShred),
|
LastInSlot(DataShred),
|
||||||
Coding(CodingShred),
|
Coding(CodingShred),
|
||||||
LastInFECSetCoding(CodingShred),
|
|
||||||
LastInSlotCoding(CodingShred),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A common header that is present at start of every shred
|
||||||
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
||||||
pub struct ShredCommonHeader {
|
pub struct ShredCommonHeader {
|
||||||
|
pub signature: Signature,
|
||||||
pub slot: u64,
|
pub slot: u64,
|
||||||
pub index: u32,
|
pub index: u32,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A common header that is present at start of every data shred
|
||||||
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
||||||
pub struct DataShredHeader {
|
pub struct DataShredHeader {
|
||||||
_reserved: CodingShredHeader,
|
_reserved: CodingShredHeader,
|
||||||
pub common_header: ShredCommonHeader,
|
pub common_header: ShredCommonHeader,
|
||||||
|
pub data_type: u8,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The first data shred also has parent slot value in it
|
||||||
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
||||||
pub struct FirstDataShredHeader {
|
pub struct FirstDataShredHeader {
|
||||||
pub data_header: DataShredHeader,
|
pub data_header: DataShredHeader,
|
||||||
pub parent: u64,
|
pub parent: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The coding shred header has FEC information
|
||||||
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, Default, PartialEq, Debug)]
|
||||||
pub struct CodingShredHeader {
|
pub struct CodingShredHeader {
|
||||||
pub common_header: ShredCommonHeader,
|
pub common_header: ShredCommonHeader,
|
||||||
pub num_data_shreds: u8,
|
pub num_data_shreds: u8,
|
||||||
pub num_coding_shreds: u8,
|
pub num_coding_shreds: u8,
|
||||||
pub position: u8,
|
pub position: u8,
|
||||||
|
pub payload: Vec<u8>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
||||||
|
@ -88,17 +67,13 @@ pub struct DataShred {
|
||||||
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
#[derive(Serialize, Deserialize, PartialEq, Debug)]
|
||||||
pub struct CodingShred {
|
pub struct CodingShred {
|
||||||
pub header: CodingShredHeader,
|
pub header: CodingShredHeader,
|
||||||
pub payload: Vec<u8>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Default shred is sized correctly to meet MTU/Packet size requirements
|
||||||
impl Default for FirstDataShred {
|
impl Default for FirstDataShred {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
let empty_shred = Shred::FirstInSlot(FirstDataShred {
|
let size = PACKET_DATA_SIZE
|
||||||
header: FirstDataShredHeader::default(),
|
- serialized_size(&Shred::FirstInSlot(Self::empty_shred())).unwrap() as usize;
|
||||||
payload: vec![],
|
|
||||||
});
|
|
||||||
let size =
|
|
||||||
MAX_DGRAM_SIZE - serialized_size(&SignedShred::new(empty_shred)).unwrap() as usize;
|
|
||||||
FirstDataShred {
|
FirstDataShred {
|
||||||
header: FirstDataShredHeader::default(),
|
header: FirstDataShredHeader::default(),
|
||||||
payload: vec![0; size],
|
payload: vec![0; size],
|
||||||
|
@ -106,14 +81,11 @@ impl Default for FirstDataShred {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Default shred is sized correctly to meet MTU/Packet size requirements
|
||||||
impl Default for DataShred {
|
impl Default for DataShred {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
let empty_shred = Shred::Data(DataShred {
|
|
||||||
header: DataShredHeader::default(),
|
|
||||||
payload: vec![],
|
|
||||||
});
|
|
||||||
let size =
|
let size =
|
||||||
MAX_DGRAM_SIZE - serialized_size(&SignedShred::new(empty_shred)).unwrap() as usize;
|
PACKET_DATA_SIZE - serialized_size(&Shred::Data(Self::empty_shred())).unwrap() as usize;
|
||||||
DataShred {
|
DataShred {
|
||||||
header: DataShredHeader::default(),
|
header: DataShredHeader::default(),
|
||||||
payload: vec![0; size],
|
payload: vec![0; size],
|
||||||
|
@ -121,64 +93,89 @@ impl Default for DataShred {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for CodingShred {
|
/// Common trait implemented by all types of shreds
|
||||||
fn default() -> Self {
|
pub trait ShredCommon {
|
||||||
let empty_shred = Shred::Coding(CodingShred {
|
/// Write at a particular offset in the shred
|
||||||
header: CodingShredHeader::default(),
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize;
|
||||||
|
/// Overhead of shred enum and headers
|
||||||
|
fn overhead() -> usize;
|
||||||
|
/// Utility function to create an empty shred
|
||||||
|
fn empty_shred() -> Self;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ShredCommon for FirstDataShred {
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
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![],
|
payload: vec![],
|
||||||
});
|
}
|
||||||
let size =
|
}
|
||||||
MAX_DGRAM_SIZE - serialized_size(&SignedShred::new(empty_shred)).unwrap() as usize;
|
}
|
||||||
|
|
||||||
|
impl ShredCommon for DataShred {
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
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![],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ShredCommon for CodingShred {
|
||||||
|
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize {
|
||||||
|
let slice_len = cmp::min(self.header.payload.len().saturating_sub(offset), buf.len());
|
||||||
|
if slice_len > 0 {
|
||||||
|
self.header.payload[offset..offset + slice_len].copy_from_slice(&buf[..slice_len]);
|
||||||
|
}
|
||||||
|
slice_len
|
||||||
|
}
|
||||||
|
|
||||||
|
fn overhead() -> usize {
|
||||||
|
bincode::serialized_size(&Shred::Coding(Self::empty_shred())).unwrap() as usize
|
||||||
|
}
|
||||||
|
|
||||||
|
fn empty_shred() -> Self {
|
||||||
CodingShred {
|
CodingShred {
|
||||||
header: CodingShredHeader::default(),
|
header: CodingShredHeader::default(),
|
||||||
payload: vec![0; size],
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait WriteAtOffset {
|
|
||||||
fn write_at(&mut self, offset: usize, buf: &[u8]) -> usize;
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WriteAtOffset for FirstDataShred {
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WriteAtOffset for DataShred {
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WriteAtOffset for CodingShred {
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
pub struct Shredder {
|
pub struct Shredder {
|
||||||
slot: u64,
|
slot: u64,
|
||||||
index: u32,
|
index: u32,
|
||||||
parent: Option<u64>,
|
parent: Option<u64>,
|
||||||
_fec_ratio: u64,
|
fec_rate: f32,
|
||||||
signer: Arc<Keypair>,
|
signer: Arc<Keypair>,
|
||||||
pub shreds: Shreds,
|
pub shreds: Vec<Vec<u8>>,
|
||||||
pub active_shred: Option<SignedShred>,
|
pub active_shred: Option<Shred>,
|
||||||
pub active_offset: usize,
|
pub active_offset: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -193,34 +190,32 @@ impl Write for Shredder {
|
||||||
.take()
|
.take()
|
||||||
.map(|parent| {
|
.map(|parent| {
|
||||||
// If parent slot is provided, assume it's first shred in slot
|
// If parent slot is provided, assume it's first shred in slot
|
||||||
SignedShred::new(Shred::FirstInSlot(self.new_first_shred(parent)))
|
Shred::FirstInSlot(self.new_first_shred(parent))
|
||||||
})
|
})
|
||||||
.unwrap_or_else(||
|
.unwrap_or_else(||
|
||||||
// If parent slot is not provided, and since there's no existing shred,
|
// If parent slot is not provided, and since there's no existing shred,
|
||||||
// assume it's first shred in FEC block
|
// assume it's first shred in FEC block
|
||||||
SignedShred::new(Shred::FirstInFECSet(self.new_data_shred()))),
|
Shred::FirstInFECSet(self.new_data_shred())),
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
let written = self.active_offset;
|
let written = self.active_offset;
|
||||||
let slice_len = match current_shred.shred.borrow_mut() {
|
let slice_len = match current_shred.borrow_mut() {
|
||||||
Shred::FirstInSlot(s) => s.write_at(written, buf),
|
Shred::FirstInSlot(s) => s.write_at(written, buf),
|
||||||
Shred::FirstInFECSet(s) => s.write_at(written, buf),
|
Shred::FirstInFECSet(s)
|
||||||
Shred::Data(s) => s.write_at(written, buf),
|
| Shred::Data(s)
|
||||||
Shred::LastInFECSetData(s) => s.write_at(written, buf),
|
| Shred::LastInFECSet(s)
|
||||||
Shred::LastInSlotData(s) => s.write_at(written, buf),
|
| Shred::LastInSlot(s) => s.write_at(written, buf),
|
||||||
Shred::Coding(s) => s.write_at(written, buf),
|
Shred::Coding(s) => s.write_at(written, buf),
|
||||||
Shred::LastInFECSetCoding(s) => s.write_at(written, buf),
|
|
||||||
Shred::LastInSlotCoding(s) => s.write_at(written, buf),
|
|
||||||
};
|
};
|
||||||
|
|
||||||
let active_shred = if buf.len() > slice_len {
|
let active_shred = if buf.len() > slice_len {
|
||||||
self.finalize_shred(current_shred);
|
self.finalize_data_shred(current_shred);
|
||||||
// Continue generating more data shreds.
|
// Continue generating more data shreds.
|
||||||
// If the caller decides to finalize the FEC block or Slot, the data shred will
|
// If the caller decides to finalize the FEC block or Slot, the data shred will
|
||||||
// morph into appropriate shred accordingly
|
// morph into appropriate shred accordingly
|
||||||
SignedShred::new(Shred::Data(DataShred::default()))
|
Shred::Data(DataShred::default())
|
||||||
} else {
|
} else {
|
||||||
self.active_offset += slice_len;
|
self.active_offset += slice_len;
|
||||||
current_shred
|
current_shred
|
||||||
|
@ -236,7 +231,7 @@ impl Write for Shredder {
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
let current_shred = self.active_shred.take().unwrap();
|
let current_shred = self.active_shred.take().unwrap();
|
||||||
self.finalize_shred(current_shred);
|
self.finalize_data_shred(current_shred);
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -245,7 +240,7 @@ impl Shredder {
|
||||||
pub fn new(
|
pub fn new(
|
||||||
slot: u64,
|
slot: u64,
|
||||||
parent: Option<u64>,
|
parent: Option<u64>,
|
||||||
fec_ratio: u64,
|
fec_rate: f32,
|
||||||
signer: &Arc<Keypair>,
|
signer: &Arc<Keypair>,
|
||||||
index: u32,
|
index: u32,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
|
@ -253,27 +248,42 @@ impl Shredder {
|
||||||
slot,
|
slot,
|
||||||
index,
|
index,
|
||||||
parent,
|
parent,
|
||||||
_fec_ratio: fec_ratio,
|
fec_rate,
|
||||||
signer: signer.clone(),
|
signer: signer.clone(),
|
||||||
..Shredder::default()
|
..Shredder::default()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn finalize_shred(&mut self, mut shred: SignedShred) {
|
/// Serialize the payload, sign it and store the signature in the shred
|
||||||
shred.sign(&self.signer);
|
/// 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);
|
||||||
self.shreds.push(shred);
|
self.shreds.push(shred);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 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());
|
||||||
self.active_offset = 0;
|
self.active_offset = 0;
|
||||||
self.index += 1;
|
self.index += 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_data_shred(&self) -> DataShred {
|
/// Creates a new data shred
|
||||||
|
fn new_data_shred(&self) -> DataShred {
|
||||||
let mut data_shred = DataShred::default();
|
let mut data_shred = DataShred::default();
|
||||||
data_shred.header.common_header.slot = self.slot;
|
data_shred.header.common_header.slot = self.slot;
|
||||||
data_shred.header.common_header.index = self.index;
|
data_shred.header.common_header.index = self.index;
|
||||||
data_shred
|
data_shred
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_first_shred(&self, parent: u64) -> FirstDataShred {
|
/// Create a new data shred that's also first in the slot
|
||||||
|
fn new_first_shred(&self, parent: u64) -> FirstDataShred {
|
||||||
let mut first_shred = FirstDataShred::default();
|
let mut first_shred = FirstDataShred::default();
|
||||||
first_shred.header.parent = parent;
|
first_shred.header.parent = parent;
|
||||||
first_shred.header.data_header.common_header.slot = self.slot;
|
first_shred.header.data_header.common_header.slot = self.slot;
|
||||||
|
@ -281,34 +291,99 @@ impl Shredder {
|
||||||
first_shred
|
first_shred
|
||||||
}
|
}
|
||||||
|
|
||||||
fn make_final_data_shred(&mut self) -> DataShred {
|
/// Generates coding shreds for the data shreds in the current FEC set
|
||||||
self.active_shred
|
fn generate_coding_shreds(&mut self) {
|
||||||
.take()
|
if self.fec_rate != 0.0 {
|
||||||
.map_or(self.new_data_shred(), |current_shred| {
|
let num_data = self.shreds.len();
|
||||||
match current_shred.shred {
|
let num_coding = (self.fec_rate * num_data as f32) as usize;
|
||||||
Shred::FirstInSlot(s) => {
|
let session =
|
||||||
self.finalize_shred(SignedShred::new(Shred::FirstInSlot(s)));
|
Session::new(num_data, num_coding).expect("Failed to create erasure session");
|
||||||
self.new_data_shred()
|
let start_index = self.index - num_data as u32;
|
||||||
}
|
|
||||||
Shred::FirstInFECSet(s) => s,
|
// All information after "reserved" field (coding shred header) in a data shred is encoded
|
||||||
Shred::Data(s) => s,
|
let coding_block_offset = CodingShred::overhead();
|
||||||
Shred::LastInFECSetData(s) => s,
|
let data_ptrs: Vec<_> = self
|
||||||
Shred::LastInSlotData(s) => s,
|
.shreds
|
||||||
Shred::Coding(_) => self.new_data_shred(),
|
.iter()
|
||||||
Shred::LastInFECSetCoding(_) => self.new_data_shred(),
|
.map(|data| &data[coding_block_offset..])
|
||||||
Shred::LastInSlotCoding(_) => self.new_data_shred(),
|
.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
|
||||||
|
fn make_final_data_shred(&mut self) -> DataShred {
|
||||||
|
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()
|
||||||
|
}
|
||||||
|
Shred::FirstInFECSet(s)
|
||||||
|
| Shred::Data(s)
|
||||||
|
| Shred::LastInFECSet(s)
|
||||||
|
| Shred::LastInSlot(s) => s,
|
||||||
|
Shred::Coding(_) => self.new_data_shred(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Finalize the current FEC block, and generate coding shreds
|
||||||
pub fn finalize_fec_block(&mut self) {
|
pub fn finalize_fec_block(&mut self) {
|
||||||
let final_shred = self.make_final_data_shred();
|
let final_shred = self.make_final_data_shred();
|
||||||
self.finalize_shred(SignedShred::new(Shred::LastInFECSetData(final_shred)));
|
self.finalize_data_shred(Shred::LastInFECSet(final_shred));
|
||||||
|
self.generate_coding_shreds();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Finalize the current slot (i.e. add last slot shred) and generate coding shreds
|
||||||
pub fn finalize_slot(&mut self) {
|
pub fn finalize_slot(&mut self) {
|
||||||
let final_shred = self.make_final_data_shred();
|
let final_shred = self.make_final_data_shred();
|
||||||
self.finalize_shred(SignedShred::new(Shred::LastInSlotData(final_shred)));
|
self.finalize_data_shred(Shred::LastInSlot(final_shred));
|
||||||
|
self.generate_coding_shreds();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -319,7 +394,7 @@ mod tests {
|
||||||
#[test]
|
#[test]
|
||||||
fn test_data_shredder() {
|
fn test_data_shredder() {
|
||||||
let keypair = Arc::new(Keypair::new());
|
let keypair = Arc::new(Keypair::new());
|
||||||
let mut shredder = Shredder::new(0x123456789abcdef0, Some(5), 0, &keypair, 0);
|
let mut shredder = Shredder::new(0x123456789abcdef0, Some(5), 0.0, &keypair, 0);
|
||||||
|
|
||||||
assert!(shredder.shreds.is_empty());
|
assert!(shredder.shreds.is_empty());
|
||||||
assert_eq!(shredder.active_shred, None);
|
assert_eq!(shredder.active_shred, None);
|
||||||
|
@ -337,8 +412,8 @@ mod tests {
|
||||||
assert!(shredder.shreds.is_empty());
|
assert!(shredder.shreds.is_empty());
|
||||||
assert_eq!(shredder.active_offset, 50);
|
assert_eq!(shredder.active_offset, 50);
|
||||||
|
|
||||||
// Test2: Write enough data to create a shred (> MAX_DGRAM_SIZE)
|
// Test2: Write enough data to create a shred (> PACKET_DATA_SIZE)
|
||||||
let data: Vec<_> = (0..MAX_DGRAM_SIZE).collect();
|
let data: Vec<_> = (0..PACKET_DATA_SIZE).collect();
|
||||||
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
||||||
let offset = shredder.write(&data).unwrap();
|
let offset = shredder.write(&data).unwrap();
|
||||||
assert_ne!(offset, data.len());
|
assert_ne!(offset, data.len());
|
||||||
|
@ -349,23 +424,30 @@ mod tests {
|
||||||
// Assert that the new active shred was not populated
|
// Assert that the new active shred was not populated
|
||||||
assert_eq!(shredder.active_offset, 0);
|
assert_eq!(shredder.active_offset, 0);
|
||||||
|
|
||||||
|
let data_offset = CodingShred::overhead()
|
||||||
|
+ bincode::serialized_size(&Signature::default()).unwrap() as usize;
|
||||||
|
|
||||||
// Test3: Assert that the first shred in slot was created (since we gave a parent to shredder)
|
// Test3: Assert that the first shred in slot was created (since we gave a parent to shredder)
|
||||||
let shred = shredder.shreds.pop().unwrap();
|
let shred = shredder.shreds.pop().unwrap();
|
||||||
assert_matches!(shred.shred, Shred::FirstInSlot(_));
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
||||||
|
info!("Len: {}", shred.len());
|
||||||
let pdu = bincode::serialize(&shred).unwrap();
|
info!("{:?}", shred);
|
||||||
assert_eq!(pdu.len(), MAX_DGRAM_SIZE);
|
|
||||||
info!("Len: {}", pdu.len());
|
|
||||||
info!("{:?}", pdu);
|
|
||||||
|
|
||||||
// Test4: Try deserialize the PDU and assert that it matches the original shred
|
// Test4: Try deserialize the PDU and assert that it matches the original shred
|
||||||
let deserialized_shred: SignedShred =
|
let deserialized_shred: Shred =
|
||||||
bincode::deserialize(&pdu).expect("Failed in deserializing the PDU");
|
bincode::deserialize(&shred).expect("Failed in deserializing the PDU");
|
||||||
assert_eq!(shred, deserialized_shred);
|
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..]));
|
||||||
|
}
|
||||||
|
|
||||||
// Test5: Write left over data, and assert that a data shred is being created
|
// Test5: Write left over data, and assert that a data shred is being created
|
||||||
shredder.write(&data[offset..]).unwrap();
|
shredder.write(&data[offset..]).unwrap();
|
||||||
// assert_matches!(shredder.active_shred.unwrap().shred, Shred::Data(_));
|
|
||||||
|
|
||||||
// It shouldn't generate a signed shred
|
// It shouldn't generate a signed shred
|
||||||
assert!(shredder.shreds.is_empty());
|
assert!(shredder.shreds.is_empty());
|
||||||
|
@ -379,13 +461,21 @@ mod tests {
|
||||||
|
|
||||||
// Must be Last in FEC Set
|
// Must be Last in FEC Set
|
||||||
let shred = shredder.shreds.pop().unwrap();
|
let shred = shredder.shreds.pop().unwrap();
|
||||||
assert_matches!(shred.shred, Shred::LastInFECSetData(_));
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
||||||
let pdu = bincode::serialize(&shred).unwrap();
|
|
||||||
assert_eq!(pdu.len(), MAX_DGRAM_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..]));
|
||||||
|
}
|
||||||
|
|
||||||
// Test7: Let's write some more data to the shredder.
|
// Test7: Let's write some more data to the shredder.
|
||||||
// Now we should get a new FEC block
|
// Now we should get a new FEC block
|
||||||
let data: Vec<_> = (0..MAX_DGRAM_SIZE).collect();
|
let data: Vec<_> = (0..PACKET_DATA_SIZE).collect();
|
||||||
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
let data: Vec<u8> = data.iter().map(|x| *x as u8).collect();
|
||||||
let offset = shredder.write(&data).unwrap();
|
let offset = shredder.write(&data).unwrap();
|
||||||
assert_ne!(offset, data.len());
|
assert_ne!(offset, data.len());
|
||||||
|
@ -395,9 +485,17 @@ mod tests {
|
||||||
|
|
||||||
// Must be FirstInFECSet
|
// Must be FirstInFECSet
|
||||||
let shred = shredder.shreds.pop().unwrap();
|
let shred = shredder.shreds.pop().unwrap();
|
||||||
assert_matches!(shred.shred, Shred::FirstInFECSet(_));
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
||||||
let pdu = bincode::serialize(&shred).unwrap();
|
|
||||||
assert_eq!(pdu.len(), MAX_DGRAM_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..]));
|
||||||
|
}
|
||||||
|
|
||||||
// Test8: Write more data to generate an intermediate data shred
|
// Test8: Write more data to generate an intermediate data shred
|
||||||
let offset = shredder.write(&data).unwrap();
|
let offset = shredder.write(&data).unwrap();
|
||||||
|
@ -408,9 +506,17 @@ mod tests {
|
||||||
|
|
||||||
// Must be a Data shred
|
// Must be a Data shred
|
||||||
let shred = shredder.shreds.pop().unwrap();
|
let shred = shredder.shreds.pop().unwrap();
|
||||||
assert_matches!(shred.shred, Shred::Data(_));
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
||||||
let pdu = bincode::serialize(&shred).unwrap();
|
|
||||||
assert_eq!(pdu.len(), MAX_DGRAM_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..]));
|
||||||
|
}
|
||||||
|
|
||||||
// Test9: Write some data to shredder
|
// Test9: Write some data to shredder
|
||||||
let data: Vec<u8> = (0..25).collect();
|
let data: Vec<u8> = (0..25).collect();
|
||||||
|
@ -424,8 +530,120 @@ mod tests {
|
||||||
|
|
||||||
// Must be LastInSlot
|
// Must be LastInSlot
|
||||||
let shred = shredder.shreds.pop().unwrap();
|
let shred = shredder.shreds.pop().unwrap();
|
||||||
assert_matches!(shred.shred, Shred::LastInSlotData(_));
|
assert_eq!(shred.len(), PACKET_DATA_SIZE);
|
||||||
let pdu = bincode::serialize(&shred).unwrap();
|
|
||||||
assert_eq!(pdu.len(), MAX_DGRAM_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..]));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue