X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Fc_types%2Fmod.rs;h=472d4d0d15482e30c031720f0ee4de708d53daef;hp=83dae2b0c268a8f00553ee95092c1f967059931c;hb=dd5bf474af6c806b20c26f4f2b751f3226a94dfd;hpb=ea9eafe5c885b2b298618d8bdc00e1b395af2033

diff --git a/lightning-c-bindings/src/c_types/mod.rs b/lightning-c-bindings/src/c_types/mod.rs
index 83dae2b..472d4d0 100644
--- a/lightning-c-bindings/src/c_types/mod.rs
+++ b/lightning-c-bindings/src/c_types/mod.rs
@@ -14,6 +14,18 @@ use bitcoin::secp256k1::recovery::RecoverableSignature as SecpRecoverableSignatu
 use bitcoin::bech32;
 
 use std::convert::TryInto; // Bindings need at least rustc 1.34
+use core::ffi::c_void;
+use std::io::{Cursor, Read}; // TODO: We should use core2 here when we support no_std
+
+#[repr(C)]
+/// A dummy struct of which an instance must never exist.
+/// This corresponds to the Rust type `Infallible`, or, in unstable rust, `!`
+pub struct NotConstructable {
+	_priv_thing: core::convert::Infallible,
+}
+impl From<core::convert::Infallible> for NotConstructable {
+	fn from(_: core::convert::Infallible) -> Self { unreachable!(); }
+}
 
 /// Integer in the range `0..32`
 #[derive(PartialEq, Eq, Copy, Clone)]
@@ -289,6 +301,13 @@ pub extern "C" fn Transaction_free(_res: Transaction) { }
 pub(crate) fn bitcoin_to_C_outpoint(outpoint: ::bitcoin::blockdata::transaction::OutPoint) -> crate::lightning::chain::transaction::OutPoint {
 	crate::lightning::chain::transaction::OutPoint_new(ThirtyTwoBytes { data: outpoint.txid.into_inner() }, outpoint.vout.try_into().unwrap())
 }
+pub(crate) fn C_to_bitcoin_outpoint(outpoint: crate::lightning::chain::transaction::OutPoint) -> ::bitcoin::blockdata::transaction::OutPoint {
+	unsafe {
+		::bitcoin::blockdata::transaction::OutPoint {
+			txid: (*outpoint.inner).txid, vout: (*outpoint.inner).index as u32
+		}
+	}
+}
 
 #[repr(C)]
 #[derive(Clone)]
@@ -315,6 +334,12 @@ impl TxOut {
 		}
 	}
 }
+
+#[no_mangle]
+/// Convenience function for constructing a new TxOut
+pub extern "C" fn TxOut_new(script_pubkey: derived::CVec_u8Z, value: u64) -> TxOut {
+	TxOut { script_pubkey, value }
+}
 #[no_mangle]
 /// Frees the data pointed to by script_pubkey.
 pub extern "C" fn TxOut_free(_res: TxOut) { }
@@ -342,6 +367,18 @@ impl u8slice {
 		if self.datalen == 0 { return &[]; }
 		unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
 	}
+	pub(crate) fn to_reader<'a>(&'a self) -> Cursor<&'a [u8]> {
+		let sl = self.to_slice();
+		Cursor::new(sl)
+	}
+	pub(crate) fn from_vec(v: &derived::CVec_u8Z) -> u8slice {
+		Self::from_slice(v.as_slice())
+	}
+}
+pub(crate) fn reader_to_vec<R: Read>(r: &mut R) -> derived::CVec_u8Z {
+	let mut res = Vec::new();
+	r.read_to_end(&mut res).unwrap();
+	derived::CVec_u8Z::from(res)
 }
 
 #[repr(C)]
@@ -367,8 +404,8 @@ pub struct ThreeBytes { /** The three bytes */ pub data: [u8; 3], }
 pub struct FourBytes { /** The four bytes */ pub data: [u8; 4], }
 #[derive(Clone)]
 #[repr(C)]
-/// A 10-byte byte array.
-pub struct TenBytes { /** The ten bytes */ pub data: [u8; 10], }
+/// A 12-byte byte array.
+pub struct TwelveBytes { /** The twelve bytes */ pub data: [u8; 12], }
 #[derive(Clone)]
 #[repr(C)]
 /// A 16-byte byte array.
@@ -384,9 +421,6 @@ impl lightning::util::ser::Writer for VecWriter {
 		self.0.extend_from_slice(buf);
 		Ok(())
 	}
-	fn size_hint(&mut self, size: usize) {
-		self.0.reserve_exact(size);
-	}
 }
 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
 	let mut out = VecWriter(Vec::new());
@@ -396,12 +430,14 @@ pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derive
 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
 	I::read(&mut s.to_slice())
 }
+pub(crate) fn maybe_deserialize_obj<I: lightning::util::ser::MaybeReadable>(s: u8slice) -> Result<Option<I>, lightning::ln::msgs::DecodeError> {
+	I::read(&mut s.to_slice())
+}
 pub(crate) fn deserialize_obj_arg<A, I: lightning::util::ser::ReadableArgs<A>>(s: u8slice, args: A) -> Result<I, lightning::ln::msgs::DecodeError> {
 	I::read(&mut s.to_slice(), args)
 }
 
 #[repr(C)]
