X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Frouting%2Fnetwork_graph.rs;h=765a3430f579c033b31b674ae6071ab94b125330;hb=47cb2939c8d618bfced370e5c9103eac4ee6ce9e;hp=6aca414754cf5d6856065a3ab371aad336243757;hpb=f4adb9f0131c6592daee56fdb4031226c4d56094;p=rust-lightning diff --git a/lightning/src/routing/network_graph.rs b/lightning/src/routing/network_graph.rs index 6aca4147..765a3430 100644 --- a/lightning/src/routing/network_graph.rs +++ b/lightning/src/routing/network_graph.rs @@ -152,7 +152,7 @@ macro_rules! secp_verify_sig { }; } -impl RoutingMessageHandler for NetGraphMsgHandler where C::Target: chain::Access, L::Target: Logger { +impl RoutingMessageHandler for NetGraphMsgHandler where C::Target: chain::Access, L::Target: Logger { fn handle_node_announcement(&self, msg: &msgs::NodeAnnouncement) -> Result { self.network_graph.write().unwrap().update_node_from_announcement(msg, &self.secp_ctx)?; Ok(msg.contents.excess_data.len() <= MAX_EXCESS_BYTES_FOR_RELAY && @@ -317,23 +317,26 @@ impl RoutingMessageHandler for N Ok(()) } - /// Processes a query from a peer by finding channels whose funding UTXOs + /// Processes a query from a peer by finding announced/public channels whose funding UTXOs /// are in the specified block range. Due to message size limits, large range /// queries may result in several reply messages. This implementation enqueues - /// all reply messages into pending events. + /// all reply messages into pending events. Each message will allocate just under 65KiB. A full + /// sync of the public routing table with 128k channels will generated 16 messages and allocate ~1MB. + /// Logic can be changed to reduce allocation if/when a full sync of the routing table impacts + /// memory constrained systems. fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError> { log_debug!(self.logger, "Handling query_channel_range peer={}, first_blocknum={}, number_of_blocks={}", log_pubkey!(their_node_id), msg.first_blocknum, msg.number_of_blocks); let network_graph = self.network_graph.read().unwrap(); - let start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0); + let inclusive_start_scid = scid_from_parts(msg.first_blocknum as u64, 0, 0); - // We receive valid queries with end_blocknum that would overflow SCID conversion. - // Manually cap the ending block to avoid this overflow. + // We might receive valid queries with end_blocknum that would overflow SCID conversion. + // If so, we manually cap the ending block to avoid this overflow. let exclusive_end_scid = scid_from_parts(cmp::min(msg.end_blocknum() as u64, MAX_SCID_BLOCK), 0, 0); // Per spec, we must reply to a query. Send an empty message when things are invalid. - if msg.chain_hash != network_graph.genesis_hash || start_scid.is_err() || exclusive_end_scid.is_err() { + if msg.chain_hash != network_graph.genesis_hash || inclusive_start_scid.is_err() || exclusive_end_scid.is_err() || msg.number_of_blocks == 0 { let mut pending_events = self.pending_events.lock().unwrap(); pending_events.push(MessageSendEvent::SendReplyChannelRange { node_id: their_node_id.clone(), @@ -345,14 +348,17 @@ impl RoutingMessageHandler for N short_channel_ids: vec![], } }); - return Ok(()); + return Err(LightningError { + err: String::from("query_channel_range could not be processed"), + action: ErrorAction::IgnoreError, + }); } // Creates channel batches. We are not checking if the channel is routable // (has at least one update). A peer may still want to know the channel // exists even if its not yet routable. let mut batches: Vec> = vec![Vec::with_capacity(MAX_SCIDS_PER_REPLY)]; - for (_, ref chan) in network_graph.get_channels().range(start_scid.unwrap()..exclusive_end_scid.unwrap()) { + for (_, ref chan) in network_graph.get_channels().range(inclusive_start_scid.unwrap()..exclusive_end_scid.unwrap()) { if let Some(chan_announcement) = &chan.announcement_message { // Construct a new batch if last one is full if batches.last().unwrap().len() == batches.last().unwrap().capacity() { @@ -368,28 +374,18 @@ impl RoutingMessageHandler for N let mut pending_events = self.pending_events.lock().unwrap(); let batch_count = batches.len(); for (batch_index, batch) in batches.into_iter().enumerate() { - // Per spec, the initial first_blocknum needs to be <= the query's first_blocknum. - // Use the query's values since we don't use pre-processed reply ranges. - let first_blocknum = if batch_index == 0 { - msg.first_blocknum - } - // Subsequent replies must be >= the last sent first_blocknum. Use the first block - // in the new batch. - else { - block_from_scid(batch.first().unwrap()) - }; - - // Per spec, the last end_block needs to be >= the query's end_block. Last - // reply calculates difference between the query's end_blocknum and the start of the reply. - // Overflow safe since end_blocknum=msg.first_block_num+msg.number_of_blocks and first_blocknum - // will be either msg.first_blocknum or a higher block height. + // Per spec, the initial first_blocknum needs to be <= the query's first_blocknum and subsequent + // must be >= the prior reply. We'll simplify this by using zero since its still spec compliant and + // sequence completion is now explicitly. + let first_blocknum = 0; + + // Per spec, the final end_blocknum needs to be >= the query's end_blocknum, so we'll use the + // query's value. Prior batches must use the number of blocks that fit into the message. We'll + // base this off the last SCID in the batch since we've somewhat abusing first_blocknum. let number_of_blocks = if batch_index == batch_count-1 { - msg.end_blocknum() - first_blocknum - } - // Prior replies should use the number of blocks that fit into the reply. Overflow - // safe since first_blocknum is always <= last SCID's block. - else { - block_from_scid(batch.last().unwrap()) - first_blocknum + 1 + msg.end_blocknum() + } else { + block_from_scid(batch.last().unwrap()) + 1 }; // Only true for the last message in a sequence @@ -2203,7 +2199,6 @@ mod tests { // used for testing resumption on same block scids.push(scid_from_parts(108001, 1, 0).unwrap()); - scids.push(scid_from_parts(108001, 2, 0).unwrap()); for scid in scids { let unsigned_announcement = UnsignedChannelAnnouncement { @@ -2231,7 +2226,7 @@ mod tests { }; } - // Empty reply when number_of_blocks=0 + // Error when number_of_blocks=0 do_handling_query_channel_range( &net_graph_msg_handler, &node_id_2, @@ -2240,6 +2235,7 @@ mod tests { first_blocknum: 0, number_of_blocks: 0, }, + false, vec![ReplyChannelRange { chain_hash: chain_hash.clone(), first_blocknum: 0, @@ -2249,7 +2245,7 @@ mod tests { }] ); - // Empty when wrong chain + // Error when wrong chain do_handling_query_channel_range( &net_graph_msg_handler, &node_id_2, @@ -2258,6 +2254,7 @@ mod tests { first_blocknum: 0, number_of_blocks: 0xffff_ffff, }, + false, vec![ReplyChannelRange { chain_hash: genesis_block(Network::Bitcoin).header.block_hash(), first_blocknum: 0, @@ -2267,7 +2264,7 @@ mod tests { }] ); - // Empty reply when first_blocknum > 0xffffff + // Error when first_blocknum > 0xffffff do_handling_query_channel_range( &net_graph_msg_handler, &node_id_2, @@ -2276,6 +2273,7 @@ mod tests { first_blocknum: 0x01000000, number_of_blocks: 0xffff_ffff, }, + false, vec![ReplyChannelRange { chain_hash: chain_hash.clone(), first_blocknum: 0x01000000, @@ -2285,8 +2283,7 @@ mod tests { }] ); - // Empty reply when max valid SCID block num. - // Unlike prior test this is a valid query but no results are found + // Empty reply when max valid SCID block num do_handling_query_channel_range( &net_graph_msg_handler, &node_id_2, @@ -2295,11 +2292,12 @@ mod tests { first_blocknum: 0xffffff, number_of_blocks: 1, }, + true, vec![ ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 0xffffff, - number_of_blocks: 1, + first_blocknum: 0, + number_of_blocks: 0x01000000, sync_complete: true, short_channel_ids: vec![] }, @@ -2312,14 +2310,15 @@ mod tests { &node_id_2, QueryChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 0x00800000, + first_blocknum: 1000, number_of_blocks: 1000, }, + true, vec![ ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 0x00800000, - number_of_blocks: 1000, + first_blocknum: 0, + number_of_blocks: 2000, sync_complete: true, short_channel_ids: vec![], } @@ -2335,11 +2334,12 @@ mod tests { first_blocknum: 0xfe0000, number_of_blocks: 0xffffffff, }, + true, vec![ ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 0xfe0000, - number_of_blocks: 0xffffffff - 0xfe0000, + first_blocknum: 0, + number_of_blocks: 0xffffffff, sync_complete: true, short_channel_ids: vec![ 0xfffffe_ffffff_ffff, // max @@ -2348,6 +2348,29 @@ mod tests { ] ); + // Single block exactly full + do_handling_query_channel_range( + &net_graph_msg_handler, + &node_id_2, + QueryChannelRange { + chain_hash: chain_hash.clone(), + first_blocknum: 100000, + number_of_blocks: 8000, + }, + true, + vec![ + ReplyChannelRange { + chain_hash: chain_hash.clone(), + first_blocknum: 0, + number_of_blocks: 108000, + sync_complete: true, + short_channel_ids: (100000..=107999) + .map(|block| scid_from_parts(block, 0, 0).unwrap()) + .collect(), + }, + ] + ); + // Multiple split on new block do_handling_query_channel_range( &net_graph_msg_handler, @@ -2357,11 +2380,12 @@ mod tests { first_blocknum: 100000, number_of_blocks: 8001, }, + true, vec![ ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 100000, - number_of_blocks: 8000, + first_blocknum: 0, + number_of_blocks: 108000, sync_complete: false, short_channel_ids: (100000..=107999) .map(|block| scid_from_parts(block, 0, 0).unwrap()) @@ -2369,8 +2393,8 @@ mod tests { }, ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 108000, - number_of_blocks: 1, + first_blocknum: 0, + number_of_blocks: 108001, sync_complete: true, short_channel_ids: vec![ scid_from_parts(108000, 0, 0).unwrap(), @@ -2388,11 +2412,12 @@ mod tests { first_blocknum: 100002, number_of_blocks: 8000, }, + true, vec![ ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 100002, - number_of_blocks: 8000, + first_blocknum: 0, + number_of_blocks: 108002, sync_complete: false, short_channel_ids: (100002..=108001) .map(|block| scid_from_parts(block, 0, 0).unwrap()) @@ -2400,12 +2425,11 @@ mod tests { }, ReplyChannelRange { chain_hash: chain_hash.clone(), - first_blocknum: 108001, - number_of_blocks: 1, + first_blocknum: 0, + number_of_blocks: 108002, sync_complete: true, short_channel_ids: vec![ scid_from_parts(108001, 1, 0).unwrap(), - scid_from_parts(108001, 2, 0).unwrap(), ], } ] @@ -2416,10 +2440,16 @@ mod tests { net_graph_msg_handler: &NetGraphMsgHandler, Arc>, test_node_id: &PublicKey, msg: QueryChannelRange, + expected_ok: bool, expected_replies: Vec ) { let result = net_graph_msg_handler.handle_query_channel_range(test_node_id, msg); - assert!(result.is_ok()); + + if expected_ok { + assert!(result.is_ok()); + } else { + assert!(result.is_err()); + } let events = net_graph_msg_handler.get_and_clear_pending_msg_events(); assert_eq!(events.len(), expected_replies.len());