lldb 0.1.0 → 0.3.0

data/lib/lldb/types.rb

@@ -3,6 +3,21 @@
 # rbs_inline: enabled
 
 module LLDB
+  INVALID_ADDRESS = (1 << 64) - 1 # : Integer
+  INVALID_PROCESS_ID = 0 # : Integer
+  INVALID_THREAD_ID = 0 # : Integer
+  INVALID_BREAK_ID = 0 # : Integer
+  INVALID_LINE_NUMBER = 0xFFFFFFFF # : Integer
+
+  module NativeStatus
+    OK = 0 # : Integer
+    INVALID_ARGUMENT = 1 # : Integer
+    INVALID_HANDLE = 2 # : Integer
+    UNSUPPORTED = 3 # : Integer
+    LLDB_ERROR = 4 # : Integer
+    INTERNAL_ERROR = 5 # : Integer
+  end
+
   module State
     INVALID = 0 # : Integer
     UNLOADED = 1 # : Integer
@@ -51,6 +66,10 @@ module LLDB
     PLAN_COMPLETE = 8 # : Integer
     THREAD_EXITING = 9 # : Integer
     INSTRUMENTATION = 10 # : Integer
+    PROCESSOR_TRACE = 11 # : Integer
+    FORK = 12 # : Integer
+    VFORK = 13 # : Integer
+    VFORK_DONE = 14 # : Integer
 
     NAMES = { # : Hash[Integer, String]
       INVALID => 'invalid',
@@ -63,7 +82,11 @@ module LLDB
       EXEC => 'exec',
       PLAN_COMPLETE => 'plan complete',
       THREAD_EXITING => 'thread exiting',
-      INSTRUMENTATION => 'instrumentation'
+      INSTRUMENTATION => 'instrumentation',
+      PROCESSOR_TRACE => 'processor trace',
+      FORK => 'fork',
+      VFORK => 'vfork',
+      VFORK_DONE => 'vfork done'
     }.freeze
 
     # @rbs reason: Integer
@@ -81,7 +104,8 @@ module LLDB
     BLOCK = 1 << 4 # : Integer
     LINE_ENTRY = 1 << 5 # : Integer
     SYMBOL = 1 << 6 # : Integer
-    EVERYTHING = 0xFFFF # : Integer
+    VARIABLE = 1 << 7 # : Integer
+    EVERYTHING = 0x7F # : Integer
   end
 
   module ValueType
@@ -93,6 +117,7 @@ module LLDB
     REGISTER = 5 # : Integer
     REGISTER_SET = 6 # : Integer
     CONSTANT_RESULT = 7 # : Integer
+    VARIABLE_THREAD_LOCAL = 8 # : Integer
 
     NAMES = { # : Hash[Integer, String]
       INVALID => 'invalid',
@@ -102,7 +127,8 @@ module LLDB
       VARIABLE_LOCAL => 'local',
       REGISTER => 'register',
       REGISTER_SET => 'register set',
-      CONSTANT_RESULT => 'constant result'
+      CONSTANT_RESULT => 'constant result',
+      VARIABLE_THREAD_LOCAL => 'thread local'
     }.freeze
 
     # @rbs value_type: Integer
@@ -145,6 +171,9 @@ module LLDB
     OBJ_C_CLASS = 29 # : Integer
     OBJ_C_SEL = 30 # : Integer
     NULL_PTR = 31 # : Integer
+    # LLDB inserted eBasicTypeChar8 before SHORT in newer releases. The
+    # wrapper normalizes it to this value so the public Ruby enum is stable.
+    CHAR8 = 32 # : Integer
 
     NAMES = { # : Hash[Integer, String]
       INVALID => 'invalid',
@@ -178,7 +207,8 @@ module LLDB
       OBJ_C_ID => 'id',
       OBJ_C_CLASS => 'Class',
       OBJ_C_SEL => 'SEL',
-      NULL_PTR => 'nullptr_t'
+      NULL_PTR => 'nullptr_t',
+      CHAR8 => 'char8_t'
     }.freeze
 
     # @rbs basic_type: Integer
@@ -187,4 +217,39 @@ module LLDB
       NAMES[basic_type] || 'unknown'
     end
   end
