gdb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de69fa7d5ddc398f6e0bdd176061f23bd650acba
-  data.tar.gz: 5d86b5bafafa5d321226633751375a3faf9513fd
+  metadata.gz: 465e52470a227ee794a0ad1cbc6e643b6e7892d6
+  data.tar.gz: 377b2acb9be71480b63999833ea24247dcceba1e
 SHA512:
-  metadata.gz: 0a534be09b10af62159decf1793bad3c977680b9885bd4de3af3c70211d6319d3fde4720e1079d26f83e57dc2518af2f8b3ac9c0f7fac7454715705069f25d43
-  data.tar.gz: 40b8085db8abb15a5d2564b6fc4d43c185ccf21d9fa799f93e48dbb669289a2dbdb34aaf254c963351c16ce93beacf0c7badc188e3a6afbeece41bb12cc59401
+  metadata.gz: efbff6edff5a76a1774bb4a5ba2300885cce78ff783730270fef4f0d5b8b1503539efa626f6cd56a220f4a9ccc0a2646c96eaa6d0392e7ff64511f9ef143f39b
+  data.tar.gz: b91c6d713bc611fefcfa1898097ccfa402e18220f737f39ab1de6ee830603c760283a6a761ba7c745a4001255b316ccf8a9945df327781a7208335308d84ade0

data/README.md

@@ -104,8 +104,8 @@ gdb.run('-c "echo cat"')
 rdi = gdb.reg(:rdi)
 #=> 3
 rsi = gdb.reg(:rsi)
-argv = gdb.readm(rsi, rdi, as: :uint64)
-argv.map{ |c|'0x%x' % c }
+argv = gdb.readm(rsi, rdi, as: :u64)
+argv.map { |c| '0x%x' % c }
 #=> ['0x7fffffffe61b', '0x7fffffffe625', '0x7fffffffe628']
 
 # 3. overwrite argv[2]'s 'cat' to 'FAT'

data/lib/gdb/gdb.rb

@@ -1,11 +1,11 @@
 require 'io/console'
+require 'memory_io'
 require 'pty'
 require 'readline'
 
 require 'gdb/eval_context'
 require 'gdb/gdb_error'
 require 'gdb/tube/tube'
-require 'gdb/type_io'
 
 module GDB
   # For launching a gdb process.
@@ -156,19 +156,35 @@ module GDB
 
     # Read current process's memory.
     #
-    # See {TypeIO#read} for details.
+    # @param [Integer, String] addr
+    #   Address to start to read.
+    #   +addr+ can be a string like 'heap+0x10'.
+    #   Supported variables are names in /proc/$pid/maps such as +heap/libc/stack/ld+.
     #
-    # @param [Mixed] args
-    #   See {TypeIO#read}.
+    # @param [Integer] num_elements
+    #   Number of elements to read.
+    #   If +num_elements+ equals to 1, an object read will be returned.
+    #   Otherwise, an array with size +num_elements+ will be returned.
     #
-    # @return [Object]
-    #   See {TypeIO#read}.
+    # @option [Symbol, Class] as
+    #   Types that supported by [MemoryIO](https://github.com/david942j/memory_io).
+    #
+    # @return [Object, Array<Object>]
+    #   Return types are decided by value of +num_elements+ and option +as+.
     #
     # @yieldparam [IO] io
-    #   See {TypeIO#read}.
+    #   The +IO+ object that points to +addr+,
+    #   read from it.
     #
     # @yieldreturn [Object]
-    #   See {TypeIO#read}.
+    #   Whatever you read from +io+.
+    #
+    # @example
+    #   gdb = GDB::GDB.new('spec/binaries/amd64.elf')
+    #   gdb.break('main')
+    #   gdb.run
+    #   gdb.read_memory('amd64.elf', 4)
+    #   #=> "\x7fELF"
     #
     # @example
     #   # example of fetching argv
@@ -179,41 +195,47 @@ module GDB
     #   #=> "\x7fELF"
     #   argc = gdb.register(:rdi)
     #   #=> 4
-    #   args = gdb.read_memory(gdb.register(:rsi), argc, as: :uint64)
+    #   args = gdb.read_memory(gdb.register(:rsi), argc, as: :u64)
     #   Array.new(3) do |i|
     #     gdb.read_memory(args[i + 1], 1) do |m|
     #       str = ''
