gdbdump 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 806c8f4485ae5cfad83522a88e00ea3a625d7ed5
-  data.tar.gz: a125ef9b802bb4cece94f042a11340a3ca862296
+  metadata.gz: 589c4ae8d652fe1c24deb76f73deea5ba82ec242
+  data.tar.gz: 2689d144842a157d13168a70c28adcce61a5e78d
 SHA512:
-  metadata.gz: 2e9373b1893dac6dad697b3eb95dca41e0f43d64b2400e136e9387850755152474e472e0c5038a1ee181e180dfb4e3e8d0bbb7d365bf263a8c2b973cc4e405e0
-  data.tar.gz: f2eb578d9859bbccd7149156bba3e1a35dcedb70dab66915597c6bbea807492c426e3da7b076d7588b8776f0c4c79c7bc9a51b01a3d77a6542ee5246c6031615
+  metadata.gz: 5923cc6b4353b49039095e8440401b92645e6080dd95bc5c45a46804ed649f2cdc3e280a3fbef2f9f3b1759ce32a4dd7c0fc9e6061fbfe7c37ad6dcb4aaabc55
+  data.tar.gz: 12dd18e4ca417c9d108767aa13f43d39aea3d69d477017ea19c1e91140b1a3af00fcdc2ff88b338ca6854b0256f6fd996dfecdafbae1d66859460a59a4b1c153

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.9.1
+
+Enhancements:
+
+* Get ruby version from `ruby -e 'puts RUBY_VERSION'` instead of `strings ruby | grep RUBY_VERSION` so that I do not need to assume `strings` command is available
+
+Changes:
+
+* Add `--ruby` option instead of `[prog pid]` argument style.
+
 # 0.9.0
 
 Enhancements:

data/README.md

