gdbdump 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47f96b6948a61ee96134de40f22548c97d265549
-  data.tar.gz: 406b7e0a333f356278bc813082cbffc599f7fcc6
+  metadata.gz: aaf969a8db507b5039c1388a62aeb79b3ed84b25
+  data.tar.gz: 3997ea8491bd4e51eac15a947f94b77987c3d59a
 SHA512:
-  metadata.gz: 73adc0c34ac5e358de859b99be87e59da5558cce6fbcc1ba5ffc01d366d1c0d3fe27abe82afc1b2966dccd6b9165e09932147402a09f29172b7345fc30a0e4b3
-  data.tar.gz: eea4efc06c19748d84b626b6593a2afcb89ab9876f5e44c3686658bf222ce9f30d2a875de4efd4ff3db78373b5a5b532655cee35a21db5ea013d733794fe5486
+  metadata.gz: 4f1509a7d172d61d4a03ae1783a07f4cce70ff31a644c6a84feca32bf6b7e104b5b99ae2f25f7e2d9739f89968b00a85faa521a0122bb3692fb447d233960f1d
+  data.tar.gz: 44df74f4bca8c8ec24da6e07ecfcab451952c0c835ee8652f1c0f05fa338358711fda6d3a1887716168d6cb1e40fb2ce97cb2c640f9d5274fb323645967ab1d0

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .ruby-version
+core.*

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.9.4
+
+Enhancements:
+
+* Support core file
+
 # 0.9.3
 
 Enhancements:

data/README.md

@@ -1,6 +1,6 @@
 # gdbdump
 
-Print C level and Ruby level backtrace of living ruby process using gdb
+Dump C level and Ruby level backtrace from living ruby process or core file using gdb.
 
 ## Installation
 
@@ -12,33 +12,31 @@ $ gem install gdbdump
 
 * gdb
 * linux
-* `sudo gdb` must be allowed
+* `sudo gdb` must be allowed to dump backtrace of living ruby process
 
