rbx-trepanning 0.0.5-universal-rubinius-1.2.1

data/processor/frame.rb

@@ -0,0 +1,211 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../app/frame'
+require_relative '../app/util'
+class Trepan
+  class CmdProcessor
+
+    include Util
+    attr_reader   :current_thread
+
+    # ThreadFrame, current frame
+    attr_accessor :frame
+
+    # frame index in a "backtrace" command
+    attr_accessor :frame_index
+    attr_reader   :hide_level
+
+    # Hash[thread_id] -> FixNum, the level of the last frame to
+    # show. If we called the debugger directly, then there is
+    # generally a portion of a backtrace we don't want to show. We
+    # don't need to store this for all threads, just those we want to
+    # hide frame on. A value of 1 means to hide just the oldest
+    # level. The default or showing all levels is 0.
+    attr_accessor :hidelevels
+
+    # Hash[container] -> file container. This gives us a way to map non-file
+    # container objects to a file container for display.
+    attr_accessor :remap_container
+    
+    attr_accessor :stack_size
+
+    # top frame of current thread.
+    attr_accessor :top_frame       
+    # attr_reader   :threads2frames  # Hash[thread_id] -> top_frame
+    
+
+    def adjust_frame(frame_num, absolute_pos)
+      frame, frame_num = get_frame(frame_num, absolute_pos)
+      if frame 
+        @frame = @dbgr.frame(frame_num)
+        @frame_index = frame_num
+        print_location unless @settings[:traceprint]
+        @line_no = @frame.line
+        @frame
+      else
+        nil
+      end
+    end
+
+    # def frame_container(frame, canonicalize=true)
+    #   container = 
+    #     if @remap_container.member?(frame.source_container)
+    #       @remap_container[frame.source_container]
+    #     elsif frame.iseq && @remap_iseq.member?(frame.iseq.sha1)
+    #       @remap_iseq[frame.iseq.sha1]
+    #     else
+    #       frame.source_container
+    #     end
+
+    #   container[1] = canonic_file(container[1]) if canonicalize
+    #   container
+    # end
+
+    # Initializes the thread and frame variables: @frame, @top_frame, 
+    # @frame_index, @current_thread, and @threads2frames
+    def frame_setup
+      @frame_index        = 0
+      @frame = @top_frame = @dbgr.current_frame
+      @current_thread     = @dbgr.debugee_thread
+      @line_no            = @frame.line
+
+      @threads2frames   ||= {} 
+      @threads2frames[@current_thread] = @top_frame
+      set_hide_level
+    end
+
+    # Remove access to thread and frame variables
+    def frame_teardown
+      @top_frame = @frame = @frame_index = @current_thread = nil 
+      @threads2frames = {}
+    end
+
+    def frame_initialize
+      @remap_container = {}
+      @remap_iseq      = {}
+      @hidelevels      = Hash.new(nil) 
+      @hide_level      = 0
+    end
+
+    def get_frame(frame_num, absolute_pos)
+      if absolute_pos
+        frame_num += @stack_size if frame_num < 0
+      else
+        frame_num += @frame_index
+      end
+
+      if frame_num < 0
+        errmsg('Adjusting would put us beyond the newest frame.')
+        return [nil, nil]
+      elsif frame_num >= @stack_size
+        errmsg('Adjusting would put us beyond the oldest frame.')
+        return [nil, nil]
+      end
+
+      [frame, frame_num]
+    end
+
+    def parent_frame
+      frame = @dbgr.frame(@frame.number + 1)
+      unless frame
+        errmsg "Unable to find parent frame at level #{@frame.number+1}"
+        return nil
+      end
+      frame
+    end
+
+    def set_hide_level
+      @hide_level = 
+        if !@settings[:hidelevel] || @settings[:hidelevel] < 0
+          @settings[:hidelevel] = @hidelevels[@current_thread] =  
+            find_main_script(@dbgr.vm_locations) || max_stack_size
+        else
+          @settings[:hidelevel]
+        end
+      max_stack_size = @dbgr.vm_locations.size
+      @stack_size = if @hide_level >= max_stack_size  
+                      max_stack_size else max_stack_size - @hide_level
+                    end
+    end
+      
+    # def get_nonsync_frame(tf)
+    #   if (tf.stack_size > 10)
+    #     check_frames = (0..5).map{|i| tf.prev(i).method}
+    #     if check_frames == 
+    #         %w(synchronize event_processor IFUNC call trace_hook IFUNC)
+    #       return tf.prev(6)
+    #     end
+    #   end
+    #   tf
+    # end
+
+    # def get_frame_from_thread(th)
+    #   if th == Thread.current
+    #     @threads2frames[th]
+    #   else
+    #     # FIXME: Check to see if we are blocked on entry to debugger.
+    #     # If so, walk back frames.
+    #     tf = get_nonsync_frame(th.threadframe)
+    #     @threads2frames = tf
+    #   end
+    # end
+
+    # # The dance we have to do to set debugger frame state to
+    # #    `frame', which is in the thread with id `thread_id'. We may
+    # #    need to the hide initial debugger frames.
+    # def find_and_set_debugged_frame(th, position)
+      
+    #   thread = threading._active[thread_id]
+    #   thread_name = thread.getName()
+    #   if (!@settings['dbg_pydbgr'] &&
+    #       thread_name == Mthread.current_thread_name())
+    #     # The frame we came in on ('current_thread_name') is
+    #     # the same as the one we want to switch to. In this case
+    #     # we need to some debugger frames are in this stack so 
+    #     # we need to remove them.
+    #     newframe = Mthread.find_debugged_frame(frame)
+    #     frame = newframe unless newframe
+    #   end
+    #   ## FIXME: else: we might be blocked on other threads which are
+    #   # about to go into the debugger it not for the fact this one got there
+    #   # first. Possibly in the future we want
+    #   # to hide the blocks into threading of that locking code as well. 
+      
+    #   # Set stack to new frame
+    #   @frame, @curindex = Mcmdproc.get_stack(frame, nil, self.proc)
+    #   @proc.stack, @proc.curindex = self.stack, self.curindex
+      
+    #   # @frame_thread_name = thread_name
+    # end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative 'main'   # Have to include before defining CmdProcessor!
+                            # FIXME
+  class Trepan::CmdProcessor
+    def errmsg(msg)
+      puts msg
+    end
+    def print_location
+      puts "frame location: #{frame.file} #{frame.line}"
+    end
+  end
+
+  require_relative './mock'
+  dbgr, cmd = MockDebugger::setup('exit', false)
+  # require_relative '../lib/trepanning'
+  # Trepan.start(:set_restart => true)
+  proc  = cmd.proc
+  0.upto(proc.stack_size-1) { |i| proc.adjust_frame(i, true) }
+  puts '*' * 10
+  proc.adjust_frame(-1, true)
+  proc.adjust_frame(0, true)
+  puts '*' * 10
+  proc.stack_size.times { proc.adjust_frame(1, false) }
+  puts '*' * 10
+  proc.adjust_frame(proc.stack_size-1, true)
+  proc.stack_size.times { proc.adjust_frame(-1, false) }
+    
+end

