//! The `window` module defines data structure for storing the tail of the ledger.
//!
use cluster_info::ClusterInfo;
use counter::Counter;
use entry::reconstruct_entries_from_blobs;
use entry::Entry;
use leader_scheduler::LeaderScheduler;
use log::Level;
use packet::SharedBlob;
use solana_sdk::pubkey::Pubkey;
use std::cmp;
use std::mem;
use std::net::SocketAddr;
use std::sync::atomic::AtomicUsize;
use std::sync::{Arc, RwLock};

#[derive(Default, Clone)]
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().index().ok(),
            None => None,
        }
    }

    fn clear_data(&mut self) {
        self.data.take();
    }
}

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, consumed: u64, received: u64) -> Vec<u64>;

    fn window_size(&self) -> u64;

    fn repair(
        &mut self,
        cluster_info: &Arc<RwLock<ClusterInfo>>,
        id: &Pubkey,
        times: usize,
        consumed: u64,
        received: u64,
        tick_height: u64,
        max_entry_height: u64,
        leader_scheduler_option: &Arc<RwLock<LeaderScheduler>>,
    ) -> 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 Vec<Entry>,
        consumed: &mut u64,
        tick_height: &mut u64,
        leader_unknown: bool,
        pending_retransmits: &mut bool,
    );

    fn blob_idx_in_window(&self, id: &Pubkey, pix: u64, consumed: u64, received: &mut u64) -> bool;
}

impl WindowUtil for Window {
    fn clear_slots(&mut self, consumed: u64, received: u64) -> Vec<u64> {
        (consumed..received)
            .filter_map(|pix| {
                let i = (pix % self.window_size()) as usize;
                if let Some(blob_idx) = self[i].blob_index() {
                    if blob_idx == pix {
                        return None;
                    }
                }
                self[i].clear_data();
                Some(pix)
            })
            .collect()
    }

    fn blob_idx_in_window(&self, 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 + self.window_size() {
                trace!(
                    "{}: received: {} will overrun window: {} skipping..",
                    id,
                    pix,
                    consumed + self.window_size()
                );
                false
            } else {
                true
            }
        }
    }

    fn window_size(&self) -> u64 {
        self.len() as u64
    }

    fn repair(
        &mut self,
        cluster_info: &Arc<RwLock<ClusterInfo>>,
        id: &Pubkey,
        times: usize,
        consumed: u64,
        received: u64,
        tick_height: u64,
        max_entry_height: u64,
        leader_scheduler_option: &Arc<RwLock<LeaderScheduler>>,
    ) -> Vec<(SocketAddr, Vec<u8>)> {
        let rcluster_info = cluster_info.read().unwrap();
        let mut is_next_leader = false;
        {
            let ls_lock = leader_scheduler_option.read().unwrap();
            if !ls_lock.use_only_bootstrap_leader {
                // Calculate the next leader rotation height and check if we are the leader
                if let Some(next_leader_rotation_height) =
                    ls_lock.max_height_for_leader(tick_height)
                {
                    match ls_lock.get_scheduled_leader(next_leader_rotation_height) {
                        Some((leader_id, _)) if leader_id == *id => is_next_leader = true,
                        // In the case that we are not in the current scope of the leader schedule
                        // window then either:
                        //
                        // 1) The replicate stage hasn't caught up to the "consumed" entries we sent,
                        // in which case it will eventually catch up
                        //
                        // 2) We are on the border between seed_rotation_intervals, so the
                        // schedule won't be known until the entry on that cusp is received
                        // by the replicate stage (which comes after this stage). Hence, the next
                        // leader at the beginning of that next epoch will not know they are the
                        // leader until they receive that last "cusp" entry. The leader also won't ask for repairs
                        // for that entry because "is_next_leader" won't be set here. In this case,
                        // everybody will be blocking waiting for that "cusp" entry instead of repairing,
                        // until the leader hits "times" >= the max times in calculate_max_repair().
                        // The impact of this, along with the similar problem from broadcast for the transitioning
                        // leader, can be observed in the multinode test, test_full_leader_validator_network(),
                        None => (),
                        _ => (),
                    }
                }
            }
        }

        let num_peers = rcluster_info.tvu_peers().len() as u64;
        let max_repair = if max_entry_height == 0 {
            calculate_max_repair(
                num_peers,
                consumed,
                received,
                times,
                is_next_leader,
                self.window_size(),
            )
        } else {
            max_entry_height + 1
        };

        let idxs = self.clear_slots(consumed, max_repair);
        let reqs: Vec<_> = idxs
            .into_iter()
            .filter_map(|pix| rcluster_info.window_index_request(pix).ok())
            .collect();

        drop(rcluster_info);

        inc_new_counter_info!("streamer-repair_window-repair", reqs.len());

        if log_enabled!(Level::Trace) {
            trace!(
                "{}: repair_window counter times: {} consumed: {} received: {} max_repair: {} missing: {}",
                id,
                times,
                consumed,
                received,
                max_repair,
                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 % self.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
    /// * `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 Vec<Entry>,
        consumed: &mut u64,
        tick_height: &mut u64,
        leader_unknown: bool,
        pending_retransmits: &mut bool,
    ) {
        let w = (pix % self.window_size()) as usize;

        let is_coding = blob.read().unwrap().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>,
            c_or_d: &str,
        ) -> bool {
            if let Some(old) = mem::replace(window_slot, Some(blob)) {
                let is_dup = old.read().unwrap().index().unwrap() == pix;
                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, "coding")
        } else {
            insert_blob_is_dup(id, blob, pix, &mut self[w].data, "data")
        };

        if is_duplicate {
            return;
        }

        self[w].leader_unknown = leader_unknown;
        *pending_retransmits = true;

        // push all contiguous blobs into consumed queue, increment consumed
        loop {
            let k = (*consumed % self.window_size()) as usize;
            trace!("{}: k: {} consumed: {}", id, k, *consumed,);

            let k_data_blob;
            let k_data_slot = &mut self[k].data;
            if let Some(blob) = k_data_slot {
                if blob.read().unwrap().index().unwrap() < *consumed {
                    // window wrap-around, end of received
                    break;
                }
                k_data_blob = (*blob).clone();
            } else {
                // self[k].data is None, end of received
                break;
            }

            // Check that we can get the entries from this blob
            match reconstruct_entries_from_blobs(vec![k_data_blob]) {
                Ok((entries, num_ticks)) => {
                    consume_queue.extend(entries);
                    *tick_height += num_ticks;
                }
                Err(_) => {
                    // If the blob can't be deserialized, then remove it from the
                    // window and exit. *k_data_slot cannot be None at this point,
                    // so it's safe to unwrap.
                    k_data_slot.take();
                    break;
                }
            }

            *consumed += 1;
        }
    }
}

