lldb 0.2.0 → 0.3.0

data/lib/lldb/compile_unit.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class CompileUnit
+    prepend NativeLifecycle
+
+    # @rbs target: Target?
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(ptr, target: nil, context: nil)
+      @target = target
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_compile_unit_destroy(released) },
+        context: context || target&.context
+      )
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_compile_unit_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: FileSpec?
+    def file_spec
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_compile_unit_get_file_spec(@ptr)
+      return nil if ptr.nil? || ptr.null?
+
+      FileSpec.from_ptr(ptr, context: context)
+    end
+
+    # @rbs return: Integer
+    def num_line_entries
+      return 0 unless valid?
+
+      FFIBindings.lldb_compile_unit_get_num_line_entries(@ptr)
+    end
+
+    # @rbs index: Integer
+    # @rbs return: LineEntry?
+    def line_entry_at_index(index)
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_compile_unit_get_line_entry_at_index(@ptr, index)
+      return nil if ptr.nil? || ptr.null?
+
+      LineEntry.new(ptr, target: @target, context: context)
+    end
+
+    # @rbs return: Array[LineEntry]
+    def line_entries
+      (0...num_line_entries).map { |index| line_entry_at_index(index) }.compact
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/context.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require 'weakref'
+
+module LLDB
+  class Context
+    OPEN = :open
+    CLOSING = :closing
+    CLOSED = :closed
+
+    # @rbs return: void
+    def initialize
+      @mutex = Mutex.new
+      @state = OPEN
+      @handles = [] # : Array[WeakRef]
+    end
+
+    # @rbs handle: NativeHandle
+    # @rbs return: NativeHandle
+    def register(handle)
+      @mutex.synchronize do
+        raise LifecycleError, 'LLDB context is closed' unless @state == OPEN
+
+        @handles << WeakRef.new(handle)
+      end
+      handle
+    end
+
+    # @rbs return: ::Symbol
+    def state
+      @mutex.synchronize { @state }
+    end
+
+    # @rbs return: bool
+    def open?
+      state == OPEN
+    end
+
+    # @rbs return: bool
+    def closing?
+      state == CLOSING
+    end
+
+    # @rbs return: bool
+    def closed?
+      state == CLOSED
+    end
+
+    # @rbs return: void
+    def ensure_open!
+      raise ClosedObjectError, 'LLDB context is closed' unless open?
+    end
+
+    # @rbs except: NativeHandle?
+    # @rbs return: void
+    def close(except: nil)
+      handles = @mutex.synchronize do
+        next nil if @state == CLOSED || @state == CLOSING
+
+        @state = CLOSING
+        @handles.filter_map do |reference|
+          begin
+            handle = reference.__getobj__
+            handle unless handle.equal?(except)
+          rescue WeakRef::RefError
+            nil
+          end
+        end
+      end
+      return unless handles
+
+      begin
+        handles.each(&:close)
+      ensure
+        @mutex.synchronize { @state = CLOSED }
+      end
+    end
+  end
+end

data/lib/lldb/debugger.rb

@@ -4,21 +4,27 @@
 
 module LLDB
   class Debugger
+    prepend NativeLifecycle
+
     # @rbs return: Debugger
-    def self.create
+    def self.create(source_init_files: false)
       LLDB.ensure_initialized!
-      ptr = FFIBindings.lldb_debugger_create
+      ptr = FFIBindings.lldb_debugger_create_with_source_init_files(source_init_files ? 1 : 0)
       raise LLDBError, 'Failed to create debugger' if ptr.null?
 
-      new(ptr)
+      new(ptr, context: Context.new).tap { |debugger| LLDB.register_debugger(debugger) }
     end
 
     # @rbs ptr: FFI::Pointer
+    # @rbs context: Context
     # @rbs return: void
-    def initialize(ptr)
-      @ptr = ptr # : FFI::Pointer
+    def initialize(ptr, context: Context.new)
       @targets = [] # : Array[Target]