data/processor/help.rb

@@ -0,0 +1,72 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+class Trepan
+  module Help
+
+    def abbrev_stringify(name, min_abbrev)
+      "(#{name[0..min_abbrev-1]})#{name[min_abbrev..-1]}"
+    end
+
+    def summary_help(subcmd)
+      # Set class constant SHORT_HELP to be the first line of HELP
+      # unless it has been defined in the class already.
+      # The below was the simplest way I could find to do this since
+      # we are the super class but want to set the subclass's constant.
+      # defined? didn't seem to work here.
+      c = subcmd.class.constants
+      if c.member?('HELP') and !c.member?('SHORT_HELP')
+        short_help = subcmd.class.const_get('HELP').split("\n")[0].chomp('.')
+        subcmd.class.const_set(:SHORT_HELP, short_help)
+      end
+      
+      '  %-12s -- %s' %
+          [abbrev_stringify(obj_const(subcmd, :NAME), 
+                            obj_const(subcmd, :MIN_ABBREV)),
+           obj_const(subcmd, :SHORT_HELP)]
+    end
+
+    # We were given cmd without a subcommand; cmd is something
+    # like "show", "info" or "set". Generally this means list
+    # all of the subcommands.
+    def summary_list(name, subcmds)
+      msg "List of #{name} commands (with minimum abbreviation in parenthesis):"
+      subcmds.list.each do |subcmd_name|
+        # Some commands have lots of output.
+        # they are excluded here because 'in_list' is false.
+        msg summary_help(subcmds.subcmds[subcmd_name])
+      end
+    end
+
+
+    # Error message when subcommand asked for but doesn't exist
+    def undefined_subcmd(cmd, subcmd)
+      errmsg(('Undefined "%s" subcommand: "%s". ' + 
+              'Try "help %s *".') % [cmd, subcmd, cmd])
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  class TestClass
+    include Trepan::Help
+    HELP       = 'TestClass HELP.
+
+Long description goes here.'
+    MIN_ABBREV = 1
+    NAME       = File.basename(__FILE__)
+    def obj_const(obj, name)
+      obj.class.const_get(name) 
+    end
+    def msg(mess)
+      puts mess
+    end
+    def errmsg(mess)
+      puts "***#{mess}"
+    end
+    def initialize
+      puts summary_help(self)
+      undefined_subcmd('foo', 'bar')
+    end
+  end
+  TestClass.new
+end

