Implement PriorityCollector

Author: HoOngEe

core/src/consensus/mod.rs

@@ -31,6 +31,7 @@ pub use self::cuckoo::Cuckoo;
 pub use self::null_engine::NullEngine;
 pub use self::simple_poa::SimplePoA;
 pub use self::solo::Solo;
+pub use self::sortition::vrf_sortition::{Priority, PriorityInfo, VRFSortition};
 pub use self::tendermint::{
     ConsensusMessage, Height, Step, Tendermint, TendermintParams, TimeGapParams, View, VoteOn, VoteStep,
 };

core/src/consensus/tendermint/message.rs

@@ -27,6 +27,14 @@ pub use super::super::sortition::PriorityMessage;
 use super::super::BitSet;
 use super::{Height, Step, View};
 
+/// Step for the sortition round.
+/// FIXME: It has a large overlap with the previous VoteStep.
+#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, RlpDecodable, RlpEncodable)]
+pub struct SortitionRound {
+    pub height: Height,
+    pub view: View,
+}
+
 /// Complete step of the consensus process.
 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash, RlpDecodable, RlpEncodable)]
 pub struct VoteStep {
@@ -73,6 +81,18 @@ impl Ord for VoteStep {
     }
 }
 
+impl PartialOrd for SortitionRound {
+    fn partial_cmp(&self, other: &SortitionRound) -> Option<cmp::Ordering> {
+        Some(self.cmp(other))
+    }
+}
+
+impl Ord for SortitionRound {
+    fn cmp(&self, other: &SortitionRound) -> cmp::Ordering {
+        (self.height, self.view).cmp(&(other.height, other.view))
+    }
+}
+
 const MESSAGE_ID_CONSENSUS_MESSAGE: u8 = 0x01;
 const MESSAGE_ID_PROPOSAL_BLOCK: u8 = 0x02;
 const MESSAGE_ID_STEP_STATE: u8 = 0x03;

core/src/consensus/tendermint/mod.rs

@@ -20,6 +20,7 @@ mod engine;
 mod message;
 mod network;
 mod params;
+pub mod priority_collector;
 pub mod types;
 pub mod vote_collector;
 mod vote_regression_checker;
@@ -35,7 +36,7 @@ use ctimer::TimerToken;
 use parking_lot::RwLock;
 
 use self::chain_notify::TendermintChainNotify;
-pub use self::message::{ConsensusMessage, VoteOn, VoteStep};
+pub use self::message::{ConsensusMessage, PriorityMessage, SortitionRound, VoteOn, VoteStep};
 pub use self::params::{TendermintParams, TimeGapParams, TimeoutParams};
 pub use self::types::{Height, Step, View};
 use super::{stake, ValidatorSet};

core/src/consensus/tendermint/priority_collector.rs

@@ -0,0 +1,77 @@
+// Copyright 2019 Kodebox, Inc.
+// This file is part of CodeChain.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+use std::cmp::Ordering;
+use std::collections::{BTreeMap, BinaryHeap};
+
+use rug::{integer::Order, Integer};
+
+use super::{PriorityMessage, SortitionRound};
+use crate::consensus::Priority;
+
+/// Storing Priorities
+#[derive(Default)]
+pub struct PriorityCollector {
+    priorities: BTreeMap<SortitionRound, BinaryHeap<PriorityInfoSummary>>,
+}
+
+#[derive(Eq, PartialEq)]
+pub struct PriorityInfoSummary {
+    priority: Priority,
+    signer_idx: usize,
+}
+
+impl Ord for PriorityInfoSummary {
+    fn cmp(&self, other: &Self) -> Ordering {
+        let self_as_int = Integer::from_digits(&self.priority, Order::MsfBe);
+        let other_as_int = Integer::from_digits(&other.priority, Order::MsfBe);
+
+        self_as_int.cmp(&other_as_int)
+    }
+}
+
+impl PartialOrd for PriorityInfoSummary {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        Some(self.cmp(other))
+    }
+}
+
+impl PriorityInfoSummary {
+    pub fn from_message_and_idx(message: &PriorityMessage, signer_idx: usize) -> Self {
+        Self {
+            priority: message.info.priority(),
+            signer_idx,
+        }
+    }
+}
+
+impl PriorityCollector {
+    pub fn insert(&mut self, message: &PriorityMessage, signer_idx: usize, round: SortitionRound) {
+        let info_summary = PriorityInfoSummary::from_message_and_idx(message, signer_idx);
+        self.priorities.entry(round).or_insert_with(Default::default).push(info_summary);
+    }
+
+    pub fn get_highest_priority(&mut self, round: SortitionRound) -> Option<PriorityInfoSummary> {
+        self.priorities.entry(round).or_default().pop()
+    }
+
+    /// Throw away priorities older than the given round.
+    pub fn throw_away_old(&mut self, round: &SortitionRound) {
+        let new_collector = self.priorities.split_off(round);
+        assert!(!new_collector.is_empty());
+        self.priorities = new_collector;
+    }
+}