+
+  module ErrorType
+    INVALID = 0 # : Integer
+    GENERIC = 1 # : Integer
+    MACH_KERNEL = 2 # : Integer
+    POSIX = 3 # : Integer
+    EXPRESSION = 4 # : Integer
+    WIN32 = 5 # : Integer
+
+    NAMES = { # : Hash[Integer, String]
+      INVALID => 'invalid',
+      GENERIC => 'generic',
+      MACH_KERNEL => 'mach kernel',
+      POSIX => 'POSIX',
+      EXPRESSION => 'expression',
+      WIN32 => 'Win32'
+    }.freeze
+  end
+
+  module ReturnStatus
+    INVALID = 0 # : Integer
+    SUCCESS_FINISH_NO_RESULT = 1 # : Integer
+    SUCCESS_FINISH_RESULT = 2 # : Integer
+    SUCCESS_CONTINUING_NO_RESULT = 3 # : Integer
+    SUCCESS_CONTINUING_RESULT = 4 # : Integer
+    STARTED = 5 # : Integer
+    FAILED = 6 # : Integer
+    QUIT = 7 # : Integer
+  end
+
+  module RunMode
+    ONLY_THIS_THREAD = 0 # : Integer
+    ALL_THREADS = 1 # : Integer
+    ONLY_DURING_STEPPING = 2 # : Integer
+  end
 end

data/lib/lldb/value.rb

@@ -4,6 +4,7 @@
 
 module LLDB
   class Value
+    prepend NativeLifecycle
     include Enumerable #[Value]
 
     # @rbs return: Frame | Value | Target
@@ -12,10 +13,13 @@ module LLDB
     # @rbs ptr: FFI::Pointer
     # @rbs parent: Frame | Value | Target
     # @rbs return: void
-    def initialize(ptr, parent:)
-      @ptr = ptr # : FFI::Pointer
+    def initialize(ptr, parent:, context: parent.context)
       @parent = parent
-      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_value_destroy(released) },
+        context: context
+      )
     end
 
     # @rbs ptr: FFI::Pointer
@@ -72,7 +76,7 @@ module LLDB
       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)
+      Value.new(child_ptr, parent: self, context: context)
     end
 
     # @rbs name: String
@@ -83,7 +87,7 @@ module LLDB
       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)
+      Value.new(child_ptr, parent: self, context: context)
     end
 
     alias [] child_member
@@ -105,7 +109,10 @@ module LLDB
     def value_as_signed
       return 0 unless valid?
 
-      FFIBindings.lldb_value_get_value_as_signed(@ptr)
+      error = Error.new
+      result = FFIBindings.lldb_value_get_value_as_signed(@ptr, error.to_ptr, 0)
+      error.raise_if_error!('value.value_as_signed')
+      result
     end
 
     alias to_i value_as_signed
@@ -114,7 +121,10 @@ module LLDB
     def value_as_unsigned
       return 0 unless valid?
 
-      FFIBindings.lldb_value_get_value_as_unsigned(@ptr)
+      error = Error.new
+      result = FFIBindings.lldb_value_get_value_as_unsigned(@ptr, error.to_ptr, 0)
+      error.raise_if_error!('value.value_as_unsigned')
+      result
     end
 
     # @rbs return: Integer
@@ -153,7 +163,7 @@ module LLDB
       deref_ptr = FFIBindings.lldb_value_dereference(@ptr)
       return nil if deref_ptr.nil? || deref_ptr.null?
 
-      Value.new(deref_ptr, parent: self)
+      Value.new(deref_ptr, parent: self, context: context)
     end
 
     # @rbs return: Value?
@@ -163,7 +173,7 @@ module LLDB
       addr_ptr = FFIBindings.lldb_value_address_of(@ptr)
       return nil if addr_ptr.nil? || addr_ptr.null?
 
-      Value.new(addr_ptr, parent: self)
+      Value.new(addr_ptr, parent: self, context: context)
     end
 
     # @rbs return: String
@@ -189,7 +199,7 @@ module LLDB
       type_ptr = FFIBindings.lldb_value_get_type(@ptr)
       return nil if type_ptr.nil? || type_ptr.null?
 
-      Type.new(type_ptr)
+      Type.new(type_ptr, context: context)
     end
 
     # @rbs target_type: Type
@@ -200,12 +210,12 @@ module LLDB
       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)
+      Value.new(cast_ptr, parent: self, context: context)
     end
 
     # @rbs return: Integer
     def load_address
-      return 0 unless valid?
+      return INVALID_ADDRESS unless valid?
 
       FFIBindings.lldb_value_get_load_address(@ptr)
     end
@@ -243,7 +253,7 @@ module LLDB
       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)
+      Value.new(child_ptr, parent: self, context: context)
     end
 
     # @rbs name: String
@@ -256,7 +266,7 @@ module LLDB
       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)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs name: String
@@ -268,7 +278,7 @@ module LLDB
       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)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs resolve: bool
@@ -285,7 +295,7 @@ module LLDB
       return nil if wp_ptr.nil? || wp_ptr.null?
 
       target = get_target_from_parent
