diff --git a/sync/src/chain.rs b/sync/src/chain.rs index 8b0b52080..301bf80a8 100644 --- a/sync/src/chain.rs +++ b/sync/src/chain.rs @@ -23,6 +23,7 @@ use ethcore::error::*; use ethcore::block::Block; use io::SyncIo; use time; +use std::option::Option; impl ToUsize for BlockNumber { fn to_usize(&self) -> usize { @@ -81,7 +82,7 @@ struct HeaderId { } #[derive(Copy, Clone, Eq, PartialEq, Debug)] -/// Sync state +/// Sync state pub enum SyncState { /// Initial chain sync has not started yet NotSynced, @@ -103,14 +104,14 @@ pub struct SyncStatus { pub protocol_version: u8, /// BlockChain height for the moment the sync started. pub start_block_number: BlockNumber, - /// Last fully downloaded and imported block number. - pub last_imported_block_number: BlockNumber, - /// Highest block number in the download queue. - pub highest_block_number: BlockNumber, + /// Last fully downloaded and imported block number (if any). + pub last_imported_block_number: Option, + /// Highest block number in the download queue (if any). + pub highest_block_number: Option, /// Total number of blocks for the sync process. - pub blocks_total: usize, + pub blocks_total: BlockNumber, /// Number of blocks downloaded so far. - pub blocks_received: usize, + pub blocks_received: BlockNumber, /// Total number of connected peers pub num_peers: usize, /// Total number of active peers @@ -131,7 +132,7 @@ struct PeerInfo { protocol_version: u32, /// Peer chain genesis hash genesis: H256, - /// Peer network id + /// Peer network id network_id: U256, /// Peer best block hash latest: H256, @@ -153,7 +154,7 @@ pub struct ChainSync { /// Last block number for the start of sync starting_block: BlockNumber, /// Highest block number seen - highest_block: BlockNumber, + highest_block: Option, /// Set of block header numbers being downloaded downloading_headers: HashSet, /// Set of block body numbers being downloaded @@ -167,9 +168,9 @@ pub struct ChainSync { /// Used to map body to header header_ids: HashMap, /// Last impoted block number - last_imported_block: BlockNumber, + last_imported_block: Option, /// Last impoted block hash - last_imported_hash: H256, + last_imported_hash: Option, /// Syncing total difficulty syncing_difficulty: U256, /// True if common block for our and remote chain has been found @@ -183,15 +184,15 @@ impl ChainSync { ChainSync { state: SyncState::NotSynced, starting_block: 0, - highest_block: 0, + highest_block: None, downloading_headers: HashSet::new(), downloading_bodies: HashSet::new(), headers: Vec::new(), bodies: Vec::new(), peers: HashMap::new(), header_ids: HashMap::new(), - last_imported_block: 0, - last_imported_hash: H256::new(), + last_imported_block: None, + last_imported_hash: None, syncing_difficulty: U256::from(0u64), have_common_block: false, } @@ -205,8 +206,8 @@ impl ChainSync { start_block_number: self.starting_block, last_imported_block_number: self.last_imported_block, highest_block_number: self.highest_block, - blocks_received: (self.last_imported_block - self.starting_block) as usize, - blocks_total: (self.highest_block - self.starting_block) as usize, + blocks_received: match self.last_imported_block { None => 0, Some(x) => x - self.starting_block }, + blocks_total: match self.highest_block { None => 0, Some(x) => x - self.starting_block }, num_peers: self.peers.len(), num_active_peers: self.peers.values().filter(|p| p.asking != PeerAsking::Nothing).count(), } @@ -235,10 +236,10 @@ impl ChainSync { /// Restart sync pub fn restart(&mut self, io: &mut SyncIo) { self.reset(); - self.last_imported_block = 0; - self.last_imported_hash = H256::new(); + self.last_imported_block = None; + self.last_imported_hash = None; self.starting_block = 0; - self.highest_block = 0; + self.highest_block = None; self.have_common_block = false; io.chain().clear_queue(); self.starting_block = io.chain().chain_info().best_block_number; @@ -259,7 +260,7 @@ impl ChainSync { }; trace!(target: "sync", "New peer {} (protocol: {}, network: {:?}, difficulty: {:?}, latest:{}, genesis:{})", peer_id, peer.protocol_version, peer.network_id, peer.difficulty, peer.latest, peer.genesis); - + let chain_info = io.chain().chain_info(); if peer.genesis != chain_info.genesis_hash { io.disable_peer(peer_id); @@ -300,25 +301,27 @@ impl ChainSync { for i in 0..item_count { let info: BlockHeader = try!(r.val_at(i)); let number = BlockNumber::from(info.number); - if number <= self.last_imported_block || self.headers.have_item(&number) { + if number <= self.current_base_block() || self.headers.have_item(&number) { trace!(target: "sync", "Skipping existing block header"); continue; } - if number > self.highest_block { - self.highest_block = number; + + if self.highest_block == None || number > self.highest_block.unwrap() { + self.highest_block = Some(number); } let hash = info.hash(); match io.chain().block_status(&hash) { BlockStatus::InChain => { self.have_common_block = true; - self.last_imported_block = number; - self.last_imported_hash = hash.clone(); + self.last_imported_block = Some(number); + self.last_imported_hash = Some(hash.clone()); trace!(target: "sync", "Found common header {} ({})", number, hash); }, _ => { if self.have_common_block { //validate chain - if self.have_common_block && number == self.last_imported_block + 1 && info.parent_hash != self.last_imported_hash { + let base_hash = self.last_imported_hash.clone().unwrap(); + if self.have_common_block && number == self.current_base_block() + 1 && info.parent_hash != base_hash { // TODO: lower peer rating debug!(target: "sync", "Mismatched block header {} {}", number, hash); continue; @@ -413,9 +416,9 @@ impl ChainSync { trace!(target: "sync", "{} -> NewBlock ({})", peer_id, h); let header_view = HeaderView::new(header_rlp.as_raw()); + let mut unknown = false; // TODO: Decompose block and add to self.headers and self.bodies instead - let mut unknown = false; - if header_view.number() == From::from(self.last_imported_block + 1) { + if header_view.number() == From::from(self.current_base_block() + 1) { match io.chain().import_block(block_rlp.as_raw().to_vec()) { Err(ImportError::AlreadyInChain) => { trace!(target: "sync", "New block already in chain {:?}", h); @@ -423,20 +426,20 @@ impl ChainSync { Err(ImportError::AlreadyQueued) => { trace!(target: "sync", "New block already queued {:?}", h); }, + Ok(_) => { + trace!(target: "sync", "New block queued {:?}", h); + }, Err(ImportError::UnknownParent) => { unknown = true; trace!(target: "sync", "New block with unknown parent {:?}", h); }, - Ok(_) => { - trace!(target: "sync", "New block queued {:?}", h); - }, Err(e) => { debug!(target: "sync", "Bad new block {:?} : {:?}", h, e); io.disable_peer(peer_id); } }; - } - else { + } + else { unknown = true; } if unknown { @@ -456,7 +459,7 @@ impl ChainSync { Ok(()) } - /// Handles NewHashes packet. Initiates headers download for any unknown hashes. + /// Handles NewHashes packet. Initiates headers download for any unknown hashes. fn on_peer_new_hashes(&mut self, io: &mut SyncIo, peer_id: PeerId, r: &UntrustedRlp) -> Result<(), PacketDecodeError> { if self.peers.get_mut(&peer_id).expect("ChainSync: unknown peer").asking != PeerAsking::Nothing { trace!(target: "sync", "Ignoring new hashes since we're already downloading."); @@ -565,6 +568,10 @@ impl ChainSync { } } + fn current_base_block(&self) -> BlockNumber { + match self.last_imported_block { None => 0, Some(x) => x } + } + /// Find some headers or blocks to download for a peer. fn request_blocks(&mut self, io: &mut SyncIo, peer_id: PeerId) { self.clear_peer_download(peer_id); @@ -578,7 +585,7 @@ impl ChainSync { let mut needed_bodies: Vec = Vec::new(); let mut needed_numbers: Vec = Vec::new(); - if self.have_common_block && !self.headers.is_empty() && self.headers.range_iter().next().unwrap().0 == self.last_imported_block + 1 { + if self.have_common_block && !self.headers.is_empty() && self.headers.range_iter().next().unwrap().0 == self.current_base_block() + 1 { for (start, ref items) in self.headers.range_iter() { if needed_bodies.len() > MAX_BODIES_TO_REQUEST { break; @@ -611,12 +618,12 @@ impl ChainSync { } if start == 0 { self.have_common_block = true; //reached genesis - self.last_imported_hash = chain_info.genesis_hash; + self.last_imported_hash = Some(chain_info.genesis_hash); } } if self.have_common_block { let mut headers: Vec = Vec::new(); - let mut prev = self.last_imported_block + 1; + let mut prev = self.current_base_block() + 1; for (next, ref items) in self.headers.range_iter() { if !headers.is_empty() { break; @@ -671,7 +678,7 @@ impl ChainSync { { let headers = self.headers.range_iter().next().unwrap(); let bodies = self.bodies.range_iter().next().unwrap(); - if headers.0 != bodies.0 || headers.0 != self.last_imported_block + 1 { + if headers.0 != bodies.0 || headers.0 != self.current_base_block() + 1 { return; } @@ -684,27 +691,29 @@ impl ChainSync { block_rlp.append_raw(body.at(0).as_raw(), 1); block_rlp.append_raw(body.at(1).as_raw(), 1); let h = &headers.1[i].hash; - // Perform basic block verification + + // Perform basic block verification if !Block::is_good(block_rlp.as_raw()) { debug!(target: "sync", "Bad block rlp {:?} : {:?}", h, block_rlp.as_raw()); restart = true; break; } + match io.chain().import_block(block_rlp.out()) { Err(ImportError::AlreadyInChain) => { trace!(target: "sync", "Block already in chain {:?}", h); - self.last_imported_block = headers.0 + i as BlockNumber; - self.last_imported_hash = h.clone(); + self.last_imported_block = Some(headers.0 + i as BlockNumber); + self.last_imported_hash = Some(h.clone()); }, Err(ImportError::AlreadyQueued) => { trace!(target: "sync", "Block already queued {:?}", h); - self.last_imported_block = headers.0 + i as BlockNumber; - self.last_imported_hash = h.clone(); + self.last_imported_block = Some(headers.0 + i as BlockNumber); + self.last_imported_hash = Some(h.clone()); }, Ok(_) => { trace!(target: "sync", "Block queued {:?}", h); - self.last_imported_block = headers.0 + i as BlockNumber; - self.last_imported_hash = h.clone(); + self.last_imported_block = Some(headers.0 + i as BlockNumber); + self.last_imported_hash = Some(h.clone()); imported += 1; }, Err(e) => { @@ -721,8 +730,8 @@ impl ChainSync { return; } - self.headers.remove_head(&(self.last_imported_block + 1)); - self.bodies.remove_head(&(self.last_imported_block + 1)); + self.headers.remove_head(&(self.last_imported_block.unwrap() + 1)); + self.bodies.remove_head(&(self.last_imported_block.unwrap() + 1)); if self.headers.is_empty() { assert!(self.bodies.is_empty()); @@ -730,7 +739,7 @@ impl ChainSync { } } - /// Remove downloaded bocks/headers starting from specified number. + /// Remove downloaded bocks/headers starting from specified number. /// Used to recover from an error and re-download parts of the chain detected as bad. fn remove_downloaded_blocks(&mut self, start: BlockNumber) { for n in self.headers.get_tail(&start) { @@ -974,7 +983,7 @@ impl ChainSync { NEW_BLOCK_HASHES_PACKET => self.on_peer_new_hashes(io, peer, &rlp), GET_NODE_DATA_PACKET => self.return_node_data(io, &rlp), GET_RECEIPTS_PACKET => self.return_receipts(io, &rlp), - _ => { + _ => { debug!(target: "sync", "Unknown packet {}", packet_id); Ok(()) } @@ -984,7 +993,10 @@ impl ChainSync { }) } - /// Handle peer timeouts + /// Maintain other peers. Send out any new blocks and transactions + pub fn _maintain_sync(&mut self, _io: &mut SyncIo) { + } + pub fn maintain_peers(&self, io: &mut SyncIo) { let tick = time::precise_time_s(); for (peer_id, peer) in &self.peers { @@ -993,7 +1005,6 @@ impl ChainSync { } } } - /// Maintain other peers. Send out any new blocks and transactions pub fn maintain_sync(&mut self, io: &mut SyncIo) { if !io.chain().queue_info().full && self.state == SyncState::Waiting { @@ -1002,4 +1013,3 @@ impl ChainSync { } } } - diff --git a/sync/src/tests.rs b/sync/src/tests.rs index 5b796e6f1..88f19a8b6 100644 --- a/sync/src/tests.rs +++ b/sync/src/tests.rs @@ -4,7 +4,7 @@ use ethcore::block_queue::BlockQueueInfo; use ethcore::header::{Header as BlockHeader, BlockNumber}; use ethcore::error::*; use io::SyncIo; -use chain::ChainSync; +use chain::{ChainSync, SyncState}; struct TestBlockChainClient { blocks: RwLock>, @@ -248,13 +248,15 @@ struct TestPeer { } struct TestNet { - peers: Vec + peers: Vec, + started: bool, } impl TestNet { pub fn new(n: usize) -> TestNet { let mut net = TestNet { peers: Vec::new(), + started: false, }; for _ in 0..n { net.peers.push(TestPeer { @@ -294,14 +296,32 @@ impl TestNet { trace!("----------------"); } let mut p = self.peers.get_mut(peer).unwrap(); - p.sync._maintain_sync(&mut TestIo::new(&mut p.chain, &mut p.queue, None)); + p.sync.maintain_sync(&mut TestIo::new(&mut p.chain, &mut p.queue, None)); } } - pub fn sync(&mut self) { + pub fn restart_peer(&mut self, i: usize) { + let peer = self.peer_mut(i); + peer.sync.restart(&mut TestIo::new(&mut peer.chain, &mut peer.queue, None)); + } + + pub fn sync(&mut self) -> u32 { self.start(); + let mut total_steps = 0; while !self.done() { - self.sync_step() + self.sync_step(); + total_steps = total_steps + 1; + } + total_steps + } + + pub fn sync_steps(&mut self, count: usize) { + if !self.started { + self.start(); + self.started = true; + } + for _ in 0..count { + self.sync_step(); } } @@ -310,9 +330,8 @@ impl TestNet { } } - #[test] -fn full_sync_two_peers() { +fn chain_two_peers() { ::env_logger::init().ok(); let mut net = TestNet::new(3); net.peer_mut(1).chain.add_blocks(1000, false); @@ -323,7 +342,27 @@ fn full_sync_two_peers() { } #[test] -fn full_sync_empty_blocks() { +fn chain_status_after_sync() { + ::env_logger::init().ok(); + let mut net = TestNet::new(3); + net.peer_mut(1).chain.add_blocks(1000, false); + net.peer_mut(2).chain.add_blocks(1000, false); + net.sync(); + let status = net.peer(0).sync.status(); + assert_eq!(status.state, SyncState::Idle); +} + +#[test] +fn chain_takes_few_steps() { + let mut net = TestNet::new(3); + net.peer_mut(1).chain.add_blocks(100, false); + net.peer_mut(2).chain.add_blocks(100, false); + let total_steps = net.sync(); + assert!(total_steps < 7); +} + +#[test] +fn chain_empty_blocks() { ::env_logger::init().ok(); let mut net = TestNet::new(3); for n in 0..200 { @@ -336,7 +375,7 @@ fn full_sync_empty_blocks() { } #[test] -fn forked_sync() { +fn chain_forked() { ::env_logger::init().ok(); let mut net = TestNet::new(3); net.peer_mut(0).chain.add_blocks(300, false); @@ -354,3 +393,25 @@ fn forked_sync() { assert_eq!(net.peer(1).chain.numbers.read().unwrap().deref(), &peer1_chain); assert_eq!(net.peer(2).chain.numbers.read().unwrap().deref(), &peer1_chain); } + +#[test] +fn chain_restart() { + let mut net = TestNet::new(3); + net.peer_mut(1).chain.add_blocks(1000, false); + net.peer_mut(2).chain.add_blocks(1000, false); + + net.sync_steps(8); + + // make sure that sync has actually happened + assert!(net.peer(0).chain.chain_info().best_block_number > 100); + net.restart_peer(0); + + let status = net.peer(0).sync.status(); + assert_eq!(status.state, SyncState::NotSynced); +} + +#[test] +fn chain_status_empty() { + let net = TestNet::new(2); + assert_eq!(net.peer(0).sync.status().state, SyncState::NotSynced); +} \ No newline at end of file