-    #       str << m.read(1) until str.end_with?("\x00")
+    #       loop do
+    #         c = m.read(1)
+    #         break if c == "\x00"
+    #         str << c
+    #       end
     #       str
     #     end
     #   end
-    #   #=> ["pusheen\x00", "the\x00", "cat\x00"]
+    #   #=> ["pusheen", "the", "cat"]
     #
-    #   # or, use our build-in types listed in {TypeIO::TYPES}
-    #   gdb.read_memory(args[1], 3, as: :cstring)
-    #   #=> ["pusheen\x00", "the\x00", "cat\x00"]
-    def read_memory(*args, &block)
+    #   # or, use our build-in types of gem +memory_io+.
+    #   gdb.read_memory(args[1], 3, as: :c_str)
+    #   #=> ["pusheen", "the", "cat"]
+    def read_memory(addr, num_elements, options = {}, &block)
       check_alive! # this would set @pid
-      File.open("/proc/#{@pid}/mem", 'rb') do |f|
-        ::GDB::TypeIO.new(f).read(*args, &block)
-      end
+      options[:as] = block if block_given?
+      MemoryIO.attach(@pid).read(addr, num_elements, **options)
     end
     alias readm read_memory
 
-    # Write a string to process at specific address.
+    # Write an object to process at specific address.
     #
-    # @param [Integer] addr
+    # @param [Integer, String] addr
     #   Target address.
-    # @param [String] str
-    #   String to be written.
+    #   +addr+ can be a string like 'heap+0x10'.
+    #   Supported variables are names in +/proc/$pid/maps+ such as +heap/libc/stack/ld+.
+    # @param [Objects, Array<Objects>] objects
+    #   Objects to be written.
     #
-    # @return [Integer]
-    #   Bytes written.
-    def write_memory(addr, str)
+    # @option [Symbol, Class] as
+    #   See {#read_memory}.
+    #
+    # @return [void]
+    def write_memory(addr, objects, options = {}, &block)
       check_alive! # this would set @pid
-      File.open("/proc/#{@pid}/mem", 'wb') do |f|
-        ::GDB::TypeIO.new(f).write(addr, str)
-      end
+      options[:as] = block if block_given?
+      MemoryIO.attach(@pid).write(addr, objects, **options)
     end
     alias writem write_memory
 
@@ -251,7 +273,7 @@ module GDB
 
     # Raise {GDBError} if process is not running.
     #
-    # @return [nil]
+    # @return [void]
     def check_alive!
       raise GDBError, 'Process is not running' unless alive?
     end

data/lib/gdb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-14 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: memory_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +141,6 @@ files:
 - lib/gdb/scripts/gdbinit.py
 - lib/gdb/tube/buffer.rb
 - lib/gdb/tube/tube.rb
-- lib/gdb/type_io.rb
 - lib/gdb/version.rb
 homepage: https://github.com/david942j/gdb-ruby
 licenses:
@@ -149,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: GDB Ruby-binding and Ruby command in GDB

data/lib/gdb/type_io.rb