-      Watchpoint.new(wp_ptr, target: target)
+      Watchpoint.new(wp_ptr, target: target, context: context)
     end
 
     # @rbs return: String?
@@ -309,7 +319,7 @@ module LLDB
       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)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs return: FFI::Pointer

data/lib/lldb/value_list.rb

@@ -4,6 +4,7 @@
 
 module LLDB
   class ValueList
+    prepend NativeLifecycle
     include Enumerable #[Value]
 
     # @rbs return: Frame | Value
@@ -12,10 +13,13 @@ module LLDB
     # @rbs ptr: FFI::Pointer
     # @rbs parent: Frame | Value
     # @rbs return: void
-    def initialize(ptr, parent:)
-      @ptr = ptr # : FFI::Pointer
+    def initialize(ptr, parent:, context: parent.context)
       @parent = parent
-      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_value_list_destroy(released) },
+        context: context
+      )
     end
 
     # @rbs ptr: FFI::Pointer
@@ -46,7 +50,7 @@ module LLDB
       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)
+      Value.new(value_ptr, parent: @parent, context: context)
     end
 
     alias [] value_at_index
@@ -59,7 +63,7 @@ module LLDB
       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)
+      Value.new(value_ptr, parent: @parent, context: context)
     end
 
     # @rbs return: Array[Value]

data/lib/lldb/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 module LLDB
-  VERSION = '0.1.0' # : String
+  VERSION = '0.3.0' # : String
 end

data/lib/lldb/watchpoint.rb

@@ -4,16 +4,21 @@
 
 module LLDB
   class Watchpoint
+    prepend NativeLifecycle
+
     # @rbs return: Target
     attr_reader :target
 
     # @rbs ptr: FFI::Pointer
     # @rbs target: Target
     # @rbs return: void
-    def initialize(ptr, target:)
-      @ptr = ptr # : FFI::Pointer
+    def initialize(ptr, target:, context: target.context)
       @target = target
-      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_watchpoint_destroy(released) },
+        context: context
+      )
     end
 
     # @rbs ptr: FFI::Pointer
@@ -29,7 +34,7 @@ module LLDB
 
     # @rbs return: Integer
     def id
-      return -1 unless valid?
+      return INVALID_BREAK_ID unless valid?
 
       FFIBindings.lldb_watchpoint_get_id(@ptr)
     end
@@ -99,7 +104,7 @@ module LLDB
 
     # @rbs return: Integer
     def watch_address
-      return 0 unless valid?
+      return INVALID_ADDRESS unless valid?
 
       FFIBindings.lldb_watchpoint_get_watch_address(@ptr)
     end
@@ -113,16 +118,28 @@ module LLDB
 
     # @rbs return: bool
     def watching_reads?
-      return false unless valid?
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+      APISupport.require_feature!(:watchpoint_access_kind)
 
-      FFIBindings.lldb_watchpoint_is_watching_reads(@ptr) != 0
+      result = FFI::MemoryPointer.new(:int)
+      status = FFIBindings.lldb_watchpoint_is_watching_reads(@ptr, result)
+      raise UnsupportedAPIError, 'Watchpoint read access is unsupported' if status == NativeStatus::UNSUPPORTED
+      raise LLDBError, "Failed to query watchpoint read access (status=#{status})" unless status == NativeStatus::OK
+
+      result.read_int != 0
     end
 
     # @rbs return: bool
     def watching_writes?
-      return false unless valid?
+      raise InvalidObjectError, 'Watchpoint is not valid' unless valid?
+      APISupport.require_feature!(:watchpoint_access_kind)
+
+      result = FFI::MemoryPointer.new(:int)
+      status = FFIBindings.lldb_watchpoint_is_watching_writes(@ptr, result)
+      raise UnsupportedAPIError, 'Watchpoint write access is unsupported' if status == NativeStatus::UNSUPPORTED
+      raise LLDBError, "Failed to query watchpoint write access (status=#{status})" unless status == NativeStatus::OK
 
-      FFIBindings.lldb_watchpoint_is_watching_writes(@ptr) != 0
+      result.read_int != 0
     end
 
     # @rbs return: bool

data/lib/lldb.rb

@@ -3,13 +3,30 @@
 # rbs_inline: enabled
 
 require_relative 'lldb/version'
+require_relative 'lldb/error'
 require_relative 'lldb/ffi_bindings'
 require_relative 'lldb/types'
