gdbdump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea50c60dac2189b7cea3222ddcf45ef8a351d203
+  data.tar.gz: df893c9a3c07006e1864358def10125388660f4d
+SHA512:
+  metadata.gz: 209d5cd21074e35b9b02a14a29b6ba396b8dfb03f66aaf76f34bc1e556f3f31fb7ffce4df202cbfd5321c2e4ac0b913356a89a6b7d140ea23d47a56217758c89
+  data.tar.gz: 4999fe00d9d43b77b4a330eeb57a7185a1dcb4b870d712ea8799ac9737da3dbf5cbff91addbcc5fdf6f7c2604a8e2d3a649705a545484d8646db408234476ea4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gdbdump.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 sonots
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Gdbdump
+
+Print C level and Ruby level backtrace of living process using gdb
+
+## Installation
+
+    $ gem install gdbdump
+
+## Requirements
+
+* run with sudo.
+* on Linux.
+
+I verified that this gem works with ruby executables built by [rbenv/ruby-build](https://github.com/rbenv/ruby-build).
+
+## Example
+
+With living ruby process of pid 1897,
+
+```
+$ sudo gdbdump 1897
+```
+
+You will see C and Ruby level backtrace on STDERR of **the target process** of pid 1897 as:
+
+```
+== c backtrace ==
+/home/ubuntu/.rbenv/versions/2.4.1/bin/ruby(rb_print_backtrace+0x15) [0x7fd23062c115] vm_dump.c:684
+[0x7ffc98c378af]
+== ruby backtrace ==
+        from loop.rb:3:in `<main>'
+        from loop.rb:3:in `loop'
+        from loop.rb:5:in `block in <main>'
+        from loop.rb:5:in `sleep'
+```
+
+## Usage
+
+```
+Usage: gdbdump [options] [pid|prog pid]
+    -d, --[no-]debug                 print debug log (default: false)
+```
+
+## How this work
+
+Attach to the ruby process with gdb, and call `rb_print_backtrace()` (C level backtrace) and `rb_backtrace()` (Ruby level backtrace). That's it.
+
+The path of ruby executable is found by `/proc/[PID]/exe` as default.
+
+## ToDo
+
+* Want to print backtrace on STDOUT of gdbdump process.
+  * To do it, we need another version of `rb_print_backtrace` and `rb_backtrace` to print results into a file in CRuby itself.
+  * If they are available, gdbdump can dump to a file and, then read and print into STDOUT of gdbdump process.
+
+## Comparisons
+
+* gdb
+  * You can get C level backtrace with raw gdb, of course.
+* [sigdump](https://github.com/frsyuki/sigdump)
+  * You can get ruby level backtrace with sigdump gem, but your ruby application must pre-install sigdump and `require 'sigdump/setup'`. `gdbdump` does not require it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/gdbdump. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gdbdump project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gdbdump/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gdbdump"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gdbdump

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/gdbdump/cli'
+Gdbdump::CLI.new.run

data/gdbdump.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gdbdump/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gdbdump"
+  spec.version       = Gdbdump::VERSION
+  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.homepage      = "https://github.com/sonots/gdbdump-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+end

data/lib/gdbdump.rb

@@ -0,0 +1,3 @@
+require_relative "gdbdump/version"
+require_relative "gdbdump/gdb"
+require_relative "gdbdump/procfs"

data/lib/gdbdump/cli.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+require_relative '../gdbdump'
+
+class Gdbdump
+  class CLI
+    def parse_options(argv = ARGV)
+      op = OptionParser.new
+
+      self.class.module_eval do
+        define_method(:usage) do |msg = nil|
+          puts op.to_s
+          puts "error: #{msg}" if msg
+          exit 1
+        end
+      end
+
+      opts = {
+        debug: false,
+      }
+
+      op.on('-d', '--[no-]debug', "print debug log (default: #{opts[:debug]})") {|v|
+        opts[:debug] = v
+      }
+
+      op.banner += ' [pid|prog pid]'
+      begin
+        args = op.parse(argv)
+      rescue OptionParser::InvalidOption => e
+        usage e.message
+      end
+
+      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'
+      end
+
+      @opts = opts
+    end
+
+    def run
+      parse_options
+      GDB.new(pid: @pid, prog: @prog, debug: @opts[:debug]).print_backtrace
+    end
+  end
+end

data/lib/gdbdump/gdb.rb

@@ -0,0 +1,102 @@
+require 'open3'
+
+class Gdbdump
+  # GDB.new(pid: 999, prog: '/path/to/ruby', debug: true).run do |gdb|
+  #   puts gdb.cmd_exec('bt')
+  # end
+  class GDB
+    COMMAND_READ_BUFFER_SIZE = 1024
+
+    def initialize(pid:, prog:, debug: false)
+      @prog = prog
+      @pid = pid.to_s
+      @debug = debug
+      @exec_options = ['gdb', '-silent', '-nw', @prog, @pid]
+    end
+
+    def print_backtrace
+      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
+      @stdin, @stdout, @stderr = Open3.popen3(*@exec_options)
+      if get_response =~ /ptrace: Operation not permitted./
+        raise 'Must run gdbdump with sudo'
+      end
+      prepare
+      begin
+        yield(self)
+        detach
+      ensure
+        Process.kill('CONT', @pid.to_i)
+        @stdin.close
+        @stdout.close
+        @stderr.close
+      end
+    end
+
+    def cmd_exec(cmd)
+      log('C', cmd)
+      if cmd
+        send_cmd = cmd.empty? ? cmd : "#{cmd}\n"
+        r = @stdin.syswrite(send_cmd)
+        raise "failed to send: [#{cmd}]" if r < send_cmd.length
+      end
+
+      get_response
+    end
+
+    def get_response
+      response = +''
+
+      loop do
+        begin
+          buf = @stdout.sysread(COMMAND_READ_BUFFER_SIZE)
+        rescue EOFError
+          break
+        end
+        response << buf
+        break if buf =~ /\(gdb\) $/
+      end
+
+      loop do
+        begin
+          buf = @stderr.read_nonblock(COMMAND_READ_BUFFER_SIZE)
+        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+          break
+        rescue EOFError
+          break
+        end
+        response << buf if buf
+      end
+
+      log('R', response)
+      response
+    end
+
+    private
+
+    def prepare
+      cmd_exec('')
+      cmd_exec('set pagination off')
+    end
+
+    def detach
+      cmd_exec('detach')
+      cmd_exec('quit')
+    end
+
+    def log(pre, message)
+      return unless @debug
+      message.each_line do |line|
+        puts "#{pre}: #{line}"
+      end
+    end
+  end
+end
+

data/lib/gdbdump/procfs.rb

@@ -0,0 +1,17 @@
+require_relative 'version'
+
+class Gdbdump
+  class Procfs
+    def initialize(pid)
+      @pid = pid
+    end
+
+    def exe
+      begin
+        File.readlink("/proc/#{@pid}/exe")
+      rescue Errno::ENOENT
+        raise "/proc/#{@pid}/exe does not exist, it seems pid #{@pid} does not exit"
+      end
+    end
+  end
+end

data/lib/gdbdump/version.rb

@@ -0,0 +1,3 @@
+class Gdbdump
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: gdbdump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Print C level and Ruby level backtrace of living process using gdb.
+email:
+- sonots@gmail.com
+executables:
+- gdbdump
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gdbdump
+- gdbdump.gemspec
+- lib/gdbdump.rb
+- lib/gdbdump/cli.rb
+- lib/gdbdump/gdb.rb
+- lib/gdbdump/procfs.rb
+- lib/gdbdump/version.rb
+homepage: https://github.com/sonots/gdbdump-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []