Skip to content

Commit b7533b4

Browse files
jurvisjurvis
committed
Add utils to persist scorer in BackgroundProcessor
1 parent 62edee5 commit b7533b4

File tree

3 files changed

+90
-20
lines changed

3 files changed

+90
-20
lines changed

‎lightning-background-processor/src/lib.rs

Lines changed: 66 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ use lightning::ln::channelmanager::ChannelManager;
1818
use lightning::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
1919
use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescriptor};
2020
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
21+
use lightning::routing::scoring::WriteableScore;
2122
use lightning::util::events::{Event, EventHandler, EventsProvider};
2223
use lightning::util::logger::Logger;
2324
use lightning::util::persist::Persister;
@@ -151,6 +152,7 @@ impl BackgroundProcessor {
151152
/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
152153
/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
153154
pub fn start<
155+
'a,
154156
Signer: 'static + Sign,
155157
CA: 'static + Deref + Send + Sync,
156158
CF: 'static + Deref + Send + Sync,
@@ -171,9 +173,11 @@ impl BackgroundProcessor {
171173
NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
172174
UMH: 'static + Deref + Send + Sync,
173175
PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, L, UMH>> + Send + Sync,
176+
S: 'static + Deref<Target = SC> + Send + Sync,
177+
SC: WriteableScore<'a>,
174178
>(
175179
persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
176-
net_graph_msg_handler: Option<NG>, peer_manager: PM, logger: L
180+
net_graph_msg_handler: Option<NG>, peer_manager: PM, logger: L, scorer: Option<S>
177181
) -> Self
178182
where
179183
CA::Target: 'static + chain::Access,
@@ -187,7 +191,7 @@ impl BackgroundProcessor {
187191
CMH::Target: 'static + ChannelMessageHandler,
188192
RMH::Target: 'static + RoutingMessageHandler,
189193
UMH::Target: 'static + CustomMessageHandler,
190-
PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
194+
PS::Target: 'static + Persister<'a, Signer, CW, T, K, F, L, SC>,
191195
{
192196
let stop_thread = Arc::new(AtomicBool::new(false));
193197
let stop_thread_clone = stop_thread.clone();
@@ -274,9 +278,15 @@ impl BackgroundProcessor {
274278
if let Err(e) = persister.persist_graph(handler.network_graph()) {
275279
log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
276280
}
277-
last_prune_call = Instant::now();
278-
have_pruned = true;
279281
}
282+
if let Some(ref scorer) = scorer {
283+
log_trace!(logger, "Persisting scorer");
284+
if let Err(e) = persister.persist_scorer(&scorer) {
285+
log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
286+
}
287+
}
288+
last_prune_call = Instant::now();
289+
have_pruned = true;
280290
}
281291
}
282292

@@ -285,10 +295,16 @@ impl BackgroundProcessor {
285295
// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
286296
persister.persist_manager(&*channel_manager)?;
287297

298+
// Persist Scorer on exit
299+
if let Some(ref scorer) = scorer {
300+
persister.persist_scorer(&scorer)?;
301+
}
302+
288303
// Persist NetworkGraph on exit
289304
if let Some(ref handler) = net_graph_msg_handler {
290305
persister.persist_graph(handler.network_graph())?;
291306
}
307+
292308
Ok(())
293309
});
294310
Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
@@ -369,6 +385,7 @@ mod tests {
369385
use std::path::PathBuf;
370386
use std::sync::{Arc, Mutex};
371387
use std::time::Duration;
388+
use lightning::routing::scoring::{FixedPenaltyScorer};
372389
use super::{BackgroundProcessor, FRESHNESS_TIMER};
373390

374391
const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
@@ -395,6 +412,7 @@ mod tests {
395412
network_graph: Arc<NetworkGraph>,
396413
logger: Arc<test_utils::TestLogger>,
397414
best_block: BestBlock,
415+
scorer: Arc<Mutex<FixedPenaltyScorer>>,
398416
}
399417

400418
impl Drop for Node {
@@ -410,13 +428,14 @@ mod tests {
410428
struct Persister {
411429
graph_error: Option<(std::io::ErrorKind, &'static str)>,
412430
manager_error: Option<(std::io::ErrorKind, &'static str)>,
431+
scorer_error: Option<(std::io::ErrorKind, &'static str)>,
413432
filesystem_persister: FilesystemPersister,
414433
}
415434

416435
impl Persister {
417436
fn new(data_dir: String) -> Self {
418437
let filesystem_persister = FilesystemPersister::new(data_dir.clone());
419-
Self { graph_error: None, manager_error: None, filesystem_persister }
438+
Self { graph_error: None, manager_error: None, scorer_error: None, filesystem_persister }
420439
}
421440

422441
fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
@@ -426,6 +445,10 @@ mod tests {
426445
fn with_manager_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
427446
Self { manager_error: Some((error, message)), ..self }
428447
}
448+
449+
fn with_scorer_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
450+
Self { scorer_error: Some((error, message)), ..self }
451+
}
429452
}
430453

431454
impl KVStorePersister for Persister {
@@ -442,6 +465,12 @@ mod tests {
442465
}
443466
}
444467

468+
if key == "scorer" {
469+
if let Some((error, message)) = self.scorer_error {
470+
return Err(std::io::Error::new(error, message))
471+
}
472+
}
473+
445474
self.filesystem_persister.persist(key, object)
446475
}
447476
}
@@ -473,7 +502,8 @@ mod tests {
473502
let net_graph_msg_handler = Some(Arc::new(NetGraphMsgHandler::new(network_graph.clone(), Some(chain_source.clone()), logger.clone())));
474503
let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new() )};
475504
let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(Recipient::Node).unwrap(), &seed, logger.clone(), IgnoringMessageHandler{}));
476-
let node = Node { node: manager, net_graph_msg_handler, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block };
505+
let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
506+
let node = Node { node: manager, net_graph_msg_handler, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block, scorer };
477507
nodes.push(node);
478508
}
479509

