Add feature flag tracking close method calls

lib/msf/core/feature_manager.rb

@@ -20,6 +20,7 @@ class FeatureManager
     MANAGER_COMMANDS = 'manager_commands'
     METASPLOIT_PAYLOAD_WARNINGS = 'metasploit_payload_warnings'
     DEFER_MODULE_LOADS = 'defer_module_loads'
+    LOG_ALL_CLOSE_METHOD_CALLS = 'log_all_close_method_calls'
     DEFAULTS = [
       {
         name: WRAPPED_TABLES,
@@ -53,6 +54,12 @@ class FeatureManager
         description: 'When enabled will not eagerly load all modules',
         requires_restart: true,
         default_value: false
+      }.freeze,
+      {
+        name: LOG_ALL_CLOSE_METHOD_CALLS,
+        description: 'Log all close method calls - used to debug crashes reported in https://github.com/rapid7/metasploit-framework/issues/18462',
+        requires_restart: true,
+        default_value: false
       }.freeze
     ].freeze
 

lib/msf/core/framework.rb

@@ -67,6 +67,28 @@ def initialize(options={})
     self.features = FeatureManager.instance
     self.features.load_config
 
+    if self.features.enabled?(Msf::FeatureManager::LOG_ALL_CLOSE_METHOD_CALLS)
+      log_directory = File.join(Msf::Config.log_directory, "close")
+      FileUtils.mkdir_p(log_directory)
+      close_logger = Logger.new(File.join(log_directory, "#{Time.now.to_s.gsub(' ', '-')}.log"))
+      TracePoint.new(:c_call) do |tp|
+        if tp.method_id == :close
+          event = {
+            lineno: tp.lineno,
+            defined_class: tp.defined_class,
+            tp: tp.method_id,
+            event: tp.event
+          }
+          details = <<~EOF
+        [DEBUG] Close called:
+        #{(caller || []).join("\n")}
+        #{JSON.pretty_generate(event)}
+          EOF
+          close_logger.info details
+        end
+      end.enable
+    end
+
     self.events    = EventDispatcher.new(self)
     self.modules   = ModuleManager.new(self,types)
     self.datastore = DataStore.new