Add deserialize+load steps to chanmon_fail_consistency (fixes #327)

Author: TheBlueMatt

fuzz/fuzz_targets/chanmon_fail_consistency.rs

@@ -27,21 +27,22 @@ use bitcoin::network::constants::Network;
 use bitcoin_hashes::Hash as TraitImport;
 use bitcoin_hashes::hash160::Hash as Hash160;
 use bitcoin_hashes::sha256::Hash as Sha256;
+use bitcoin_hashes::sha256d::Hash as Sha256d;
 
 use lightning::chain::chaininterface;
 use lightning::chain::transaction::OutPoint;
 use lightning::chain::chaininterface::{BroadcasterInterface,ConfirmationTarget,ChainListener,FeeEstimator,ChainWatchInterfaceUtil};
 use lightning::chain::keysinterface::{ChannelKeys, KeysInterface};
 use lightning::ln::channelmonitor;
-use lightning::ln::channelmonitor::{ChannelMonitorUpdateErr, HTLCUpdate};
-use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage};
+use lightning::ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, HTLCUpdate};
+use lightning::ln::channelmanager::{ChannelManager, PaymentHash, PaymentPreimage, ChannelManagerReadArgs};
 use lightning::ln::router::{Route, RouteHop};
 use lightning::ln::msgs::{CommitmentUpdate, ChannelMessageHandler, ErrorAction, HandleError, UpdateAddHTLC, LocalFeatures};
 use lightning::util::events;
 use lightning::util::logger::Logger;
 use lightning::util::config::UserConfig;
 use lightning::util::events::{EventsProvider, MessageSendEventsProvider};
-use lightning::util::ser::{Readable, Writeable};
+use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
 
 mod utils;
 use utils::test_logger;
@@ -51,7 +52,7 @@ use secp256k1::Secp256k1;
 
 use std::mem;
 use std::cmp::Ordering;
-use std::collections::HashSet;
+use std::collections::{HashSet, HashMap};
 use std::sync::{Arc,Mutex};
 use std::sync::atomic;
 use std::io::Cursor;
@@ -68,22 +69,60 @@ impl BroadcasterInterface for TestBroadcaster {
 	fn broadcast_transaction(&self, _tx: &Transaction) { }
 }
 
+pub struct VecWriter(pub Vec<u8>);
+impl Writer for VecWriter {
+	fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
+		self.0.extend_from_slice(buf);
+		Ok(())
+	}
+	fn size_hint(&mut self, size: usize) {
+		self.0.reserve_exact(size);
+	}
+}
+
 pub struct TestChannelMonitor {
 	pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint>>,
 	pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
+	pub latest_good_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
+	pub latest_ignored_update: Mutex<HashMap<OutPoint, Vec<u8>>>,
+	pub should_update_manager: atomic::AtomicBool,
 }
 impl TestChannelMonitor {
 	pub fn new(chain_monitor: Arc<chaininterface::ChainWatchInterface>, broadcaster: Arc<chaininterface::BroadcasterInterface>, logger: Arc<Logger>, feeest: Arc<chaininterface::FeeEstimator>) -> Self {
 		Self {
 			simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, feeest),
 			update_ret: Mutex::new(Ok(())),
+			latest_good_update: Mutex::new(HashMap::new()),
+			latest_ignored_update: Mutex::new(HashMap::new()),
+			should_update_manager: atomic::AtomicBool::new(false),
 		}
 	}
 }
 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
 	fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
+		let ret = self.update_ret.lock().unwrap().clone();
+		let mut ser = VecWriter(Vec::new());
+		monitor.write_for_disk(&mut ser).unwrap();
+		if let Ok(()) = ret {
+			let mut latest_good_update = self.latest_good_update.lock().unwrap();
+			let mut latest_ignored_update = self.latest_ignored_update.lock().unwrap();
+			latest_good_update.insert(funding_txo, ser.0);
+
+			// Because we will panic if any channels get closed on us, we have to keep track of any
+			// ChannelMonitor updates which we ignored, and include those in the serialized state
+			// when we update the ChannelManager serialized copy. This is (obviously) not required
+			// of actual clients, but ensures we should never get a channel closure in the test.
+			for (ignored_funding, ignored_update) in latest_ignored_update.drain() {
+				if ignored_funding != funding_txo {
+					latest_good_update.insert(ignored_funding, ignored_update);
+				}
+			}
+			self.should_update_manager.store(true, atomic::Ordering::Relaxed);
+		} else {
+			self.latest_ignored_update.lock().unwrap().insert(funding_txo, ser.0);
+		}
 		assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
-		self.update_ret.lock().unwrap().clone()
+		ret
 	}
 
 	fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
@@ -156,6 +195,45 @@ pub fn do_test(data: &[u8]) {
 		} }
 	}
 
