lldb 0.1.0

data/lib/lldb/launch_info.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  # Launch flags for process launching
+  module LaunchFlags
+    NONE = 0
+    EXEC = (1 << 0)
+    DEBUG = (1 << 1)
+    STOP_AT_ENTRY = (1 << 2)
+    DISABLE_ASLR = (1 << 3)
+    DISABLE_STDIO = (1 << 4)
+    LAUNCH_IN_TTY = (1 << 5)
+    LAUNCH_IN_SHELL = (1 << 6)
+    LAUNCH_IN_SEPARATE_PROCESS_GROUP = (1 << 7)
+    DONT_SET_EXIT_STATUS = (1 << 8)
+    DETACH_ON_ERROR = (1 << 9)
+    SHELL_EXPAND_ARGUMENTS = (1 << 10)
+    CLOSE_TTY_ON_EXIT = (1 << 11)
+    INHERIT_TCC_FROM_PARENT = (1 << 12)
+  end
+
+  class LaunchInfo
+    # @rbs args: Array[String]?
+    # @rbs return: void
+    def initialize(args = nil)
+      argv = nil
+      if args && !args.empty?
+        argv = FFI::MemoryPointer.new(:pointer, args.length + 1)
+        args.each_with_index do |arg, i|
+          argv[i].put_pointer(0, FFI::MemoryPointer.from_string(arg))
+        end
+        argv[args.length].put_pointer(0, nil)
+      end
+
+      @ptr = FFIBindings.lldb_launch_info_create(argv) # : FFI::Pointer
+      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+    end
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs return: ^(Integer) -> void
+    def self.release(ptr)
+      ->(_id) { FFIBindings.lldb_launch_info_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs dir: String
+    # @rbs return: void
+    def working_directory=(dir)
+      FFIBindings.lldb_launch_info_set_working_directory(@ptr, dir)
+    end
+
+    # @rbs env: Hash[String, String]
+    # @rbs append: bool
+    # @rbs return: void
+    def set_environment(env, append: true)
+      return unless env && !env.empty?
+
+      env_strings = env.map { |k, v| "#{k}=#{v}" }
+      envp = FFI::MemoryPointer.new(:pointer, env_strings.length + 1)
+      env_strings.each_with_index do |e, i|
+        envp[i].put_pointer(0, FFI::MemoryPointer.from_string(e))
+      end
+      envp[env_strings.length].put_pointer(0, nil)
+
+      FFIBindings.lldb_launch_info_set_environment_entries(@ptr, envp, append ? 1 : 0)
+    end
+
+    # @rbs return: Integer
+    def launch_flags
+      FFIBindings.lldb_launch_info_get_launch_flags(@ptr)
+    end
+
+    # @rbs flags: Integer
+    # @rbs return: void
+    def launch_flags=(flags)
+      FFIBindings.lldb_launch_info_set_launch_flags(@ptr, flags)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/module.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Module
+    # @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_module_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_module_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: String?
+    def file_path
+      return nil unless valid?
+
+      FFIBindings.lldb_module_get_file_path(@ptr)
+    end
+
+    # @rbs return: String?
+    def platform_file_path
+      return nil unless valid?
+
+      FFIBindings.lldb_module_get_platform_file_path(@ptr)
+    end
+
+    # @rbs return: Integer
+    def num_symbols
+      return 0 unless valid?
+
+      FFIBindings.lldb_module_get_num_symbols(@ptr)
+    end
+
+    # @rbs return: String
+    def to_s
+      file_path || '(unknown module)'
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/process.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Process
+    # @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_process_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_process_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def continue
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_continue(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def stop
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_stop(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def kill
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_kill(@ptr) != 0
+    end
+
+    # @rbs return: bool
+    def detach
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_detach(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def state
+      return State::INVALID unless valid?
+
+      FFIBindings.lldb_process_get_state(@ptr)
+    end
+
+    # @rbs return: String
+    def state_name
+      State.name(state)
+    end
+
+    # @rbs return: bool
+    def stopped?
+      state == State::STOPPED
+    end
+
+    # @rbs return: bool
+    def running?
+      state == State::RUNNING
+    end
+
+    # @rbs return: bool
+    def exited?
+      state == State::EXITED
+    end
+
+    # @rbs return: bool
+    def crashed?
+      state == State::CRASHED
+    end
+
+    # @rbs return: Integer
+    def num_threads
+      return 0 unless valid?
+
+      FFIBindings.lldb_process_get_num_threads(@ptr)
+    end
+
+    # @rbs index: Integer
+    # @rbs return: Thread?
+    def thread_at_index(index)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      thread_ptr = FFIBindings.lldb_process_get_thread_at_index(@ptr, index)
+      return nil if thread_ptr.nil? || thread_ptr.null?
+
+      Thread.new(thread_ptr, process: self)
+    end
+
+    # @rbs return: Thread?
+    def selected_thread
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      thread_ptr = FFIBindings.lldb_process_get_selected_thread(@ptr)
+      return nil if thread_ptr.nil? || thread_ptr.null?
+
+      Thread.new(thread_ptr, process: self)
+    end
+
+    # @rbs thread_id: Integer
+    # @rbs return: bool
+    def select_thread_by_id(thread_id)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_set_selected_thread_by_id(@ptr, thread_id) != 0
+    end
+
+    # @rbs return: Array[Thread]
+    def threads
+      (0...num_threads).map { |i| thread_at_index(i) }.compact
+    end
+
+    # @rbs return: Integer
+    def process_id
+      return 0 unless valid?
+
+      FFIBindings.lldb_process_get_process_id(@ptr)
+    end
+
+    alias pid process_id
+
+    # @rbs return: Integer
+    def exit_status
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_get_exit_status(@ptr)
+    end
+
+    # @rbs return: String?
+    def exit_description
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_get_exit_description(@ptr)
+    end
+
+    # @rbs return: bool
+    def destroy
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_destroy_process(@ptr) != 0
+    end
+
+    # @rbs signal: Integer
+    # @rbs return: bool
+    def signal(signal)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_signal(@ptr, signal) != 0
+    end
+
+    # @rbs thread_id: Integer
+    # @rbs return: Thread?
+    def thread_by_id(thread_id)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      thread_ptr = FFIBindings.lldb_process_get_thread_by_id(@ptr, thread_id)
+      return nil if thread_ptr.nil? || thread_ptr.null?
+
+      Thread.new(thread_ptr, process: self)
+    end
+
+    # @rbs index_id: Integer
+    # @rbs return: Thread?
+    def thread_by_index_id(index_id)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      thread_ptr = FFIBindings.lldb_process_get_thread_by_index_id(@ptr, index_id)
+      return nil if thread_ptr.nil? || thread_ptr.null?
+
+      Thread.new(thread_ptr, process: self)
+    end
+
+    # @rbs index_id: Integer
+    # @rbs return: bool
+    def select_thread_by_index_id(index_id)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_set_selected_thread_by_index_id(@ptr, index_id) != 0
+    end
+
+    # @rbs address: Integer
+    # @rbs size: Integer
+    # @rbs return: String
+    def read_memory(address, size)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      buffer = FFI::MemoryPointer.new(:uint8, size)
+      error = Error.new
+      bytes_read = FFIBindings.lldb_process_read_memory(@ptr, address, buffer, size, error.to_ptr)
+
+      error.raise_if_error!
+      buffer.read_string(bytes_read)
+    end
+
+    # @rbs address: Integer
+    # @rbs data: String
+    # @rbs return: Integer
+    def write_memory(address, data)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      buffer = FFI::MemoryPointer.from_string(data)
+      error = Error.new
+      bytes_written = FFIBindings.lldb_process_write_memory(@ptr, address, buffer, data.bytesize, error.to_ptr)
+
+      error.raise_if_error!
+      bytes_written
+    end
+
+    # @rbs size: Integer
+    # @rbs permissions: Integer
+    # @rbs return: Integer
+    def allocate_memory(size, permissions)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      error = Error.new
+      address = FFIBindings.lldb_process_allocate_memory(@ptr, size, permissions, error.to_ptr)
+
+      error.raise_if_error!
+      address
+    end
+
+    # @rbs address: Integer
+    # @rbs return: bool
+    def deallocate_memory(address)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_deallocate_memory(@ptr, address) != 0
+    end
+
+    # @rbs address: Integer
+    # @rbs max_size: Integer
+    # @rbs return: String
+    def read_cstring_from_memory(address, max_size = 1024)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      buffer = FFI::MemoryPointer.new(:uint8, max_size)
+      error = Error.new
+      FFIBindings.lldb_process_read_cstring_from_memory(@ptr, address, buffer, max_size, error.to_ptr)
+
+      error.raise_if_error!
+      buffer.read_string
+    end
+
+    # @rbs max_size: Integer
+    # @rbs return: String
+    def get_stdout(max_size = 4096)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      buffer = FFI::MemoryPointer.new(:uint8, max_size)
+      bytes_read = FFIBindings.lldb_process_get_stdout(@ptr, buffer, max_size)
+      buffer.read_string(bytes_read)
+    end
+
+    # @rbs max_size: Integer
+    # @rbs return: String
+    def get_stderr(max_size = 4096)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      buffer = FFI::MemoryPointer.new(:uint8, max_size)
+      bytes_read = FFIBindings.lldb_process_get_stderr(@ptr, buffer, max_size)
+      buffer.read_string(bytes_read)
+    end
+
+    # @rbs data: String
+    # @rbs return: Integer
+    def put_stdin(data)
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_put_stdin(@ptr, data, data.bytesize)
+    end
+
+    # @rbs return: bool
+    def send_async_interrupt
+      raise InvalidObjectError, 'Process is not valid' unless valid?
+
+      FFIBindings.lldb_process_send_async_interrupt(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def num_supported_hardware_watchpoints
+      return 0 unless valid?
+
+      error = Error.new
+      FFIBindings.lldb_process_get_num_supported_hardware_watchpoints(@ptr, error.to_ptr)
+    end
+
+    # @rbs return: Integer
+    def unique_id
+      return 0 unless valid?
+
+      FFIBindings.lldb_process_get_unique_id(@ptr)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/symbol_context.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class SymbolContext
+    # @rbs return: Frame
+    attr_reader :parent
+
+    # @rbs ptr: FFI::Pointer
+    # @rbs parent: Frame
+    # @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_symbol_context_destroy(ptr) unless ptr.null? }
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_symbol_context_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Module?
+    def module
+      return nil unless valid?
+
+      mod_ptr = FFIBindings.lldb_symbol_context_get_module(@ptr)
+      return nil if mod_ptr.nil? || mod_ptr.null?
+
+      Module.new(mod_ptr, target: nil)
+    end
+
+    # @rbs return: String?
+    def function_name
+      return nil unless valid?
+
+      FFIBindings.lldb_symbol_context_get_function_name(@ptr)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end