-#[derive(Clone)]
 /// A Rust str object, ie a reference to a UTF8-valid string.
 /// This is *not* null-terminated so cannot be used directly as a C string!
 pub struct Str {
@@ -417,6 +453,13 @@ impl Into<Str> for &'static str {
 		Str { chars: self.as_ptr(), len: self.len(), chars_is_owned: false }
 	}
 }
+impl Into<Str> for &mut &'static str {
+	fn into(self) -> Str {
+		let us: &'static str = *self;
+		us.into()
+	}
+}
+
 impl Str {
 	pub(crate) fn into_str(&self) -> &'static str {
 		if self.len == 0 { return ""; }
@@ -445,6 +488,11 @@ impl Into<Str> for String {
 		Str { chars: s.as_ptr(), len: s.len(), chars_is_owned: true }
 	}
 }
+impl Clone for Str {
+	fn clone(&self) -> Self {
+		self.into_str().clone().into()
+	}
+}
 
 impl Drop for Str {
 	fn drop(&mut self) {
@@ -521,3 +569,88 @@ impl<T> TakePointer<*mut T> for *mut T {
 		ret
 	}
 }
+
+
+pub(crate) mod ObjOps {
+	#[inline]
+	#[must_use = "returns new dangling pointer"]
+	pub(crate) fn heap_alloc<T>(obj: T) -> *mut T {
+		let ptr = Box::into_raw(Box::new(obj));
+		nonnull_ptr_to_inner(ptr)
+	}
+	#[inline]
+	pub(crate) fn nonnull_ptr_to_inner<T>(ptr: *const T) -> *mut T {
+		if core::mem::size_of::<T>() == 0 {
+			// We map `None::<T>` as `T { inner: null, .. }` which works great for all
+			// non-Zero-Sized-Types `T`.
+			// For ZSTs, we need to differentiate between null implying `None` and null implying
+			// `Some` with no allocation.
+			// Thus, for ZSTs, we add one (usually) page here, which should always be aligned.
+			// Note that this relies on undefined behavior! A pointer to NULL may be valid, but a
+			// pointer to NULL + 4096 is almost certainly not. That said, Rust's existing use of
+			// `(*mut T)1` for the pointer we're adding to is also not defined, so we should be
+			// fine.
+			// Note that we add 4095 here as at least the Java client assumes that the low bit on
+			// any heap pointer is 0, which is generally provided by malloc, but which is not true
+			// for ZSTs "allocated" by `Box::new`.
+			debug_assert_eq!(ptr as usize, 1);
+			unsafe { (ptr as *mut T).cast::<u8>().add(4096 - 1).cast::<T>() }
+		} else {
+			// In order to get better test coverage, also increment non-ZST pointers with
+			// --cfg=test_mod_pointers, which is set in genbindings.sh for debug builds.
+			#[cfg(test_mod_pointers)]
+			unsafe { (ptr as *mut T).cast::<u8>().add(4096).cast::<T>() }
+			#[cfg(not(test_mod_pointers))]
+			unsafe { ptr as *mut T }
+		}
+	}
+	#[inline]
+	/// Invert nonnull_ptr_to_inner
+	pub(crate) fn untweak_ptr<T>(ptr: *mut T) -> *mut T {
+		if core::mem::size_of::<T>() == 0 {
+			unsafe { ptr.cast::<u8>().sub(4096 - 1).cast::<T>() }
+		} else {
+			#[cfg(test_mod_pointers)]
+			unsafe { ptr.cast::<u8>().sub(4096).cast::<T>() }
+			#[cfg(not(test_mod_pointers))]
+			ptr
+		}
+	}
+}
+
+#[cfg(test_mod_pointers)]
+#[no_mangle]
+/// This function exists for memory safety testing purposes. It should never be used in production
+/// code
+pub extern "C" fn __unmangle_inner_ptr(ptr: *const c_void) -> *const c_void {
+	if ptr as usize == 1 {
+		core::ptr::null()
+	} else {
+		unsafe { ptr.cast::<u8>().sub(4096).cast::<c_void>() }
+	}
+}
+
+pub(crate) struct SmartPtr<T> {
+	ptr: *mut T,
+}
+impl<T> SmartPtr<T> {
+	pub(crate) fn from_obj(o: T) -> Self {
+		Self { ptr: Box::into_raw(Box::new(o)) }
+	}
+	pub(crate) fn null() -> Self {
+		Self { ptr: std::ptr::null_mut() }
+	}
+}
+impl<T> Drop for SmartPtr<T> {
+	fn drop(&mut self) {
+		if self.ptr != std::ptr::null_mut() {
+			unsafe { Box::from_raw(self.ptr); }
+		}
+	}
+}
+impl<T> std::ops::Deref for SmartPtr<T> {
+	type Target = *mut T;
+	fn deref(&self) -> &*mut T {
+		&self.ptr
+	}
+}