@@ -19,10 +19,11 @@ It was verfied that gdbdump works with ruby executables built by [rbenv/ruby-bui
 ## Usage
 
 ```
-Usage: gdbdump [options] [pid|prog pid]
-    -d, --[no-]debug   print debug log (default: false)
-    -x, --gdbinit FILE path to ruby trunk's .gdbinit (default: some of ruby trunk's .gdbinit is bundle in this gem, and used})
-        --gdb PATH     path to gdb command (default: gdb)
+Usage: gdbdump [options] pid
+    -d, --[no-]debug                 print debug log (default: false)
+    -x, --gdbinit FILE               path to ruby trunk's .gdbinit (default: some of ruby trunk'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
@@ -43,7 +44,7 @@ With living ruby 2.4.1 process of pid 1897,
 $ gdbdump 1897
 ```
 
-You will see C and Ruby level backtrace on STDERR of **the target process** of pid 1897 as:
+You will see C and Ruby level backtrace as:
 
 ```
 $1 = (rb_vm_t *) 0x7f46bb071f20
@@ -64,11 +65,10 @@ loop.rb:11:in `block in <main>'
 
 ## FAQ
 
-Q. How this work?
-A. Attach to the ruby process with gdb, and call `rb_ps` defined in gdbinit. That's it.
-
-Q. Is this available for production process?
-A. GDB stops the process during printing backtrace, would cause some issues
+* Q. How this work?
+  * A. Attach to the ruby process with gdb, and call `rb_ps` defined in gdbinit. That's it.
+* Q. Is this available for production process?
+  * A. GDB stops the process during printing backtrace, would cause some issues
 
 ## Comparisons
 
@@ -77,9 +77,11 @@ A. GDB stops the process during printing backtrace, would cause some issues
 * [sigdump](https://github.com/frsyuki/sigdump)
   * sigdump enables to print ruby level backtrace with sending CONT signal to living ruby process.
   * The ruby process must pre-install `sigdump` gem and `require 'sigdump/setup'` unlike gdbdump.
+  * sigdump prints backtrace in signal handler, so blocks main thread, but other threads still work unlike gdbdump.
 * [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.
 
 ## Development
 

data/lib/gdbdump/cli.rb

@@ -18,19 +18,23 @@ class Gdbdump
         debug: false,
         gdbinit: nil,
         gdb: nil,
+        ruby: nil,
       }
 
       op.on('-d', '--[no-]debug', "print debug log (default: #{opts[:debug]})") {|v|
         opts[:debug] = v
       }
-      op.on('-x', '--gdbinit FILE', "path to ruby trunk's .gdbinit (default: some of ruby trunk's .gdbinit is bundle in this gem, and used})") {|v|
+      op.on('-x', '--gdbinit FILE', "path to ruby trunk's .gdbinit (default: some of ruby trunk's .gdbinit is pre-bundle in this gem)") {|v|
         opts[:gdbinit] = v
       }
       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|prog pid]'
+      op.banner += ' pid'
       begin
         args = op.parse(argv)
       rescue OptionParser::InvalidOption => e
@@ -39,11 +43,8 @@ class Gdbdump
 
       if args.size == 1
         @pid = args.first
-        @prog = Gdbdump::Procfs.new(@pid).exe
-      elsif args.size == 2
-        @prog, @pid = args
       else
-        usage 'number of arguments must be 1 or 2'
+        usage 'number of arguments must be 1'
       end
 
       @opts = opts
@@ -51,7 +52,7 @@ class Gdbdump
 
     def run
       parse_options
-      GDB.new(pid: @pid, prog: @prog, **(@opts)).print_backtrace
+      GDB.new(pid: @pid, **(@opts)).print_backtrace
     end
   end
 end

data/lib/gdbdump/gdb.rb

@@ -2,21 +2,21 @@
 require 'open3'
 
 class Gdbdump
-  # GDB.new(pid: 999, prog: '/path/to/ruby', debug: true).run do |gdb|
+  # GDB.new(pid: 999, debug: true).run do |gdb|
   #   puts gdb.cmd_exec('bt')
   # end
   class GDB
     COMMAND_READ_BUFFER_SIZE = 1024
-    STRINGS_CMD = 'strings'
     SUDO_CMD = 'sudo'
 
-    def initialize(pid:, prog: nil, debug: false, gdbinit: nil, gdb: nil)
+    def initialize(pid:, debug: false, gdbinit: nil, gdb: nil, ruby: nil)
       @pid = pid.to_s
-      @prog = prog
       @debug = debug
-      @gdbinit = gdbinit || File.join(ROOT, 'vendor', 'ruby', ruby_version, 'gdbinit')
       @gdb = gdb || 'gdb'
-      @exec_options = [SUDO_CMD, @gdb, '-silent', '-nw', '-x', @gdbinit, @prog, @pid]
+      @ruby = ruby || Procfs.new(@pid).exe
+      @ruby_version = `#{@ruby} -e 'puts RUBY_VERSION'`.chomp
+      @gdbinit = gdbinit || File.join(ROOT, 'vendor', 'ruby', @ruby_version, 'gdbinit')
+      @exec_options = [SUDO_CMD, @gdb, '-silent', '-nw', '-x', @gdbinit, @ruby, @pid]
     end
 
     def print_backtrace
@@ -50,15 +50,6 @@ class Gdbdump
       end
     end
 
-    # ToDo: Any faster way to get ruby_version from pid?
-    # NOTE: I want ruby_version before starting gdb
-    def ruby_version
-      return @ruby_version if @ruby_version
-      ret = `#{STRINGS_CMD} #{@prog}`
-      line = ret.lines.find {|_| _.start_with?('RUBY_VERSION "') }
-      @ruby_version = line[14..-3] if line
-    end
-
     def cmd_exec(cmd)
       log('C', cmd)
       if cmd

data/lib/gdbdump/version.rb

@@ -1,3 +1,3 @@
 class Gdbdump
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gdbdump
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Naotoshi Seo