gdb 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 465e52470a227ee794a0ad1cbc6e643b6e7892d6
-  data.tar.gz: 377b2acb9be71480b63999833ea24247dcceba1e
+SHA256:
+  metadata.gz: fb429f1309a91731395b1a338e151f3d46431c9e060ffa067cb8cad51320d835
+  data.tar.gz: 249e06ec6ae0497951c7ed958e0da149694e76fc91696d839ebc8c3c6175e4a1
 SHA512:
-  metadata.gz: efbff6edff5a76a1774bb4a5ba2300885cce78ff783730270fef4f0d5b8b1503539efa626f6cd56a220f4a9ccc0a2646c96eaa6d0392e7ff64511f9ef143f39b
-  data.tar.gz: b91c6d713bc611fefcfa1898097ccfa402e18220f737f39ab1de6ee830603c760283a6a761ba7c745a4001255b316ccf8a9945df327781a7208335308d84ade0
+  metadata.gz: 0fdcb2dd789d8dbf3c29d46d0f0ba5b77373eeac74e4412d8136f65feaeedde0b82d95d48503c05edec8ea8f951264d798a4b99d2458b0833a48b164e032fa61
+  data.tar.gz: '09f569cd9e61aa079d0de7cf498220b010c529c4319f702f4a0d990ebf9714b8bce3f0a811254a2a9d788d6fd9fce8db93402bc1a5e98980cf84739a58c13b23'

data/README.md

@@ -8,11 +8,16 @@
 
 # GDB-Ruby
 
-It's time for Ruby lovers to use Ruby in gdb, and... gdb in Ruby!
+It's time for Ruby lovers to use Ruby in gdb and, gdb in Ruby!
+
+Achieve two things in one gem:
+
+1. Launch Ruby interactive shell (pry) in gdb.
+2. A gdb Ruby-binding, i.e. communiate with gdb in a Ruby script.
 
 # Use Ruby in gdb
 
-We provide a binary `gdb-ruby` with usage exactly same as normal gdb,
+We provide a binary `gdb-ruby` (a Ruby script actually) with usage exactly same as normal gdb,
 while has two extra commands: `ruby` and `pry`!
 
 See examples below:
@@ -51,14 +56,14 @@ Example:
 
 ## Integrate with other gdb extensions
 
