debug 0.2.1 → 1.0.0.alpha0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eef42a29a223014d5f00320882cf6e6fdc1b35671b8e600341269b37c2832cb
-  data.tar.gz: be32e52c4010218f3ca3ab3836ef4358c887775308f16a2e740f3bac39c976a2
+  metadata.gz: 58f91a1d4079133e3e7590329d65b7b811490f7158ef96d7b3f826968bc3ad1f
+  data.tar.gz: 4da17de6911dc4506cb869298d84df46de08121aca704bb9e2643f774015fbb3
 SHA512:
-  metadata.gz: f3b53ac6abee0ba7e9caa4b86c4e83845ddce62a41460f203112378e0226217cfd6e792a74c78086832d66615281dd00792aa64f017958719166ce216e725fee
-  data.tar.gz: 8f4c3124d8c0d0b4f970ab7f08238360d4535eb54cfec41f1b330560a3ddffd89bc67a7f50039c26a7d0f160e2210eaff0b3f0c267cfe94919ff5cf358100bbd
+  metadata.gz: baa1a1708b02b63f47d7d751ce9e5830edcdc690c8ca84c956f0e4ce839db5f3f63cf22e856ad4cec43190bb7401b8dcfd13a3d55de72d0a438520a3fab394bc
+  data.tar.gz: 3816a302b56757b55501950ff2814e21d978a5cdf58a4431d663bd1dfbdaae1c7652e0a9565e4401201b29119cdfaa35f47986eee1b17b0b60c1759ec21f3e6a

data/.gitignore

@@ -6,4 +6,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-/Gemfile.lock

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+The MIT License (MIT)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+Copyright (c) 2021 Koichi Sasada
 
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.
+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

@@ -1,52 +1,166 @@
-# Debug
+# debug.rb
 
-This library provides debugging functionality to Ruby.
+## How to install
 
-## Installation
+This is temporary installation guide until gemify.
 
-Add this line to your application's Gemfile:
+```
+$ git clone https://github.com/ko1/debug.git
+$ gem install debug_inspector
+$ gem install iseq_collector
+$ export RUBYOPT=-I`pwd`/debug/lib
+# or add "-I`pwd`/debug/lib" for the following command
+```
+
+# How to use
+
+## Invoke with debugger
+
+### REPL debug
 
-```ruby
-gem 'debug'
+```
+$ ruby -r debug target.rb
 ```
 
-And then execute:
+and you can see the debugger prompt. The program was suspended at the beggining of target.rb. To continue the program, type `c` (or `continue`). See other debug commands below.
 
-    $ bundle install
+You can re-enable debug command mode by `Ctrl-C`.
 
-Or install it yourself as:
+### Remote debug (1) UNIX domain socket
 
-    $ gem install debug
+```
+$ ruby -r debug/unixserver target.rb
+```
 
-## Usage
+It runs target.rb and accept debugger connection within UNIX domain socket.
 
-To add a debugger to your code, start by requiring +debug+ in your
-program:
+You can attach the program with the folliowing command:
 
-```ruby
-def say(word)
-  require 'debug'
-  puts word
-end
+```
+$ ruby -r debug/client -e connect
+Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock/ruby-debug-ko1-20642)
+...
 ```
 
-This will cause Ruby to interrupt execution and show a prompt when the +say+
-method is run.
+The debugee process will be suspended and wait for the debug command.
 
-Once you're inside the prompt, you can start debugging your program.
+If you are running multiple debuggee processes, this command shows the selection like that:
 
 ```
-(rdb:1) p word
-"hello"
+$ ruby -r debug/client -e connect
+Please select a debug session:
+  ruby-debug-ko1-19638
+  ruby-debug-ko1-19603
 ```
 
-## Development
+and you need to specify one:
 
-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.
+```
+$ ruby -r debug/client -e connect ruby-debug-ko1-19638
+```
+
+The socket file is located at
+* `RUBY_DEBUG_SOCK_DIR` environment variable if available.
+* `XDG_RUNTIME_DIR` environment variable if available.
+* `$HOME/ruby-debug-sock` if `$HOME` is available.
 
-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).
+### Remote debug (2) TCP/IP
 
