debug 1.3.4 → 1.6.0

data/lib/debug/thread_client.rb

@@ -6,11 +6,32 @@ require 'pp'
 require_relative 'color'
 
 module DEBUGGER__
+  M_INSTANCE_VARIABLES = method(:instance_variables).unbind
+  M_INSTANCE_VARIABLE_GET = method(:instance_variable_get).unbind
+  M_CLASS = method(:class).unbind
+  M_SINGLETON_CLASS = method(:singleton_class).unbind
+  M_KIND_OF_P = method(:kind_of?).unbind
+  M_RESPOND_TO_P = method(:respond_to?).unbind
+  M_METHOD = method(:method).unbind
+  M_OBJECT_ID = method(:object_id).unbind
+
   module SkipPathHelper
     def skip_path?(path)
+      !path ||
+      CONFIG.skip? ||
+      ThreadClient.current.management? ||
+      skip_internal_path?(path) ||
+      skip_config_skip_path?(path)
+    end
+
+    def skip_config_skip_path?(path)
       (skip_paths = CONFIG[:skip_path]) && skip_paths.any?{|skip_path| path.match?(skip_path)}
     end
 
+    def skip_internal_path?(path)
+      path.start_with?(__dir__) || path.start_with?('<internal:')
+    end
+
     def skip_location?(loc)
       loc_path = loc.absolute_path || "!eval:#{loc.path}"
       skip_path?(loc_path)
@@ -22,7 +43,7 @@ module DEBUGGER__
       if thc = Thread.current[:DEBUGGER__ThreadClient]
         thc
       else
-        thc = SESSION.thread_client
+        thc = SESSION.get_thread_client
         Thread.current[:DEBUGGER__ThreadClient] = thc
       end
     end
@@ -30,7 +51,11 @@ module DEBUGGER__
     include Color
     include SkipPathHelper
 
-    attr_reader :location, :thread, :id, :recorder
+    attr_reader :thread, :id, :recorder, :check_bp_fulfillment_map
+
+    def location
+      current_frame&.location
+    end
 
     def assemble_arguments(args)
       args.map do |arg|
@@ -42,7 +67,8 @@ module DEBUGGER__
       call_identifier_str =
         case frame.frame_type
         when :block
-          level, block_loc, args = frame.block_identifier
+          level, block_loc = frame.block_identifier
+          args = frame.parameters_info
 
           if !args.empty?
             args_str = " {|#{assemble_arguments(args)}|}"
@@ -50,7 +76,8 @@ module DEBUGGER__
 
           "#{colorize_blue("block")}#{args_str} in #{colorize_blue(block_loc + level)}"
         when :method
-          ci, args = frame.method_identifier
+          ci = frame.method_identifier
+          args = frame.parameters_info
 
           if !args.empty?
             args_str = "(#{assemble_arguments(args)})"
@@ -67,7 +94,7 @@ module DEBUGGER__
       result = "#{call_identifier_str} at #{location_str}"
 
       if return_str = frame.return_str
-        result += " #=> #{colorize_magenta(frame.return_str)}"
+        result += " #=> #{colorize_magenta(return_str)}"
       end
 
       result
@@ -84,8 +111,12 @@ module DEBUGGER__
       @output = []
       @frame_formatter = method(:default_frame_formatter)
       @var_map = {} # { thread_local_var_id => obj } for DAP
+      @obj_map = {} # { object_id => obj } for CDP
       @recorder = nil
       @mode = :waiting
+      @current_frame_index = 0
+      # every thread should maintain its own CheckBreakpoint fulfillment state
+      @check_bp_fulfillment_map = {} # { check_bp => boolean }
       set_mode :running
       thr.instance_variable_set(:@__thread_client_id, id)
 
@@ -100,13 +131,14 @@ module DEBUGGER__
       @is_management
     end
 
-    def is_management
+    def mark_as_management
       @is_management = true
     end
 
     def set_mode mode
+      debug_mode(@mode, mode)
       # STDERR.puts "#{@mode} => #{mode} @ #{caller.inspect}"