@@ -1,148 +0,0 @@
-module GDB
-  # Support read / write custom defined tpyes.
-  class TypeIO
-    class << self
-      # Read a little endian integer.
-      #
-      # @param [#read] io
-      # @param [Integer] byte
-      # @param [:signed, :unsigned] sign
-      #   Signed or unsigned integer.
-      #
-      # @return [Integer]
-      #   The read integer.
-      #
-      # @example
-      #   read_integer(StringIO.new("\x80"), 1, :signed)
-      #   #=> -128
-      def read_integer(io, byte, sign)
-        str = io.read(byte).reverse # little endian
-        val = str.bytes.reduce(0) { |sum, b| sum * 256 + b }
-        if sign == :signed && val >= (1 << (8 * byte - 1))
-          val -= 1 << (8 * byte)
-        end
-        val
-      end
-
-      # Read until +needle+ appears.
-      #
-      # @param [IO] io
-      # @param [String] needle
-      #
-      # @return [String]
-      def read_until(io, needle)
-        str = ''
-        str << io.read(1) until str.end_with?(needle)
-        str
-      end
-    end
-
-    # Supported built-in types.
-    TYPES = {
-      string: nil, # will be special handled
-
-      cstring: ->(io) { TypeIO.read_until(io, "\x00") }, # read a null-terminated string.
-
-      int8:   ->(io) { TypeIO.read_integer(io, 1, :signed) },
-      int16:  ->(io) { TypeIO.read_integer(io, 2, :signed) },
-      int32:  ->(io) { TypeIO.read_integer(io, 4, :signed) },
-      int64:  ->(io) { TypeIO.read_integer(io, 8, :signed) },
-      int128: ->(io) { TypeIO.read_integer(io, 16, :signed) },
-
-      uint8:   ->(io) { TypeIO.read_integer(io, 1, :unsigned) },
-      uint16:  ->(io) { TypeIO.read_integer(io, 2, :unsigned) },
-      uint32:  ->(io) { TypeIO.read_integer(io, 4, :unsigned) },
-      uint64:  ->(io) { TypeIO.read_integer(io, 8, :unsigned) },
-      uint128: ->(io) { TypeIO.read_integer(io, 16, :unsigned) },
-
-      float: ->(io) { io.read(4).unpack('F').first },
-      double: ->(io) { io.read(8).unpack('D').first }
-    }.freeze
-
-    # Instantiate a {TypeIO} object.
-    #
-    # @param [IO, #pos=, #read, #write] io
-    #   The IO file.
-    def initialize(io)
-      @io = io.binmode
-    end
-
-    # Read data at specific address and cast into desired type.
-    #
-    # @param [Integer] addr
-    #   Address to be read.
-    #
-    # @param [Integer] size
-    #   Number of data to be read. See parameter +as+ for details.
-    #
-    # @param [Symbol] as
-    #   The needed returned type.
-    #   Note that the total bytes be read will be +size * sizeof(as)+.
-    #   For example, if +as+ equals +:int32+, +size * 4+ bytes would be read,
-    #   and returned type is array of 32 bits signed integers.
-    #
-    #   Supported types are listed in {TypeIO::TYPES}, all integer-like types
-    #   are seen as little endian. If you need big endian or other fashion things, pass a block
-    #   instead of using parameter +as+.
-    #
-    # @yieldparam [IO] io
-    #   If block is given, the parameter +as+ would be ignored.
-    #   Block would be invoked +size+ times, and the returned object would be collected into
-    #   one array and returned.
-    #
-    #   This is convenient for reading non-stable size objects, e.g. c++'s string object.
-    #   See examples for clearer usage.
-    #
-    # @yieldreturn [Object]
-    #   Whatever object you like.
-    #
-    # @return [String, Object, Array<Object>]
-    #   If +as+ equals to +:string+, the string with length +size+ would be returned.
-    #   Otherwise, array of objects would be returned.
-    #   An exception is when +size+ equals to 1, the read object would be returned
-    #   instead of create an array with only one element.
-    #
-    # @example
-    #   io = TypeIO.new(StringIO.new("AAAA"))
-    #   io.read(0, 3)
-    #   #=> "AAA"
-    #   io.read(0, 1, as: :uint32)
-    #   #=> 1094795585 # 0x41414141
-    #
-    #   io = TypeIO.new(StringIO.new("\xef\xbe\xad\xde"))
-    #   io.read(0, 4, as: :int8)
-    #   #=> [-17, -66, -83, -34]
-    #
-    #   io = TypeIO.new(StringIO.new("\x04ABCD\x03AAA\x00\x04meow"))
-    #   io.read(0, 4) do |m|
-    #     len = m.read(1).ord
-    #     m.read(len)
-    #   end
-    #   #=> ['ABCD', 'AAA', '', 'meow']
-    def read(addr, size, as: :string)
-      @io.pos = addr
-      if block_given?
-        return yield @io if size == 1
-        Array.new(size) { yield @io }
-      else
-        raise ArgumentError, "Unsupported types #{as.inspect}" unless TYPES.key?(as)
-        return @io.read(size) if as == :string
-        read(addr, size, &TYPES[as])
-      end
-    end
-
-    # Write a string at specific address.
-    #
-    # @param [Integer] addr
-    #   Target address.
-    # @param [String] str
-    #   String to be written.
-    #
-    # @return [Integer]
-    #   Bytes written.
-    def write(addr, str)
-      @io.pos = addr
-      @io.write(str)
-    end
-  end
-end