lldb 0.1.0

data/lib/lldb/value.rb

@@ -0,0 +1,334 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Value
+    include Enumerable #[Value]
+
+    # @rbs return: Frame | Value | Target
+    attr_reader :parent
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs parent: Frame | Value | Target
+    # @rbs return: void
+    def initialize(ptr, parent:)
+      @ptr = ptr # : FFI::Pointer
+      @parent = parent
+      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+    end
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs return: ^(Integer) -> void
+    def self.release(ptr)
+      ->(_id) { FFIBindings.lldb_value_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_value_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: String?
+    def name
+      return nil unless valid?
+
+      FFIBindings.lldb_value_get_name(@ptr)
+    end
+
+    # @rbs return: String?
+    def value
+      return nil unless valid?
+
+      FFIBindings.lldb_value_get_value(@ptr)
+    end
+
+    # @rbs return: String?
+    def summary
+      return nil unless valid?
+
+      FFIBindings.lldb_value_get_summary(@ptr)
+    end
+
+    # @rbs return: String?
+    def type_name
+      return nil unless valid?
+
+      FFIBindings.lldb_value_get_type_name(@ptr)
+    end
+
+    # @rbs return: Integer
+    def num_children
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_get_num_children(@ptr)
+    end
+
+    # @rbs index: Integer
+    # @rbs return: Value?
+    def child_at_index(index)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      child_ptr = FFIBindings.lldb_value_get_child_at_index(@ptr, index)
+      return nil if child_ptr.nil? || child_ptr.null?
+
+      Value.new(child_ptr, parent: self)
+    end
+
+    # @rbs name: String
+    # @rbs return: Value?
+    def child_member(name)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      child_ptr = FFIBindings.lldb_value_get_child_member_with_name(@ptr, name)
+      return nil if child_ptr.nil? || child_ptr.null?
+
+      Value.new(child_ptr, parent: self)
+    end
+
+    alias [] child_member
+
+    # @rbs return: Array[Value]
+    def children
+      (0...num_children).map { |i| child_at_index(i) }.compact
+    end
+
+    # @rbs &block: (Value) -> void
+    # @rbs return: Enumerator[Value, void] | void
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      children.each(&block)
+    end
+
+    # @rbs return: Integer
+    def value_as_signed
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_get_value_as_signed(@ptr)
+    end
+
+    alias to_i value_as_signed
+
+    # @rbs return: Integer
+    def value_as_unsigned
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_get_value_as_unsigned(@ptr)
+    end
+
+    # @rbs return: Integer
+    def byte_size
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_get_byte_size(@ptr)
+    end
+
+    # @rbs return: bool
+    def might_have_children?
+      return false unless valid?
+
+      FFIBindings.lldb_value_might_have_children(@ptr) != 0
+    end
+
+    # @rbs return: Error
+    def error
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      error = Error.new
+      FFIBindings.lldb_value_get_error(@ptr, error.to_ptr)
+      error
+    end
+
+    # @rbs return: bool
+    def has_error?
+      err = error
+      err.fail?
+    end
+
+    # @rbs return: Value?
+    def dereference
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      deref_ptr = FFIBindings.lldb_value_dereference(@ptr)
+      return nil if deref_ptr.nil? || deref_ptr.null?
+
+      Value.new(deref_ptr, parent: self)
+    end
+
+    # @rbs return: Value?
+    def address_of
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      addr_ptr = FFIBindings.lldb_value_address_of(@ptr)
+      return nil if addr_ptr.nil? || addr_ptr.null?
+
+      Value.new(addr_ptr, parent: self)
+    end
+
+    # @rbs return: String
+    def to_s
+      if summary
+        "#{name} = #{summary}"
+      elsif value
+        "#{name} = #{value}"
+      else
+        "#{name} (#{type_name})"
+      end
+    end
+
+    # @rbs return: String
+    def inspect
+      "#<LLDB::Value name=#{name.inspect} type=#{type_name.inspect} value=#{value.inspect}>"
+    end
+
+    # @rbs return: Type?
+    def type
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      type_ptr = FFIBindings.lldb_value_get_type(@ptr)
+      return nil if type_ptr.nil? || type_ptr.null?
+
+      Type.new(type_ptr)
+    end
+
+    # @rbs target_type: Type
+    # @rbs return: Value?
+    def cast(target_type)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      cast_ptr = FFIBindings.lldb_value_cast(@ptr, target_type.to_ptr)
+      return nil if cast_ptr.nil? || cast_ptr.null?
+
+      Value.new(cast_ptr, parent: self)
+    end
+
+    # @rbs return: Integer
+    def load_address
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_get_load_address(@ptr)
+    end
+
+    # @rbs return: Integer
+    def value_type
+      return ValueType::INVALID unless valid?
+
+      FFIBindings.lldb_value_get_value_type(@ptr)
+    end
+
+    # @rbs return: String
+    def value_type_name
+      ValueType.name(value_type)
+    end
+
+    # @rbs str: String
+    # @rbs return: bool
+    def set_value_from_cstring(str)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      error = Error.new
+      result = FFIBindings.lldb_value_set_value_from_cstring(@ptr, str, error.to_ptr)
+      error.raise_if_error!
+      result != 0
+    end
+
+    # @rbs name: String
+    # @rbs value_type: Type
+    # @rbs offset: Integer
+    # @rbs return: Value?
+    def create_child_at_offset(name, value_type, offset)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      child_ptr = FFIBindings.lldb_value_create_child_at_offset(@ptr, name, value_type.to_ptr, offset)
+      return nil if child_ptr.nil? || child_ptr.null?
+
+      Value.new(child_ptr, parent: self)
+    end
+
+    # @rbs name: String
+    # @rbs address: Integer
+    # @rbs value_type: Type
+    # @rbs return: Value?
+    def create_value_from_address(name, address, value_type)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      value_ptr = FFIBindings.lldb_value_create_value_from_address(@ptr, name, address, value_type.to_ptr)
+      return nil if value_ptr.nil? || value_ptr.null?
+
+      Value.new(value_ptr, parent: self)
+    end
+
+    # @rbs name: String
+    # @rbs expression: String
+    # @rbs return: Value?
+    def create_value_from_expression(name, expression)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      value_ptr = FFIBindings.lldb_value_create_value_from_expression(@ptr, name, expression)
+      return nil if value_ptr.nil? || value_ptr.null?
+
+      Value.new(value_ptr, parent: self)
+    end
+
+    # @rbs resolve: bool
+    # @rbs read: bool
+    # @rbs write: bool
+    # @rbs return: Watchpoint?
+    def watch(resolve: true, read: false, write: true)
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      error = Error.new
+      wp_ptr = FFIBindings.lldb_value_watch(@ptr, resolve ? 1 : 0, read ? 1 : 0, write ? 1 : 0, error.to_ptr)
+
+      error.raise_if_error!
+      return nil if wp_ptr.nil? || wp_ptr.null?
+
+      target = get_target_from_parent
+      Watchpoint.new(wp_ptr, target: target)
+    end
+
+    # @rbs return: String?
+    def expression_path
+      return nil unless valid?
+
+      FFIBindings.lldb_value_get_expression_path(@ptr)
+    end
+
+    # @rbs return: bool
+    def pointer_type?
+      return false unless valid?
+
+      FFIBindings.lldb_value_is_pointer_type(@ptr) != 0
+    end
+
+    # @rbs return: Value?
+    def non_synthetic_value
+      raise InvalidObjectError, 'Value is not valid' unless valid?
+
+      value_ptr = FFIBindings.lldb_value_get_non_synthetic_value(@ptr)
+      return nil if value_ptr.nil? || value_ptr.null?
+
+      Value.new(value_ptr, parent: self)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+
+    private
+
+    # @rbs return: Target
+    def get_target_from_parent
+      current = @parent
+      while current
+        return current.target if current.respond_to?(:target)
+        return current if current.is_a?(Target)
+
+        current = current.respond_to?(:parent) ? current.parent : nil
+      end
+      raise LLDBError, 'Could not find target from value hierarchy'
+    end
+  end
+end

data/lib/lldb/value_list.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class ValueList
+    include Enumerable #[Value]
+
+    # @rbs return: Frame | Value
+    attr_reader :parent
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs parent: Frame | Value
+    # @rbs return: void
+    def initialize(ptr, parent:)
+      @ptr = ptr # : FFI::Pointer
+      @parent = parent
+      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+    end
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs return: ^(Integer) -> void
+    def self.release(ptr)
+      ->(_id) { FFIBindings.lldb_value_list_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_value_list_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def size
+      return 0 unless valid?
+
+      FFIBindings.lldb_value_list_get_size(@ptr)
+    end
+
+    alias length size
+
+    # @rbs index: Integer
+    # @rbs return: Value?
+    def value_at_index(index)
+      raise InvalidObjectError, 'ValueList is not valid' unless valid?
+
+      value_ptr = FFIBindings.lldb_value_list_get_value_at_index(@ptr, index)
+      return nil if value_ptr.nil? || value_ptr.null?
+
+      Value.new(value_ptr, parent: @parent)
+    end
+
+    alias [] value_at_index
+
+    # @rbs name: String
+    # @rbs return: Value?
+    def first_value_by_name(name)
+      raise InvalidObjectError, 'ValueList is not valid' unless valid?
+
+      value_ptr = FFIBindings.lldb_value_list_get_first_value_by_name(@ptr, name)
+      return nil if value_ptr.nil? || value_ptr.null?
+
+      Value.new(value_ptr, parent: @parent)
+    end
+
+    # @rbs return: Array[Value]
+    def to_a
+      (0...size).map { |i| value_at_index(i) }.compact
+    end
+
+    # @rbs &block: (Value) -> void
+    # @rbs return: Enumerator[Value, void] | void
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      to_a.each(&block)
+    end
+
+    # @rbs return: bool
+    def empty?
+      size.zero?
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  VERSION = '0.1.0' # : String
+end

data/lib/lldb/watchpoint.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Watchpoint
+    # @rbs return: Target
+    attr_reader :target
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs target: Target
+    # @rbs return: void
+    def initialize(ptr, target:)
+      @ptr = ptr # : FFI::Pointer
+      @target = target
+      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+    end
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs return: ^(Integer) -> void
+    def self.release(ptr)
+      ->(_id) { FFIBindings.lldb_watchpoint_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_watchpoint_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def id
+      return -1 unless valid?
+
+      FFIBindings.lldb_watchpoint_get_id(@ptr)
+    end
+
+    # @rbs return: bool
+    def enabled?
+      return false unless valid?
+
+      FFIBindings.lldb_watchpoint_is_enabled(@ptr) != 0
+    end
+
+    # @rbs value: bool
+    # @rbs return: void
+    def enabled=(value)
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+
+      FFIBindings.lldb_watchpoint_set_enabled(@ptr, value ? 1 : 0)
+    end
+
+    # @rbs return: void
+    def enable
+      self.enabled = true
+    end
+
+    # @rbs return: void
+    def disable
+      self.enabled = false
+    end
+
+    # @rbs return: Integer
+    def hit_count
+      return 0 unless valid?
+
+      FFIBindings.lldb_watchpoint_get_hit_count(@ptr)
+    end
+
+    # @rbs return: Integer
+    def ignore_count
+      return 0 unless valid?
+
+      FFIBindings.lldb_watchpoint_get_ignore_count(@ptr)
+    end
+
+    # @rbs count: Integer
+    # @rbs return: void
+    def ignore_count=(count)
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+
+      FFIBindings.lldb_watchpoint_set_ignore_count(@ptr, count)
+    end
+
+    # @rbs return: String?
+    def condition
+      return nil unless valid?
+
+      cond = FFIBindings.lldb_watchpoint_get_condition(@ptr)
+      cond.nil? || cond.empty? ? nil : cond
+    end
+
+    # @rbs expr: String?
+    # @rbs return: void
+    def condition=(expr)
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+
+      FFIBindings.lldb_watchpoint_set_condition(@ptr, expr)
+    end
+
+    # @rbs return: Integer
+    def watch_address
+      return 0 unless valid?
+
+      FFIBindings.lldb_watchpoint_get_watch_address(@ptr)
+    end
+
+    # @rbs return: Integer
+    def watch_size
+      return 0 unless valid?
+
+      FFIBindings.lldb_watchpoint_get_watch_size(@ptr)
+    end
+
+    # @rbs return: bool
+    def watching_reads?
+      return false unless valid?
+
+      FFIBindings.lldb_watchpoint_is_watching_reads(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def watching_writes?
+      return false unless valid?
+
+      FFIBindings.lldb_watchpoint_is_watching_writes(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def delete
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+
+      target.delete_watchpoint(id)
+    end
+
+    # @rbs return: String
+    def to_s
+      "Watchpoint #{id}: address=0x#{watch_address.to_s(16)}, size=#{watch_size}, enabled=#{enabled?}"
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require_relative 'lldb/version'
+require_relative 'lldb/ffi_bindings'
+require_relative 'lldb/types'
+require_relative 'lldb/error'
+require_relative 'lldb/debugger'
+require_relative 'lldb/target'
+require_relative 'lldb/launch_info'
+require_relative 'lldb/process'
+require_relative 'lldb/thread'
+require_relative 'lldb/frame'
+require_relative 'lldb/breakpoint'
+require_relative 'lldb/breakpoint_location'
+require_relative 'lldb/value'
+require_relative 'lldb/value_list'
+require_relative 'lldb/type'
+require_relative 'lldb/watchpoint'
+require_relative 'lldb/module'
+require_relative 'lldb/symbol_context'
+require_relative 'lldb/command_return_object'
+require_relative 'lldb/command_interpreter'
+
+module LLDB
+  class << self
+    # @rbs return: void
+    def initialize
+      return if @initialized
+
+      FFIBindings.lldb_initialize
+      @initialized = true
+
+      at_exit { terminate }
+    end
+
+    # @rbs return: void
+    def terminate
+      return unless @initialized
+
+      FFIBindings.lldb_terminate
+      @initialized = false
+    end
+
+    # @rbs return: bool
+    def initialized?
+      @initialized == true
+    end
+
+    # @rbs return: void
+    def ensure_initialized!
+      return if initialized?
+
+      raise LLDBError, 'LLDB has not been initialized. Call LLDB.initialize first.'
+    end
+
+    # @rbs return: Debugger
+    def create_debugger
+      LLDB.initialize
+      Debugger.create
+    end
+  end
+end

data/lldb.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/lldb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lldb'
+  spec.version       = LLDB::VERSION
+  spec.authors       = ['Yudai Takada']
+  spec.email         = ['t.yudai92@gmail.com']
+
+  spec.summary       = 'Ruby bindings for LLDB debugger'
+  spec.description   = 'Access LLDB debugger functionality from Ruby via FFI'
+  spec.homepage      = 'https://github.com/ydah/lldb-ruby'
+  spec.licenses      = ['MIT', 'Apache-2.0']
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile Dockerfile])
+    end
+  end
+
+  spec.files += Dir['lib/**/*.rb', 'ext/**/*']
+  spec.extensions = ['ext/lldb/extconf.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ffi', '~> 1.15'
+end