-      #pp caller
+      # pp caller
 
       # mode transition check
       case mode
@@ -148,14 +180,7 @@ module DEBUGGER__
     end
 
     def to_s
-      loc = current_frame&.location
-
-      if loc
-        str = "(#{@thread.name || @thread.status})@#{loc}"
-      else
-        str = "(#{@thread.name || @thread.status})@#{@thread.to_s}"
-      end
-
+      str = "(#{@thread.name || @thread.status})@#{current_frame&.location || @thread.to_s}"
       str += " (not under control)" unless self.waiting?
       str
     end
@@ -175,6 +200,7 @@ module DEBUGGER__
     end
 
     def << req
+      debug_cmd(req)
       @q_cmd << req
     end
 
@@ -185,6 +211,7 @@ module DEBUGGER__
     end
 
     def event! ev, *args
+      debug_event(ev, args)
       @q_evt << [self, @output, ev, generate_info, *args]
       @output = []
     end
@@ -228,8 +255,9 @@ module DEBUGGER__
       suspend :pause
     end
 
-    def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil
+    def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil, postmortem_exc: nil
       return if management?
+      debug_suspend(event)
 
       @current_frame_index = 0
 
@@ -245,7 +273,6 @@ module DEBUGGER__
 
       cf = @target_frames.first
       if cf
-        @location = cf.location
         case event
         when :return, :b_return, :c_return
           cf.has_return_value = true
@@ -256,11 +283,16 @@ module DEBUGGER__
           cf.has_raised_exception = true
           cf.raised_exception = bp.last_exc
         end
+
+        if postmortem_exc
+          cf.has_raised_exception = true
+          cf.raised_exception = postmortem_exc
+        end
       end
 
       if event != :pause
-        show_src max_lines: (CONFIG[:show_src_lines] || 10)
-        show_frames CONFIG[:show_frames] || 2
+        show_src
+        show_frames CONFIG[:show_frames]
 
         set_mode :waiting
 
@@ -292,15 +324,15 @@ module DEBUGGER__
       SUPPORT_TARGET_THREAD = false
     end
 
-    def step_tp iter
+    def step_tp iter, events = [:line, :b_return, :return]
       @step_tp.disable if @step_tp
 
       thread = Thread.current
 
       if SUPPORT_TARGET_THREAD
