debug 1.0.0.beta2 → 1.0.0.beta7

data/TODO.md

@@ -0,0 +1,27 @@
+# TODO
+
+## Basic functionality
+
+* Support Ractors
+* Signal (SIGINT) support
+
+## UI
+
+* Interactive breakpoint setting
+* irb integration
+* Web browser integrated UI
+
+## Debug command
+
+* Breakpoints
+    * Lightweight pending method break points with Ruby 3.1 feature (TP:method_added)
+    * Non-stop breakpoint but runs some code.
+* Watch points
+    * Lightweight watchpoints for instance variables with Ruby 3.1 features (TP:ivar_set)
+* Faster `next`/`finish` command by specifying target code.
+* `set`/`show` configurations
+* In-memory line traces
+* Timemachine debugging
+
+## Tests
+

data/bin/gentest

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative '../test/tool/test_builder'
+
+file_info = {}
+
+OptionParser.new do |opt|
+  opt.banner = 'Usage: bin/gentest [file] [option]'
+  opt.on('-m METHOD', 'Method name in the test file') do |m|
+    file_info[:method] = m
+  end
+  opt.on('-c CLASS', 'Class name in the test file') do |c|
+    file_info[:class] = c
+  end
+  opt.parse!(ARGV)
+end
+
+exit if ARGV.empty?
+
+DEBUGGER__::TestBuilder.new(ARGV, file_info[:method], file_info[:class]).start

data/debug.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions    = ['ext/debug/extconf.rb']
+
+  spec.add_dependency "irb" # for its color_printer class, which was added after 1.3
 end

data/exe/rdbg

@@ -1,30 +1,33 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/debug/client'
-
+require_relative '../lib/debug/config'
 config = DEBUGGER__.parse_argv(ARGV)
 
 case config[:mode]
 when :start
   require 'rbconfig'
 
-  if config[:remote]
-    start_mode = "debug/open"
-  else
-    start_mode = "debug/run"
-  end
+  libpath = File.join(File.expand_path(File.dirname(__dir__)), 'lib/debug')
+  start_mode = config[:remote] ? "open" : 'run'
+  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
 
-  ::DEBUGGER__.config_to_env(config)
-  exec("#{RbConfig.ruby}", "-I#{File.expand_path(File.dirname(__dir__))}/lib", "-r" + start_mode, *ARGV)
+  env = ::DEBUGGER__.config_to_env_hash(config)
+  env['RUBYOPT'] = "-r #{libpath}/#{start_mode}"
+
+  exec(env, cmd, *ARGV)
 
 when :attach
   require_relative "../lib/debug/client"
 
+  config.each{|k, v|
+    DEBUGGER__::CONFIG[k] = v
+  }
+
   begin
     if ARGV.empty? && config[:port]
-      connect [config[:host], config[:port]].compact
+      DEBUGGER__::Client.new([config[:host], config[:port]].compact).connect
     else
-      connect ARGV
+      DEBUGGER__::Client.new(ARGV).connect
     end
   rescue DEBUGGER__::CommandLineOptionError
     puts opt.help

data/ext/debug/debug.c

@@ -22,7 +22,7 @@ static VALUE rb_cFrameInfo;
 static VALUE
 di_entry(VALUE loc, VALUE self, VALUE binding, VALUE iseq, VALUE klass, VALUE depth)
 {
-    return rb_struct_new(rb_cFrameInfo, loc, self, binding, iseq, klass, depth, Qnil, Qnil, Qnil);
+    return rb_struct_new(rb_cFrameInfo, loc, self, binding, iseq, klass, depth, Qnil, Qnil, Qnil, Qnil, Qnil);
 }
 
 static int
@@ -49,6 +49,7 @@ di_body(const rb_debug_inspector_t *dc, void *ptr)
     long i;
 
     for (i=1; i<len; i++) {
+        VALUE loc, e;
         VALUE iseq = rb_debug_inspector_frame_iseq_get(dc, i);
 
         if (!NIL_P(iseq)) {
@@ -56,13 +57,13 @@ di_body(const rb_debug_inspector_t *dc, void *ptr)
             if (!NIL_P(path) && str_start_with(path, skip_path_prefix)) continue;
         }
 
-        VALUE loc = RARRAY_AREF(locs, i);
-        VALUE e = di_entry(loc,
-                           rb_debug_inspector_frame_self_get(dc, i),
-                           rb_debug_inspector_frame_binding_get(dc, i),
-                           iseq,
-                           rb_debug_inspector_frame_class_get(dc, i),
-                           INT2FIX(len - i));
+        loc = RARRAY_AREF(locs, i);
+        e = di_entry(loc,
+                     rb_debug_inspector_frame_self_get(dc, i),
+                     rb_debug_inspector_frame_binding_get(dc, i),
+                     iseq,
+                     rb_debug_inspector_frame_class_get(dc, i),
+                     INT2FIX(len - i));
         rb_ary_push(ary, e);
     }
 
