trepanning 0.0.4

data/processor/command/info.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/submgr'
+
+class Trepan::Command::InfoCommand < Trepan::SubcommandMgr
+  unless defined?(HELP)
+    HELP =
+'Generic command for showing things about the program being debugged. 
+
+You can give unique prefix of the name of a subcommand to get
+information about just that subcommand.
+
+Type "info" for a list of "info" subcommands and what they do.
+Type "help info *" for just a list of "info" subcommands.
+'
+
+    ALIASES       = %w(i)
+    CATEGORY      = 'status'
+    NAME          = File.basename(__FILE__, '.rb')
+    SHORT_HELP    = 'Information about debugged program and its environment'
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+end

data/processor/command/info_subcmd/args.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+require_relative '../../../app/frame'
+
+class Trepan::Subcommand::InfoArgs < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = 'Show argument variables of the current stack frame'
+    MIN_ABBREV   = 'ar'.size 
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = true
+    PREFIX       = %w(info args)
+  end
+
+  include Trepan::Frame
+  def run(args)
+    if 'CFUNC' == @proc.frame.type
+      argc = @proc.frame.argc
+      if argc > 0 
+        1.upto(argc).each do |i| 
+          msg "#{i}: #{@proc.frame.sp(argc-i+3).inspect}"
+        end
+      else
+        msg("No parameters in C call.")
+      end
+    else
+      param_names = all_param_names(@proc.frame.iseq, false)
+      if param_names.empty?
+        msg("No parameters in call.")
+      else
+        param_names.each_with_index do |var_name, i|
+          var_value = @proc.safe_rep(@proc.debug_eval_no_errmsg(var_name).inspect)
+          msg("#{var_name} = #{var_value}")
+        end
+        unless 'call' == @proc.event and 0 == @proc.frame_index
+          msg("Values may have change from the initial call values.")
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  require_relative '../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoArgs.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/info_subcmd/breakpoints.rb

@@ -0,0 +1,162 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoBreakpoints < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = <<EOH
+info breakpoints [num1 ...] [verbose]
+
+Show status of user-settable breakpoints. If no breakpoint numbers are
+given, the show all breakpoints. Otherwise only those breakpoints
+listed are shown and the order given. If VERBOSE is given, more
+information provided about each breakpoint.
+
+The "Disp" column contains one of "keep", "del", the disposition of
+the breakpoint after it gets hit.
+
+The "enb" column indicates whether the breakpoint is enabled.
+
+The "Where" column indicates where the breakpoint is located.
+EOH
+
+    MIN_ABBREV   = 'br'.size 
+    NAME         = File.basename(__FILE__, '.rb')
+    PREFIX       = %w(info breakpoints)
+    SHORT_HELP = "Status of user-settable breakpoints"
+  end
+
+  def bpprint(bp, verbose=false)
+    disp  = bp.temp?    ? 'del  ' : 'keep '
+    disp += bp.enabled? ? 'y  '   : 'n  '
+
+    iseq = bp.iseq
+    mess = '%-4dbreakpoint    %s at ' % [bp.id, disp]
+
+    line_loc = '%s:%d' % 
+      [iseq.source_container.join(' '),
+       iseq.offset2lines(bp.offset).join(', ')]
+    vm_loc = "VM offset %d of instruction sequence \"%s\"" %
+      [bp.offset, iseq.name]
+
+    loc, other_loc =
+      if 'line' == bp.type
+        [line_loc, vm_loc]
+      else # 'offset' == bp.type
+        [vm_loc, line_loc]
+      end
+    msg(mess + loc)
+    msg("\t#{other_loc}") if verbose
+
+    if bp.condition && bp.condition != 'true'
+      msg("\tstop only if %s" % bp.condition)
+    end
+    if bp.ignore > 0
+      msg("\tignore next %d hits" % bp.ignore)
+    end
+    if bp.hits > 0
+      ss = (bp.hits > 1) ? 's' : ''
+      msg("\tbreakpoint already hit %d time%s" %
+          [bp.hits, ss])
+    end
+  end
+
+  def save_command
+    bpmgr = @proc.brkpts
+    bpmgr.list.inject([]) do |res, bp|
+      iseq = bp.iseq
+      next unless 'file' == iseq.source_container[0]
+      loc = iseq.source_container[1] + ':'
+      loc += 
+        # if 'line' == bp.type
+          iseq.offset2lines(bp.offset)[0].to_s
+        # else
+        #  'O' + bp.offset.to_s
+        # end
+      res << "break #{loc}"
+    end
+  end
+
+  def run(args)
+    verbose = false
+    unless args.empty?
+      if 'verbose' == args[-1]
+        verbose = true
+        args.pop
+      end
+    end
+
+
+    show_all = 
+      if args.size > 2
+        opts = {
+        :msg_on_error => 
+        "An '#{PREFIX.join(' ')}' argument must eval to a breakpoint between 1..#{@proc.brkpts.max}.",
+        :min_value => 1,
+        :max_value => @proc.brkpts.max
+      }
+        bp_nums = @proc.get_int_list(args[2..-1])
+        false
+      else
+        true
+      end
+    
+    bpmgr = @proc.brkpts
+    if bpmgr.empty?  
+      msg('No breakpoints.')
+    else
+      # There's at least one
+      msg("Num Type          Disp Enb Where")
+      if show_all
+        bpmgr.list.each do |bp|
+          bpprint(bp, verbose)
+        end
+      else
+        notfound = []
+        bp_nums.each do |bp_num|
+          bp = @proc.brkpts[bp_num]
+          if bp
+            bpprint(bp, verbose)
+          else
+            notfound << bp_num
+          end
+        end
+        errmsg "No breakpoint number(s) #{not_found.join(' ')}." unless
+          notfound.empty? 
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoBreak.new(cmd)
+
+  puts '-' * 20
+  subcommand.run(%w(info break))
+  puts '-' * 20
+  subcommand.summary_help(name)
+  puts
+  puts '-' * 20
+
+  require 'thread_frame'
+  tf = RubyVM::ThreadFrame.current
+  pc_offset = tf.pc_offset
+  def foo
+    5 
+  end
+  
+  brk_cmd = dbgr.core.processor.commands['break']
+  brk_cmd.run(['break', "O#{pc_offset}"])
+  cmd.run(%w(info break))
+  puts '-' * 20
+  brk_cmd.run(['break', 'foo'])
+  subcommand.run(%w(info break))
+  puts '-' * 20
+  p subcommand.save_command
+
+end