-        @step_tp = TracePoint.new(:line, :b_return, :return){|tp|
+        @step_tp = TracePoint.new(*events){|tp|
           next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield
+          next if !yield(tp.event)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -313,10 +345,10 @@ module DEBUGGER__
         }
         @step_tp.enable(target_thread: thread)
       else
-        @step_tp = TracePoint.new(:line, :b_return, :return){|tp|
+        @step_tp = TracePoint.new(*events){|tp|
           next if thread != Thread.current
           next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield
+          next if !yield(tp.event)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -333,123 +365,191 @@ module DEBUGGER__
 
     ## cmd helpers
 
-    # this method is extracted to hide frame_eval's local variables from C method eval's binding
-    def instance_eval_for_cmethod frame_self, src
-      frame_self.instance_eval(src)
+    if TracePoint.respond_to? :allow_reentry
+      def tp_allow_reentry
+        TracePoint.allow_reentry do
+          yield
+        end
+      rescue RuntimeError => e
+        # on the postmortem mode, it is not stopped in TracePoint
+        if e.message == 'No need to allow reentrance.'
+          yield
+        else
+          raise
+        end
+      end
+    else
+      def tp_allow_reentry
+        yield
+      end
     end
 
+    def frame_eval_core src, b
+      saved_target_frames = @target_frames
+      saved_current_frame_index = @current_frame_index
+
+      if b
+        f, _l = b.source_location
+
+        tp_allow_reentry do
+          b.eval(src, "(rdbg)/#{f}")
+        end
+      else
+        frame_self = current_frame.self
+
+        tp_allow_reentry do
+          frame_self.instance_eval(src)
+        end
+      end
+    ensure
+      @target_frames = saved_target_frames
+      @current_frame_index = saved_current_frame_index
+    end
+
+    SPECIAL_LOCAL_VARS = [
+      [:raised_exception, "_raised"],
+      [:return_value,     "_return"],
+    ]
+
     def frame_eval src, re_raise: false
-      begin
-        @success_last_eval = false
+      @success_last_eval = false
+
+      b = current_frame.eval_binding
 
-        b = current_frame&.eval_binding || TOPLEVEL_BINDING
+      special_local_variables current_frame do |name, var|
+        b.local_variable_set(name, var) if /\%/ !~ name
+      end
 
-        result = if b
-                   f, _l = b.source_location
-                   b.eval(src, "(rdbg)/#{f}")
-                 else
-                   frame_self = current_frame.self
-                   instance_eval_for_cmethod(frame_self, src)
-                 end
-        @success_last_eval = true
-        result
+      result = frame_eval_core(src, b)
 
-      rescue Exception => e
-        return yield(e) if block_given?
+      @success_last_eval = true
+      result
 
-        puts "eval error: #{e}"
+    rescue SystemExit
+      raise
+    rescue Exception => e
+      return yield(e) if block_given?
 
-        e.backtrace_locations&.each do |loc|
-          break if loc.path == __FILE__
-          puts "  #{loc}"
-        end
-        raise if re_raise
+      puts "eval error: #{e}"
+
+      e.backtrace_locations&.each do |loc|
+        break if loc.path == __FILE__
+        puts "  #{loc}"
       end
+      raise if re_raise
     end
 
-    def show_src(frame_index: @current_frame_index,
-                 update_line: false,
-                 max_lines: 10,
-                 start_line: nil,
-                 end_line: nil,
-                 dir: +1)
-      if @target_frames && frame = @target_frames[frame_index]
-        if file_lines = frame.file_lines
-          frame_line = frame.location.lineno - 1
-
-          lines = file_lines.map.with_index do |e, i|
-            cur = i == frame_line ? '=>' : '  '
-            line = colorize_dim('%4d|' % (i+1))
-            "#{cur}#{line} #{e}"
-          end
+    def get_src(frame,
+                max_lines:,
+                start_line: nil,
+                end_line: nil,
+                dir: +1)
+      if file_lines = frame.file_lines
+        frame_line = frame.location.lineno - 1
+
+        lines = file_lines.map.with_index do |e, i|
+          cur = i == frame_line ? '=>' : '  '
+          line = colorize_dim('%4d|' % (i+1))
+          "#{cur}#{line} #{e}"
+        end
 
-          unless start_line
-            if frame.show_line
-              if dir > 0
-                start_line = frame.show_line
-              else
-                end_line = frame.show_line - max_lines
-                start_line = [end_line - max_lines, 0].max
-              end
+        unless start_line
+          if frame.show_line
+            if dir > 0
+              start_line = frame.show_line
             else
-              start_line = [frame_line - max_lines/2, 0].max
+              end_line = frame.show_line - max_lines
+              start_line = [end_line - max_lines, 0].max
             end
+          else
+            start_line = [frame_line - max_lines/2, 0].max
           end
+        end
 
-          unless end_line
-            end_line = [start_line + max_lines, lines.size].min
-          end
+        unless end_line
+          end_line = [start_line + max_lines, lines.size].min
+        end
+
+        if start_line != end_line && max_lines
+          [start_line, end_line, lines]
+        end
+      else # no file lines
+        nil
+      end
+    rescue Exception => e
+      p e
+      pp e.backtrace
+      exit!
+    end
 
+    def show_src(frame_index: @current_frame_index, update_line: false, max_lines: CONFIG[:show_src_lines], **options)
+      if frame = get_frame(frame_index)
+        start_line, end_line, lines = *get_src(frame, max_lines: max_lines, **options)
+
+        if start_line
           if update_line
             frame.show_line = end_line
           end
 
-          if start_line != end_line && max_lines
-            puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
-            puts lines[start_line ... end_line]
-          end
-        else # no file lines
+          puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
+          puts lines[start_line...end_line]
+        else
           puts "# No sourcefile available for #{frame.path}"
         end
       end
-    rescue Exception => e
-      p e
-      pp e.backtrace
-      exit!
     end
 
     def current_frame
+      get_frame(@current_frame_index)
+    end
+
+    def get_frame(index)
       if @target_frames
-        @target_frames[@current_frame_index]
+        @target_frames[index]
       else
         nil
       end
     end
 
-    ## cmd: show
+    def collect_locals(frame)
+      locals = []
 
-    def show_locals pat
-      if s = current_frame&.self
-        puts_variable_info '%self', s, pat
-      end
-      if current_frame&.has_return_value
-        puts_variable_info '%return', current_frame.return_value, pat
+      if s = frame&.self
+        locals << ["%self", s]
       end
-      if current_frame&.has_raised_exception
-        puts_variable_info "%raised", current_frame.raised_exception, pat
+      special_local_variables frame do |name, val|
+        locals << [name, val]
       end
 
-      if vars = current_frame&.local_variables
+      if vars = frame&.local_variables
         vars.each{|var, val|
-          puts_variable_info var, val, pat
+          locals << [var, val]
         }
       end
+
+      locals
+    end
+
+    ## cmd: show
+
+    def special_local_variables frame
+      SPECIAL_LOCAL_VARS.each do |mid, name|
+        next unless frame&.send("has_#{mid}")
+        name = name.sub('_', '%') if frame.eval_binding.local_variable_defined?(name)
+        yield name, frame.send(mid)
+      end
+    end
+
+    def show_locals pat
+      collect_locals(current_frame).each do |var, val|
+        puts_variable_info(var, val, pat)
+      end
     end
 
     def show_ivars pat
       if s = current_frame&.self
-        s.instance_variables.sort.each{|iv|
-          value = s.instance_variable_get(iv)
+        M_INSTANCE_VARIABLES.bind_call(s).sort.each{|iv|
+          value = M_INSTANCE_VARIABLE_GET.bind_call(s, iv)
           puts_variable_info iv, value, pat
         }
       end
@@ -458,10 +558,10 @@ module DEBUGGER__
     def show_consts pat, only_self: false
       if s = current_frame&.self
         cs = {}
-        if s.kind_of? Module
+        if M_KIND_OF_P.bind_call(s, Module)
           cs[s] = :self
         else
-          s = s.class
+          s = M_CLASS.bind_call(s)
           cs[s] = :self unless only_self
         end
 
@@ -499,7 +599,7 @@ module DEBUGGER__
       return if pat && pat !~ label
 
       begin
-        inspected = obj.inspect
+        inspected = DEBUGGER__.safe_inspect(obj)
       rescue Exception => e
         inspected = e.inspect
       end
@@ -508,28 +608,32 @@ module DEBUGGER__
       w = SESSION::width
 
       if mono_info.length >= w
-        info = truncate(mono_info, width: w)
+        maximum_value_width = w - "#{label} = ".length
+        valstr = truncate(inspected, width: maximum_value_width)
       else
         valstr = colored_inspect(obj, width: 2 ** 30)
         valstr = inspected if valstr.lines.size > 1
-        info = "#{colorize_cyan(label)} = #{valstr}"
       end
 
+      info = "#{colorize_cyan(label)} = #{valstr}"
+
       puts info
     end
 
     def truncate(string, width:)
-      str = string[0 .. (width-4)] + '...'
-      str += ">" if str.start_with?("#<")
-      str
+      if string.start_with?("#<")
+        string[0 .. (width-5)] + '...>'
+      else
+        string[0 .. (width-4)] + '...'
+      end
     end
 
     ### cmd: show edit
 
     def show_by_editor path = nil
       unless path
-        if @target_frames && frame = @target_frames[@current_frame_index]
-          path = frame.path
+        if current_frame
+          path = current_frame.path
         else
           return # can't get path
         end
@@ -554,15 +658,11 @@ module DEBUGGER__
       if @target_frames && (max ||= @target_frames.size) > 0
         frames = []
         @target_frames.each_with_index{|f, i|
-          next if pattern && !(f.name.match?(pattern) || f.location_str.match?(pattern))
-          next if CONFIG[:skip_path] && CONFIG[:skip_path].any?{|pat|
-            case pat
-            when String
-              f.location_str.start_with?(pat)
-            when Regexp
-              f.location_str.match?(pat)
-            end
-          }
+          # we need to use FrameInfo#matchable_location because #location_str is for display
+          # and it may change based on configs (e.g. use_short_path)
+          next if pattern && !(f.name.match?(pattern) || f.matchable_location.match?(pattern))
+          # avoid using skip_path? because we still want to display internal frames
+          next if skip_config_skip_path?(f.matchable_location)
 
           frames << [i, f]
         }
@@ -599,18 +699,25 @@ module DEBUGGER__
         o = Output.new(@output)
 
         locals = current_frame&.local_variables
-        klass  = (obj.class == Class || obj.class == Module ? obj : obj.class)
 
-        o.dump("constants", obj.constants) if obj.respond_to?(:constants)
+        klass = M_CLASS.bind_call(obj)
+        klass = obj if Class == klass || Module == klass
+
+        o.dump("constants", obj.constants) if M_RESPOND_TO_P.bind_call(obj, :constants)
         outline_method(o, klass, obj)
-        o.dump("instance variables", obj.instance_variables)
+        o.dump("instance variables", M_INSTANCE_VARIABLES.bind_call(obj))
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals.keys) if locals
       end
     end
 
     def outline_method(o, klass, obj)
-      singleton_class = begin obj.singleton_class; rescue TypeError; nil end
+      begin
+        singleton_class = M_SINGLETON_CLASS.bind_call(obj)
+      rescue TypeError
+        singleton_class = nil
+      end
+
       maps = class_method_map((singleton_class || klass).ancestors)
       maps.each do |mod, methods|
         name = mod == singleton_class ? "#{klass}.methods" : "#{mod}#methods"
@@ -630,22 +737,54 @@ module DEBUGGER__
 
     ## cmd: breakpoint
 
+    # TODO: support non-ASCII Constant name
+    def constant_name? name
+      case name
+      when /\A::\b/
+        constant_name? $~.post_match
+      when /\A[A-Z]\w*/
+        post = $~.post_match
+        if post.empty?
+          true
+        else
+          constant_name? post
+        end
+      else
+        false
+      end
+    end
+
     def make_breakpoint args
       case args.first
       when :method
-        klass_name, op, method_name, cond, cmd = args[1..]
-        bp = MethodBreakpoint.new(current_frame.binding, klass_name, op, method_name, cond: cond, command: cmd)
+        klass_name, op, method_name, cond, cmd, path = args[1..]
+        bp = MethodBreakpoint.new(current_frame.eval_binding, klass_name, op, method_name, cond: cond, command: cmd, path: path)
         begin
           bp.enable
+        rescue NameError => e
+          if bp.klass
+            puts "Unknown method name: \"#{e.name}\""
+          else
+            # klass_name can not be evaluated
+            if constant_name? klass_name
+              puts "Unknown constant name: \"#{e.name}\""
+            else
+              # only Class name is allowed
+              puts "Not a constant name: \"#{klass_name}\""
+              bp = nil
+            end
+          end
+
+          Session.activate_method_added_trackers if bp
         rescue Exception => e
-          puts e.message
-          ::DEBUGGER__::METHOD_ADDED_TRACKER.enable
+          puts e.inspect
+          bp = nil
         end
 
         bp
       when :watch
-        ivar, object, result = args[1..]
-        WatchIVarBreakpoint.new(ivar, object, result)
+        ivar, object, result, cond, command, path = args[1..]
+        WatchIVarBreakpoint.new(ivar, object, result, cond: cond, command: command, path: path)
       else
         raise "unknown breakpoint: #{args}"
       end
@@ -732,10 +871,11 @@ module DEBUGGER__
             break
 
           when :finish
-            depth = @target_frames.first.frame_depth
-            step_tp iter do
-              # 3 is debugger's frame count
-              DEBUGGER__.frame_depth - 3 < depth
+            finish_frames = (iter || 1) - 1
+            goal_depth = @target_frames.first.frame_depth - finish_frames
+
+            step_tp nil, [:return, :b_return] do
+              DEBUGGER__.frame_depth - 3 <= goal_depth ? true : false
             end
             break
 
@@ -834,6 +974,7 @@ module DEBUGGER__
           else
             raise "unsupported frame operation: #{arg.inspect}"
           end
+
           event! :result, nil
 
         when :show
@@ -887,7 +1028,7 @@ module DEBUGGER__
             bp = make_breakpoint args
             event! :result, :method_breakpoint, bp
           when :watch
-            ivar = args[1]
+            ivar, cond, command, path = args[1..]
             result = frame_eval(ivar)
 
             if @success_last_eval
@@ -897,7 +1038,7 @@ module DEBUGGER__
                 else
                   current_frame.self
                 end
-              bp = make_breakpoint [:watch, ivar, object, result]
+              bp = make_breakpoint [:watch, ivar, object, result, cond, command, path]
               event! :result, :watch_breakpoint, bp
             else
               event! :result, nil
@@ -910,7 +1051,7 @@ module DEBUGGER__
             begin
               obj = frame_eval args.shift, re_raise: true
               opt = args.shift
-              obj_inspect = obj.inspect
+              obj_inspect = DEBUGGER__.safe_inspect(obj)
 
               width = 50
 
@@ -918,7 +1059,7 @@ module DEBUGGER__
                 obj_inspect = truncate(obj_inspect, width: width)
               end
 
-              event! :result, :trace_pass, obj.object_id, obj_inspect, opt
+              event! :result, :trace_pass, M_OBJECT_ID.bind_call(obj), obj_inspect, opt
             rescue => e
               puts e.message
               event! :result, nil
@@ -935,8 +1076,8 @@ module DEBUGGER__
             # enable recording
             if !@recorder
               @recorder = Recorder.new
-              @recorder.enable
             end
+            @recorder.enable
           when :off
             if @recorder&.enabled?
               @recorder.disable
@@ -968,6 +1109,33 @@ module DEBUGGER__
       raise
     end
 
+    def debug_event(ev, args)
+      DEBUGGER__.debug{
+        args = args.map { |arg| DEBUGGER__.safe_inspect(arg) }
+        "#{inspect} sends Event { type: #{ev.inspect}, args: #{args} } to Session"
+      }
+    end
+
+    def debug_mode(old_mode, new_mode)
+      DEBUGGER__.debug{
+        "#{inspect} changes mode (#{old_mode} -> #{new_mode})"
+      }
+    end
+
+    def debug_cmd(cmds)
+      DEBUGGER__.debug{
+        cmd, *args = *cmds
+        args = args.map { |arg| DEBUGGER__.safe_inspect(arg) }
+        "#{inspect} receives Cmd { type: #{cmd.inspect}, args: #{args} } from Session"
+      }
+    end
+
+    def debug_suspend(event)
+      DEBUGGER__.debug{
+        "#{inspect} is suspended for #{event.inspect}"
+      }
+    end
+
     class Recorder
       attr_reader :log, :index
       attr_accessor :backup_frames
@@ -982,8 +1150,8 @@ module DEBUGGER__
 
         @tp_recorder ||= TracePoint.new(:line){|tp|
           next unless Thread.current == thread
-          next if tp.path.start_with? __dir__
-          next if tp.path.start_with? '<internal:'
+          # can't be replaced by skip_location
+          next if skip_internal_path?(tp.path)
           loc = caller_locations(1, 1).first
           next if skip_location?(loc)
 
@@ -1067,7 +1235,7 @@ module DEBUGGER__
       end
     end
 
-    # copyed from irb
+    # copied from irb
     class Output
       include Color