-      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_debugger_destroy(released) },
+        context: context
+      )
     end
 
     # @rbs ptr: FFI::Pointer
@@ -32,6 +38,16 @@ module LLDB
       !@ptr.null? && FFIBindings.lldb_debugger_is_valid(@ptr) != 0
     end
 
+    # @rbs return: bool
+    def close
+      return false if closed?
+
+      context!.close(except: @native_handle)
+      @native_handle.close
+      @ptr = NativeHandle::NULL_POINTER
+      true
+    end
+
     # @rbs filename: String
     # @rbs arch: String?
     # @rbs platform: String?
@@ -53,7 +69,7 @@ module LLDB
       error.raise_if_error!
       raise LLDBError, "Failed to create target for '#{filename}'" if target_ptr.nil? || target_ptr.null?
 
-      target = Target.new(target_ptr, debugger: self)
+      target = Target.new(target_ptr, debugger: self, context: context)
       @targets << target
       target
     end
@@ -66,7 +82,7 @@ module LLDB
       target_ptr = FFIBindings.lldb_debugger_create_target_simple(@ptr, filename.to_s)
       raise LLDBError, "Failed to create target for '#{filename}'" if target_ptr.nil? || target_ptr.null?
 
-      target = Target.new(target_ptr, debugger: self)
+      target = Target.new(target_ptr, debugger: self, context: context)
       @targets << target
       target
     end
@@ -86,7 +102,7 @@ module LLDB
       target_ptr = FFIBindings.lldb_debugger_get_target_at_index(@ptr, index)
       return nil if target_ptr.nil? || target_ptr.null?
 
-      Target.new(target_ptr, debugger: self)
+      Target.new(target_ptr, debugger: self, context: context)
     end
 
     # @rbs return: Target?
@@ -96,7 +112,7 @@ module LLDB
       target_ptr = FFIBindings.lldb_debugger_get_selected_target(@ptr)
       return nil if target_ptr.nil? || target_ptr.null?
 
-      Target.new(target_ptr, debugger: self)
+      Target.new(target_ptr, debugger: self, context: context)
     end
 
     # @rbs return: Array[Target]
@@ -145,7 +161,7 @@ module LLDB
       target_ptr = FFIBindings.lldb_debugger_find_target_with_process_id(@ptr, pid)
       return nil if target_ptr.nil? || target_ptr.null?
 
-      Target.new(target_ptr, debugger: self)
+      Target.new(target_ptr, debugger: self, context: context)
     end
 
     # @rbs return: String?
@@ -160,7 +176,27 @@ module LLDB
       ci_ptr = FFIBindings.lldb_debugger_get_command_interpreter(@ptr)
       raise LLDBError, 'Failed to get command interpreter' if ci_ptr.nil? || ci_ptr.null?
 
-      CommandInterpreter.new(ci_ptr, debugger: self)
+      CommandInterpreter.new(ci_ptr, debugger: self, context: context)
+    end
+
+    # @rbs return: Broadcaster
+    def broadcaster
+      raise InvalidObjectError, 'Debugger is not valid' unless valid?
+
+      broadcaster_ptr = FFIBindings.lldb_debugger_get_broadcaster(@ptr)
+      raise LLDBError, 'Failed to get debugger broadcaster' if broadcaster_ptr.nil? || broadcaster_ptr.null?
+
+      Broadcaster.from_ptr(broadcaster_ptr, context: context)
+    end
+
+    # @rbs return: Listener
+    def listener
+      raise InvalidObjectError, 'Debugger is not valid' unless valid?
+
+      listener_ptr = FFIBindings.lldb_debugger_get_listener(@ptr)
+      raise LLDBError, 'Failed to get debugger listener' if listener_ptr.nil? || listener_ptr.null?
+
+      Listener.from_ptr(listener_ptr, context: context)
     end
 
     # @rbs command: String