-Completely NO effort if you want to use **gdb-ruby** with other gdb extension.
+Completely *NO* effort if you want to use **gdb-ruby** with other gdb extensions.
 
 For example, I usually use [gef](https://github.com/hugsy/gef) for my gdb.
 And everything works as usual when integrated with **gdb-ruby**:
 
 Launching with `$ gdb-ruby -q bash`
 
-![ruby-in-gef](https://i.imgur.com/WMxofSs.png)
+![ruby-in-gef](https://i.imgur.com/W8biCgP.png)
 
 # Use gdb in Ruby
 
@@ -138,6 +143,7 @@ gdb.interact
 # Installation
 
 Available on RubyGems.org!
+
 ```
 $ gem install gdb
 ```
@@ -158,5 +164,5 @@ Any feature requests and suggestions are welcome! :grimacing:
 
 # Growing up
 
-**gdb-ruby** is under developing, give it a star and [watching](https://github.com/david942j/gdb-ruby/subscription)
+**gdb-ruby** is under developing, give it a star and [watch](https://github.com/david942j/gdb-ruby/subscription)
 for latest updates!

data/bin/gdb-ruby

@@ -1,9 +1,17 @@
 #!/usr/bin/env ruby
 
-require 'gdb'
 require 'shellwords'
 
+require 'gdb'
+require 'gdb/util'
+
 argv = Shellwords.join(ARGV)
 Process.setproctitle('gdb-ruby ' + argv)
 
+gdb = ::GDB::Util.find_gdb
+if gdb.nil?
+  # No gdb installed
+  warn('[ERROR] No gdb installed in your system.')
+  exit 2
+end
 GDB::GDB.new(argv).interact

data/lib/gdb/gdb.rb

@@ -6,11 +6,16 @@ require 'readline'
 require 'gdb/eval_context'
 require 'gdb/gdb_error'
 require 'gdb/tube/tube'
+require 'gdb/util'
 
 module GDB
   # For launching a gdb process.
+  #
+  # @!macro [new] gdb_displayed
+  #   @return [String]
+  #     Returns what gdb displayed after executing this command.
   class GDB
-    # Absolute path to python scripts.
+    # Absolute path to the python scripts.
     SCRIPTS_PATH = File.join(__dir__, 'scripts').freeze
 
     # To launch a gdb instance.
@@ -25,8 +30,11 @@ module GDB
     #   gdb = GDB::GDB.new('-q -nh bash')
     #   gdb = GDB::GDB.new('arm.elf', gdb: 'gdb-multiarch')
     def initialize(arguments, gdb: 'gdb')
+      gdb_bin = ::GDB::Util.which(gdb)
+      raise Errno::ENOENT, gdb if gdb_bin.nil?
+
       arguments = "--command=#{File.join(SCRIPTS_PATH, 'gdbinit.py')}" + ' ' + arguments # XXX
-      @tube = spawn(gdb + ' ' + arguments)
+      @tube = spawn(gdb_bin + ' ' + arguments)
       pre = @tube.readuntil('GDBRuby:')
       @prompt = @tube.readuntil("\n").strip
       @tube.unget(pre + @tube.readuntil(@prompt))
@@ -37,8 +45,7 @@ module GDB
     # @param [String] cmd
     #   Command to be executed.
     #
-    # @return [String]
-    #   The execution result returned by gdb.
+    # @!macro gdb_displayed
     #
     # @example
     #   gdb = GDB::GDB.new('bash')
@@ -48,22 +55,24 @@ module GDB
     #   gdb.execute('print $rsi')
     #   #=> "$1 = 0x7fffffffdef8"
     def execute(cmd)
+      # clear tube if not in interactive mode
+      @tube.clear unless interacting?
+
       @tube.puts(cmd)
       @tube.readuntil(@prompt).strip
     end
     alias exec execute
 
-    # Set break point.
+    # Set breakpoints.
     #
-    # This method some magic, see parameters or examples.
+    # This method does some magic, see examples.
     #
     # @param [Integer, String] point
     #   If +Integer+ is given, will be translated as set break point
     #   at address +point+, i.e. equivalent to +break *<integer>+.
     #   If +String+ is given, equivalent to invoke +execute("break <point>")+.
     #
-    # @return [String]
-    #   Returns what gdb displayed after set a break point.
+    # @!macro gdb_displayed
     #
     # @example
     #   gdb = GDB::GDB.new('bash')
@@ -79,13 +88,12 @@ module GDB
     end
     alias b break
 
-    # Run process.
+    # Run the process.
     #
     # @param [String] args
-    #   Arguments to pass to run command.
+    #   Arguments to pass to +run+ command.
     #
-    # @return [String]
-    #   Returns what gdb displayed.
+    # @!macro gdb_displayed
     #
     # @example
     #   gdb = GDB::GDB.new('bash')
@@ -97,7 +105,7 @@ module GDB
     #
     # @note
     #   If breakpoints are not set properly and cause gdb hangs,
-    #   this method will hang, too.
+    #   this method hangs as well.
     def run(args = '')
       execute('run ' + args)
     end
@@ -133,7 +141,7 @@ module GDB
     end
     alias code_base text_base
 
-    # Is process running?
+    # Is the process running?
     #
     # Actually judged by if {#pid} returns zero.
     #
@@ -149,11 +157,43 @@ module GDB
     # This method implemented by invoking +python print(gdb.selected_inferior().pid)+.
     #
     # @return [Integer]
-    #   The pid of process. If process is not running, zero is returned.
+    #   The pid of the process. If the process is not running, zero is returned.
     def pid
       @pid = python_p('gdb.selected_inferior().pid').to_i
     end
 
+    # Execute +continue+ command.
+    #
+    # @!macro gdb_displayed
+    #
+    # @note
+    #   This method may block the IO if no breakpoints are properly set.
+    def continue
+      check_alive!
+      execute('continue')
+    end
+
+    # Execute +info+ command.
+    #
+    # @param [String] args
+    #   Arguments to pass to +info+ command.
+    #
+    # @!macro gdb_displayed
+    #
+    # @example
+    #   gdb = GDB::GDB.new('spec/binaries/amd64.elf')
+    #   gdb.break('main')
+    #   gdb.run
+    #   puts gdb.info('proc stat')
+    #   # process 32537
+    #   # cmdline = '/home/gdb-ruby/spec/binaries/amd64.elf'
+    #   # cwd = '/home/gdb-ruby'
+    #   # exe = '/home/gdb-ruby/spec/binaries/amd64.elf'
+    #   gdb.close
+    def info(args = '')
+      execute('info ' + args)
+    end
+
     # Read current process's memory.
     #
     # @param [Integer, String] addr
@@ -243,6 +283,7 @@ module GDB
     #
     # @param [String] cmd
     #   python command.
+    #
     # @return [String]
     #   Execution result.
     def python_p(cmd)
@@ -250,10 +291,13 @@ module GDB
     end
 
     # Enter gdb interactive mode.
-    # Gdb will be closed after interaction.
+    # GDB will be closed after interaction.
     #
     # @return [void]
     def interact
+      return if interacting?
+
+      @interacting = true
       $stdin.raw { @tube.interact(method(:output_hook)) }
       close
     end
@@ -263,6 +307,7 @@ module GDB
     # @return [void]
     def close
       return if @tube.closed?
+
       @tube.close
       Process.wait(@gdb_pid)
       nil
@@ -271,6 +316,10 @@ module GDB
 
     private
 
+    def interacting?
+      defined?(@interacting)
+    end
+
     # Raise {GDBError} if process is not running.
     #
     # @return [void]
@@ -278,11 +327,9 @@ module GDB
       raise GDBError, 'Process is not running' unless alive?
     end
 
-    TIOCSWINSZ = 0x5414
-
     def spawn(cmd)
       output, input, @gdb_pid = PTY.spawn(cmd)
-      output.ioctl(TIOCSWINSZ, [*IO.console.winsize, 0, 0].pack('S*'))
+      IO.console && output.winsize = IO.console.winsize
       ::GDB::Tube::Tube.new(input, output)
     end
 
@@ -290,15 +337,25 @@ module GDB
 
     # @param [String] output
     #
-    # @return [String]
+    # @yieldparam [String] output
+    # @yieldreturn [void]
+    #
+    # @return [void]
     def output_hook(output)
       idx = output.index(COMMAND_PREFIX)
       return yield output.gsub(@prompt, '') if idx.nil?
+
       yield output.slice!(0, idx)
       cmd, args = output.slice(COMMAND_PREFIX.size..-1).split(' ', 2)
       # only support ruby and pry now.
-      return yield output unless %w[ruby pry].include?(cmd)
-      args = 'send(:invoke_pry)' if cmd == 'pry'
+      return yield output unless %w[ruby pry rsource].include?(cmd)
+
+      args = case cmd
+             when 'pry' then '__send__(:invoke_pry)'
+             when 'rsource' then File.read(File.expand_path(args.strip))
+             else args
+             end
+      args = '__send__(:invoke_pry)' if cmd == 'pry'
       # gdb by default set tty
       # hack it
       `stty opost onlcr`
@@ -313,7 +370,7 @@ module GDB
     end
 
     def eval_context
-      @context ||= ::GDB::EvalContext.new(self)
+      @eval_context ||= ::GDB::EvalContext.new(self)
     end
   end
 end

data/lib/gdb/scripts/gdbinit.py

@@ -36,7 +36,7 @@ class GDBRuby():
         return self.gdbruby_prompt + org
 
     def _gen_prompt(self):
-        rnd = ''.join([random.choice(string.ascii_lowercase) for i in range(8)])
+        rnd = ''.join([random.choice(string.ascii_lowercase) for i in range(20)])
         return '(gdb-ruby-%s)' % rnd
 
 __commands__ = []
@@ -99,6 +99,17 @@ Example:
 """
     _cmdline_ = 'pry'
 
+@register_command
+class RSourceCommand():
+    _doc_ = """Source a Ruby script.
+
+Syntax: rsource <file>
+
+Example:
+    rsource ~/.gdbinit.rb
+"""
+    _cmdline_ = 'rsource'
+
 
 if not 'gdbruby' in globals():
     [GDBRubyCommand(c) for c in __commands__]

data/lib/gdb/tube/buffer.rb

@@ -19,6 +19,7 @@ module GDB
       def <<(str)
         str = str.to_s.dup
         return self if str.empty?
+
         @data << str
         @size += str.size
         self
@@ -66,6 +67,7 @@ module GDB
       # @return [void]
       def unshift(str)
         return if str.nil? || str.empty?
+
         @data.unshift(str)
         @size += str.size
       end

data/lib/gdb/tube/tube.rb

@@ -32,6 +32,15 @@ module GDB
         @buffer.get(n)
       end
 
+      # Clear received data.
+      #
+      # @return [String]
+      #   The data cleared.
+      #   An empty string is returned if the buffer is already empty.
+      def clear
+        @buffer.get
+      end
+
       # Receive from +io+ until string +str+ appears.
       #
       # @param [String] str
@@ -63,8 +72,10 @@ module GDB
       #
       # @return [void]
       def puts(data)
+        return data.split("\n").each(&method(:puts)) if data.strip.include?("\n")
+
         @in.puts(data)
-        readuntil(data)
+        readuntil("\n")
       end
 
       # Enter interactive mode.
@@ -83,11 +94,12 @@ module GDB
           io, = IO.select([$stdin, @out])
           @in.write($stdin.readpartial(READ_SIZE)) if io.include?($stdin)
           next unless io.include?(@out)
+
           begin
             recv = @out.readpartial(READ_SIZE)
             output_hook.call(recv) { |str| $stdout.write(str) }
             @out.ungetc(@buffer.get) unless @buffer.empty?
-          rescue Errno::EIO
+          rescue Errno::EIO, EOFError
             break
           end
         end

data/lib/gdb/util.rb

@@ -0,0 +1,35 @@
+module GDB
+  # Defines utility methods.
+  module Util
+    module_function
+
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    # @param [String] cmd
+    # @return [String?]
+    # @example
+    #   which('ruby')
+    #   #=> "/usr/bin/ruby"
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      nil
+    end
+
+    # The name of gdb could be:
+    #   - gdb
+    #   - ggdb (macOS)
+    # @return [String?]
+    # @example
+    #   find_gdb
+    #   #=> 'gdb'
+    def find_gdb
+      %w[gdb ggdb].find { |n| which(n) }
+    end
+  end
+end

data/lib/gdb/version.rb

@@ -1,4 +1,4 @@
 module GDB
   # The current version of GDB.
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2019-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.60'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: tty-platform
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 'It''s time for Ruby lovers to use Ruby in gdb, and... gdb in Ruby!
+description: 'It''s time for Ruby lovers to use Ruby in gdb, and gdb in Ruby!
 
 '
 email:
@@ -141,6 +141,7 @@ files:
 - lib/gdb/scripts/gdbinit.py
 - lib/gdb/tube/buffer.rb
 - lib/gdb/tube/tube.rb
+- lib/gdb/util.rb
 - lib/gdb/version.rb
 homepage: https://github.com/david942j/gdb-ruby
 licenses:
@@ -161,8 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: GDB Ruby-binding and Ruby command in GDB