Merge pull request #185 from TheBlueMatt/2018-09-ser-rework

Serialization Framework Tweaks

Author: TheBlueMatt

fuzz/fuzz_targets/channel_target.rs

@@ -15,7 +15,7 @@ use lightning::chain::chaininterface::{FeeEstimator, ConfirmationTarget};
 use lightning::chain::transaction::OutPoint;
 use lightning::util::reset_rng_state;
 use lightning::util::logger::Logger;
-use lightning::util::ser::{Readable, Reader};
+use lightning::util::ser::Readable;
 
 mod utils;
 
@@ -121,7 +121,7 @@ pub fn do_test(data: &[u8]) {
 
 	macro_rules! decode_msg {
 		($MsgType: path, $len: expr) => {{
-			let mut reader = Reader::new(::std::io::Cursor::new(get_slice!($len)));
+			let mut reader = ::std::io::Cursor::new(get_slice!($len));
 			match <($MsgType)>::read(&mut reader) {
 				Ok(msg) => msg,
 				Err(e) => match e {

fuzz/fuzz_targets/msg_targets/msg_accept_channel_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_announcement_signatures_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_channel_announcement_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_channel_reestablish_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_channel_update_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_closing_signed_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_commitment_signed_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_decoded_onion_error_packet_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_error_message_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_funding_created_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_funding_locked_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_funding_signed_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_init_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_node_announcement_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_onion_hop_data_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_open_channel_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_ping_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_pong_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_revoke_and_ack_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_shutdown_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_target_template.txt

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_update_add_htlc_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_update_fail_htlc_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_update_fail_malformed_htlc_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_update_fee_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/msg_update_fulfill_htlc_target.rs

@@ -7,6 +7,7 @@ use lightning::ln::msgs;
 use lightning::util::reset_rng_state;
 
 mod utils;
+use utils::VecWriter;
 
 #[inline]
 pub fn do_test(data: &[u8]) {

fuzz/fuzz_targets/msg_targets/utils.rs

@@ -1,19 +1,31 @@
 #![macro_use]
 
+use lightning::util::ser::Writer;
+pub struct VecWriter(pub Vec<u8>);
+impl Writer for VecWriter {
+	fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
+		assert!(self.0.capacity() >= self.0.len() + buf.len());
+		self.0.extend_from_slice(buf);
+		Ok(())
+	}
+	fn size_hint(&mut self, size: usize) {
+		self.0.reserve_exact(size);
+	}
+}
+
 #[macro_export]
 macro_rules! test_msg {
 	($MsgType: path, $data: ident) => {
 		{
-			use lightning::util::ser::{Writer, Reader, Writeable, Readable};
-			let mut r = Reader::new(::std::io::Cursor::new($data));
+			use lightning::util::ser::{Writeable, Readable};
+			let mut r = ::std::io::Cursor::new($data);
 			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
-				let p = r.get_ref().position() as usize;
-				let mut w = Writer::new(::std::io::Cursor::new(vec![]));
+				let p = r.position() as usize;
+				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
 
-				let buf = w.into_inner().into_inner();
-				assert_eq!(buf.len(), p);
-				assert_eq!(&r.into_inner().into_inner()[..p], &buf[..p]);
+				assert_eq!(w.0.len(), p);
+				assert_eq!(&r.into_inner()[..p], &w.0[..p]);
 			}
 		}
 	}
@@ -23,10 +35,11 @@ macro_rules! test_msg {
 macro_rules! test_msg_simple {
 	($MsgType: path, $data: ident) => {
 		{
-			use lightning::util::ser::{Writer, Reader, Writeable, Readable};
-			let mut r = Reader::new(::std::io::Cursor::new($data));
+			use lightning::util::ser::{Writeable, Readable};
+			let mut r = ::std::io::Cursor::new($data);
 			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
-				msg.write(&mut Writer::new(::std::io::Cursor::new(vec![]))).unwrap();
+				let mut w = VecWriter(Vec::new());
+				msg.write(&mut w).unwrap();
 			}
 		}
 	}
@@ -36,14 +49,13 @@ macro_rules! test_msg_simple {
 macro_rules! test_msg_exact {
 	($MsgType: path, $data: ident) => {
 		{
-			use lightning::util::ser::{Writer, Reader, Writeable, Readable};
-			let mut r = Reader::new(::std::io::Cursor::new($data));
+			use lightning::util::ser::{Writeable, Readable};
+			let mut r = ::std::io::Cursor::new($data);
 			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
-				let mut w = Writer::new(::std::io::Cursor::new(vec![]));
+				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
 
-				let buf = w.into_inner().into_inner();
-				assert_eq!(&r.into_inner().into_inner()[..], &buf[..]);
+				assert_eq!(&r.into_inner()[..], &w.0[..]);
 			}
 		}
 	}
@@ -53,17 +65,16 @@ macro_rules! test_msg_exact {
 macro_rules! test_msg_hole {
 	($MsgType: path, $data: ident, $hole: expr, $hole_len: expr) => {
 		{
-			use lightning::util::ser::{Writer, Reader, Writeable, Readable};
-			let mut r = Reader::new(::std::io::Cursor::new($data));
+			use lightning::util::ser::{Writeable, Readable};
+			let mut r = ::std::io::Cursor::new($data);
 			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
-				let mut w = Writer::new(::std::io::Cursor::new(vec![]));
+				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
-				let p = w.get_ref().position() as usize;
+				let p = w.0.len() as usize;
 
-				let buf = w.into_inner().into_inner();
-				assert_eq!(buf.len(),p);
-				assert_eq!(&r.get_ref().get_ref()[..$hole], &buf[..$hole]);
-				assert_eq!(&r.get_ref().get_ref()[$hole+$hole_len..p], &buf[$hole+$hole_len..]);
+				assert_eq!(w.0.len(), p);
+				assert_eq!(&r.get_ref()[..$hole], &w.0[..$hole]);
+				assert_eq!(&r.get_ref()[$hole+$hole_len..p], &w.0[$hole+$hole_len..]);
 			}
 		}
 	}

fuzz/fuzz_targets/router_target.rs

@@ -12,7 +12,7 @@ use lightning::ln::msgs::{RoutingMessageHandler};
 use lightning::ln::router::{Router, RouteHint};
 use lightning::util::reset_rng_state;
 use lightning::util::logger::Logger;
-use lightning::util::ser::{Reader, Readable};
+use lightning::util::ser::Readable;
 
 use secp256k1::key::PublicKey;
 use secp256k1::Secp256k1;
@@ -121,7 +121,7 @@ pub fn do_test(data: &[u8]) {
 
 	macro_rules! decode_msg {
 		($MsgType: path, $len: expr) => {{
-			let mut reader = Reader::new(::std::io::Cursor::new(get_slice!($len)));
+			let mut reader = ::std::io::Cursor::new(get_slice!($len));
 			match <($MsgType)>::read(&mut reader) {
 				Ok(msg) => msg,
 				Err(e) => match e {