@@ -90,7 +91,7 @@ method_added_tracker(VALUE tpval, void *ptr)
     VALUE mid = rb_tracearg_callee_id(arg);
 
     if (RB_UNLIKELY(mid == ID2SYM(rb_intern("method_added")) ||
-                    mid == ID2SYM(rb_intern("singleton_method_method_added")))) {
+                    mid == ID2SYM(rb_intern("singleton_method_added")))) {
         VALUE args[] = {
             tpval,
         };

data/lib/debug.rb

@@ -1 +1,4 @@
-require_relative 'debug/run'
+# frozen_string_literal: true
+
+require_relative 'debug/session'
+DEBUGGER__::start no_sigint_hook: true, nonstop: true

data/lib/debug/breakpoint.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'color'
+
 module DEBUGGER__
   class Breakpoint
     attr_reader :key
@@ -28,7 +32,7 @@ module DEBUGGER__
     end
 
     def disable
-      @tp.disable
+      @tp&.disable
     end
 
     def enabled?
@@ -45,27 +49,50 @@ module DEBUGGER__
     end
 
     def suspend
+      if @command
+        provider, pre_cmds, do_cmds = @command
+        nonstop = true if do_cmds
+        cmds = [*pre_cmds&.split(';;'), *do_cmds&.split(';;')]
+        SESSION.add_preset_commands provider, cmds, kick: false, continue: nonstop
+      end
+
       ThreadClient.current.on_breakpoint @tp, self
     end
 
     def to_s
-      if @cond
-        " if #{@cond}"
-      else
-        ""
-      end
+      s = ''.dup
+      s << " if: #{@cond}"        if defined?(@cond) && @cond
+      s << " pre: #{@command[1]}" if defined?(@command) && @command && @command[1]
+      s << " do: #{@command[2]}"  if defined?(@command) && @command && @command[2]
+      s
+    end
+
+    def description
+      to_s
+    end
+
+    def duplicable?
+      false
+    end
+
+    include Color
+
+    def generate_label(name)
+      colorize(" BP - #{name} ", [:YELLOW, :BOLD, :REVERSE])
     end
   end
 
   class LineBreakpoint < Breakpoint
     attr_reader :path, :line, :iseq
 
-    def initialize path, line, cond: nil, oneshot: false, hook_call: true
+    def initialize path, line, cond: nil, oneshot: false, hook_call: true, command: nil
       @path = path
       @line = line
       @cond = cond
       @oneshot = oneshot
       @hook_call = hook_call
+      @command = command
+      @pending = false
 
       @iseq = nil
       @type = nil
@@ -73,23 +100,21 @@ module DEBUGGER__
       @key = [@path, @line].freeze
 
       super()
+
       try_activate
+      @pending = !@iseq
     end
 
     def setup
       return unless @type
 
-      if !@cond
-        @tp = TracePoint.new(@type) do |tp|
-          delete if @oneshot
-          suspend
-        end
-      else
-        @tp = TracePoint.new(@type) do |tp|
+      @tp = TracePoint.new(@type) do |tp|
+        if @cond
           next unless safe_eval tp.binding, @cond
-          delete if @oneshot
-          suspend
         end
+        delete if @oneshot
+
+        suspend
       end
     end
 
@@ -115,9 +140,12 @@ module DEBUGGER__
 
       @key = [@path, @line].freeze
       SESSION.rehash_bps
-
       setup
       enable
+
+      if @pending && !@oneshot
+        DEBUGGER__.warn "#{self} is activated."
+      end
     end
 
     def activate_exact iseq, events, line
@@ -138,13 +166,20 @@ module DEBUGGER__
       end
     end
 
+    def duplicable?
+      @oneshot
+    end
+
     NearestISeq = Struct.new(:iseq, :line, :events)
 
     def try_activate
       nearest = nil # NearestISeq
 
       ObjectSpace.each_iseq{|iseq|
-        if (iseq.absolute_path || iseq.path) == self.path && iseq.first_lineno <= self.line
+        if (iseq.absolute_path || iseq.path) == self.path &&
+            iseq.first_lineno <= self.line &&
+            iseq.type != :ensure # ensure iseq is copied (duplicated)
+
           iseq.traceable_lines_norec(line_events = {})
           lines = line_events.keys.sort
 
@@ -183,9 +218,9 @@ module DEBUGGER__
       oneshot = @oneshot ? " (oneshot)" : ""
 
       if @iseq
-        "line bp #{@path}:#{@line} (#{@type})#{oneshot}" + super
+        "#{generate_label("Line")} #{@path}:#{@line} (#{@type})#{oneshot}" + super
       else
-        "line bp (pending) #{@path}:#{@line}#{oneshot}" + super
+        "#{generate_label("Line (pending)")} #{@path}:#{@line}#{oneshot}" + super
       end
     end
 
@@ -195,9 +230,12 @@ module DEBUGGER__
   end
 
   class CatchBreakpoint < Breakpoint
+    attr_reader :last_exc
+
     def initialize pat
       @pat = pat.freeze
       @key = [:catch, @pat].freeze
+      @last_exc = nil
 
       super()
     end
@@ -205,14 +243,26 @@ module DEBUGGER__
     def setup
       @tp = TracePoint.new(:raise){|tp|
         exc = tp.raised_exception
+        next if SystemExit === exc
+        should_suspend = false
+
         exc.class.ancestors.each{|cls|
-          suspend if pat === cls.name
+          if @pat === cls.name
+            should_suspend = true
+            @last_exc = exc
+            break
+          end
         }
+        suspend if should_suspend
       }
     end
 
     def to_s
-      "catch bp #{@pat.inspect}"
+      "#{generate_label("Catch")} #{@pat.inspect}"
+    end
+
+    def description
+      "#{@last_exc.inspect} is raised."
     end
   end
 
@@ -228,6 +278,8 @@ module DEBUGGER__
       @tp = TracePoint.new(:line){|tp|
         next if tp.path.start_with? __dir__
         next if tp.path.start_with? '<internal:'
+        # Skip when `JSON.generate` is called during tests
+        next if tp.defined_class.to_s == '#<Class:JSON>' and ENV['RUBY_DEBUG_TEST_MODE']
 
         if safe_eval tp.binding, @expr
           suspend
@@ -236,21 +288,22 @@ module DEBUGGER__
     end
 
     def to_s
-      "check bp: #{@expr}"
+      "#{generate_label("Check")} #{@expr}"
     end
   end
 
-  class WatchExprBreakpoint < Breakpoint
-    def initialize expr, current
-      @expr = expr.freeze
-      @key = [:watch, @expr].freeze
+  class WatchIVarBreakpoint < Breakpoint
+    def initialize ivar, object, current
+      @ivar = ivar.to_sym
+      @object = object
+      @key = [:watch, @ivar].freeze
 
       @current = current
       super()
     end
 
-    def watch_eval b
-      result = b.eval(@expr)
+    def watch_eval
+      result = @object.instance_variable_get(@ivar)
       if result != @current
         begin
           @prev = @current
@@ -260,7 +313,7 @@ module DEBUGGER__
           remove_instance_variable(:@prev)
         end
       end
-    rescue Exception => e
+    rescue Exception
       false
     end
 
@@ -269,23 +322,25 @@ module DEBUGGER__
         next if tp.path.start_with? __dir__
         next if tp.path.start_with? '<internal:'
 
-        watch_eval(tp.binding)
+        watch_eval
       }
     end
 
     def to_s
-      if defined? @prev
-        "watch bp: #{@expr} = #{@prev} -> #{@current}"
-      else
-        "watch bp: #{@expr} = #{@current}"
-      end
+      value_str =
+        if defined?(@prev)
+          "#{@prev} -> #{@current}"
+        else
+          "#{@current}"
+        end
+      "#{generate_label("Watch")} #{@object} #{@ivar} = #{value_str}"
     end
   end
 
   class MethodBreakpoint < Breakpoint
     attr_reader :sig_method_name, :method
 
-    def initialize b, klass_name, op, method_name, cond
+    def initialize b, klass_name, op, method_name, cond, command: nil
       @sig_klass_name = klass_name
       @sig_op = op
       @sig_method_name = method_name
@@ -294,6 +349,7 @@ module DEBUGGER__
       @klass = nil
       @method = nil
       @cond = cond
+      @command = command
       @key = "#{klass_name}#{op}#{method_name}".freeze
 
       super(false)
@@ -330,30 +386,39 @@ module DEBUGGER__
       end
     end
 
-    def enable quiet: false
+    def enable
+      try_enable
+    end
+
+    def try_enable added: false
       eval_class_name
       search_method
 
       begin
         retried = false
         @tp.enable(target: @method)
+        DEBUGGER__.warn "#{self} is activated." if added
 
-      rescue ArgumentError => e
+      rescue ArgumentError
         raise if retried
         retried = true
+        sig_method_name = @sig_method_name
 
         # maybe C method
         @klass.module_eval do
-          orig_name = @sig_method_name + '__orig__'
-          alias_method orig_name, @sig_method_name
-          define_method(@sig_method_name) do |*args|
+          orig_name = sig_method_name + '__orig__'
+          alias_method orig_name, sig_method_name
+          define_method(sig_method_name) do |*args|
             send(orig_name, *args)
           end
         end
+
+        # re-collect the method object after the above patch
+        search_method
         retry
       end
     rescue Exception
-      raise unless quiet
+      raise unless added
     end
 
     def sig
@@ -362,9 +427,9 @@ module DEBUGGER__
 
     def to_s
       if @method
-        "method bp: #{sig}"
+        "#{generate_label("Method")} #{sig} at #{@method.source_location.join(':')}"
       else
-        "method bp (pending): #{sig}"
+        "#{generate_label("Method (pending)")} #{sig}"
       end + super
     end
   end