debug 1.0.0.rc2 → 1.2.1

data/lib/debug/session.rb

@@ -1,7 +1,21 @@
 # frozen_string_literal: true
 
 # skip to load debugger for bundle exec
-return if $0.end_with?('bin/bundle') && ARGV.first == 'exec'
+
+if $0.end_with?('bin/bundle') && ARGV.first == 'exec'
+  trace_var(:$0) do |file|
+    trace_var(:$0, nil)
+    if /-r (#{__dir__}\S+)/ =~ ENV['RUBYOPT']
+      lib = $1
+      $LOADED_FEATURES.delete_if{|path| path.start_with?(__dir__)}
+      ENV['RUBY_DEBUG_INITIAL_SUSPEND_PATH'] = file
+      require lib
+      ENV['RUBY_DEBUG_INITIAL_SUSPEND_PATH'] = nil
+    end
+  end
+
+  return
+end
 
 require_relative 'config'
 require_relative 'thread_client'
@@ -9,6 +23,10 @@ require_relative 'source_repository'
 require_relative 'breakpoint'
 require_relative 'tracer'
 
+# To prevent loading old lib/debug.rb in Ruby 2.6 to 3.0
+$LOADED_FEATURES << 'debug.rb'
+require 'debug' # invalidate the $LOADED_FEATURE cache
+
 require 'json' if ENV['RUBY_DEBUG_TEST_MODE']
 
 class RubyVM::InstructionSequence
@@ -68,7 +86,7 @@ module DEBUGGER__
                 #   [:watch, ivar] => WatchIVarBreakpoint
                 #   [:check, expr] => CheckBreakpoint
       #
-      @tracers = []
+      @tracers = {}
       @th_clients = nil # {Thread => ThreadClient}
       @q_evt = Queue.new
       @displays = []
@@ -78,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?
@@ -99,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
@@ -142,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
 
@@ -159,11 +183,18 @@ module DEBUGGER__
 
     def session_server_main
       while evt = pop_event
-        # varible `@internal_info` is only used for test
+        # variable `@internal_info` is only used for test
         tc, output, ev, @internal_info, *ev_args = evt
         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
 
@@ -175,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?
@@ -228,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
@@ -303,7 +332,9 @@ module DEBUGGER__
         if @preset_command.commands.empty?
           if @preset_command.auto_continue
             @preset_command = nil
+
             @tc << :continue
+            restart_all_threads
             return
           else
             @preset_command = nil
@@ -412,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]`
@@ -596,7 +650,7 @@ module DEBUGGER__
       #   * Show information about the current frame (local variables)
       #   * It includes `self` as `%self` and a return value as `%return`.
       # * `i[nfo] i[var[s]]` or `i[nfo] instance`
-      #   * Show information about insttance variables about `self`.
+      #   * Show information about instance variables about `self`.
       # * `i[nfo] c[onst[s]]` or `i[nfo] constant[s]`
       #   * Show information about accessible constants except toplevel constants.
       # * `i[nfo] g[lobal[s]]`
@@ -702,10 +756,16 @@ module DEBUGGER__
       when 'pp'
         @tc << [:eval, :pp, arg.to_s]
 
-      # * `e[val] <expr>`
+      # * `eval <expr>`
       #   * Evaluate `<expr>` on the current frame.
-      when 'e', 'eval', 'call'
-        @tc << [:eval, :call, arg]
+      when 'eval', 'call'
+        if arg == nil || arg.empty?
+          show_help 'eval'
+          @ui.puts "\nTo evaluate the variable `#{cmd}`, use `pp #{cmd}` instead."
+          return :retry
+        else
+          @tc << [:eval, :call, arg]
+        end
 
       # * `irb`
       #   * Invoke `irb` on the current frame.
@@ -714,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
@@ -752,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
@@ -786,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}"
@@ -1145,6 +1202,11 @@ module DEBUGGER__
       add_bp bp
     end
 
+    def add_catch_breakpoint pat
+      bp = CatchBreakpoint.new(pat)
+      add_bp bp
+    end
+
     def add_check_breakpoint expr
       bp = CheckBreakpoint.new(expr)
       add_bp bp
@@ -1159,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
@@ -1211,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 = {}
 
@@ -1225,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
 
@@ -1355,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
@@ -1368,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
@@ -1380,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
@@ -1400,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
@@ -1494,7 +1613,13 @@ module DEBUGGER__
 
   def self.setup_initial_suspend
     if !CONFIG[:nonstop]
-      if loc = ::DEBUGGER__.require_location
+      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
         # require 'debug/start' or 'debug'
         add_line_breakpoint loc.absolute_path, loc.lineno + 1, oneshot: true, hook_call: false
       else
@@ -1506,29 +1631,8 @@ module DEBUGGER__
 
   class << self
     define_method :initialize_session do |ui|
-      DEBUGGER__.warn "Session start (pid: #{Process.pid})"
-
+      DEBUGGER__.info "Session start (pid: #{Process.pid})"
       ::DEBUGGER__.const_set(:SESSION, Session.new(ui))
-
-      # default breakpoints
-
-      # ::DEBUGGER__.add_catch_breakpoint 'RuntimeError'
-
-      Binding.module_eval do
-        def break pre: nil, do: nil
-          return unless SESSION.active?
-
-          if pre || (do_expr = binding.local_variable_get(:do))
-            cmds = ['binding.break', pre, do_expr]
-          end
-
-          ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true, command: cmds
-          true
-        end
-        alias b break
-        # alias bp break
-      end
-
       load_rc
     end
   end
@@ -1586,14 +1690,6 @@ module DEBUGGER__
     end
   end
 
-  LOG_LEVELS = {
-    UNKNOWN: 0,
-    FATAL:   1,
-    ERROR:   2,
-    WARN:    3,
-    INFO:    4,
-  }.freeze
-
   def self.warn msg
     log :WARN, msg
   end
@@ -1638,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 = -> {
@@ -1670,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
@@ -1679,5 +1814,29 @@ module DEBUGGER__
       prepend ForkInterceptor
     end
   end
+
+  module ::Signal
+    class << self
+      prepend TrapInterceptor
+    end
+  end
+end
+
+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))
+      cmds = ['binding.break', pre, do_expr]
+    end
+
+    ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true, command: cmds
+    self
+  end
+end
+
+class Binding
+  alias break debugger
+  alias b debugger
 end