-## Contributing
+```
+$ RUBY_DEBUG_PORT=12345 RUBY_DEBUG_HOST=localhost ruby -r debug/tcpserver target.rb
+Debugger can attach via TCP/IP (localhost:12345)
+...
+```
+
+This command invoke target.rb with TCP/IP attach server with given port and host. If host is not given, `localhost` will be used. 
+
+```
+$ ruby -r debug/client -e connect localhost 12345
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
+tries to connect with given host (`localhost`) and port (`12345`). You can eliminate host part and `localhost` will be used.
+
+
+## Debug command
+
+* `Enter` repeats the last command (useful when repeating `step`s).
+* `Ctrl-D` is equal to `quit` command.
+
+### Control flow
+
+* `s[tep]`
+  * Step in. Resume the program until next breakable point.
+* `n[ext]`
+  * Step over. Resume the program until next line.
+* `fin[ish]`
+  * Finish this frame. Resume the program until the current frame is finished.
+* `c[ontinue]`
+  * Resume the program.
+* `q[uit]` or `Ctrl-D`
+  * Finish debugger (with a process, if not remote debugging).
+* `kill`
+  * Stop the debuggee program.
+
+### Breakpoint
+
+* `b[reak]`
+  * Show all breakpoints.
+* `b[reak] <line>`
+  * Set breakpoint on `<line>` at the current frame's file.
+* `b[reak] <file>:<line>`
+  * Set breakpoint on `<file>:<line>`.
+* `catch <Error>`
+  * Set breakpoint on raising `<Error>`.
+* `del[ete]`
+  * delete all breakpoints.
+* `del[ete] <bpnum>`
+  * delete specified breakpoint.
+
+### Frame control
+
+* `bt` or `backtrace`
+  * Show backtrace information.
+* `f[rame]`
+  * Show current frame.
+* `f[rame] <framenum>`
+  * Specify frame. Evaluation are run on this frame environement.
+* `up`
+  * Specify upper frame.
+* `down`
+  * Specify down frame.
+
+### Evaluate
+
+* `p <expr>`
+  * Evaluate like `p <expr>` on the current frame.
+* `pp <expr>`
+  * Evaluate like `pp <expr>` on the current frame.
+* `e[val] <expr>`
+  * Evaluate `<expr>` on the current frame.
+
+### Information
+
+* `list`
+  * Show current frame's source code.
+* `info l[ocal[s]]`
+  * Show current frame's local variables. It includes `self` as `%self` and a return value as `%return`.
+* `info i[nstance]` or `info ivars`
+  * Show current frame's insntance variables.
+* `display`
+  * Show display setting.
+* `display <expr>`
+  * Add `<expr>` at suspended timing.
+* `undisplay`
+  * Remove all display settings.
+* `undisplay <displaynum>`
+  * Remove a specified display setting.
+* `trace [on|off]`
+  * enable or disable line tracer.
+
+### Thread control
+
+* `th[read] [l[ist]]`
+  * Show all threads.
+* `th[read] <thnum>`
+  * Switch thread specified by `<thnum>`
 

data/Rakefile

@@ -1 +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/debug.gemspec

@@ -1,22 +1,32 @@
+require_relative 'lib/debug/version'
+
 Gem::Specification.new do |spec|
   spec.name          = "debug"
-  spec.version       = "0.2.1"
-  spec.authors       = ["Yukihiro Matsumoto"]
-  spec.email         = ["matz@ruby-lang.org"]
+  spec.version       = DEBUGGER__::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+
+  spec.summary       = %q{debug.rb}
+  spec.description   = %q{debug.rb}
+  spec.homepage      = "https://github.com/ko1/debug"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
-  spec.summary       = %q{Debugging functionality for Ruby}
-  spec.description   = %q{Debugging functionality for Ruby}
-  spec.homepage      = "https://github.com/ruby/debug"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ko1/debug"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
-  spec.executables   = []
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'debug_inspector'
+  spec.add_runtime_dependency 'iseq_collector'
 end

data/exe/rdbg

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "debug"

data/lib/debug/bp.vim

@@ -0,0 +1,68 @@
+let g:rdb_bps = {}
+
+function SET_BP()
+  let signed = sign_getplaced(bufname(), {'lnum': line('.')})
+  if empty(signed[0]['signs'])
+    call sign_place(0, '', 'signBP', bufname(), {'lnum': line('.')})
+  else
+    "echo signed[0]['signs']
+    call sign_unplace('', {'buffer': bufname(), 'id': signed[0]['signs'][0]['id']})
+  endif
+endfunction
+
+function UPDATE_BPS()
+  let signs = sign_getplaced(bufname())
+  let key = expand('%:p')
+
+  if empty(signs[0]['signs'])
+    let removed = remove(g:rdb_bps, key)
+  else
+    let g:rdb_bps[key] = signs[0]['signs']
+  endif
+endfunction
+
+function APPLY_BPS()
+  let key = expand('%:p')
+  if has_key(g:rdb_bps, key)
+    for b in g:rdb_bps[key]
+      call sign_place(0, '', 'signBP', bufname(), {'lnum': b['lnum']})
+    endfor
+  endif
+endfunction
+
+function WRITE_BPS()
+  call writefile([json_encode(g:rdb_bps)], '.rdb_breakpoints.json')
+endfunction
+
+" load
+try
+  let json = readfile('.rdb_breakpoints.json')
+  let g:rdb_bps = json_decode(json[0])
+  " {"/full/path/to/file1": [{"lnum": 10}, ...], ...}
+catch /Can't open/
+  let g:rdb_bps = {}
+catch /Invalid arguments for function json_decode/
+  let g:rdb_bps = {}
+endtry
+
+sign define signBP text=BR
+
+call APPLY_BPS()
+
+autocmd BufReadPost * call APPLY_BPS()
+autocmd BufUnload   * call UPDATE_BPS()
+autocmd VimLeave    * call WRITE_BPS()
+
+function! s:ruby_bp_settings() abort
+  echomsg "Type <Space> to toggle break points and <q> to quit"
+
+  if &readonly
+    nnoremap <silent> <buffer> <Space> :call SET_BP()<CR>
+    nnoremap <silent> <buffer> q :<C-u>quit<CR>
+  endif
+endfunction
+
+" autocmd FileType ruby call s:ruby_bp_settings()
+autocmd BufEnter *.rb call s:ruby_bp_settings()
+
+call s:ruby_bp_settings()

data/lib/debug/breakpoint.rb

@@ -0,0 +1,97 @@
+module DEBUGGER__
+  class LineBreakpoint
+    attr_reader :path, :line, :key
+
+    def initialize type, iseq, line, cond = nil, oneshot: false
+      @iseq = iseq
+      @path = iseq.path
+      @line = line
+      @type = type
+      @cond = cond
+      @oneshot = oneshot
+      @key = [@path, @line].freeze
+      setup
+      enable
+    end
+
+    def safe_eval b, expr
+      b.eval(expr)
+    rescue Exception => e
+      puts "[EVAL ERROR]"
+      puts "  expr: #{expr}"
+      puts "  err: #{e} (#{e.class})"
+      nil
+    end
+
+    def setup
+      if !@cond
+        @tp = TracePoint.new(@type) do |tp|
+          tp.disable if @oneshot
+          ThreadClient.current.on_breakpoint tp
+        end
+      else
+        @tp = TracePoint.new(@type) do |tp|
+          next unless safe_eval tp.binding, @cond
+          tp.disable if @oneshot
+          ThreadClient.current.on_breakpoint tp
+        end
+      end
+    end
+
+    def enable
+      if @type == :line
+        @tp.enable(target: @iseq, target_line: @line)
+      else
+        @tp.enable(target: @iseq)
+      end
+    rescue ArgumentError
+      puts @iseq.disasm # for debug
+      raise
+    end
+
+    def disable
+      @tp.disable
+    end
+
+    def to_s
+      "line bp #{@iseq.absolute_path}:#{@line} (#{@type})" +
+        if @cond
+          "if #{@cond}"
+        else
+          ""
+        end
+    end
+
+    def inspect
+      "<#{self.class.name} #{self.to_s}>"
+    end
+  end
+
+  class CatchBreakpoint
+    attr_reader :key
+
+    def initialize pat
+      @pat = pat
+      @tp = TracePoint.new(:raise){|tp|
+        exc = tp.raised_exception
+        exc.class.ancestors.each{|cls|
+          if pat === cls.name
+            puts "catch #{exc.class.inspect} by #{@pat.inspect}"
+            ThreadClient.current.on_suspend :catch
+          end
+        }
+      }
+      @tp.enable
+
+      @key = pat.freeze
+    end
+
+    def disable
+      @tp.disable
+    end
+
+    def to_s
+      "catch bp #{@pat.inspect}"
+    end
+  end
+end

data/lib/debug/client.rb

@@ -0,0 +1,135 @@
+require 'socket'
+require_relative 'config'
+
+module DEBUGGER__
+  class Client
+    begin
+      require 'readline'
+      def readline
+        Readline.readline("\n(rdb) ", true)
+      end
+    rescue LoadError
+      def readline
+        print "\n(rdb) "
+        gets
+      end
+    end
+
+    def help
+      puts "-run -e attach       # connect via UNIX Domain socket"
+      puts "-run -e attach name  # connect via UNIX Domain socket with specified name"
+      puts "-run -e attach port_num  # connect via TCP/IP socket with specified port"
+      puts "-run -e attach host port_num"
+      puts "               # connect via TCP/IP socket with specified host and port"
+    end
+
+    def initialize argv
+      case argv.size
+      when 0
+        connect_unix
+      when 1
+        case arg = argv.shift
+        when /-h/, /--help/
+          help
+          exit
+        when /\A\d+\z/
+          connect_tcp nil, arg.to_i
+        else
+          connect_unix arg
+        end
+      when 2
+        connect_tcp argv[0], argv[1]
+      else
+        help
+        exit!
+      end
+    end
+
+    def cleanup_unix_domain_sockets
+      Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*') do |file|
+        if /(\d+)$/ =~ file
+          begin
+            Process.kill(0, $1.to_i)
+          rescue Errno::ESRCH
+            File.unlink(file)
+          end
+        end
+      end
+    end
+
+    def connect_unix name = nil
+      if name
+        if File.exist? name
+          @s = Socket.unix(name)
+        else
+          @s = Socket.unix(File.join(DEBUGGER__.unix_domain_socket_basedir, name))
+        end
+      else
+        cleanup_unix_domain_sockets
+        files = Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+        case files.size
+        when 0
+          $stderr.puts "There is no debug sessions."
+          exit
+        when 1
+          @s = Socket.unix(files.first)
+        else
+          $stderr.puts "Please select a debug session:"
+          files.each{|f|
+            $stderr.puts "  #{File.basename(f)}"
+          }
+          exit
+        end
+      end
+    end
+
+    def connect_tcp host, port
+      @s = Socket.tcp(host, port)
+    end
+
+    def connect
+      trap(:SIGINT){
+        @s.puts "pause"
+      }
+
+      while line = @s.gets
+        # p line: line
+        case line
+        when /^out (.*)/
+          puts "#{$1}"
+        when /^input/
+          prev_trap = trap(:SIGINT, 'DEFAULT')
+
+          begin
+            line = readline
+          rescue Interrupt
+            retry
+          ensure
+            trap(:SIGINT, prev_trap)
+          end
+
+          line = (line || 'quit').strip
+          @s.puts "command #{line}"
+        when /^ask (.*)/
+          print $1
+          @s.puts "answer #{gets || ''}"
+        when /^quit/
+          raise 'quit'
+        else
+          puts "(unknown) #{line.inspect}"
+        end
+      end
+    rescue
+      STDERR.puts "disconnected (#{$!})"
+      exit
+    end
+  end
+end
+
+def connect argv = ARGV
+  DEBUGGER__::Client.new(argv).connect
+end
+
+if __FILE__ == $0
+  connect
+end

data/lib/debug/config.rb

@@ -0,0 +1,26 @@
+module DEBUGGER__
+  def self.unix_domain_socket_basedir
+    case
+    when path = ENV['RUBY_DEBUG_SOCK_DIR']
+    when path = ENV['XDG_RUNTIME_DIR']
+    when home = ENV['HOME']
+      path = File.join(home, '.ruby-debug-sock')
+      unless File.exist?(path)
+        Dir.mkdir(path, 0700)
+      end
+    else
+      raise 'specify RUBY_DEBUG_SOCK_DIR environment variable for UNIX domain socket directory.'
+    end
+
+    path
+  end
+
+  def self.create_unix_domain_socket_name_prefix
+    user = ENV['USER'] || 'ruby-debug'
+    File.join(unix_domain_socket_basedir, "ruby-debug-#{user}")
+  end
+
+  def self.create_unix_domain_socket_name
+    create_unix_domain_socket_name_prefix + "-#{Process.pid}"
+  end
+end