+	macro_rules! reload_node {
+		($ser: expr, $node_id: expr, $old_monitors: expr) => { {
+			let logger: Arc<Logger> = Arc::new(test_logger::TestLogger::new($node_id.to_string()));
+			let watch = Arc::new(ChainWatchInterfaceUtil::new(Network::Bitcoin, Arc::clone(&logger)));
+			let monitor = Arc::new(TestChannelMonitor::new(watch.clone(), broadcast.clone(), logger.clone(), fee_est.clone()));
+
+			let keys_manager = Arc::new(KeyProvider { node_id: $node_id, session_id: atomic::AtomicU8::new(0), channel_id: atomic::AtomicU8::new(0) });
+			let mut config = UserConfig::new();
+			config.channel_options.fee_proportional_millionths = 0;
+			config.channel_options.announced_channel = true;
+			config.peer_channel_config_limits.min_dust_limit_satoshis = 0;
+
+			let mut monitors = HashMap::new();
+			let mut old_monitors = $old_monitors.lock().unwrap();
+			for (outpoint, monitor_ser) in old_monitors.drain() {
+				monitors.insert(outpoint, <(Sha256d, ChannelMonitor)>::read(&mut Cursor::new(&monitor_ser), Arc::clone(&logger)).expect("Failed to read monitor").1);
+				monitor.latest_good_update.lock().unwrap().insert(outpoint, monitor_ser);
+			}
+			let mut monitor_refs = HashMap::new();
+			for (outpoint, monitor) in monitors.iter() {
+				monitor_refs.insert(*outpoint, monitor);
+			}
+
+			let read_args = ChannelManagerReadArgs {
+				keys_manager,
+				fee_estimator: fee_est.clone(),
+				monitor: monitor.clone(),
+				chain_monitor: watch,
+				tx_broadcaster: broadcast.clone(),
+				logger,
+				default_config: config,
+				channel_monitors: &monitor_refs,
+			};
+
+			(<(Sha256d, ChannelManager)>::read(&mut Cursor::new(&$ser.0), read_args).expect("Failed to read manager").1, monitor)
+		} }
+	}
+
+
 	let mut channel_txn = Vec::new();
 	macro_rules! make_channel {
 		($source: expr, $dest: expr, $chan_id: expr) => { {
@@ -265,11 +343,11 @@ pub fn do_test(data: &[u8]) {
 
 	// 3 nodes is enough to hit all the possible cases, notably unknown-source-unknown-dest
 	// forwarding.
-	let (node_a, monitor_a) = make_node!(0);
-	let (node_b, monitor_b) = make_node!(1);
-	let (node_c, monitor_c) = make_node!(2);
+	let (mut node_a, mut monitor_a) = make_node!(0);
+	let (mut node_b, mut monitor_b) = make_node!(1);
+	let (mut node_c, mut monitor_c) = make_node!(2);
 
-	let nodes = [node_a, node_b, node_c];
+	let mut nodes = [node_a, node_b, node_c];
 
 	make_channel!(nodes[0], nodes[1], 0);
 	make_channel!(nodes[1], nodes[2], 1);
@@ -290,6 +368,13 @@ pub fn do_test(data: &[u8]) {
 	let mut ba_events = Vec::new();
 	let mut bc_events = Vec::new();
 
+	let mut node_a_ser = VecWriter(Vec::new());
+	nodes[0].write(&mut node_a_ser).unwrap();
+	let mut node_b_ser = VecWriter(Vec::new());
+	nodes[1].write(&mut node_b_ser).unwrap();
+	let mut node_c_ser = VecWriter(Vec::new());
+	nodes[2].write(&mut node_c_ser).unwrap();
+
 	macro_rules! test_err {
 		($res: expr) => {
 			match $res {
@@ -584,8 +669,64 @@ pub fn do_test(data: &[u8]) {
 			0x1c => process_msg_events!(2, false),
 			0x1d => process_events!(2, true),
 			0x1e => process_events!(2, false),
+			0x1f => {
+				if !chan_a_disconnected {
+					nodes[1].peer_disconnected(&nodes[0].get_our_node_id(), false);
+					chan_a_disconnected = true;
+					drain_msg_events_on_disconnect!(0);
+				}
+				let (new_node_a, new_monitor_a) = reload_node!(node_a_ser, 0, monitor_a.latest_good_update);
+				node_a = Arc::new(new_node_a);
+				nodes[0] = node_a.clone();
+				monitor_a = new_monitor_a;
+			},
+			0x20 => {
+				if !chan_a_disconnected {
+					nodes[0].peer_disconnected(&nodes[1].get_our_node_id(), false);
+					chan_a_disconnected = true;
+					nodes[0].get_and_clear_pending_msg_events();
+					ba_events.clear();
+				}
+				if !chan_b_disconnected {
+					nodes[2].peer_disconnected(&nodes[1].get_our_node_id(), false);
+					chan_b_disconnected = true;
+					nodes[2].get_and_clear_pending_msg_events();
+					bc_events.clear();
+				}
+				let (new_node_b, new_monitor_b) = reload_node!(node_b_ser, 1, monitor_b.latest_good_update);
+				node_b = Arc::new(new_node_b);
+				nodes[1] = node_b.clone();
+				monitor_b = new_monitor_b;
+			},
+			0x21 => {
+				if !chan_b_disconnected {
+					nodes[1].peer_disconnected(&nodes[2].get_our_node_id(), false);
+					chan_b_disconnected = true;
+					drain_msg_events_on_disconnect!(2);
+				}
+				let (new_node_c, new_monitor_c) = reload_node!(node_c_ser, 2, monitor_c.latest_good_update);
+				node_c = Arc::new(new_node_c);
+				nodes[2] = node_c.clone();
+				monitor_c = new_monitor_c;
+			},
 			_ => test_return!(),
 		}
+
+		if monitor_a.should_update_manager.load(atomic::Ordering::Relaxed) {
+			node_a_ser.0.clear();
+			nodes[0].write(&mut node_a_ser).unwrap();
+			monitor_a.should_update_manager.store(false, atomic::Ordering::Relaxed);
+		}
+		if monitor_b.should_update_manager.load(atomic::Ordering::Relaxed) {
+			node_b_ser.0.clear();
+			nodes[1].write(&mut node_b_ser).unwrap();
+			monitor_b.should_update_manager.store(false, atomic::Ordering::Relaxed);
+		}
+		if monitor_c.should_update_manager.load(atomic::Ordering::Relaxed) {
+			node_c_ser.0.clear();
+			nodes[2].write(&mut node_c_ser).unwrap();
+			monitor_c.should_update_manager.store(false, atomic::Ordering::Relaxed);
+		}
 	}
 }