release store custom channel manager persister from Bindings' pointer dictionary jail

Author: arik-so

bindings/LDK/Bindings.swift

@@ -6,7 +6,6 @@
 //
 
 import Foundation
-import LDKHeaders
 
 public typealias LDKTransactionOutputs = LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ
 public typealias LDKTxid = LDKThirtyTwoBytes
@@ -21,6 +20,7 @@ open class NativeTypeWrapper: Hashable {
     internal let globalInstanceNumber: UInt
     internal var dangling = false
     internal private(set) var anchors: Set<NativeTypeWrapper> = []
+    internal var pointerDebugDescription: String? = nil
 
     init(conflictAvoidingVariableName: UInt) {
         Self.globalInstanceCounter += 1
@@ -3955,25 +3955,42 @@ withUnsafePointer(to: htlc.cOpaqueStruct!) { (htlcPointer: UnsafePointer<LDKHTLC
 
 	/* STATIC_METHODS_END */
 
-	static var nativelyExposedInstances = [String: AnyObject]()
+	static var nativelyExposedInstances = [String: NativeTypeWrapper]()
 
-	public class func instanceToPointer(instance: AnyObject) -> UnsafeMutableRawPointer {
+	public class func instanceToPointer(instance: NativeTypeWrapper) -> UnsafeMutableRawPointer {
 		let pointer = Unmanaged.passUnretained(instance).toOpaque()
+        instance.pointerDebugDescription = pointer.debugDescription
 		Self.nativelyExposedInstances[pointer.debugDescription] = instance
 		return pointer
 	}
 
-	public class func pointerToInstance<T: AnyObject>(pointer: UnsafeRawPointer, sourceMarker: String?) -> T{
+	public class func pointerToInstance<T: NativeTypeWrapper>(pointer: UnsafeRawPointer, sourceMarker: String?) -> T{
 
 		let callStack = Thread.callStackSymbols
 		let caller = sourceMarker ?? callStack[1]
-		print("Retrieving instance from pointer for caller: \(caller)")
+		// print("Retrieving instance from pointer for caller: \(caller)")
 		// let value = Unmanaged<T>.fromOpaque(pointer).takeUnretainedValue()
 		let value = Self.nativelyExposedInstances[pointer.debugDescription] as! T
-		print("Instance retrieved for caller: \(caller)")
+		// print("Instance retrieved for caller: \(caller)")
 		return value
 	}
 
+    public class func removeInstancePointer(instance: NativeTypeWrapper) -> Bool {
+        guard let debugDescription = instance.pointerDebugDescription else {
+            return false
+        }
+        Self.nativelyExposedInstances.removeValue(forKey: debugDescription)
+        instance.pointerDebugDescription = nil
+        return true
+    }
+
+    public class func clearInstancePointers() {
+        for (_, currentInstance) in Self.nativelyExposedInstances {
+            currentInstance.pointerDebugDescription = nil
+        }
+        Self.nativelyExposedInstances.removeAll()
+    }
+
 	/* SWIFT_TO_RUST_START */
 	public class func new_LDKTransactionWrapper(array: [UInt8]) -> LDKTransactionWrapper {
 		/* DIMENSION_REDUCTION_PREP */
@@ -4105,11 +4122,11 @@ withUnsafePointer(to: htlc.cOpaqueStruct!) { (htlcPointer: UnsafePointer<LDKHTLC
 
 }
 
-public class InstanceCrashSimulator {
+public class InstanceCrashSimulator: NativeTypeWrapper {
 
     public init() {
-
-    }
+		super.init(conflictAvoidingVariableName: 0)
+	}
 
     public func getPointer() -> UnsafeMutableRawPointer {
         let pointer = Bindings.instanceToPointer(instance: self)

bindings/batteries/ChannelManagerConstructor.swift

@@ -69,19 +69,18 @@ public class ChannelManagerConstructor: NativeTypeWrapper {
         }
 
         print("Collected channel monitors, reading channel manager")
-        let channelManagerResult = UtilMethods.constructor_BlockHashChannelManagerZ_read(ser: channel_manager_serialized, arg_keys_manager: keys_interface, arg_fee_estimator: fee_estimator, arg_chain_monitor: chain_monitor.as_Watch(), arg_tx_broadcaster: tx_broadcaster, arg_logger: logger, arg_default_config: UserConfig(), arg_channel_monitors: monitors)
+        let channelManagerResult: Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ = UtilMethods.constructor_BlockHashChannelManagerZ_read(ser: channel_manager_serialized, arg_keys_manager: keys_interface, arg_fee_estimator: fee_estimator, arg_chain_monitor: chain_monitor.as_Watch(), arg_tx_broadcaster: tx_broadcaster, arg_logger: logger, arg_default_config: UserConfig(), arg_channel_monitors: monitors)
         if channelManagerResult.isOk() != true {
             throw InvalidSerializedDataError.invalidSerializedChannelManager
         }
 
-
         for clonedChannelMonitor in self.channel_monitors {
             clonedChannelMonitor.0.cOpaqueStruct!.is_owned = true
         }
 
         let latestBlockHash = Bindings.LDKThirtyTwoBytes_to_array(nativeType: channelManagerResult.cOpaqueStruct!.contents.result.pointee.a)
-        let channelManager = ChannelManager(pointer: channelManagerResult.cOpaqueStruct!.contents.result.pointee.b)
-        try! channelManager.addAnchor(anchor: channelManagerResult)
+        let channelManager = ChannelManager(pointer: channelManagerResult.dangle().cOpaqueStruct!.contents.result.pointee.b)
+        // try! channelManager.addAnchor(anchor: channelManagerResult)
 
 
         self.channelManager = channelManager
@@ -170,18 +169,25 @@ public class ChannelManagerConstructor: NativeTypeWrapper {
             monitorClone.cOpaqueStruct?.is_owned = true
         }
 
-        self.customPersister = CustomChannelManagerPersister(handler: persister)
-        self.customEventHandler = CustomEventHandler(handler: persister)
-        self.backgroundProcessor = BackgroundProcessor(persister: self.customPersister!, event_handler: self.customEventHandler!, chain_monitor: self.chain_monitor, channel_manager: self.channelManager, peer_manager: self.peerManager, logger: self.logger)
+        let customPersister = CustomChannelManagerPersister(handler: persister)
+        let customEventHandler = CustomEventHandler(handler: persister)
+        /*self.backgroundProcessor = BackgroundProcessor(persister: self.customPersister!, event_handler: self.customEventHandler!, chain_monitor: self.chain_monitor, channel_manager: self.channelManager, peer_manager: self.peerManager, logger: self.logger)
+        try! self.backgroundProcessor!.addAnchor(anchor: self.channelManager)
         try! self.backgroundProcessor!.addAnchor(anchor: self.peerManager)
+        try! self.backgroundProcessor!.addAnchor(anchor: self.customPersister!)
+        try! self.backgroundProcessor!.addAnchor(anchor: self.customEventHandler!)*/
 
     }
 
     public func interrupt() {
         self.shutdown = true
         self.backgroundProcessor?.stop()
+        self.backgroundProcessor = nil
     }
 
+    deinit {
+        print("channelmanagerconstructor destructor")
+    }
 
 }
 

ci/LDKSwift/Tests/LDKSwiftTests/LDKSwiftTest.swift

@@ -73,7 +73,10 @@ class LDKSwiftTest: XCTestCase {
         let channel_manager = channel_manager_constructor.channelManager;
         let cmPersister = TestChannelManagerPersister(channelManager: channel_manager)
 
-        channel_manager_constructor.chain_sync_completed(persister: cmPersister)
+        //  channel_manager_constructor.chain_sync_completed(persister: cmPersister)
+        // channel_manager_constructor.interrupt()
+
+        Bindings.removeInstancePointer(instance: cmPersister)
 
     }
 

ci/LDKSwift/Tests/LDKSwiftTests/TestChannelManagerPersister.swift

@@ -9,19 +9,19 @@ import LDKSwift
 import LDKHeaders
 
 class TestChannelManagerPersister : ChannelManagerPersister, ExtendedChannelManagerPersister {
-    
+
     private let channelManager: ChannelManager?
     private let keysManager: KeysManager? = nil
-    
+
     init(channelManager: ChannelManager?) {
         self.channelManager = channelManager
         super.init()
     }
-    
+
     func handle_event(event: Event) {
         // privateHandleEvent(event: event)
     }
-    
+
     override func persist_manager(channel_manager: ChannelManager) -> Result_NoneErrorZ {
         return Result_NoneErrorZ()
     }