data/processor/command/info_subcmd/file.rb

@@ -0,0 +1,162 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'linecache'
+require_relative '../base/subcmd'
+require_relative '../../../app/file'
+
+class Trepan::Subcommand::InfoFile < Trepan::Subcommand
+  unless defined?(HELP)
+    DEFAULT_FILE_ARGS = %w(size sha1)
+
+    HELP =
+"info file [{FILENAME|.} [all | brkpts | iseq | sha1 | size | stat]]
+
+Show information about the current file. If no filename is given and
+the program is running then the current file associated with the
+current stack entry is used. Sub options which can be shown about a file are:
+
+brkpts -- Line numbers where there are statement boundaries. 
+          These lines can be used in breakpoint commands.
+iseq   -- Instruction sequences from this file.
+sha1   -- A SHA1 hash of the source text. This may be useful in comparing
+          source code.
+size   -- The number of lines in the file.
+stat   -- File.stat information
+
+all    -- All of the above information.
+
+If no sub-options are given #{DEFAULT_FILE_ARGS.join(' ')} are assumed.
+"
+    MIN_ABBREV   = 'fi'.size  # Note we have "info frame"
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = false
+    PREFIX       = %w(info file)
+  end
+
+  include Trepanning
+  
+  # Get file information
+  def run(args)
+    return if args.size < 2
+    args << '.' if 2 == args.size 
+    filename = 
+      if '.' == args[2]
+        if not @proc.frame
+          errmsg("No frame - no default file.")
+          return false
+          nil
+        else
+          File.expand_path(@proc.frame.source_container[1])
+        end
+      else
+        args[2]
+      end
+    args += DEFAULT_FILE_ARGS if args.size == 3
+
+    m = filename + ' is'
+    canonic_name = LineCache::map_file(filename)
+    if LineCache::cached?(canonic_name)
+      m += " cached in debugger"
+      if canonic_name != filename
+        m += (' as:' + canonic_name)
+      end
+      m += '.'
+      msg(m)
+    elsif !(matches = find_scripts(filename)).empty?
+      if (matches.size > 1)
+        msg("Multiple files found:")
+        matches.each { |filename| msg("\t%s" % filename) }
+        return
+      else
+        msg('File "%s" just now cached.' % filename)
+        LineCache::cache(matches[0])
+        LineCache::remap_file(matches[0], filename)
+        canonic_name = matches[0]
+      end
+    else
+      msg(m + ' not cached in debugger.')
+      return
+    end
+    seen = {}
+    args[3..-1].each do |arg|
+      processed_arg = false
+
+      if %w(all size).member?(arg) 
+        unless seen[:size]
+          max_line = LineCache::size(canonic_name)
+          msg "File has %d lines." % max_line if max_line
+        end
+        processed_arg = seen[:size] = true
+      end
+
+      if %w(all sha1).member?(arg)
+        unless seen[:sha1]
+          msg("SHA1 is %s." % LineCache::sha1(canonic_name))
+        end
+        processed_arg = seen[:sha1] = true
+      end
+
+      if %w(all brkpts).member?(arg)
+        unless seen[:brkpts]
+          msg("Possible breakpoint line numbers:")
+          lines = LineCache::trace_line_numbers(canonic_name)
+          fmt_lines = columnize_numbers(lines)
+          msg(fmt_lines)
+        end
+        processed_arg = seen[:brkpts] = true
+      end
+
+      if %w(all iseq).member?(arg) 
+        unless seen[:iseq]
+          if SCRIPT_ISEQS__.member?(canonic_name)
+            msg("File contains instruction sequences:")
+            SCRIPT_ISEQS__[canonic_name].each do |iseq|
+              msg("\t %s %s" % [iseq, iseq.name.inspect])
+            end 
+          else
+            msg("Instruction sequences not recorded; there may be some, though.")
+          end
+        end
+        processed_arg = seen[:iseq] = true
+      end
+
+      if %w(all stat).member?(arg)
+        unless seen[:stat]
+          msg("Stat info:\n\t%s." % LineCache::stat(canonic_name).inspect)
+        end
+        processed_arg = seen[:stat] = true
+      end
+
+      if not processed_arg
+        errmsg("I don't understand sub-option \"%s\"." % arg)
+      end
+    end unless args.empty?
+  end
+end
+
+if __FILE__ == $0
+  if  not (ARGV.size == 1 && ARGV[0] == 'noload')
+    ISEQS__        = {}
+    SCRIPT_ISEQS__ = {}
+    ARGV[0..-1]    = ['noload']
+    load(__FILE__)
+  else    
+    require_relative '../../mock'
+    require_relative '../../subcmd'
+    name = File.basename(__FILE__, '.rb')
+    # FIXME: DRY the below code
+    dbgr, cmd = MockDebugger::setup('info')
+    subcommand = Trepan::Subcommand::InfoFile.new(cmd)
+    testcmdMgr = Trepan::Subcmd.new(subcommand)
+    
+    [%w(info file nothere),
+     %w(info file .),
+     %w(info file),
+     %w(info file file.rb),
+     %w(info file . all),
+     %w(info file . lines size sha1 sha1)].each do |args|
+      subcommand.run(args)
+      puts '-' * 40
+    end
+  end
+end