-It was verfied that gdbdump works with ruby executables built by [rbenv/ruby-build](https://github.com/rbenv/ruby-build).
+It was verified that gdbdump works with ruby executables built by [rbenv/ruby-build](https://github.com/rbenv/ruby-build).
 
 ## Usage
 
 ```
-Usage: gdbdump [options] pid
+Usage: gdbdump [options] [ pid | /path/to/ruby pid | /path/to/ruby core ]
     -d, --[no-]debug                 print debug log (default: false)
     -x, --gdbinit FILE               path to ruby repo's .gdbinit (default: some of ruby repo's .gdbinit is pre-bundle in this gem)
         --gdb PATH                   path to gdb command (default: gdb)
-        --ruby PATH                  path to ruby which the attached process uses (default: get from /proc/[PID]/exe)
 ```
 
-### .gdbinit
+### --gdbinit
 
 Default supported ruby versions: 2.1.x - 2.4.x
 
-Ruby repo's [.gdbinit](https://github.com/ruby/ruby/blob/trunk/.gdbinit) file defines useful helper functions and it is maintained by ruby core team. `gdbdump` uses it.
-Some versions written as above of .gdbinit are bundled in this gem, but if you want to use `gdbdump` for older or newer ruby versions:
+Ruby repo's [.gdbinit](https://github.com/ruby/ruby/blob/trunk/.gdbinit) file defines useful helper functions and it is maintained by ruby core team. `gdbdump` uses it. `.gdbinit` of some versions written on above are pre-bundled in this gem. But, if you want to use `gdbdump` for older or newer ruby versions:
 
 1. Download .gdbinit from ruby repo like [ruby/2.4.1/.gdbinit](https://github.com/ruby/ruby/blob/v2_4_1/.gdbinit), and specify with `-x` option
 2. Or, send PR to bundle the .gdbinit in `gdbdump` gem.
 
-## Example
+## Example (live ruby process)
 
-With living ruby 2.4.1 process of pid 1897,
+With live ruby process of pid 1897,
 
 ```
 $ gdbdump 1897
@@ -63,6 +61,20 @@ loop.rb:13:in `block (2 levels) in <main>'
 loop.rb:11:in `block in <main>'
 ```
 
+## Example (core file)
+
+With core file, you have to specify path of ruby executable.
+
+```
+$ gdbdump $HOME/.rbenv/versions/2.4.1/bin/ruby core.1897
+```
+
+You can get a core file with `gcore` command as:
+
+```
+$ sudo gcore 1897
+```
+
 ## FAQ
 
 * Q. How this work?
@@ -81,7 +93,8 @@ loop.rb:11:in `block in <main>'
 * [gdbruby](https://github.com/gunyarakun/gdbruby)
   * gdbruby enables to print C level and ruby level backtrace of living ruby process and core file.
   * gdbruby **must follow changes of C level interfaces of CRuby** to get backtrace of the core file, it rises fragility that it will be broken on newer ruby versions.
-  * gdbruby stops the process during printing backtrace as gdbdump, but it supports also core file. Using `gcore` command to get core file, it would be possible to analyze without stopping the process.
+  * gdbruby supports only ruby 2.0 and 2.1 (2017-06-05).
+  * I believe `gdbdump` can replace `gdbruby`.
 
 ## Development
 

data/gdbdump.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Naotoshi Seo"]
   spec.email         = ["sonots@gmail.com"]
 
-  spec.summary       = %q{Print C level and Ruby level backtrace of living process using gdb.}
-  spec.description   = %q{Print C level and Ruby level backtrace of living process using gdb.}
+  spec.summary       = %q{Dump C level and Ruby level backtrace from living process or core file using gdb.}
+  spec.description   = %q{Dump C level and Ruby level backtrace from living process or core file using gdb.}
   spec.homepage      = "https://github.com/sonots/gdbdump-ruby"
   spec.license       = "MIT"
 

data/lib/gdbdump/cli.rb

@@ -19,6 +19,7 @@ class Gdbdump
         gdbinit: nil,
         gdb: nil,
         ruby: nil,
+        pid_or_core: nil,
       }
 
       op.on('-d', '--[no-]debug', "print debug log (default: #{opts[:debug]})") {|v|
@@ -30,11 +31,8 @@ class Gdbdump
       op.on('--gdb PATH', "path to gdb command (default: gdb)") {|v|
         opts[:gdb] = v
       }
-      op.on('--ruby PATH', "path to ruby which the attached process uses (default: get from /proc/[PID]/exe)") {|v|
-        opts[:ruby] = v
-      }
 
-      op.banner += ' pid'
+      op.banner += ' [ pid | /path/to/ruby pid | /path/to/ruby core ]'
       begin
         args = op.parse(argv)
       rescue OptionParser::InvalidOption => e
@@ -42,9 +40,12 @@ class Gdbdump
       end
 
       if args.size == 1
-        @pid = args.first
+        opts[:pid_or_core] = args[0]
+      elsif args.size == 2
+        opts[:ruby] = args[0]
+        opts[:pid_or_core] = args[1]
       else
-        usage 'number of arguments must be 1'
+        usage 'number of arguments must be 1 or 2'
       end
 
       @opts = opts
@@ -52,7 +53,7 @@ class Gdbdump
 
     def run
       parse_options
-      GDB.new(pid: @pid, **(@opts)).print_backtrace
+      GDB.new(@opts).print_backtrace
     end
   end
 end

data/lib/gdbdump/gdb.rb

@@ -9,17 +9,27 @@ class Gdbdump
     COMMAND_READ_BUFFER_SIZE = 1024
     SUDO_CMD = 'sudo'
 
-    def initialize(pid:, debug: false, gdbinit: nil, gdb: nil, ruby: nil)
-      @pid = pid.to_s
+    def initialize(ruby: nil, pid_or_core:, debug: false, gdbinit: nil, gdb: nil)
+      if pid_or_core =~ /\A\d+\z/
+        @pid  = pid_or_core.to_s
+        @ruby = ruby || Procfs.new(@pid).exe
+      else
+        @core = pid_or_core
+        raise "core #{@core} is not readable" unless File.readable?(@core)
+        @ruby = ruby || raise("With core file, ruby path is required")
+      end
+      @pid_or_core = pid_or_core
+      raise "ruby #{@ruby} is not accessible" unless File.executable?(@ruby)
+
+      @gdbinit = gdbinit || File.join(ROOT, 'vendor', 'ruby', ruby_minor_version, 'gdbinit')
+      raise "gdbinit #{@gdbinit} is not readable" unless File.readable?(@gdbinit)
+
       @debug = debug
       @gdb = gdb || 'gdb'
-      @ruby = (ruby || Procfs.new(@pid).exe).tap do |path|
-        raise "ruby #{path} is not accessible" unless File.executable?(path)
-      end
-      @gdbinit = (gdbinit || File.join(ROOT, 'vendor', 'ruby', ruby_minor_version, 'gdbinit')).tap do |path|
-        raise "gdbinit #{path} is not readable" unless File.readable?(path)
-      end
-      @exec_options = [SUDO_CMD, @gdb, '-silent', '-nw', '-x', @gdbinit, @ruby, @pid]
+
+      @exec_options = [@gdb, '-silent', '-nw', '-x', @gdbinit, @ruby, @pid_or_core]
+      @exec_options.unshift(SUDO_CMD) if @pid # sudo is required to ptrace a living process
+      log('C', @exec_options.join(' '))
     end
 
     private def ruby_version
@@ -36,12 +46,6 @@ class Gdbdump
         $stdout.puts out
         $stderr.puts err unless err.empty?
       end
-      # run do |gdb|
-      #   gdb.cmd_exec('call write(2, "== c backtrace ==\n", 18)')
-      #   gdb.cmd_exec('call rb_print_backtrace()')
-      #   gdb.cmd_exec('call write(2, "== ruby backtrace ==\n", 21)')
-      #   gdb.cmd_exec('call rb_backtrace()')
-      # end
     end
 
     def run
@@ -54,7 +58,7 @@ class Gdbdump
         yield(self)
         detach
       ensure
-        Process.kill('CONT', @pid.to_i)
+        Process.kill('CONT', @pid.to_i) if @pid
         @stdin.close
         @stdout.close
         @stderr.close

data/lib/gdbdump/version.rb

@@ -1,3 +1,3 @@
 class Gdbdump
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdbdump
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Print C level and Ruby level backtrace of living process using gdb.
+description: Dump C level and Ruby level backtrace from living process or core file
+  using gdb.
 email:
 - sonots@gmail.com
 executables:
@@ -111,5 +112,6 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Print C level and Ruby level backtrace of living process using gdb.
+summary: Dump C level and Ruby level backtrace from living process or core file using
+  gdb.
 test_files: []