debug 1.1.0 → 1.2.3

data/lib/debug/session.rb

@@ -86,7 +86,7 @@ module DEBUGGER__
                 #   [:watch, ivar] => WatchIVarBreakpoint
                 #   [:check, expr] => CheckBreakpoint
       #
-      @tracers = []
+      @tracers = {}
       @th_clients = nil # {Thread => ThreadClient}
       @q_evt = Queue.new
       @displays = []
@@ -96,17 +96,22 @@ module DEBUGGER__
       @postmortem_hook = nil
       @postmortem = false
       @thread_stopper = nil
+      @intercept_trap_sigint = false
+      @intercepted_sigint_cmd = 'DEFAULT'
 
       @frame_map = {} # {id => [threadId, frame_depth]} for DAP
       @var_map   = {1 => [:globals], } # {id => ...} for DAP
       @src_map   = {} # {id => src}
 
+      @tp_thread_begin = nil
       @tp_load_script = TracePoint.new(:script_compiled){|tp|
         ThreadClient.current.on_load tp.instruction_sequence, tp.eval_script
       }
       @tp_load_script.enable
 
       activate
+
+      self.postmortem = CONFIG[:postmortem]
     end
 
     def active?
@@ -117,40 +122,41 @@ module DEBUGGER__
       @bps.has_key? [file, line]
     end
 
-    def check_forked
-      unless active?
-        # TODO: Support it
-        raise 'DEBUGGER: stop at forked process is not supported yet.'
+    def activate on_fork: false
+      @tp_thread_begin&.disable
+      @tp_thread_begin = nil
+
+      if on_fork
+        @ui.activate self, on_fork: true
+      else
+        @ui.activate self, on_fork: false
       end
-    end
 
-    def activate on_fork: false
+      q = Queue.new
       @session_server = Thread.new do
         Thread.current.name = 'DEBUGGER__::SESSION@server'
         Thread.current.abort_on_exception = true
-        session_server_main
-      end
 
-      setup_threads
+        # Thread management
+        setup_threads
+        thc = thread_client Thread.current
+        thc.is_management
 
-      thc = thread_client @session_server
-      thc.is_management
+        if @ui.respond_to?(:reader_thread) && thc = thread_client(@ui.reader_thread)
+          thc.is_management
+        end
 
-      if on_fork
-        @tp_thread_begin.disable
-        @tp_thread_begin = nil
-        @ui.activate on_fork: true
-      end
+        @tp_thread_begin = TracePoint.new(:thread_begin) do |tp|
+          thread_client
+        end
+        @tp_thread_begin.enable
 
-      if @ui.respond_to?(:reader_thread) && thc = thread_client(@ui.reader_thread)
-        thc.is_management
+        # session start
+        q << true
+        session_server_main
       end
 
-      @tp_thread_begin = TracePoint.new(:thread_begin){|tp|
-        th = Thread.current
-        ThreadClient.current.on_thread_begin th
-      }
-      @tp_thread_begin.enable
+      q.pop
     end
 
     def deactivate
@@ -160,14 +166,14 @@ module DEBUGGER__
       @tp_thread_begin.disable
       @bps.each{|k, bp| bp.disable}
       @th_clients.each{|th, thc| thc.close}
-      @tracers.each{|t| t.disable}
+      @tracers.values.each{|t| t.disable}
       @q_evt.close
       @ui&.deactivate
       @ui = nil
     end
 
     def reset_ui ui
-      @ui.close
+      @ui.deactivate
       @ui = ui
     end
 
@@ -182,6 +188,13 @@ module DEBUGGER__
         output.each{|str| @ui.puts str}
 
         case ev
+
+        when :thread_begin # special event, tc is nil
+          th = ev_args.shift
+          q = ev_args.shift
+          on_thread_begin th
+          q << true
+
         when :init
           wait_command_loop tc
 
@@ -193,26 +206,25 @@ module DEBUGGER__
 
         when :trace
           trace_id, msg = ev_args
-          if t = @tracers.find{|t| t.object_id == trace_id}
+          if t = @tracers.values.find{|t| t.object_id == trace_id}
             t.puts msg
           end
           tc << :continue
 
