debug 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9851059a728e477461cc318c9b94932fa0aeb19215f936ab6c25cf62f67cd0
-  data.tar.gz: b050eee3dbf0afecfda2c1221fe38ab678808405c10f89d5832a1950e2728aa8
+  metadata.gz: ebbeeac4c437bdefb9c0115008b705debb189b6332ee9ea056fd469c323c7149
+  data.tar.gz: 7a6abfb0490eaa49ec118efe89e50c51111be291a0b342fca930c3887a66aa72
 SHA512:
-  metadata.gz: a15549ee06b890a32d0960dd24a99c4c925d66b5f6512a7e5ff3052f10ca3a255038d44eaa2d10046cbe2b68bca121c813db3a8e5fea68def5dcd2e1797864d7
-  data.tar.gz: '058b5ef8c6e40a8ccfa12b62b09c8808c1b524c398e37a25ffd790b8a8e0364026911478019d06100b7a6d8fde878dd7695f2f2630f3f35f37f12695b84b2ddf'
+  metadata.gz: 7bfb31a8b9b5fc882c20c28992ecdc501d4a11a8088023664ef2d590385e7ba3a8f756b92b74c607b0148e7e6710c213a14659ce8f33e10b261ee4031993582d
+  data.tar.gz: ad174799dd193021f845e971e08c19cc8c31bb915ee603659c33299c4a5e21d9bdf2e7687dfb1da75e0e573442fdc116b343d8caa7e54550ae62fbeea1ed6165

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Your environment**
+
+* `ruby -v`: 
+* `rdbg -v`:
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Blank issue
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Your proposal**
+What is your idea?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/README.md

@@ -372,6 +372,7 @@ config set no_color true
 
 * BOOT
   * `RUBY_DEBUG_NONSTOP` (`nonstop`): Nonstop mode
+  * `RUBY_DEBUG_STOP_AT_LOAD` (`stop_at_load`): Stop at just loading location
   * `RUBY_DEBUG_INIT_SCRIPT` (`init_script`): debug command script path loaded at first stop
   * `RUBY_DEBUG_COMMANDS` (`commands`): debug commands invoked at first stop. commands should be separated by ';;'
   * `RUBY_DEBUG_NO_RC` (`no_rc`): ignore loading ~/.rdbgrc(.rb)
@@ -436,6 +437,9 @@ The `<...>` notation means the argument.
   * Stop the debuggee process with `Kernal#exit!`.
 * `kill!`
   * Same as kill but without the confirmation prompt.
+* `sigint`
+  * Execute SIGINT handler registerred by the debuggee.
+  * Note that this command should be used just after stop by `SIGINT`.
 
 ### Breakpoint
 
@@ -728,6 +732,7 @@ Attach mode:
 Other options:
     -h, --help                       Print help
         --util=NAME                  Utility mode (used by tools)
+        --stop-at-load               Stop immediately when the debugging feature is loaded.
 
 NOTE
   All messages communicated between a debugger and a debuggee are *NOT* encrypted.

data/Rakefile

@@ -7,14 +7,17 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-require "rake/extensiontask"
-
-task :build => :compile
-
-Rake::ExtensionTask.new("debug") do |ext|
-  ext.lib_dir = "lib/debug"
+begin
+  require "rake/extensiontask"
+  task :build => :compile
+
+  Rake::ExtensionTask.new("debug") do |ext|
+    ext.lib_dir = "lib/debug"
+  end
+rescue LoadError
 end
 