@@ -175,5 +211,12 @@ module LLDB
     def to_ptr
       @ptr
     end
+
+    private
+
+    # @rbs return: void
+    def close_context
+      context!.close(except: @native_handle)
+    end
   end
 end

data/lib/lldb/error.rb

@@ -5,11 +5,45 @@
 module LLDB
   class LLDBError < StandardError; end
   class InvalidObjectError < LLDBError; end
+  class ClosedObjectError < InvalidObjectError; end
+  class LifecycleError < LLDBError; end
   class LaunchError < LLDBError; end
   class AttachError < LLDBError; end
   class BreakpointError < LLDBError; end
   class EvaluationError < LLDBError; end
   class UnsupportedAPIError < LLDBError; end
+  class UnsupportedPlatformError < LLDBError; end
+  class IncompatibleWrapperError < LLDBError; end
+
+  class OperationError < LLDBError
+    attr_reader :operation, :error, :code, :error_type
+
+    # @rbs operation: String
+    # @rbs error: Error
+    # @rbs return: void
+    def initialize(operation, error)
+      @operation = operation
+      @error = error
+      @code = error.code
+      @error_type = error.type
+      super("LLDB operation '#{operation}' failed (type=#{error.type_name}, code=#{error.code}): #{error.message}")
+    end
+  end
+
+  class InternalBindingError < LLDBError
+    attr_reader :operation, :native_message, :native_code
+
+    # @rbs operation: String
+    # @rbs native_message: String
+    # @rbs native_code: Integer
+    # @rbs return: void
+    def initialize(operation, native_message, native_code)
+      @operation = operation
+      @native_message = native_message
+      @native_code = native_code
+      super("Native wrapper operation '#{operation}' failed (code=#{native_code}): #{native_message}")
+    end
+  end
 
   class Error
     # @rbs ptr: FFI::Pointer?
@@ -43,10 +77,22 @@ module LLDB
     alias to_s message
 
     # @rbs return: Integer
-    def error_code
+    def code
       FFIBindings.lldb_error_get_error(@ptr)
     end
 
+    alias error_code code
+
+    # @rbs return: Integer
+    def type
+      FFIBindings.lldb_error_get_type(@ptr)
+    end
+
+    # @rbs return: String
+    def type_name
+      ErrorType::NAMES.fetch(type, 'unknown')
+    end
+
     # @rbs return: void
     def clear
       FFIBindings.lldb_error_clear(@ptr)
@@ -63,9 +109,10 @@ module LLDB
       @ptr
     end
 
+    # @rbs operation: String
     # @rbs return: void
-    def raise_if_error!
-      raise LLDBError, message if fail?
+    def raise_if_error!(operation = 'native operation')
+      raise OperationError.new(operation, self) if fail?
     end
   end
 end