data/processor/hook.rb

@@ -0,0 +1,133 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+class Trepan
+  class CmdProcessor
+    # Command processor hooks.
+    attr_reader   :autodis_hook
+    attr_reader   :autoirb_hook
+    attr_reader   :autolist_hook
+    attr_reader   :debug_dbgr_hook
+    attr_reader   :display_hook
+    attr_reader   :timer_hook
+    attr_reader   :trace_hook
+    attr_reader   :tracebuf_hook
+    attr_reader   :unconditional_prehooks
+    attr_reader   :cmdloop_posthooks
+    attr_reader   :cmdloop_prehooks
+
+    # Used to time how long a debugger action takes
+    attr_accessor :time_last
+
+    class Hook
+      attr_accessor :list
+
+      def initialize(list=[])
+        @list = list
+      end
+
+      def delete_by_name(delete_name)
+        @list.delete_if {|hook_name, priority, hook| hook_name == delete_name}
+      end
+
+      def empty?
+        @list.empty?
+      end
+
+      def insert(priority, name, hook)
+        insert_loc = @list.size  # at end
+        @list.each_with_index do |entry, index|
+          n, p, h = entry
+          if priority > p 
+            insert_loc = index
+            break
+          end
+        end
+        @list.insert(insert_loc, [name, priority, hook])
+      end
+
+      def insert_if_new(priority, name, hook)
+        insert(priority, name, hook) unless
+          @list.find {|try_name, try_priority, try_hook| try_name == name}
+      end
+
+      # Run each function in `hooks' with args
+      def run(*args)
+        @list.each do |name, priority, hook| 
+          hook.call(name, *args) 
+        end
+      end
+
+      # Could add delete_at and delete if necessary.
+    end
+    
+    def hook_initialize(commands)
+      @cmdloop_posthooks      = Hook.new
+      @cmdloop_prehooks       = Hook.new
+      @unconditional_prehooks = Hook.new
+
+      irb_cmd = commands['irb']
+      @autoirb_hook  = ['autoirb', 
+                        Proc.new{|*args| irb_cmd.run(['irb']) if irb_cmd}]
+
+      @debug_dbgr_hook = ['dbgdbgr',
+                          Proc.new{|*args| 
+                            if settings[:debugdbgr]
+                              $trepan_cmdproc  = self
+                              $trepan_frame    = @frame
+                            else
+                              $trepan_cmdproc  = nil
+                              $trepan_frame    = nil
+                            end}]
+
+      display_cmd = commands['display']
+      @display_hook   = ['display', 
+                         Proc.new{|*args| display_cmd.run(['display']) if display_cmd}]
+
+      # FIXME: generalize for any command run 
+      dis_cmd = commands['disassemble']
+      @autodis_hook  = ['autodis', 
+                         Proc.new{|*args| dis_cmd.run(['disassemble']) if dis_cmd}]
+
+      list_cmd = commands['list']
+      @autolist_hook  = ['autolist', 
+                         Proc.new{|*args| list_cmd.run(['list']) if list_cmd}]
+      
+      @timer_hook     = ['timer', 
+                         Proc.new{|*args|
+                           now = Time.now
+                           msg("%g seconds" % 
+                               (now - @time_last)) if @time_last
+                           @time_last = now
+                         }]
+      @timer_posthook = ['timer', Proc.new{|*args| @time_last = Time.now}]
+      @trace_hook     = ['trace', 
+                        Proc.new{|*args| print_location}]
+      @tracebuf_hook  = ['tracebuffer', 
+                         Proc.new{|*args| @eventbuf.append(@core.event, @frame, 
+                                                           @core.hook_arg)}]
+    end
+
+  end
+end
+if __FILE__ == $0
+  # Demo it.
+  hooks = Trepan::CmdProcessor::Hook.new
+  hooks.run(5)
+  hook1 = Proc.new {|name, a| puts "#{name} called with #{a}"}
+  hooks = Trepan::CmdProcessor::Hook.new()
+  hooks.insert(-1, 'hook1', hook1)
+  p hooks.list
+  hooks.insert_if_new(-1, 'hook1', hook1)
+  puts '-' * 30
+  p hooks.list
+  hooks.run(10)
+  puts '-' * 30
+  hooks.insert(-1, 'hook2', hook1)
+  hooks.run(20)
+  puts '-' * 30
+  hooks.delete_by_name('hook2')
+  hooks.run(30)
+  puts '-' * 30
+  hooks.delete_by_name('hook1')
+  hooks.run(30)
+  puts '-' * 30
+end