data/processor/command/info_subcmd/frame.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoFrame < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = 'Show all information about the selected frame'
+    MIN_ABBREV   = 'fr'.size # Note we have "info file"
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = true
+    PREFIX       = %w(info frame)
+  end
+
+  def run(args)
+    frame = @proc.frame
+    msg("Line %s of %s at PC offset %d, type: %s" %
+        [@proc.frame_line, frame.source_container[1], frame.pc_offset, 
+         frame.type])
+    if @proc.event == 'return'
+      msg("Return value class: #{@proc.frame.sp(1).class}")
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  require_relative '../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoFrame.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/info_subcmd/iseq.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoIseq < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = 
+'info iseq [METHOD|.]
+
+Show information about an instruction sequence.
+
+Examples:
+  info iseq
+  info iseq .
+  info iseq require_relative
+'
+    MIN_ABBREV   = 'is'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = true
+    PREFIX       = %w(info iseq)
+    SHORT_HELP   = 'Information about an instruction sequence'
+  end
+
+  def run(args)
+    if 2 == args.size
+      iseq_name = '.'
+    else
+      iseq_name = args[2]
+    end
+    if '.' == iseq_name
+      iseq = frame = @proc.frame.iseq
+    elsif !(matches = find_iseqs(ISEQS__, iseq_name)).empty?
+      # FIXME: do something if there is more than one
+      iseq = matches[0]
+    else
+      iseq = nil
+    end
+    
+    if iseq
+      msg('Instruction sequence:')
+      %w(name source_container arg_block arg_opts arg_post_len arg_rest 
+         arg_simple argc arity iseq_size local_size orig
+         ).each do |field|
+        msg("\t#{field}: %s" % iseq.send(field).inspect)
+      end
+      msg("\tsha1: #{iseq.sha1}")
+      if iseq.brkpts
+        if iseq.brkpts.empty?
+          msg("Breakpoints have been allocated, but none have been set.")
+        else
+          s = iseq.brkpts.size > 1 ? 's' : ''
+          msg("Breakpoint%s at offset%s: %s" % [s, s, iseq.brkpts.join(', ')])
+        end
+      else
+        msg("Breakpoints have not been allocated.")
+      end
+    else
+      mess = "Can't find instruction sequence"
+      mess += " for #{args.join(' ')}" unless args.empty?
+      errmsg mess
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  ISEQS__        = {}
+  SCRIPT_ISEQS__ = {} 
+
+  require_relative '../../mock'
+  require_relative '../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoIseq.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  subcommand.run_show_bool
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/info_subcmd/locals.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'columnize'
+require_relative '../base/subcmd'
+require_relative '../../../app/frame'
+
+class Trepan::Subcommand::InfoLocals < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = 'Show local variables of the current stack frame'
+    MAX_ARGS     = 1
+    MIN_ABBREV   = 'lo'.size 
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = true
+    PREFIX       = %w(info locals)
+  end
+
+  include Trepan::Frame
+  def get_local_names
+    iseq = @proc.frame.iseq
+    0.upto(iseq.local_size-2).map do
+      |i|
+      iseq.local_name(i)
+    end
+  end
+
+  def run(args)
+    if args.size == 3
+      if 0 == 'names'.index(args[-1].downcase)
+        if 'CFUNC' == @proc.frame.type
+          errmsg('info local names not supported for C frames')
+        else
+          local_names = get_local_names()
+          if local_names.empty?
+            msg "No local variables defined."
+          else
+            msg "Local variable names:"
+            width = settings[:maxwidth]
+            mess = Columnize::columnize(local_names, 
+                                        @proc.settings[:maxwidth], ', ',
+                                        false, true, ' ' * 2).chomp
+            msg mess
+          end
+        end
+      else
+        errmsg("unrecognized argument #{args[2]}")
+      end
+    elsif args.size == 2
+      if 'CFUNC' == @proc.frame.type
+        argc = @proc.frame.argc
+        if argc > 0 
+          1.upto(argc).each do |i| 
+            msg "#{i}: #{@proc.frame.sp(argc-i+3).inspect}"
+          end
+        else
+          msg("No parameters in C call; showing other C locals is not supported.")
+        end
+      else
+        local_names = get_local_names
+        if local_names.empty?
+          msg "No local variables defined."
+        else
+          msg "Local variables:"
+          get_local_names.each_with_index do |var_name, i| 
+            var_value = @proc.safe_rep(@proc.debug_eval_no_errmsg(var_name).inspect)
+            msg("#{var_name} = #{var_value}")
+          end
+        end
+      end
+    else
+      errmsg("Wrong number of arguments #{args.size}")
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  require_relative '../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoLocals.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/info_subcmd/program.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoProgram < Trepan::Subcommand
+  unless defined?(HELP)
+    HELP         = 'Information about debugged program and its environment'
+    MIN_ABBREV   = 'pr'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_STACK   = true
+    PREFIX       = %w(info program)
+  end
+
+  def run(args)
+    frame = @proc.frame
+    m = 'Program stop event: %s' % @proc.event
+    m += 
+      if frame.iseq
+        '; PC offset %d of instruction sequence: %s' % 
+          [frame.pc_offset, frame.iseq.name]
+      else
+        '.'
+      end
+    msg m
+    if 'return' == @proc.event 
+      msg 'R=> %s' % @proc.frame.sp(1).inspect 
+    elsif 'raise' == @proc.event
+      msg @proc.core.hook_arg.inspect if @proc.core.hook_arg
+    end
+
+    if @proc.brkpt
+      msg('It is stopped at %sbreakpoint %d.' %
+          [@proc.brkpt.temp? ? 'temporary ' : '',
+           @proc.brkpt.id])
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoProgram.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  name = File.basename(__FILE__, '.rb')
+  subcommand.run([name])
+  subcommand.summary_help(name)
+  puts
+end