-        when :thread_begin
-          th = ev_args.shift
-          on_thread_begin th
-          @ui.event :thread_begin, th
-          tc << :continue
-
         when :suspend
           case ev_args.first
           when :breakpoint
             bp, i = bp_index ev_args[1]
-            @ui.event :suspend_bp, i, bp
+            @ui.event :suspend_bp, i, bp, tc.id
           when :trap
-            @ui.event :suspend_trap, ev_args[1]
+            @ui.event :suspend_trap, sig = ev_args[1], tc.id
+
+            if sig == :SIGINT && (@intercepted_sigint_cmd.kind_of?(Proc) || @intercepted_sigint_cmd.kind_of?(String))
+              @ui.puts "#{@intercepted_sigint_cmd.inspect} is registerred as SIGINT handler."
+              @ui.puts "`sigint` command execute it."
+            end
           else
-            @ui.event :suspended
+            @ui.event :suspended, tc.id
           end
 
           if @displays.empty?
@@ -246,8 +258,7 @@ module DEBUGGER__
             obj_id = ev_args[1]
             obj_inspect = ev_args[2]
             opt = ev_args[3]
-            @tracers << t = ObjectTracer.new(@ui, obj_id, obj_inspect, **opt)
-            @ui.puts "Enable #{t.to_s}"
+            add_tracer ObjectTracer.new(@ui, obj_id, obj_inspect, **opt)
           else
             # ignore
           end
@@ -432,6 +443,29 @@ module DEBUGGER__
       when 'kill!'
         exit! (arg || 1).to_i
 
+      # * `sigint`
+      #   * Execute SIGINT handler registerred by the debuggee.
+      #   * Note that this command should be used just after stop by `SIGINT`.
+      when 'sigint'
+        begin
+          case cmd = @intercepted_sigint_cmd
+          when nil, 'IGNORE', :IGNORE, 'DEFAULT', :DEFAULT
+            # ignore
+          when String
+            eval(cmd)
+          when Proc
+            cmd.call
+          end
+
+          @tc << :continue
+          restart_all_threads
+
+        rescue Exception => e
+          @ui.puts "Exception: #{e}"
+          @ui.puts e.backtrace.map{|line| "  #{e}"}
+          return :retry
+        end
+
       ### Breakpoint
 
       # * `b[reak]`
@@ -740,7 +774,7 @@ module DEBUGGER__
           @ui.puts "not supported on the remote console."
           return :retry
         end
-        @tc << [:eval, :call, 'binding.irb']
+        @tc << [:eval, :irb]
 
         # don't repeat irb command
         @repl_prev_line = nil
@@ -778,32 +812,29 @@ module DEBUGGER__
         case arg
         when nil
           @ui.puts 'Tracers:'