fn calculate_max_repair(
    num_peers: u64,
    consumed: u64,
    received: u64,
    times: usize,
    is_next_leader: bool,
    window_size: 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 max_repair = if times >= 8 || is_next_leader {
        // if repair backoff is getting high, or if we are the next leader,
        // don't wait for avalanche
        cmp::max(consumed, received)
    } else {
        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, max_repair)
}

pub fn new_window(window_size: usize) -> Window {
    (0..window_size).map(|_| WindowSlot::default()).collect()
}

pub fn default_window() -> Window {
    (0..2048).map(|_| WindowSlot::default()).collect()
}

#[cfg(test)]
mod test {
    use packet::{Blob, Packet, Packets, SharedBlob, PACKET_DATA_SIZE};
    use solana_sdk::pubkey::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::{calculate_max_repair, new_window, Window, WindowUtil};

    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 (s_reader, r_reader) = channel();
        let t_receiver = receiver(
            Arc::new(read),
            exit.clone(),
            s_reader,
            "window-streamer-test",
        );
        let t_responder = {
            let (s_responder, r_responder) = channel();
            let t_responder = responder("streamer_send_test", Arc::new(send), r_responder);
            let mut msgs = Vec::new();
            for i in 0..10 {
                let mut b = SharedBlob::default();
                {
                    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 test_calculate_max_repair() {
        const WINDOW_SIZE: u64 = 200;

        assert_eq!(calculate_max_repair(0, 10, 90, 0, false, WINDOW_SIZE), 90);
        assert_eq!(calculate_max_repair(15, 10, 90, 32, false, WINDOW_SIZE), 90);
        assert_eq!(calculate_max_repair(15, 10, 90, 0, false, WINDOW_SIZE), 75);
        assert_eq!(calculate_max_repair(90, 10, 90, 0, false, WINDOW_SIZE), 10);
        assert_eq!(calculate_max_repair(90, 10, 50, 0, false, WINDOW_SIZE), 10);
        assert_eq!(calculate_max_repair(90, 10, 99, 0, false, WINDOW_SIZE), 10);
        assert_eq!(calculate_max_repair(90, 10, 101, 0, false, WINDOW_SIZE), 11);
        assert_eq!(
            calculate_max_repair(90, 10, 95 + WINDOW_SIZE, 0, false, WINDOW_SIZE),
            WINDOW_SIZE + 5
        );
        assert_eq!(
            calculate_max_repair(90, 10, 99 + WINDOW_SIZE, 0, false, WINDOW_SIZE),
            WINDOW_SIZE + 9
        );
        assert_eq!(
            calculate_max_repair(90, 10, 100 + WINDOW_SIZE, 0, false, WINDOW_SIZE),
            WINDOW_SIZE + 9
        );
        assert_eq!(
            calculate_max_repair(90, 10, 120 + WINDOW_SIZE, 0, false, WINDOW_SIZE),
            WINDOW_SIZE + 9
        );
        assert_eq!(
            calculate_max_repair(50, 100, 50 + WINDOW_SIZE, 0, false, WINDOW_SIZE),
            WINDOW_SIZE
        );
        assert_eq!(
            calculate_max_repair(50, 100, 50 + WINDOW_SIZE, 0, true, WINDOW_SIZE),
            50 + WINDOW_SIZE
        );
    }

    fn wrap_blob_idx_in_window(
        window: &Window,
        id: &Pubkey,
        pix: u64,
        consumed: u64,
        received: u64,
    ) -> (bool, u64) {
        let mut received = received;
        let is_in_window = window.blob_idx_in_window(&id, pix, consumed, &mut received);
        (is_in_window, received)
    }
    #[test]
    pub fn test_blob_idx_in_window() {
        let id = Pubkey::default();
        const WINDOW_SIZE: u64 = 200;
        let window = new_window(WINDOW_SIZE as usize);

        assert_eq!(
            wrap_blob_idx_in_window(&window, &id, 90 + WINDOW_SIZE, 90, 100),
            (false, 90 + WINDOW_SIZE)
        );
        assert_eq!(
            wrap_blob_idx_in_window(&window, &id, 91 + WINDOW_SIZE, 90, 100),
            (false, 91 + WINDOW_SIZE)
        );
        assert_eq!(
            wrap_blob_idx_in_window(&window, &id, 89, 90, 100),
            (false, 100)
        );

        assert_eq!(
            wrap_blob_idx_in_window(&window, &id, 91, 90, 100),
            (true, 100)
        );
        assert_eq!(
            wrap_blob_idx_in_window(&window, &id, 101, 90, 100),
            (true, 101)
        );
    }
}