-require_relative 'lldb/error'
+require_relative 'lldb/native'
+require_relative 'lldb/native_handle'
+require_relative 'lldb/context'
+require_relative 'lldb/native_lifecycle'
+require_relative 'lldb/native_buffer'
+require_relative 'lldb/api_support'
+require_relative 'lldb/native_string_array'
+require_relative 'lldb/file_spec'
+require_relative 'lldb/file_spec_list'
+require_relative 'lldb/address'
+require_relative 'lldb/line_entry'
+require_relative 'lldb/attach_info'
+require_relative 'lldb/expression_options'
+require_relative 'lldb/broadcaster'
+require_relative 'lldb/listener'
+require_relative 'lldb/event'
 require_relative 'lldb/debugger'
 require_relative 'lldb/target'
 require_relative 'lldb/launch_info'
 require_relative 'lldb/process'
+require_relative 'lldb/memory_region_info'
 require_relative 'lldb/thread'
 require_relative 'lldb/frame'
 require_relative 'lldb/breakpoint'
@@ -17,6 +34,13 @@ require_relative 'lldb/breakpoint_location'
 require_relative 'lldb/value'
 require_relative 'lldb/value_list'
 require_relative 'lldb/type'
+require_relative 'lldb/type_member'
+require_relative 'lldb/symbol'
+require_relative 'lldb/function'
+require_relative 'lldb/compile_unit'
+require_relative 'lldb/block'
+require_relative 'lldb/instruction'
+require_relative 'lldb/instruction_list'
 require_relative 'lldb/watchpoint'
 require_relative 'lldb/module'
 require_relative 'lldb/symbol_context'
@@ -27,20 +51,29 @@ module LLDB
   class << self
     # @rbs return: void
     def initialize
-      return if @initialized
+      lifecycle_mutex.synchronize do
+        return if @initialized
 
-      FFIBindings.lldb_initialize
-      @initialized = true
+        error = Error.new
+        status = FFIBindings.lldb_initialize(error.to_ptr)
+        Native.check_status!(status, 'lldb.initialize', error)
+        @initialized = true
 
-      at_exit { terminate }
+        at_exit { terminate if open_debugger_count.zero? }
+      end
     end
 
     # @rbs return: void
     def terminate
-      return unless @initialized
+      lifecycle_mutex.synchronize do
+        return unless @initialized
+        if live_debugger_count.positive?
+          raise LifecycleError, 'cannot terminate LLDB while debuggers are open'
+        end
 
-      FFIBindings.lldb_terminate
-      @initialized = false
+        FFIBindings.lldb_terminate
+        @initialized = false
+      end
     end
 
     # @rbs return: bool
@@ -56,9 +89,46 @@ module LLDB
     end
 
     # @rbs return: Debugger
-    def create_debugger
+    def create_debugger(source_init_files: false)
       LLDB.initialize
-      Debugger.create
+      Debugger.create(source_init_files: source_init_files)
+    end
+
+    # @rbs return: Integer
+    def open_debugger_count
+      lifecycle_mutex.synchronize { live_debugger_count }
+    end
+
+    # @rbs debugger: Debugger
+    # @rbs return: void
+    def register_debugger(debugger)
+      lifecycle_mutex.synchronize do
+        debuggers = (@debuggers ||= []) # : Array[WeakRef]
+        debuggers << WeakRef.new(debugger)
+      end
+    end
+
+    private
+
+    # @rbs return: Integer
+    def live_debugger_count
+      live = [] # : Array[WeakRef]
+      count = (@debuggers || []).count do |reference|
+        begin
+          debugger = reference.__getobj__
+          live << reference
+          !debugger.closed?
+        rescue WeakRef::RefError
+          false
+        end
+      end
+      @debuggers = live
+      count
+    end
+
+    # @rbs return: Mutex
+    def lifecycle_mutex
+      @lifecycle_mutex ||= Mutex.new
     end
   end
 end

data/lldb.gemspec

@@ -25,7 +25,10 @@ Gem::Specification.new do |spec|
     end
   end
 
-  spec.files += Dir['lib/**/*.rb', 'ext/**/*']
+  generated_extension_file = %r{\Aext/lldb/(?:Makefile|mkmf\.log|lldb_wrapper_config\.h|.*\.(?:o|so|dylib|dll))\z}
+  spec.files += Dir['lib/**/*.rb', 'ext/**/*'].select do |file|
+    File.file?(file) && !file.match?(generated_extension_file)
+  end
   spec.extensions = ['ext/lldb/extconf.rb']
   spec.require_paths = ['lib']
 

data/rbs_collection.yaml

@@ -3,7 +3,7 @@ sources:
   - type: git
     name: ruby/gem_rbs_collection
     remote: https://github.com/ruby/gem_rbs_collection.git
-    revision: main
+    revision: b01c0409f55afb1c03e43077c61c44bae61026eb
     repo_dir: gems
 
 # You can specify local directories as sources also.