+
 task :default => [:clobber, :compile, 'README.md', :test]
 
 file 'README.md' => ['lib/debug/session.rb', 'lib/debug/config.rb',

data/debug.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   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
+  spec.add_dependency "irb", ">= 1.3.6" # for its color_printer class, which was added after 1.3
   spec.add_dependency "reline", ">= 0.2.7"
 end

data/ext/debug/debug.c

@@ -122,6 +122,11 @@ Init_debug(void)
 {
     rb_mDebugger = rb_const_get(rb_cObject, rb_intern("DEBUGGER__"));
     rb_cFrameInfo = rb_const_get(rb_mDebugger, rb_intern("FrameInfo"));
+
+    // Debugger and FrameInfo were defined in Ruby. We need to register them
+    // as mark objects so they are automatically pinned.
+    rb_gc_register_mark_object(rb_mDebugger);
+    rb_gc_register_mark_object(rb_cFrameInfo);
     rb_define_singleton_method(rb_mDebugger, "capture_frames", capture_frames, 1);
     rb_define_singleton_method(rb_mDebugger, "frame_depth", frame_depth, 0);
     rb_define_singleton_method(rb_mDebugger, "create_method_added_tracker", create_method_added_tracker, 0);

data/lib/debug/breakpoint.rb

@@ -288,6 +288,7 @@ module DEBUGGER__
       @tp = TracePoint.new(:line){|tp|
         next if tp.path.start_with? __dir__
         next if tp.path.start_with? '<internal:'
+        next if ThreadClient.current.management?
 
         if safe_eval tp.binding, @expr
           suspend
@@ -430,7 +431,10 @@ module DEBUGGER__
         if @sig_op == '#'
           @cond_class = @klass if @method.owner != @klass
         else # '.'
-          @cond_class = @klass.singleton_class if @method.owner != @klass.singleton_class
+          begin
+            @cond_class = @klass.singleton_class if @method.owner != @klass.singleton_class
+          rescue TypeError
+          end
         end
 
       rescue ArgumentError
@@ -440,7 +444,11 @@ module DEBUGGER__
         # maybe C method
         case @sig_op
         when '.'
-          override @klass.singleton_class
+          begin
+            override @klass.singleton_class
+          rescue TypeError
+            override @klass.class
+          end
         when '#'
           override @klass
         end
@@ -460,7 +468,8 @@ module DEBUGGER__
 
     def to_s
       if @method
-        "#{generate_label("Method")} #{sig} at #{@method.source_location.join(':')}"
+        loc = @method.source_location || []
+        "#{generate_label("Method")} #{sig} at #{loc.join(':')}"
       else
         "#{generate_label("Method (pending)")} #{sig}"
       end + super

data/lib/debug/client.rb

@@ -13,9 +13,37 @@ module DEBUGGER__
   class CommandLineOptionError < Exception; end
 
   class Client
-    def initialize argv
-      return util(argv) if String === argv
+    class << self
+      def util name
+        case name
+        when 'gen-sockpath'
+          puts DEBUGGER__.create_unix_domain_socket_name
+        when 'list-socks'
+          cleanup_unix_domain_sockets
+          puts list_connections
+        else
+          raise "Unknown utility: #{name}"
+        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 list_connections
+        Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+      end
+    end
+
+    def initialize argv
       @console = Console.new
 
       case argv.size
@@ -48,34 +76,6 @@ module DEBUGGER__
       @console.readline "(rdbg:remote) "
     end
 
-    def util name
-      case name
-      when 'gen-sockpath'
-        puts DEBUGGER__.create_unix_domain_socket_name
-      when 'list-socks'
-        cleanup_unix_domain_sockets
-        puts list_connections
-      else
-        raise "Unknown utility: #{name}"
-      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 list_connections
-      Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
-    end
-
     def connect_unix name = nil
       if name
         if File.exist? name
@@ -84,8 +84,9 @@ module DEBUGGER__
           @s = Socket.unix(File.join(DEBUGGER__.unix_domain_socket_dir, name))
         end
       else
-        cleanup_unix_domain_sockets
-        files = list_connections
+        Client.cleanup_unix_domain_sockets
+        files = Client.list_connections
+
         case files.size
         when 0
           $stderr.puts "No debug session is available."

data/lib/debug/color.rb

@@ -17,9 +17,25 @@ end
 module DEBUGGER__
   module Color
     if defined? IRB::Color.colorize
+      begin
+        IRB::Color.colorize('', [:DIM], colorable: true)
+        SUPPORT_COLORABLE_OPTION = true
+      rescue ArgumentError
+      end
+
+      if defined? SUPPORT_COLORABLE_OPTION
+        def irb_colorize str, color
+          IRB::Color.colorize str, color, colorable: true
+        end
+      else
+        def irb_colorize str, color
+          IRB::Color.colorize str, color
+        end
+      end
+
       def colorize str, color
         if !CONFIG[:no_color]
-          IRB::Color.colorize str, color
+          irb_colorize str, color
         else
           str
         end
@@ -63,8 +79,14 @@ module DEBUGGER__
     end
 
     if defined? IRB::Color.colorize_code
-      def colorize_code code
-        IRB::Color.colorize_code(code)
+      if SUPPORT_COLORABLE_OPTION
+        def colorize_code code
+          IRB::Color.colorize_code(code, colorable: true)
+        end
+      else
+        def colorize_code code
+          IRB::Color.colorize_code(code)
+        end
       end
     else
       def colorize_code code

data/lib/debug/config.rb

@@ -29,6 +29,7 @@ module DEBUGGER__
 
     # boot setting
     nonstop:        ['RUBY_DEBUG_NONSTOP',     "BOOT: Nonstop mode",                                                :bool],
+    stop_at_load:   ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location",                               :bool],
     init_script:    ['RUBY_DEBUG_INIT_SCRIPT', "BOOT: debug command script path loaded at first stop"],
     commands:       ['RUBY_DEBUG_COMMANDS',    "BOOT: debug commands invoked at first stop. commands should be separated by ';;'"],
     no_rc:          ['RUBY_DEBUG_NO_RC',       "BOOT: ignore loading ~/.rdbgrc(.rb)",                               :bool],
@@ -110,7 +111,9 @@ module DEBUGGER__
       end
 
       if_updated old_conf, conf, :postmortem do |_, new_p|
-        SESSION.postmortem = new_p
+        if defined?(SESSION)
+          SESSION.postmortem = new_p
+        end
       end
 
       if_updated old_conf, conf, :sigdump_sig do |old_sig, new_sig|
@@ -310,10 +313,14 @@ module DEBUGGER__
 
         o.on('--util=NAME', 'Utility mode (used by tools)') do |name|
           require_relative 'client'
-          Client.new(name)
+          Client.util(name)
           exit
         end
 
+        o.on('--stop-at-load', 'Stop immediately when the debugging feature is loaded.') do
+          config[:stop_at_load] = true
+        end
+
         o.separator ''
         o.separator 'NOTE'
         o.separator '  All messages communicated between a debugger and a debuggee are *NOT* encrypted.'
@@ -345,9 +352,26 @@ module DEBUGGER__
   ## Unix domain socket configuration
 
   def self.unix_domain_socket_dir
+    require 'tmpdir'
+
     case
     when path = CONFIG[:sock_dir]
     when path = ENV['XDG_RUNTIME_DIR']
+    when tmpdir = Dir.tmpdir
+      path = File.join(tmpdir, "ruby-debug-sock-#{Process.uid}")
+
+      if File.exist?(path)
+        fs = File.stat(path)
+        unless (dir_uid = fs.uid) == (uid = Process.uid)
+          raise "#{path} uid is #{dir_uid}, but Process.uid is #{uid}"
+        end
+        unless (dir_mode = fs.mode) == 040700 # 4: dir, 7:rwx
+          raise "#{path}'s mode is #{dir_mode.to_s(8)} (should be 040700)"
+        end
+      else
+        d = Dir.mktmpdir
+        File.rename(d, path)
+      end
     when home = ENV['HOME']
       path = File.join(home, '.ruby-debug-sock')
 

data/lib/debug/console.rb

@@ -6,11 +6,19 @@ module DEBUGGER__
       require 'reline'
 
       # reline 0.2.7 or later is required.
-      raise LoadError if Reline::VERSION < '0.2.6'
+      raise LoadError if Reline::VERSION < '0.2.7'
 
       require_relative 'color'
       include Color
 
+      begin
+        prev = trap(:SIGWINCH, nil)
+        trap(:SIGWINCH, prev)
+        SIGWINCH_SUPPORTED = true
+      rescue ArgumentError
+        SIGWINCH_SUPPORTED = false
+      end
+
       # 0.2.7 has SIGWINCH issue on non-main thread
       class ::Reline::LineEditor
         m = Module.new do
@@ -20,7 +28,7 @@ module DEBUGGER__
           end
         end
         prepend m
-      end
+      end if SIGWINCH_SUPPORTED
 
       def readline_setup prompt
         commands = DEBUGGER__.commands

data/lib/debug/frame_info.rb

@@ -9,10 +9,10 @@ module DEBUGGER__
                         )
 
   # extend FrameInfo with debug.so
-  if File.exist? File.join(__dir__, 'debug.so')
+  begin
     require_relative 'debug.so'
-  else
-    require_relative 'debug'
+  rescue LoadError
+    require 'debug/debug.so'
   end
 
   class FrameInfo
@@ -27,6 +27,7 @@ module DEBUGGER__
     end
 
     def pretty_path
+      return '#<none>' unless path = self.path
       use_short_path = CONFIG[:use_short_path]
 
       case
@@ -137,10 +138,9 @@ module DEBUGGER__
       if lvars = self._local_variables
         lvars
       elsif b = self.binding
-        lvars = b.local_variables.map{|var|
+        b.local_variables.map{|var|
           [var, b.local_variable_get(var)]
         }.to_h
-        self._local_variables = lvars
       end
     end
 

data/lib/debug/local.rb

@@ -7,32 +7,27 @@ module DEBUGGER__
   class UI_LocalConsole < UI_Base
     def initialize
       @console = Console.new
-
-      unless CONFIG[:no_sigint_hook]
-        @prev_handler = trap(:SIGINT){
-          if SESSION.active?
-            ThreadClient.current.on_trap :SIGINT
-          end
-        }
-      end
-    end
-
-    def close
-      if @prev_handler
-        trap(:SIGINT, @prev_handler)
-      end
     end
 
     def remote?
       false
     end
 
-    def activate on_fork: false
-      # Do nothing
+    def activate session, on_fork: false
+      unless CONFIG[:no_sigint_hook]
+        prev_handler = trap(:SIGINT){
+          if session.active?
+            ThreadClient.current.on_trap :SIGINT
+          end
+        }
+        session.intercept_trap_sigint_start prev_handler
+      end
     end
 
     def deactivate
-      # Do nothing
+      if SESSION.intercept_trap_sigint?
+        trap(:SIGINT, SESSION.intercepted_sigint_cmd)
+      end
     end
 
     def width
@@ -76,15 +71,17 @@ module DEBUGGER__
     end
 
     def setup_interrupt
-      current_thread = Thread.current # should be session_server thread
+      SESSION.intercept_trap_sigint false do
+        current_thread = Thread.current # should be session_server thread
 
-      prev_handler = trap(:INT){
-        current_thread.raise Interrupt
-      }
+        prev_handler = trap(:INT){
+          current_thread.raise Interrupt
+        }
 
-      yield
-    ensure
-      trap(:INT, prev_handler)
+        yield
+      ensure
+        trap(:INT, prev_handler)
+      end
     end
   end
 end

data/lib/debug/server.rb

@@ -15,8 +15,6 @@ module DEBUGGER__
       @q_ans = nil
       @unsent_messages = []
       @width = 80
-
-      activate
     end
 
     class Terminate < StandardError
@@ -37,7 +35,7 @@ module DEBUGGER__
       end
     end
 
-    def activate on_fork: false
+    def activate session, on_fork: false
       @reader_thread = Thread.new do
         # An error on this thread should break the system.
         Thread.current.abort_on_exception = true
@@ -138,9 +136,9 @@ module DEBUGGER__
     end
 
     def setup_interrupt
-      prev_handler = trap(:SIGINT) do
+      prev_handler = trap(:SIGURG) do
         # $stderr.puts "trapped SIGINT"
-        ThreadClient.current.on_trap :SIGINT
+        ThreadClient.current.on_trap :SIGURG
 
         case prev_handler
         when Proc
@@ -150,9 +148,12 @@ module DEBUGGER__
         end
       end
 
+      if prev_handler != "SYSTEM_DEFAULT"
+        DEBUGGER__.warn "SIGURG handler is overriddend by the debugger."
+      end
       yield
     ensure
-      trap(:SIGINT, prev_handler)
+      trap(:SIGURG, prev_handler)
     end
 
     attr_reader :reader_thread
@@ -230,7 +231,7 @@ module DEBUGGER__
 
     def pause
       # $stderr.puts "DEBUG: pause request"
-      Process.kill(:SIGINT, Process.pid)
+      Process.kill(:SIGURG, Process.pid)
     end
 
     def quit n

data/lib/debug/server_dap.rb

@@ -182,7 +182,7 @@ module DEBUGGER__
           @q_msg << 'continue'
         when 'attach'
           send_response req
-          Process.kill(:SIGINT, Process.pid)
+          Process.kill(:SIGURG, Process.pid)
         when 'disconnect'
           send_response req
           @q_msg << 'continue'
@@ -205,7 +205,7 @@ module DEBUGGER__
           exit
         when 'pause'
           send_response req
-          Process.kill(:SIGINT, Process.pid)
+          Process.kill(:SIGURG, Process.pid)
         when 'reverseContinue'
           send_response req,
                         success: false, message: 'cancelled',
@@ -256,7 +256,7 @@ module DEBUGGER__
     def event type, *args
       case type
       when :suspend_bp
-        _i, bp = *args
+        _i, bp, tid = *args
         if bp.kind_of?(CatchBreakpoint)
           reason = 'exception'
           text = bp.description
@@ -268,24 +268,26 @@ module DEBUGGER__
         send_event 'stopped', reason: reason,
                               description: text,
                               text: text,
-                              threadId: 1,
+                              threadId: tid,
                               allThreadsStopped: true
       when :suspend_trap
+        _sig, tid = *args
         send_event 'stopped', reason: 'pause',
-                              threadId: 1,
+                              threadId: tid,
                               allThreadsStopped: true
       when :suspended
+        tid, = *args
         send_event 'stopped', reason: 'step',
-                              threadId: 1,
+                              threadId: tid,
                               allThreadsStopped: true
       end
     end
   end
 
   class Session
-    def find_tc id
+    def find_waiting_tc id
       @th_clients.each{|th, tc|
-        return tc if tc.id == id
+        return tc if tc.id == id && tc.waiting?
       }
       return nil
     end
@@ -306,7 +308,7 @@ module DEBUGGER__
 
       when 'stackTrace'
         tid = req.dig('arguments', 'threadId')
-        if tc = find_tc(tid)
+        if tc = find_waiting_tc(tid)
           tc << [:dap, :backtrace, req]
         else
           fail_response req
@@ -315,7 +317,7 @@ module DEBUGGER__
         frame_id = req.dig('arguments', 'frameId')
         if @frame_map[frame_id]
           tid, fid = @frame_map[frame_id]
-          if tc = find_tc(tid)
+          if tc = find_waiting_tc(tid)
             tc << [:dap, :scopes, req, fid]
           else
             fail_response req
@@ -348,7 +350,7 @@ module DEBUGGER__
             frame_id = ref[1]
             tid, fid = @frame_map[frame_id]
 
-            if tc = find_tc(tid)
+            if tc = find_waiting_tc(tid)
               tc << [:dap, :scope, req, fid]
             else
               fail_response req
@@ -357,7 +359,7 @@ module DEBUGGER__
           when :variable
             tid, vid = ref[1], ref[2]
 
-            if tc = find_tc(tid)
+            if tc = find_waiting_tc(tid)
               tc << [:dap, :variable, req, vid]
             else
               fail_response req
@@ -373,7 +375,7 @@ module DEBUGGER__
         if @frame_map[frame_id]
           tid, fid = @frame_map[frame_id]
           expr = req.dig('arguments', 'expression')
-          if tc = find_tc(tid)
+          if tc = find_waiting_tc(tid)
             tc << [:dap, :evaluate, req, fid, expr]
           else
             fail_response req