-          @tracers.each_with_index{|t, i|
+          @tracers.values.each_with_index{|t, i|
             @ui.puts "* \##{i} #{t}"
           }
           @ui.puts
           return :retry
 
         when /\Aline\z/
-          @tracers << t = LineTracer.new(@ui, pattern: pattern, into: into)
-          @ui.puts "Enable #{t.to_s}"
+          add_tracer LineTracer.new(@ui, pattern: pattern, into: into)
           return :retry
 
         when /\Acall\z/
-          @tracers << t = CallTracer.new(@ui, pattern: pattern, into: into)
-          @ui.puts "Enable #{t.to_s}"
+          add_tracer CallTracer.new(@ui, pattern: pattern, into: into)
           return :retry
 
         when /\Aexception\z/
-          @tracers << t = ExceptionTracer.new(@ui, pattern: pattern, into: into)
-          @ui.puts "Enable #{t.to_s}"
+          add_tracer ExceptionTracer.new(@ui, pattern: pattern, into: into)
           return :retry
 
         when /\Aobject\s+(.+)/
           @tc << [:trace, :object, $1.strip, {pattern: pattern, into: into}]
 
         when /\Aoff\s+(\d+)\z/
-          if t = @tracers[$1.to_i]
+          if t = @tracers.values[$1.to_i]
             t.disable
             @ui.puts "Disable #{t.to_s}"
           else
@@ -812,7 +843,7 @@ module DEBUGGER__
           return :retry
 
         when /\Aoff(\s+(line|call|exception|object))?\z/
-          @tracers.each{|t|
+          @tracers.values.each{|t|
             if $2.nil? || t.type == $2
               t.disable
               @ui.puts "Disable #{t.to_s}"
@@ -1190,6 +1221,20 @@ module DEBUGGER__
       @ui.puts e.message
     end
 
+    # tracers
+
+    def add_tracer tracer
+      # don't repeat commands that add tracers
+      @repl_prev_line = nil
+      if @tracers.has_key? tracer.key
+        tracer.disable
+        @ui.puts "Duplicated tracer: #{tracer}"
+      else
+        @tracers[tracer.key] = tracer
+        @ui.puts "Enable #{tracer}"
+      end
+    end
+
     # threads
 
     def update_thread_list
@@ -1242,10 +1287,6 @@ module DEBUGGER__
       thread_list
     end
 
-    def thread_client_create th
-      @th_clients[th] = ThreadClient.new((@tc_id += 1), @q_evt, Queue.new, th)
-    end
-
     def setup_threads
       @th_clients = {}
 
@@ -1256,18 +1297,38 @@ module DEBUGGER__
 
     def on_thread_begin th
       if @th_clients.has_key? th
-        # OK
-      else
         # TODO: NG?
+      else
         thread_client_create th
       end
     end
 
-    def thread_client thr = Thread.current
-      if @th_clients.has_key? thr
-        @th_clients[thr]
+    private def thread_client_create th
+      # TODO: Ractor support
+      raise "Only session_server can create thread_client" unless Thread.current == @session_server
+      @th_clients[th] = ThreadClient.new((@tc_id += 1), @q_evt, Queue.new, th)
+    end
+
+    private def ask_thread_client th = Thread.current
+      # TODO: Ractor support
+      q2 = Queue.new
+      # tc, output, ev, @internal_info, *ev_args = evt
+      @q_evt << [nil, [], :thread_begin, nil, th, q2]
+      q2.pop
+
+      @th_clients[th] or raise "unexpected error"
+    end
+
+    # can be called by other threads
+    def thread_client th = Thread.current
+      if @th_clients.has_key? th
+        @th_clients[th]
       else
-        @th_clients[thr] = thread_client_create(thr)
+        if Thread.current == @session_server
+          thread_client_create th
+        else
+          ask_thread_client th
+        end
       end
     end
 
@@ -1386,7 +1447,10 @@ module DEBUGGER__
       end
     end
 
-    def enter_postmortem_session frames
+    def enter_postmortem_session exc
+      return unless exc.instance_variable_defined? :@__debugger_postmortem_frames
+
+      frames = exc.instance_variable_get(:@__debugger_postmortem_frames)
       @postmortem = true
       ThreadClient.current.suspend :postmortem, postmortem_frames: frames
     ensure
@@ -1399,7 +1463,7 @@ module DEBUGGER__
           @postmortem_hook = TracePoint.new(:raise){|tp|
             exc = tp.raised_exception
             frames = DEBUGGER__.capture_frames(__dir__)
-            exc.instance_variable_set(:@postmortem_frames, frames)
+            exc.instance_variable_set(:@__debugger_postmortem_frames, frames)
           }
           at_exit{
             @postmortem_hook.disable
@@ -1411,7 +1475,7 @@ module DEBUGGER__
                 @ui.puts exc.backtrace.map{|e| '  ' + e}
                 @ui.puts "\n"
 
-                enter_postmortem_session exc.instance_variable_get(:@postmortem_frames)
+                enter_postmortem_session exc
               rescue SystemExit
                 exit!
               rescue Exception => e
@@ -1431,6 +1495,30 @@ module DEBUGGER__
         end
       end
     end
+
+    def save_int_trap cmd
+      prev, @intercepted_sigint_cmd = @intercepted_sigint_cmd, cmd
+      prev
+    end
+
+    attr_reader :intercepted_sigint_cmd
+
+    def intercept_trap_sigint?
+      @intercept_trap_sigint
+    end
+
+    def intercept_trap_sigint flag, &b
+      prev = @intercept_trap_sigint
+      @intercept_trap_sigint = flag
+      yield
+    ensure
+      @intercept_trap_sigint = prev
+    end
+
+    def intercept_trap_sigint_start prev
+      @intercept_trap_sigint = true
+      @intercepted_sigint_cmd = prev
+    end
   end
 
   class UI_Base
@@ -1526,6 +1614,9 @@ module DEBUGGER__
   def self.setup_initial_suspend
     if !CONFIG[:nonstop]
       case
+      when CONFIG[:stop_at_load]
+        add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true, hook_call: false
+        nil # stop here
       when path = ENV['RUBY_DEBUG_INITIAL_SUSPEND_PATH']
         add_line_breakpoint path, 0, oneshot: true, hook_call: false
       when loc = ::DEBUGGER__.require_location
@@ -1643,7 +1734,18 @@ module DEBUGGER__
 
           at_exit{
             trap(:SIGINT, :IGNORE)
-            Process.waitpid(child_pid)
+
+            # only check child process from its parent
+            if Process.pid == parent_pid
+              begin
+                # sending a null signal to see if the child is still alive
+                Process.kill(0, child_pid)
+                # if the child is still alive, wait for it
+                Process.waitpid(child_pid)
+              rescue Errno::ESRCH
+                # if the child process has died, do nothing
+              end
+            end
           }
         }
         child_hook = -> {
@@ -1675,8 +1777,36 @@ module DEBUGGER__
     end
   end
 
-  class ::Object
-    include ForkInterceptor
+  module TrapInterceptor
+    def trap sig, *command, &command_proc
+      case sig&.to_sym
+      when :INT, :SIGINT
+        if defined?(SESSION) && SESSION.active? && SESSION.intercept_trap_sigint?
+          return SESSION.save_int_trap(command.empty? ? command_proc : command.first)
+        end
+      end
+
+      super
+    end
+  end
+
+  if RUBY_VERSION >= '3.0.0'
+    module ::Kernel
+      prepend ForkInterceptor
+      prepend TrapInterceptor
+    end
+  else
+    class ::Object
+      include ForkInterceptor
+      include TrapInterceptor
+    end
+  end
+
+  module ::Kernel
+    class << self
+      prepend ForkInterceptor
+      prepend TrapInterceptor
+    end
   end
 
   module ::Process
@@ -1684,10 +1814,16 @@ module DEBUGGER__
       prepend ForkInterceptor
     end
   end
+
+  module ::Signal
+    class << self
+      prepend TrapInterceptor
+    end
+  end
 end
 
-class Binding
-  def break pre: nil, do: nil
+module Kernel
+  def debugger pre: nil, do: nil
     return if !defined?(::DEBUGGER__::SESSION) || !::DEBUGGER__::SESSION.active?
 
     if pre || (do_expr = binding.local_variable_get(:do))
@@ -1697,20 +1833,10 @@ class Binding
     ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true, command: cmds
     self
   end
-  alias b break
 end
 
-module Kernel
-  if RUBY_VERSION >= '2.7.0'
-    eval <<~RUBY, binding, __FILE__, __LINE__
-      def debugger(...)
-        binding.break(...)
-      end
-    RUBY
-  else
-    def debugger pre: nil, do: nil
-      b = binding
-      b.break pre: pre, do: b.local_variable_get(:do)
-    end
-  end
+class Binding
+  alias break debugger
+  alias b debugger
 end
+

data/lib/debug/thread_client.rb

@@ -20,9 +20,11 @@ module DEBUGGER__
 
   class ThreadClient
     def self.current
-      Thread.current[:DEBUGGER__ThreadClient] || begin
-        tc = ::DEBUGGER__::SESSION.thread_client
-        Thread.current[:DEBUGGER__ThreadClient] = tc
+      if thc = Thread.current[:DEBUGGER__ThreadClient]
+        thc
+      else
+        thc = SESSION.thread_client
+        Thread.current[:DEBUGGER__ThreadClient] = thc
       end
     end
 
@@ -115,7 +117,7 @@ module DEBUGGER__
         # TODO: there is waiting -> waiting
         # raise "#{mode} is given, but #{mode}" unless self.running?
       else
-        raise
+        raise "unknown mode: #{mode}"
       end
 
       @mode = mode
@@ -138,7 +140,11 @@ module DEBUGGER__
     end
 
     def inspect
-      "#<DBG:TC #{self.id}:#{@mode}@#{@thread.backtrace[-1]}>"
+      if bt = @thread.backtrace
+        "#<DBG:TC #{self.id}:#{@mode}@#{bt[-1]}>"
+      else # bt can be nil
+        "#<DBG:TC #{self.id}:#{@mode}>"
+      end
     end
 
     def to_s
@@ -194,10 +200,6 @@ module DEBUGGER__
       wait_next_action
     end
 
-    def on_thread_begin th
-      wait_reply [:thread_begin, th]
-    end
-
     def on_load iseq, eval_src
       wait_reply [:load, iseq, eval_src]
     end
@@ -340,7 +342,8 @@ module DEBUGGER__
       begin
         @success_last_eval = false
 
-        b = current_frame.eval_binding
+        b = current_frame&.eval_binding || TOPLEVEL_BINDING
+
         result = if b
                    f, _l = b.source_location
                    b.eval(src, "(rdbg)/#{f}")
@@ -659,18 +662,17 @@ module DEBUGGER__
 
     def wait_next_action_
       # assertions
-      raise "@mode is #{@mode}" unless @mode == :waiting
+      raise "@mode is #{@mode}" if !waiting?
 
       unless SESSION.active?
         pp caller
         set_mode :running
         return
       end
-      # SESSION.check_forked
 
       while true
         begin
-          set_mode :waiting if @mode != :waiting
+          set_mode :waiting if !waiting?
           cmds = @q_cmd.pop
           # pp [self, cmds: cmds]
           break unless cmds
@@ -779,6 +781,13 @@ module DEBUGGER__
             end
           when :call
             result = frame_eval(eval_src)
+          when :irb
+            begin
+              result = frame_eval('binding.irb')
+            ensure
+              # workaround: https://github.com/ruby/debug/issues/308
+              Reline.prompt_proc = nil if defined? Reline
+            end
           when :display, :try_display
             failed_results = []
             eval_src.each_with_index{|src, i|

data/lib/debug/tracer.rb

@@ -14,7 +14,7 @@ module DEBUGGER__
       end
     end
 
-    attr_reader :type
+    attr_reader :type, :key
 
     def initialize ui, pattern: nil, into: nil
       if /\ADEBUGGER__::(([A-Z][a-z]+?)[A-Z][a-z]+)/ =~ self.class.name
@@ -37,6 +37,8 @@ module DEBUGGER__
         @output = ui
       end
 
+      @key = [@type, @pattern, @into].freeze
+
       enable
     end
 
@@ -95,6 +97,8 @@ module DEBUGGER__
     end
 
     def minfo tp
+      return "block{}" if tp.event == :b_call
+
       klass = tp.defined_class
 
       if klass.singleton_class?
@@ -172,6 +176,7 @@ module DEBUGGER__
       @obj_id = obj_id
       @obj_inspect = obj_inspect
       super(ui, **kw)
+      @key = [@type, @obj_id, @pattern, @into].freeze
     end
 
     def description
@@ -201,7 +206,7 @@ module DEBUGGER__
             end
 
           out tp, " #{colorized_obj_inspect} receives #{colorize_blue(method_info)}"
-        else
+        elsif !tp.parameters.empty?
           b = tp.binding
           method_info = colorize_blue(minfo(tp))
 

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.1.0"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Koichi Sasada
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: reline
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +48,9 @@ extensions:
 - ext/debug/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/custom.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - CONTRIBUTING.md
@@ -91,7 +94,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/debug
   source_code_uri: https://github.com/ruby/debug
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Debugging functionality for Ruby
 test_files: []