@@ -571,7 +601,7 @@ mod tests {
571601
let data_dir = nodes[0].persister.get_data_dir();
572602
let persister = Arc::new(Persister::new(data_dir));
573603
let event_handler = |_: &_| {};
574-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
604+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
575605

576606
macro_rules! check_persisted_data {
577607
($node: expr, $filepath: expr) => {
@@ -621,6 +651,10 @@ mod tests {
621651
check_persisted_data!(network_graph, filepath.clone());
622652
}
623653

654+
// Check scorer is persisted
655+
let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "scorer".to_string());
656+
check_persisted_data!(nodes[0].scorer, filepath.clone());
657+
624658
assert!(bg_processor.stop().is_ok());
625659
}
626660

@@ -632,7 +666,7 @@ mod tests {
632666
let data_dir = nodes[0].persister.get_data_dir();
633667
let persister = Arc::new(Persister::new(data_dir));
634668
let event_handler = |_: &_| {};
635-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
669+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
636670
loop {
637671
let log_entries = nodes[0].logger.lines.lock().unwrap();
638672
let desired_log = "Calling ChannelManager's timer_tick_occurred".to_string();
@@ -655,7 +689,7 @@ mod tests {
655689
let data_dir = nodes[0].persister.get_data_dir();
656690
let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
657691
let event_handler = |_: &_| {};
658-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
692+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
659693
match bg_processor.join() {
660694
Ok(_) => panic!("Expected error persisting manager"),
661695
Err(e) => {
@@ -672,7 +706,7 @@ mod tests {
672706
let data_dir = nodes[0].persister.get_data_dir();
673707
let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
674708
let event_handler = |_: &_| {};
675-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
709+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
676710

677711
match bg_processor.stop() {
678712
Ok(_) => panic!("Expected error persisting network graph"),
@@ -683,6 +717,24 @@ mod tests {
683717
}
684718
}
685719

720+
#[test]
721+
fn test_scorer_persist_error() {
722+
// Test that if we encounter an error during scorer persistence, an error gets returned.
723+
let nodes = create_nodes(2, "test_persist_scorer_error".to_string());
724+
let data_dir = nodes[0].persister.get_data_dir();
725+
let persister = Arc::new(Persister::new(data_dir).with_scorer_error(std::io::ErrorKind::Other, "test"));
726+
let event_handler = |_: &_| {};
727+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
728+
729+
match bg_processor.stop() {
730+
Ok(_) => panic!("Expected error persisting scorer"),
731+
Err(e) => {
732+
assert_eq!(e.kind(), std::io::ErrorKind::Other);
733+
assert_eq!(e.get_ref().unwrap().to_string(), "test");
734+
},
735+
}
736+
}
737+
686738
#[test]
687739
fn test_background_event_handling() {
688740
let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
@@ -695,7 +747,7 @@ mod tests {
695747
let event_handler = move |event: &Event| {
696748
sender.send(handle_funding_generation_ready!(event, channel_value)).unwrap();
697749
};
698-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
750+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
699751

700752
// Open a channel and check that the FundingGenerationReady event was handled.
701753
begin_open_channel!(nodes[0], nodes[1], channel_value);
@@ -720,7 +772,7 @@ mod tests {
720772
let (sender, receiver) = std::sync::mpsc::sync_channel(1);
721773
let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
722774
let persister = Arc::new(Persister::new(data_dir));
723-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
775+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
724776

725777
// Force close the channel and check that the SpendableOutputs event was handled.
726778
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
@@ -747,11 +799,10 @@ mod tests {
747799
// Initiate the background processors to watch each node.
748800
let data_dir = nodes[0].persister.get_data_dir();
749801
let persister = Arc::new(Persister::new(data_dir));
750-
let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
751802
let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
752-
let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
803+
let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, Arc::clone(&nodes[0].scorer), Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
753804
let event_handler = Arc::clone(&invoice_payer);
754-
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
805+
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
755806
assert!(bg_processor.stop().is_ok());
756807
}
757808
}

‎lightning/src/routing/scoring.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ pub trait LockableScore<'a> {
137137
fn lock(&'a self) -> Self::Locked;
138138
}
139139

140+
/// Refers to a scorer that is accessible under lock and also writeable to disk
141+
///
142+
/// We need this trait to be able to pass in a scorer to `lightning-background-processor` that will enable us to
143+
/// use the Persister to persist it.
144+
pub trait WriteableScore<'a>: LockableScore<'a> + Writeable {}
145+
146+
impl<'a, T> WriteableScore<'a> for T where T: LockableScore<'a> + Writeable {}
147+
140148
/// (C-not exported)
141149
impl<'a, T: 'a + Score> LockableScore<'a> for Mutex<T> {
142150
type Locked = MutexGuard<'a, T>;

‎lightning/src/util/persist.rs

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use core::ops::Deref;
1212
use bitcoin::hashes::hex::ToHex;
1313
use io::{self};
14+
use routing::scoring::WriteableScore;
1415

1516
use crate::{chain::{keysinterface::{Sign, KeysInterface}, self, transaction::{OutPoint}, chaininterface::{BroadcasterInterface, FeeEstimator}, chainmonitor::{Persist, MonitorUpdateId}, channelmonitor::{ChannelMonitor, ChannelMonitorUpdate}}, ln::channelmanager::ChannelManager, routing::network_graph::NetworkGraph};
1617
use super::{logger::Logger, ser::Writeable};
@@ -24,37 +25,47 @@ pub trait KVStorePersister {
2425
fn persist<W: Writeable>(&self, key: &str, object: &W) -> io::Result<()>;
2526
}
2627

27-
/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
28-
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
28+
/// Trait that handles persisting a [`ChannelManager`], [`NetworkGraph`], and [`WriteableScore`] to disk.
29+
pub trait Persister<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref, S>
2930
where M::Target: 'static + chain::Watch<Signer>,
3031
T::Target: 'static + BroadcasterInterface,
3132
K::Target: 'static + KeysInterface<Signer = Signer>,
3233
F::Target: 'static + FeeEstimator,
3334
L::Target: 'static + Logger,
35+
S: WriteableScore<'a>,
3436
{
3537
/// Persist the given ['ChannelManager'] to disk, returning an error if persistence failed.
3638
fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), io::Error>;
3739

3840
/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
3941
fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), io::Error>;
42+
43+
/// Persist the given [`WriteableScore`] to disk, returning an error if persistence failed.
44+
fn persist_scorer(&self, scorer: &S) -> Result<(), io::Error>;
4045
}
4146

42-
impl<A: KVStorePersister, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Persister<Signer, M, T, K, F, L> for A
47+
impl<'a, A: KVStorePersister, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref, S> Persister<'a, Signer, M, T, K, F, L, S> for A
4348
where M::Target: 'static + chain::Watch<Signer>,
4449
T::Target: 'static + BroadcasterInterface,
4550
K::Target: 'static + KeysInterface<Signer = Signer>,
4651
F::Target: 'static + FeeEstimator,
4752
L::Target: 'static + Logger,
53+
S: WriteableScore<'a>,
4854
{
49-
/// Persist the given ['ChannelManager'] to disk, returning an error if persistence failed.
55+
/// Persist the given ['ChannelManager'] to disk with the name "manager", returning an error if persistence failed.
5056
fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), io::Error> {
5157
self.persist("manager", channel_manager)
5258
}
5359

54-
/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
60+
/// Persist the given [`NetworkGraph`] to disk with the name "network_graph", returning an error if persistence failed.
5561
fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), io::Error> {
5662
self.persist("network_graph", network_graph)
5763
}
64+
65+
/// Persist the given [`WriteableScore`] to disk with name "scorer", returning an error if persistence failed.
66+
fn persist_scorer(&self, scorer: &S) -> Result<(), io::Error> {
67+
self.persist("scorer", &scorer)
68+
}
5869
}
5970

6071
impl<ChannelSigner: Sign, K: KVStorePersister> Persist<ChannelSigner> for K {

0 commit comments

Comments
 (0)