525 lines
17 KiB
Rust
525 lines
17 KiB
Rust
//! The `window` module defines data structure for storing the tail of the ledger.
|
|
//!
|
|
use counter::Counter;
|
|
use crdt::{Crdt, NodeInfo};
|
|
use entry::Entry;
|
|
#[cfg(feature = "erasure")]
|
|
use erasure;
|
|
use ledger::Block;
|
|
use log::Level;
|
|
use packet::{BlobRecycler, SharedBlob, SharedBlobs};
|
|
use result::Result;
|
|
use signature::Pubkey;
|
|
use std::cmp;
|
|
use std::mem;
|
|
use std::net::SocketAddr;
|
|
use std::sync::atomic::AtomicUsize;
|
|
use std::sync::{Arc, RwLock};
|
|
|
|
pub const WINDOW_SIZE: u64 = 2 * 1024;
|
|
|
|
#[derive(Clone, Default)]
|
|
pub struct WindowSlot {
|
|
pub data: Option<SharedBlob>,
|
|
pub coding: Option<SharedBlob>,
|
|
pub leader_unknown: bool,
|
|
}
|
|
|
|
impl WindowSlot {
|
|
fn blob_index(&self) -> Option<u64> {
|
|
match self.data {
|
|
Some(ref blob) => blob.read().unwrap().get_index().ok(),
|
|
None => None,
|
|
}
|
|
}
|
|
|
|
fn clear_data(&mut self, recycler: &BlobRecycler) {
|
|
if let Some(blob) = self.data.take() {
|
|
recycler.recycle(blob, "WindowSlot::clear_data");
|
|
}
|
|
}
|
|
}
|
|
|
|
type Window = Vec<WindowSlot>;
|
|
pub type SharedWindow = Arc<RwLock<Window>>;
|
|
|
|
#[derive(Debug)]
|
|
pub struct WindowIndex {
|
|
pub data: u64,
|
|
pub coding: u64,
|
|
}
|
|
|
|
pub trait WindowUtil {
|
|
/// Finds available slots, clears them, and returns their indices.
|
|
fn clear_slots(&mut self, recycler: &BlobRecycler, consumed: u64, received: u64) -> Vec<u64>;
|
|
|
|
fn repair(
|
|
&mut self,
|
|
crdt: &Arc<RwLock<Crdt>>,
|
|
recycler: &BlobRecycler,
|
|
id: &Pubkey,
|
|
times: usize,
|
|
consumed: u64,
|
|
received: u64,
|
|
) -> Vec<(SocketAddr, Vec<u8>)>;
|
|
|
|
fn print(&self, id: &Pubkey, consumed: u64) -> String;
|
|
|
|
fn process_blob(
|
|
&mut self,
|
|
id: &Pubkey,
|
|
blob: SharedBlob,
|
|
pix: u64,
|
|
consume_queue: &mut SharedBlobs,
|
|
recycler: &BlobRecycler,
|
|
consumed: &mut u64,
|
|
leader_unknown: bool,
|
|
pending_retransmits: &mut bool,
|
|
);
|
|
}
|
|
|
|
impl WindowUtil for Window {
|
|
fn clear_slots(&mut self, recycler: &BlobRecycler, consumed: u64, received: u64) -> Vec<u64> {
|
|
(consumed..received)
|
|
.filter_map(|pix| {
|
|
let i = (pix % WINDOW_SIZE) as usize;
|
|
if let Some(blob_idx) = self[i].blob_index() {
|
|
if blob_idx == pix {
|
|
return None;
|
|
}
|
|
}
|
|
self[i].clear_data(recycler);
|
|
Some(pix)
|
|
}).collect()
|
|
}
|
|
|
|
fn repair(
|
|
&mut self,
|
|
crdt: &Arc<RwLock<Crdt>>,
|
|
recycler: &BlobRecycler,
|
|
id: &Pubkey,
|
|
times: usize,
|
|
consumed: u64,
|
|
received: u64,
|
|
) -> Vec<(SocketAddr, Vec<u8>)> {
|
|
let num_peers = crdt.read().unwrap().table.len() as u64;
|
|
let highest_lost = calculate_highest_lost_blob_index(num_peers, consumed, received);
|
|
|
|
let idxs = self.clear_slots(recycler, consumed, highest_lost);
|
|
let reqs: Vec<_> = idxs
|
|
.into_iter()
|
|
.filter_map(|pix| crdt.read().unwrap().window_index_request(pix).ok())
|
|
.collect();
|
|
|
|
inc_new_counter_info!("streamer-repair_window-repair", reqs.len());
|
|
if log_enabled!(Level::Trace) {
|
|
trace!(
|
|
"{}: repair_window counter times: {} consumed: {} highest_lost: {} missing: {}",
|
|
id,
|
|
times,
|
|
consumed,
|
|
highest_lost,
|
|
reqs.len()
|
|
);
|
|
|
|
for (to, _) in &reqs {
|
|
trace!("{}: repair_window request to {}", id, to);
|
|
}
|
|
}
|
|
reqs
|
|
}
|
|
|
|
fn print(&self, id: &Pubkey, consumed: u64) -> String {
|
|
let pointer: Vec<_> = self
|
|
.iter()
|
|
.enumerate()
|
|
.map(|(i, _v)| {
|
|
if i == (consumed % WINDOW_SIZE) as usize {
|
|
"V"
|
|
} else {
|
|
" "
|
|
}
|
|
}).collect();
|
|
|
|
let buf: Vec<_> = self
|
|
.iter()
|
|
.map(|v| {
|
|
if v.data.is_none() && v.coding.is_none() {
|
|
"O"
|
|
} else if v.data.is_some() && v.coding.is_some() {
|
|
"D"
|
|
} else if v.data.is_some() {
|
|
// coding.is_none()
|
|
"d"
|
|
} else {
|
|
// data.is_none()
|
|
"c"
|
|
}
|
|
}).collect();
|
|
format!(
|
|
"\n{}: WINDOW ({}): {}\n{}: WINDOW ({}): {}",
|
|
id,
|
|
consumed,
|
|
pointer.join(""),
|
|
id,
|
|
consumed,
|
|
buf.join("")
|
|
)
|
|
}
|
|
|
|
/// process a blob: Add blob to the window. If a continuous set of blobs
|
|
/// starting from consumed is thereby formed, add that continuous
|
|
/// range of blobs to a queue to be sent on to the next stage.
|
|
///
|
|
/// * `self` - the window we're operating on
|
|
/// * `id` - this node's id
|
|
/// * `blob` - the blob to be processed into the window and rebroadcast
|
|
/// * `pix` - the index of the blob, corresponds to
|
|
/// the entry height of this blob
|
|
/// * `consume_queue` - output, blobs to be rebroadcast are placed here
|
|
/// * `recycler` - where to return the blob once processed, also where
|
|
/// to return old blobs from the window
|
|
/// * `consumed` - input/output, the entry-height to which this
|
|
/// node has populated and rebroadcast entries
|
|
fn process_blob(
|
|
&mut self,
|
|
id: &Pubkey,
|
|
blob: SharedBlob,
|
|
pix: u64,
|
|
consume_queue: &mut SharedBlobs,
|
|
recycler: &BlobRecycler,
|
|
consumed: &mut u64,
|
|
leader_unknown: bool,
|
|
pending_retransmits: &mut bool,
|
|
) {
|
|
let w = (pix % WINDOW_SIZE) as usize;
|
|
|
|
let is_coding = {
|
|
let blob_r = blob
|
|
.read()
|
|
.expect("blob read lock for flogs streamer::window");
|
|
blob_r.is_coding()
|
|
};
|
|
|
|
// insert a newly received blob into a window slot, clearing out and recycling any previous
|
|
// blob unless the incoming blob is a duplicate (based on idx)
|
|
// returns whether the incoming is a duplicate blob
|
|
fn insert_blob_is_dup(
|
|
id: &Pubkey,
|
|
blob: SharedBlob,
|
|
pix: u64,
|
|
window_slot: &mut Option<SharedBlob>,
|
|
recycler: &BlobRecycler,
|
|
c_or_d: &str,
|
|
) -> bool {
|
|
if let Some(old) = mem::replace(window_slot, Some(blob)) {
|
|
let is_dup = old.read().unwrap().get_index().unwrap() == pix;
|
|
recycler.recycle(old, "insert_blob_is_dup");
|
|
trace!(
|
|
"{}: occupied {} window slot {:}, is_dup: {}",
|
|
id,
|
|
c_or_d,
|
|
pix,
|
|
is_dup
|
|
);
|
|
is_dup
|
|
} else {
|
|
trace!("{}: empty {} window slot {:}", id, c_or_d, pix);
|
|
false
|
|
}
|
|
}
|
|
|
|
// insert the new blob into the window, overwrite and recycle old (or duplicate) entry
|
|
let is_duplicate = if is_coding {
|
|
insert_blob_is_dup(id, blob, pix, &mut self[w].coding, recycler, "coding")
|
|
} else {
|
|
insert_blob_is_dup(id, blob, pix, &mut self[w].data, recycler, "data")
|
|
};
|
|
|
|
if is_duplicate {
|
|
return;
|
|
}
|
|
|
|
self[w].leader_unknown = leader_unknown;
|
|
*pending_retransmits = true;
|
|
|
|
#[cfg(feature = "erasure")]
|
|
{
|
|
if erasure::recover(
|
|
id,
|
|
recycler,
|
|
self,
|
|
*consumed,
|
|
(*consumed % WINDOW_SIZE) as usize,
|
|
).is_err()
|
|
{
|
|
trace!("{}: erasure::recover failed", id);
|
|
}
|
|
}
|
|
|
|
// push all contiguous blobs into consumed queue, increment consumed
|
|
loop {
|
|
let k = (*consumed % WINDOW_SIZE) as usize;
|
|
trace!("{}: k: {} consumed: {}", id, k, *consumed,);
|
|
|
|
if let Some(blob) = &self[k].data {
|
|
if blob.read().unwrap().get_index().unwrap() < *consumed {
|
|
// window wrap-around, end of received
|
|
break;
|
|
}
|
|
} else {
|
|
// self[k].data is None, end of received
|
|
break;
|
|
}
|
|
consume_queue.push(self[k].data.clone().expect("clone in fn recv_window"));
|
|
*consumed += 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
fn calculate_highest_lost_blob_index(num_peers: u64, consumed: u64, received: u64) -> u64 {
|
|
// Calculate the highest blob index that this node should have already received
|
|
// via avalanche. The avalanche splits data stream into nodes and each node retransmits
|
|
// the data to their peer nodes. So there's a possibility that a blob (with index lower
|
|
// than current received index) is being retransmitted by a peer node.
|
|
let highest_lost = cmp::max(consumed, received.saturating_sub(num_peers));
|
|
|
|
// This check prevents repairing a blob that will cause window to roll over. Even if
|
|
// the highes_lost blob is actually missing, asking to repair it might cause our
|
|
// current window to move past other missing blobs
|
|
cmp::min(consumed + WINDOW_SIZE - 1, highest_lost)
|
|
}
|
|
|
|
pub fn blob_idx_in_window(id: &Pubkey, pix: u64, consumed: u64, received: &mut u64) -> bool {
|
|
// Prevent receive window from running over
|
|
// Got a blob which has already been consumed, skip it
|
|
// probably from a repair window request
|
|
if pix < consumed {
|
|
trace!(
|
|
"{}: received: {} but older than consumed: {} skipping..",
|
|
id,
|
|
pix,
|
|
consumed
|
|
);
|
|
false
|
|
} else {
|
|
// received always has to be updated even if we don't accept the packet into
|
|
// the window. The worst case here is the server *starts* outside
|
|
// the window, none of the packets it receives fits in the window
|
|
// and repair requests (which are based on received) are never generated
|
|
*received = cmp::max(pix, *received);
|
|
|
|
if pix >= consumed + WINDOW_SIZE {
|
|
trace!(
|
|
"{}: received: {} will overrun window: {} skipping..",
|
|
id,
|
|
pix,
|
|
consumed + WINDOW_SIZE
|
|
);
|
|
false
|
|
} else {
|
|
true
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn default_window() -> Window {
|
|
vec![WindowSlot::default(); WINDOW_SIZE as usize]
|
|
}
|
|
|
|
pub fn index_blobs(
|
|
node_info: &NodeInfo,
|
|
blobs: &[SharedBlob],
|
|
receive_index: &mut u64,
|
|
) -> Result<()> {
|
|
// enumerate all the blobs, those are the indices
|
|
trace!("{}: INDEX_BLOBS {}", node_info.id, blobs.len());
|
|
for (i, b) in blobs.iter().enumerate() {
|
|
// only leader should be broadcasting
|
|
let mut blob = b.write().expect("'blob' write lock in crdt::index_blobs");
|
|
blob.set_id(node_info.id)
|
|
.expect("set_id in pub fn broadcast");
|
|
blob.set_index(*receive_index + i as u64)
|
|
.expect("set_index in pub fn broadcast");
|
|
blob.set_flags(0).unwrap();
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Initialize a rebroadcast window with most recent Entry blobs
|
|
/// * `crdt` - gossip instance, used to set blob ids
|
|
/// * `blobs` - up to WINDOW_SIZE most recent blobs
|
|
/// * `entry_height` - current entry height
|
|
pub fn initialized_window(
|
|
node_info: &NodeInfo,
|
|
blobs: Vec<SharedBlob>,
|
|
entry_height: u64,
|
|
) -> Window {
|
|
let mut window = default_window();
|
|
let id = node_info.id;
|
|
|
|
trace!(
|
|
"{} initialized window entry_height:{} blobs_len:{}",
|
|
id,
|
|
entry_height,
|
|
blobs.len()
|
|
);
|
|
|
|
// Index the blobs
|
|
let mut received = entry_height - blobs.len() as u64;
|
|
index_blobs(&node_info, &blobs, &mut received).expect("index blobs for initial window");
|
|
|
|
// populate the window, offset by implied index
|
|
let diff = cmp::max(blobs.len() as isize - window.len() as isize, 0) as usize;
|
|
for b in blobs.into_iter().skip(diff) {
|
|
let ix = b.read().unwrap().get_index().expect("blob index");
|
|
let pos = (ix % WINDOW_SIZE) as usize;
|
|
trace!("{} caching {} at {}", id, ix, pos);
|
|
assert!(window[pos].data.is_none());
|
|
window[pos].data = Some(b);
|
|
}
|
|
|
|
window
|
|
}
|
|
|
|
pub fn new_window_from_entries(
|
|
ledger_tail: &[Entry],
|
|
entry_height: u64,
|
|
node_info: &NodeInfo,
|
|
blob_recycler: &BlobRecycler,
|
|
) -> Window {
|
|
// convert to blobs
|
|
let blobs = ledger_tail.to_blobs(&blob_recycler);
|
|
initialized_window(&node_info, blobs, entry_height)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use packet::{Blob, BlobRecycler, Packet, PacketRecycler, Packets, PACKET_DATA_SIZE};
|
|
use signature::Pubkey;
|
|
use std::io;
|
|
use std::io::Write;
|
|
use std::net::UdpSocket;
|
|
use std::sync::atomic::{AtomicBool, Ordering};
|
|
use std::sync::mpsc::channel;
|
|
use std::sync::Arc;
|
|
use std::time::Duration;
|
|
use streamer::{receiver, responder, PacketReceiver};
|
|
use window::{blob_idx_in_window, calculate_highest_lost_blob_index, WINDOW_SIZE};
|
|
|
|
fn get_msgs(r: PacketReceiver, num: &mut usize) {
|
|
for _t in 0..5 {
|
|
let timer = Duration::new(1, 0);
|
|
match r.recv_timeout(timer) {
|
|
Ok(m) => *num += m.read().unwrap().packets.len(),
|
|
e => info!("error {:?}", e),
|
|
}
|
|
if *num == 10 {
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
#[test]
|
|
pub fn streamer_debug() {
|
|
write!(io::sink(), "{:?}", Packet::default()).unwrap();
|
|
write!(io::sink(), "{:?}", Packets::default()).unwrap();
|
|
write!(io::sink(), "{:?}", Blob::default()).unwrap();
|
|
}
|
|
#[test]
|
|
pub fn streamer_send_test() {
|
|
let read = UdpSocket::bind("127.0.0.1:0").expect("bind");
|
|
read.set_read_timeout(Some(Duration::new(1, 0))).unwrap();
|
|
|
|
let addr = read.local_addr().unwrap();
|
|
let send = UdpSocket::bind("127.0.0.1:0").expect("bind");
|
|
let exit = Arc::new(AtomicBool::new(false));
|
|
let pack_recycler = PacketRecycler::default();
|
|
let resp_recycler = BlobRecycler::default();
|
|
let (s_reader, r_reader) = channel();
|
|
let t_receiver = receiver(
|
|
Arc::new(read),
|
|
exit.clone(),
|
|
pack_recycler.clone(),
|
|
s_reader,
|
|
);
|
|
let t_responder = {
|
|
let (s_responder, r_responder) = channel();
|
|
let t_responder = responder(
|
|
"streamer_send_test",
|
|
Arc::new(send),
|
|
resp_recycler.clone(),
|
|
r_responder,
|
|
);
|
|
let mut msgs = Vec::new();
|
|
for i in 0..10 {
|
|
let b = resp_recycler.allocate();
|
|
{
|
|
let mut w = b.write().unwrap();
|
|
w.data[0] = i as u8;
|
|
w.meta.size = PACKET_DATA_SIZE;
|
|
w.meta.set_addr(&addr);
|
|
}
|
|
msgs.push(b);
|
|
}
|
|
s_responder.send(msgs).expect("send");
|
|
t_responder
|
|
};
|
|
|
|
let mut num = 0;
|
|
get_msgs(r_reader, &mut num);
|
|
assert_eq!(num, 10);
|
|
exit.store(true, Ordering::Relaxed);
|
|
t_receiver.join().expect("join");
|
|
t_responder.join().expect("join");
|
|
}
|
|
|
|
#[test]
|
|
pub fn calculate_highest_lost_blob_index_test() {
|
|
assert_eq!(calculate_highest_lost_blob_index(0, 10, 90), 90);
|
|
assert_eq!(calculate_highest_lost_blob_index(15, 10, 90), 75);
|
|
assert_eq!(calculate_highest_lost_blob_index(90, 10, 90), 10);
|
|
assert_eq!(calculate_highest_lost_blob_index(90, 10, 50), 10);
|
|
assert_eq!(calculate_highest_lost_blob_index(90, 10, 99), 10);
|
|
assert_eq!(calculate_highest_lost_blob_index(90, 10, 101), 11);
|
|
assert_eq!(
|
|
calculate_highest_lost_blob_index(90, 10, 95 + WINDOW_SIZE),
|
|
WINDOW_SIZE + 5
|
|
);
|
|
assert_eq!(
|
|
calculate_highest_lost_blob_index(90, 10, 99 + WINDOW_SIZE),
|
|
WINDOW_SIZE + 9
|
|
);
|
|
assert_eq!(
|
|
calculate_highest_lost_blob_index(90, 10, 100 + WINDOW_SIZE),
|
|
WINDOW_SIZE + 9
|
|
);
|
|
assert_eq!(
|
|
calculate_highest_lost_blob_index(90, 10, 120 + WINDOW_SIZE),
|
|
WINDOW_SIZE + 9
|
|
);
|
|
}
|
|
|
|
fn wrap_blob_idx_in_window(id: &Pubkey, pix: u64, consumed: u64, received: u64) -> (bool, u64) {
|
|
let mut received = received;
|
|
let is_in_window = blob_idx_in_window(&id, pix, consumed, &mut received);
|
|
(is_in_window, received)
|
|
}
|
|
#[test]
|
|
pub fn blob_idx_in_window_test() {
|
|
let id = Pubkey::default();
|
|
assert_eq!(
|
|
wrap_blob_idx_in_window(&id, 90 + WINDOW_SIZE, 90, 100),
|
|
(false, 90 + WINDOW_SIZE)
|
|
);
|
|
assert_eq!(
|
|
wrap_blob_idx_in_window(&id, 91 + WINDOW_SIZE, 90, 100),
|
|
(false, 91 + WINDOW_SIZE)
|
|
);
|
|
assert_eq!(wrap_blob_idx_in_window(&id, 89, 90, 100), (false, 100));
|
|
|
|
assert_eq!(wrap_blob_idx_in_window(&id, 91, 90, 100), (true, 100));
|
|
assert_eq!(wrap_blob_idx_in_window(&id, 101, 90, 100), (true, 101));
|
|
}
|
|
}
|