data/lib/lldb/event.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Event
+    prepend NativeLifecycle
+
+    # @rbs context: Context?
+    # @rbs pointer: FFI::Pointer
+    # @rbs return: void
+    def initialize(pointer, context: nil)
+      initialize_native_object(
+        pointer,
+        release: ->(released) { FFIBindings.lldb_event_destroy(released) },
+        context: context
+      )
+    end
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs context: Context?
+    # @rbs return: Event
+    def self.from_ptr(ptr, context: nil)
+      new(ptr, context: context)
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_event_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def type
+      return 0 unless valid?
+
+      FFIBindings.lldb_event_get_type(@ptr)
+    end
+
+    # @rbs return: String?
+    def data_flavor
+      return nil unless valid?
+
+      FFIBindings.lldb_event_get_data_flavor(@ptr)
+    end
+
+    # @rbs return: String?
+    def broadcaster_class
+      return nil unless valid?
+
+      FFIBindings.lldb_event_get_broadcaster_class(@ptr)
+    end
+
+    # @rbs return: String
+    def description
+      return '' unless valid?
+
+      NativeBuffer.read_c_string do |buffer, length|
+        FFIBindings.lldb_event_get_description(@ptr, buffer, length)
+      end
+    end
+
+    # @rbs return: Broadcaster?
+    def broadcaster
+      return nil unless valid?
+
+      broadcaster_ptr = FFIBindings.lldb_event_get_broadcaster(@ptr)
+      return nil if broadcaster_ptr.nil? || broadcaster_ptr.null?
+
+      Broadcaster.from_ptr(broadcaster_ptr, context: context)
+    end
+
+    # @rbs return: bool
+    def process_event?
+      valid? && FFIBindings.lldb_event_is_process_event(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def process_state
+      return State::INVALID unless valid?
+
+      FFIBindings.lldb_event_get_process_state(@ptr)
+    end
+
+    # @rbs return: Process?
+    def process
+      return nil unless process_event?
+
+      process_ptr = FFIBindings.lldb_event_get_process(@ptr)
+      return nil if process_ptr.nil? || process_ptr.null?
+
+      Process.new(process_ptr, target: nil, context: context)
+    end
+
+    # @rbs return: bool
+    def restarted?
+      valid? && FFIBindings.lldb_event_get_restarted(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def interrupted?
+      valid? && FFIBindings.lldb_event_get_interrupted(@ptr) != 0
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/expression_options.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  module DynamicValue
+    NO_DYNAMIC = 0
+    CAN_RUN_TARGET = 1
+    DONT_RUN_TARGET = 2
+  end
+
+  class ExpressionOptions
+    prepend NativeLifecycle
+
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(context: nil)
+      ptr = FFIBindings.lldb_expression_options_create
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_expression_options_destroy(released) },
+        context: context
+      )
+      @language = nil
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null?
+    end
+
+    # @rbs return: Integer
+    def timeout
+      FFIBindings.lldb_expression_options_get_timeout(@ptr)
+    end
+
+    # @rbs value: Integer
+    # @rbs return: void
+    def timeout=(value)
+      FFIBindings.lldb_expression_options_set_timeout(@ptr, value)
+    end
+
+    # @rbs return: bool
+    def unwind_on_error?
+      FFIBindings.lldb_expression_options_get_unwind_on_error(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def unwind_on_error=(value)
+      FFIBindings.lldb_expression_options_set_unwind_on_error(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: bool
+    def ignore_breakpoints?
+      FFIBindings.lldb_expression_options_get_ignore_breakpoints(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def ignore_breakpoints=(value)
+      FFIBindings.lldb_expression_options_set_ignore_breakpoints(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: Integer
+    def fetch_dynamic_value
+      FFIBindings.lldb_expression_options_get_fetch_dynamic_value(@ptr)
+    end
+
+    # @rbs value: Integer
+    # @rbs return: void
+    def fetch_dynamic_value=(value)
+      FFIBindings.lldb_expression_options_set_fetch_dynamic_value(@ptr, value)
+    end
+
+    # @rbs return: bool
+    def try_all_threads?
+      FFIBindings.lldb_expression_options_get_try_all_threads(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def try_all_threads=(value)
+      FFIBindings.lldb_expression_options_set_try_all_threads(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: bool
+    def stop_others?
+      FFIBindings.lldb_expression_options_get_stop_others(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def stop_others=(value)
+      FFIBindings.lldb_expression_options_set_stop_others(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: Integer?
+    attr_reader :language
+
+    # @rbs value: Integer
+    # @rbs return: void
+    def language=(value)
+      @language = value
+      FFIBindings.lldb_expression_options_set_language(@ptr, value)
+    end
+
+    # @rbs return: bool
+    def suppress_persistent_result?
+      FFIBindings.lldb_expression_options_get_suppress_persistent_result(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def suppress_persistent_result=(value)
+      FFIBindings.lldb_expression_options_set_suppress_persistent_result(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end