data/processor/load_cmds.rb

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net> 
+
+# Part of Trepan::CmdProcess that loads up debugger commands from
+# builtin and user directories.  
+# Sets @commands, @aliases, @macros
+require 'rubygems'; require 'require_relative'
+require_relative '../app/complete'
+class Trepan
+  class CmdProcessor
+
+    attr_reader   :aliases         # Hash[String] of command names
+                                   # indexed by alias name
+    attr_reader   :commands        # Hash[String] of command objects
+                                   # indexed by name
+    attr_reader   :macros          # Hash[String] of Proc objects 
+                                   # indexed by macro name.
+    
+    # "initialize" for multi-file class. Called from main.rb's "initialize".
+    def load_cmds_initialize
+      @commands = {}
+      @aliases = {}
+      @macros = {}
+
+      cmd_dirs = [ File.join(File.dirname(__FILE__), 'command') ]
+      cmd_dirs <<  @settings[:user_cmd_dir] if @settings[:user_cmd_dir]
+      cmd_dirs.each do |cmd_dir| 
+        load_debugger_commands(cmd_dir) if File.directory?(cmd_dir)
+      end
+    end
+
+    # Loads in debugger commands by require'ing each ruby file in the
+    # 'command' directory. Then a new instance of each class of the 
+    # form Trepan::xxCommand is added to @commands and that array
+    # is returned.
+    def load_debugger_commands(file_or_dir)
+      if File.directory?(file_or_dir)
+        dir = File.expand_path(file_or_dir)
+        Dir.glob(File.join(dir, '*.rb')).each do |rb| 
+          # We use require so that multiple calls have no effect.
+          require rb
+        end
+      elsif File.readable?(file_or_dir)
+        # We use load in case we are reloading. 
+        # 'require' would not be effective here
+        load file_or_dir
+      else
+        return false
+      end
+      # Instantiate each Command class found by the above require(s).
+      Trepan::Command.constants.grep(/.Command$/).each do |name|
+        klass = Trepan::Command.const_get(name)
+        cmd = klass.send(:new, self)
+
+        # Add to list of commands and aliases.
+        cmd_name = klass.const_get(:NAME)
+        if klass.constants.member?('ALIASES')
+          aliases= klass.const_get('ALIASES')
+          aliases.each {|a| @aliases[a] = cmd_name}
+        end
+        @commands[cmd_name] = cmd
+      end
+    end
+
+    # Looks up cmd_array[0] in @commands and runs that. We do lots of 
+    # validity testing on cmd_array.
+    def run_cmd(cmd_array)
+      unless cmd_array.is_a?(Array)
+        errmsg "run_cmd argument should be an Array, got: #{cmd_array.class}"
+        return
+      end
+      if cmd_array.detect{|item| !item.is_a?(String)}
+        errmsg "run_cmd argument Array should only contain strings. " + 
+          "Got #{cmd_array.inspect}"
+        return
+      end
+      if cmd_array.empty?
+        errmsg "run_cmd Array should have at least one item. " + 
+          "Got: #{cmd_array.inspect}"
+        return
+      end
+      cmd_name = cmd_array[0]
+      if @commands.member?(cmd_name)
+        @commands[cmd_name].run(cmd_array)
+      end
+    end
+
+    def complete_token_with_next(arg)
+    end
+
+    def complete(arg)
+      if arg.kind_of?(String)
+        args = arg.split
+      elsif arg.kind_of?(Array)
+        args = arg
+      else
+        return []
+      end
+      args = [''] if args.empty?
+      coms_macs = @commands.merge(@macros)
+      match_pairs = Trepan::Complete.complete_token_with_next(coms_macs,
+                                                               args[0])
+      return [] if match_pairs.empty?
+      match_hash = {}
+      match_pairs.each do |pair|
+        match_hash[pair[0]] = pair[1]
+      end
+      alias_pairs = Trepan::Complete.
+        complete_token_filtered_with_next(@aliases, args[0], match_hash,
+                                          @commands)
+      match_pairs += alias_pairs
+      if args.size == 1
+        return match_pairs.map{|pair| pair[0]}.sort
+      else 
+        alias_pairs.each do |pair|
+          match_hash[pair[0]] = pair[1]
+        end
+        if match_pairs.size > 1
+          # FIXME: figure out what to do here.
+          return match_pairs.map do |name, cmd|
+            ["#{name} #{args[1..-1].join(' ')}"]
+          end
+        end
+        # match_pairs.size == 1
+        # FIXME generalize more and turn into a routine.
+        first_arg, cmd = match_pairs[0]
+        if cmd.respond_to?(:complete_token_with_next)
+          match_pairs = cmd.complete_token_with_next(args[1])
+          if match_pairs.empty?
+            return [args.join(' ')] 
+          elsif args.size > 2 && match_pairs.size == 1
+            second_arg, cmd = match_pairs[0]
+            if cmd.respond_to?(:complete)
+              matches = cmd.complete(args[2])
+              return matches.map do |third_arg|
+                # FIXME: break out args[3..-1] if that exists to 
+                # handle more complex completions including subsubcmds.
+                "#{first_arg} #{second_arg.to_s} #{third_arg}" + 
+                  ((args.size > 3) ? "#{args[3..-1].join(' ')}" : '')
+              end
+            end
+          end
+          return match_pairs.map do |second_arg, junk|
+            # FIXME: break out args[2..-1] if that exists to 
+            # handle more complex completions including subsubcmds.
+            "#{first_arg} #{second_arg.to_s}" + 
+              ((args.size > 2) ? " #{args[2..-1].join(' ')}" : '')
+          end
+        end
+        return ["#{first_arg} #{args[1..-1].join(' ')}"]
+      end
+    end
+  end
+end
+if __FILE__ == $0
+  class Trepan::CmdProcessor
+    def initialize(core, settings={})
+    end
+  end
+
+  cmdproc = Trepan::CmdProcessor.new(nil)
+  cmddir = File.join(File.dirname(__FILE__), 'command')
+  cmdproc.instance_variable_set('@settings', {})
+  cmdproc.load_cmds_initialize
+  require 'columnize'
+  puts Columnize.columnize(cmdproc.commands.keys.sort)
+  puts '=' * 20
+  puts Columnize.columnize(cmdproc.aliases.keys.sort)
+  puts '=' * 20
+
+  def cmdproc.errmsg(mess)
+    puts "** #{mess}"
+  end
+
+  def cmdproc.msg(mess)
+    puts mess
+  end
+
+  cmdproc.run_cmd('foo')  # Invalid - not an Array
+  cmdproc.run_cmd([])     # Invalid - empty Array
+  cmdproc.run_cmd(['list', 5])  # Invalid - nonstring arg
+  p cmdproc.complete("d")
+  p cmdproc.complete("sho d")
+  p cmdproc.complete('')
+end