Class: DEBUGGER__::Session
- Includes:
- Color, GlobalVariablesHelper
- Defined in:
- lib/debug/server_cdp.rb,
lib/debug/server_dap.rb,
lib/debug/session.rb
Constant Summary collapse
- INVALID_PARAMS =
-32602
- INTERNAL_ERROR =
-32603
- BREAK_KEYWORDS =
%w(if: do: pre: path:).freeze
- METHOD_ADDED_TRACKERS =
Hash.new
Constants included from GlobalVariablesHelper
GlobalVariablesHelper::SKIP_GLOBAL_LIST
Instance Attribute Summary collapse
-
#intercepted_sigint_cmd ⇒ Object
readonly
Returns the value of attribute intercepted_sigint_cmd.
-
#process_group ⇒ Object
readonly
Returns the value of attribute process_group.
-
#subsession_id ⇒ Object
readonly
Returns the value of attribute subsession_id.
Class Method Summary collapse
- .activate_method_added_trackers ⇒ Object
- .create_method_added_tracker(mod, method_added_id, method_accessor = :method) ⇒ Object
- .deactivate_method_added_trackers ⇒ Object
Instance Method Summary collapse
- #activate(ui = nil, on_fork: false) ⇒ Object
- #active? ⇒ Boolean
- #add_bp(bp) ⇒ Object
- #add_catch_breakpoint(pat, cond: nil) ⇒ Object
- #add_check_breakpoint(cond, path, command) ⇒ Object
- #add_iseq_breakpoint(iseq, **kw) ⇒ Object
- #add_line_breakpoint(file, line, **kw) ⇒ Object
- #add_preset_commands(name, cmds, kick: true, continue: true) ⇒ Object
-
#add_tracer(tracer) ⇒ Object
tracers.
- #after_fork_parent ⇒ Object
- #ask(msg, default = 'Y') ⇒ Object
- #before_fork(need_lock = true) ⇒ Object
- #bp_index(specific_bp_key) ⇒ Object
-
#bps_pending_until_load? ⇒ Boolean
breakpoint management.
- #cancel_auto_continue ⇒ Object
- #capture_exception_frames(*exclude_path) ⇒ Object
- #cdp_event(args) ⇒ Object
- #check_postmortem ⇒ Object
- #check_unsafe ⇒ Object
- #clean_bps ⇒ Object
- #clear_all_breakpoints ⇒ Object
- #clear_breakpoints(&condition) ⇒ Object
- #clear_catch_breakpoints(*exception_names) ⇒ Object
- #clear_line_breakpoints(path) ⇒ Object
- #config_command(arg) ⇒ Object
- #config_set(key, val, append: false) ⇒ Object
- #config_show(key) ⇒ Object
- #dap_event(args) ⇒ Object
- #deactivate ⇒ Object
- #delete_bp(arg = nil) ⇒ Object
- #enter_postmortem_session(exc) ⇒ Object
- #fail_response(req, **kw) ⇒ Object
- #find_waiting_tc(id) ⇒ Object
-
#get_thread_client(th = Thread.current) ⇒ Object
can be called by other threads.
-
#get_type(obj) ⇒ Object
FIXME: unify this method with ThreadClient#propertyDescriptor.
- #in_subsession? ⇒ Boolean
-
#initialize ⇒ Session
constructor
A new instance of Session.
- #inspect ⇒ Object
- #intercept_trap_sigint(flag, &b) ⇒ Object
- #intercept_trap_sigint? ⇒ Boolean
- #intercept_trap_sigint_end ⇒ Object
- #intercept_trap_sigint_start(prev) ⇒ Object
- #iterate_bps ⇒ Object
- #managed_thread_clients ⇒ Object
- #method_added(tp) ⇒ Object
-
#on_load(iseq, src) ⇒ Object
event.
- #on_thread_begin(th) ⇒ Object
- #pop_event ⇒ Object
- #postmortem=(is_enable) ⇒ Object
- #process_command(line) ⇒ Object
- #process_event(evt) ⇒ Object
- #process_info ⇒ Object
- #process_protocol_request(req) ⇒ Object
- #prompt ⇒ Object
- #register_default_command ⇒ Object
- #register_var(v, tid) ⇒ Object
- #register_vars(vars, tid) ⇒ Object
- #rehash_bps ⇒ Object
- #remote? ⇒ Boolean
- #repl_add_breakpoint(arg) ⇒ Object
- #repl_add_catch_breakpoint(arg) ⇒ Object
- #repl_add_watch_breakpoint(arg) ⇒ Object
- #request_tc(req) ⇒ Object
- #reset_ui(ui) ⇒ Object
- #resolve_path(file) ⇒ Object
- #save_int_trap(cmd) ⇒ Object
- #session_server_main ⇒ Object
- #set_no_sigint_hook(old, new) ⇒ Object
- #setup_threads ⇒ Object
- #show_bps(specific_bp = nil) ⇒ Object
- #show_help(arg = nil) ⇒ Object
- #source(iseq) ⇒ Object
- #step_command(type, arg) ⇒ Object
- #stop_stepping?(file, line, subsession_id = nil) ⇒ Boolean
- #switch_thread(n) ⇒ Object
- #thread_list ⇒ Object
-
#update_thread_list ⇒ Object
threads.
- #wait_command ⇒ Object
- #wait_command_loop ⇒ Object
- #width ⇒ Object
Methods included from Color
#color_pp, #colored_inspect, #colorize, #colorize_blue, #colorize_code, #colorize_cyan, #colorize_dim, #colorize_magenta, #irb_colorize, #with_inspection_error_guard
Methods included from GlobalVariablesHelper
Constructor Details
#initialize ⇒ Session
Returns a new instance of Session.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/debug/session.rb', line 98 def initialize @ui = nil @sr = SourceRepository.new @bps = {} # bp.key => bp # [file, line] => LineBreakpoint # "Error" => CatchBreakpoint # "Foo#bar" => MethodBreakpoint # [:watch, ivar] => WatchIVarBreakpoint # [:check, expr] => CheckBreakpoint # @tracers = {} @th_clients = {} # {Thread => ThreadClient} @q_evt = Queue.new @displays = [] @tc = nil @tc_id = 0 @preset_command = nil @postmortem_hook = nil @postmortem = false @intercept_trap_sigint = false @intercepted_sigint_cmd = 'DEFAULT' @process_group = ProcessGroup.new @subsession_stack = [] @subsession_id = 0 @frame_map = {} # for DAP: {id => [threadId, frame_depth]} and CDP: {id => frame_depth} @var_map = {1 => [:globals], } # {id => ...} for DAP @src_map = {} # {id => src} @scr_id_map = {} # for CDP @obj_map = {} # { object_id => ... } for CDP @tp_thread_begin = nil @commands = {} @unsafe_context = false has_keep_script_lines = RubyVM.respond_to? :keep_script_lines @tp_load_script = TracePoint.new(:script_compiled){|tp| if !has_keep_script_lines || bps_pending_until_load? eval_script = tp.eval_script unless has_keep_script_lines ThreadClient.current.on_load tp.instruction_sequence, eval_script end } @tp_load_script.enable @thread_stopper = thread_stopper self.postmortem = CONFIG[:postmortem] register_default_command end |
Instance Attribute Details
#intercepted_sigint_cmd ⇒ Object (readonly)
Returns the value of attribute intercepted_sigint_cmd.
94 95 96 |
# File 'lib/debug/session.rb', line 94 def intercepted_sigint_cmd @intercepted_sigint_cmd end |
#process_group ⇒ Object (readonly)
Returns the value of attribute process_group.
94 95 96 |
# File 'lib/debug/session.rb', line 94 def process_group @process_group end |
#subsession_id ⇒ Object (readonly)
Returns the value of attribute subsession_id.
94 95 96 |
# File 'lib/debug/session.rb', line 94 def subsession_id @subsession_id end |
Class Method Details
.activate_method_added_trackers ⇒ Object
1816 1817 1818 1819 1820 1821 1822 |
# File 'lib/debug/session.rb', line 1816 def self.activate_method_added_trackers METHOD_ADDED_TRACKERS.each do |m, tp| tp.enable(target: m) unless tp.enabled? rescue ArgumentError DEBUGGER__.warn "Methods defined under #{m.owner} can not track by the debugger." end end |
.create_method_added_tracker(mod, method_added_id, method_accessor = :method) ⇒ Object
1809 1810 1811 1812 1813 1814 |
# File 'lib/debug/session.rb', line 1809 def self.create_method_added_tracker mod, method_added_id, method_accessor = :method m = mod.__send__(method_accessor, method_added_id) METHOD_ADDED_TRACKERS[m] = TracePoint.new(:call) do |tp| SESSION.method_added tp end end |
.deactivate_method_added_trackers ⇒ Object
1824 1825 1826 1827 1828 |
# File 'lib/debug/session.rb', line 1824 def self.deactivate_method_added_trackers METHOD_ADDED_TRACKERS.each do |m, tp| tp.disable if tp.enabled? end end |
Instance Method Details
#activate(ui = nil, on_fork: false) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/debug/session.rb', line 168 def activate ui = nil, on_fork: false @ui = ui if ui @tp_thread_begin&.disable @tp_thread_begin = nil @ui.activate self, on_fork: on_fork q = Queue.new @session_server = Thread.new do Thread.current.name = 'DEBUGGER__::SESSION@server' Thread.current.abort_on_exception = true # Thread management setup_threads thc = get_thread_client Thread.current thc.mark_as_management if @ui.respond_to?(:reader_thread) && thc = get_thread_client(@ui.reader_thread) thc.mark_as_management end @tp_thread_begin = TracePoint.new(:thread_begin) do |tp| get_thread_client end @tp_thread_begin.enable # session start q << true session_server_main end q.pop end |
#active? ⇒ Boolean
150 151 152 |
# File 'lib/debug/session.rb', line 150 def active? !@q_evt.closed? end |
#add_bp(bp) ⇒ Object
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 |
# File 'lib/debug/session.rb', line 1372 def add_bp bp # don't repeat commands that add breakpoints if @bps.has_key? bp.key if bp.duplicable? bp else @ui.puts "duplicated breakpoint: #{bp}" bp.disable nil end else @bps[bp.key] = bp end end |
#add_catch_breakpoint(pat, cond: nil) ⇒ Object
1472 1473 1474 1475 |
# File 'lib/debug/session.rb', line 1472 def add_catch_breakpoint pat, cond: nil bp = CatchBreakpoint.new(pat, cond: cond) add_bp bp end |
#add_check_breakpoint(cond, path, command) ⇒ Object
1477 1478 1479 1480 |
# File 'lib/debug/session.rb', line 1477 def add_check_breakpoint cond, path, command bp = CheckBreakpoint.new(cond: cond, path: path, command: command) add_bp bp end |
#add_iseq_breakpoint(iseq, **kw) ⇒ Object
1519 1520 1521 1522 |
# File 'lib/debug/session.rb', line 1519 def add_iseq_breakpoint iseq, **kw bp = ISeqBreakpoint.new(iseq, [:line], **kw) add_bp bp end |
#add_line_breakpoint(file, line, **kw) ⇒ Object
1482 1483 1484 1485 1486 1487 1488 1489 |
# File 'lib/debug/session.rb', line 1482 def add_line_breakpoint file, line, **kw file = resolve_path(file) bp = LineBreakpoint.new(file, line, **kw) add_bp bp rescue Errno::ENOENT => e @ui.puts e. end |
#add_preset_commands(name, cmds, kick: true, continue: true) ⇒ Object
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/debug/session.rb', line 346 def add_preset_commands name, cmds, kick: true, continue: true cs = cmds.map{|c| c.each_line.map{|line| line = line.strip.gsub(/\A\s*\#.*/, '').strip line unless line.empty? }.compact }.flatten.compact if @preset_command && !@preset_command.commands.empty? @preset_command.commands += cs else @preset_command = PresetCommands.new(cs, name, continue) end ThreadClient.current.on_init name if kick end |
#add_tracer(tracer) ⇒ Object
tracers
1526 1527 1528 1529 1530 1531 1532 1533 1534 |
# File 'lib/debug/session.rb', line 1526 def add_tracer tracer if @tracers.has_key? tracer.key tracer.disable @ui.puts "Duplicated tracer: #{tracer}" else @tracers[tracer.key] = tracer @ui.puts "Enable #{tracer}" end end |
#after_fork_parent ⇒ Object
1980 1981 1982 |
# File 'lib/debug/session.rb', line 1980 def after_fork_parent @ui.after_fork_parent end |
#ask(msg, default = 'Y') ⇒ Object
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 |
# File 'lib/debug/session.rb', line 1310 def ask msg, default = 'Y' opts = '[y/n]'.tr(default.downcase, default) input = @ui.ask("#{msg} #{opts} ") input = default if input.empty? case input when 'y', 'Y' true else false end end |
#before_fork(need_lock = true) ⇒ Object
1974 1975 1976 1977 1978 |
# File 'lib/debug/session.rb', line 1974 def before_fork need_lock = true if need_lock @process_group.multi_process! end end |
#bp_index(specific_bp_key) ⇒ Object
1349 1350 1351 1352 1353 1354 1355 1356 |
# File 'lib/debug/session.rb', line 1349 def bp_index specific_bp_key iterate_bps do |key, bp, i| if key == specific_bp_key return [bp, i] end end nil end |
#bps_pending_until_load? ⇒ Boolean
breakpoint management
1324 1325 1326 |
# File 'lib/debug/session.rb', line 1324 def bps_pending_until_load? @bps.any?{|key, bp| bp.pending_until_load?} end |
#cancel_auto_continue ⇒ Object
1258 1259 1260 1261 1262 |
# File 'lib/debug/session.rb', line 1258 def cancel_auto_continue if @preset_command&.auto_continue @preset_command.auto_continue = false end end |
#capture_exception_frames(*exclude_path) ⇒ Object
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 |
# File 'lib/debug/session.rb', line 1860 def capture_exception_frames *exclude_path postmortem_hook = TracePoint.new(:raise){|tp| exc = tp.raised_exception frames = DEBUGGER__.capture_frames(__dir__) exclude_path.each{|ex| if Regexp === ex frames.delete_if{|e| ex =~ e.path} else frames.delete_if{|e| e.path.start_with? ex.to_s} end } exc.instance_variable_set(:@__debugger_postmortem_frames, frames) } postmortem_hook.enable begin yield nil rescue Exception => e if e.instance_variable_defined? :@__debugger_postmortem_frames e else raise end ensure postmortem_hook.disable end end |
#cdp_event(args) ⇒ Object
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 |
# File 'lib/debug/server_cdp.rb', line 839 def cdp_event args type, req, result = args case type when :backtrace result[:callFrames].each.with_index do |frame, i| frame_id = frame[:callFrameId] @frame_map[frame_id] = i path = frame[:url] unless s_id = @scr_id_map[path] s_id = (@scr_id_map.size + 1).to_s @scr_id_map[path] = s_id if path && File.exist?(path) src = File.read(path) end @src_map[s_id] = src end if src = @src_map[s_id] lineno = src.lines.count else lineno = 0 end frame[:location][:scriptId] = s_id frame[:functionLocation][:scriptId] = s_id @ui.fire_event 'Debugger.scriptParsed', scriptId: s_id, url: frame[:url], startLine: 0, startColumn: 0, endLine: lineno, endColumn: 0, executionContextId: 1, hash: src.hash.inspect frame[:scopeChain].each {|s| oid = s.dig(:object, :objectId) @obj_map[oid] = [s[:type], frame_id] } end if oid = result.dig(:data, :objectId) @obj_map[oid] = ['properties'] end @ui.fire_event 'Debugger.paused', **result when :evaluate = result.delete :message if fail_response req, code: INVALID_PARAMS, message: else src = req.dig('params', 'expression') s_id = (@src_map.size + 1).to_s @src_map[s_id] = src lineno = src.lines.count @ui.fire_event 'Debugger.scriptParsed', scriptId: s_id, url: '', startLine: 0, startColumn: 0, endLine: lineno, endColumn: 0, executionContextId: 1, hash: src.hash.inspect if exc = result.dig(:response, :exceptionDetails) exc[:stackTrace][:callFrames].each{|frame| if frame[:url].empty? frame[:scriptId] = s_id else path = frame[:url] unless s_id = @scr_id_map[path] s_id = (@scr_id_map.size + 1).to_s @scr_id_map[path] = s_id end frame[:scriptId] = s_id end } if oid = exc[:exception][:objectId] @obj_map[oid] = ['exception'] end end rs = result.dig(:response, :result) [rs].each{|obj| if oid = obj[:objectId] @obj_map[oid] = ['properties'] end } @ui.respond req, **result[:response] out = result[:output] if out && !out.empty? @ui.fire_event 'Runtime.consoleAPICalled', type: 'log', args: [ type: out.class, value: out ], executionContextId: 1, # Change this number if something goes wrong. timestamp: Time.now.to_f end end when :scope result.each{|obj| if oid = obj.dig(:value, :objectId) @obj_map[oid] = ['properties'] end } @ui.respond req, result: result when :properties result.each_value{|v| v.each{|obj| if oid = obj.dig(:value, :objectId) @obj_map[oid] = ['properties'] end } } @ui.respond req, **result when :exception @ui.respond req, **result end end |
#check_postmortem ⇒ Object
1838 1839 1840 1841 1842 |
# File 'lib/debug/session.rb', line 1838 def check_postmortem if @postmortem raise PostmortemError, "Can not use this command on postmortem mode." end end |
#check_unsafe ⇒ Object
1844 1845 1846 1847 1848 |
# File 'lib/debug/session.rb', line 1844 def check_unsafe if @unsafe_context raise RuntimeError, "#{@repl_prev_line.dump} is not allowed on unsafe context." end end |
#clean_bps ⇒ Object
1366 1367 1368 1369 1370 |
# File 'lib/debug/session.rb', line 1366 def clean_bps @bps.delete_if{|_k, bp| bp.deleted? } end |
#clear_all_breakpoints ⇒ Object
1515 1516 1517 |
# File 'lib/debug/session.rb', line 1515 def clear_all_breakpoints clear_breakpoints{true} end |
#clear_breakpoints(&condition) ⇒ Object
1491 1492 1493 1494 1495 1496 1497 1498 |
# File 'lib/debug/session.rb', line 1491 def clear_breakpoints(&condition) @bps.delete_if do |k, bp| if condition.call(k, bp) bp.delete true end end end |
#clear_catch_breakpoints(*exception_names) ⇒ Object
1509 1510 1511 1512 1513 |
# File 'lib/debug/session.rb', line 1509 def clear_catch_breakpoints *exception_names clear_breakpoints do |k, bp| bp.is_a?(CatchBreakpoint) && exception_names.include?(k[1]) end end |
#clear_line_breakpoints(path) ⇒ Object
1500 1501 1502 1503 1504 1505 1506 1507 |
# File 'lib/debug/session.rb', line 1500 def clear_line_breakpoints path path = resolve_path(path) clear_breakpoints do |k, bp| bp.is_a?(LineBreakpoint) && DEBUGGER__.compare_path(k.first, path) end rescue Errno::ENOENT # just ignore end |
#config_command(arg) ⇒ Object
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 |
# File 'lib/debug/session.rb', line 1224 def config_command arg case arg when nil CONFIG_SET.each do |k, _| config_show k end when /\Aunset\s+(.+)\z/ if CONFIG_SET[key = $1.to_sym] CONFIG[key] = nil end config_show key when /\A(\w+)\s*=\s*(.+)\z/ config_set $1, $2 when /\A\s*set\s+(\w+)\s+(.+)\z/ config_set $1, $2 when /\A(\w+)\s*<<\s*(.+)\z/ config_set $1, $2, append: true when /\A\s*append\s+(\w+)\s+(.+)\z/ config_set $1, $2, append: true when /\A(\w+)\z/ config_show $1 else @ui.puts "Can not parse parameters: #{arg}" end end |
#config_set(key, val, append: false) ⇒ Object
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 |
# File 'lib/debug/session.rb', line 1208 def config_set key, val, append: false if CONFIG_SET[key = key.to_sym] begin if append CONFIG.append_config(key, val) else CONFIG[key] = val end rescue => e @ui.puts e. end end config_show key end |
#config_show(key) ⇒ Object
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
# File 'lib/debug/session.rb', line 1184 def config_show key key = key.to_sym config_detail = CONFIG_SET[key] if config_detail v = CONFIG[key] kv = "#{key} = #{v.inspect}" desc = config_detail[1] if config_default = config_detail[3] desc += " (default: #{config_default})" end line = "%-34s \# %s" % [kv, desc] if line.size > SESSION.width @ui.puts "\# #{desc}\n#{kv}" else @ui.puts line end else @ui.puts "Unknown configuration: #{key}. 'config' shows all configurations." end end |
#dap_event(args) ⇒ Object
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
# File 'lib/debug/server_dap.rb', line 658 def dap_event args # puts({dap_event: args}.inspect) type, req, result = args case type when :backtrace result[:stackFrames].each{|fi| frame_depth = fi[:id] fi[:id] = id = @frame_map.size + 1 @frame_map[id] = [req.dig('arguments', 'threadId'), frame_depth] if fi[:source] if src = fi[:source][:sourceReference] src_id = @src_map.size + 1 @src_map[src_id] = src fi[:source][:sourceReference] = src_id else fi[:source][:sourceReference] = 0 end end } @ui.respond req, result when :scopes frame_id = req.dig('arguments', 'frameId') local_scope = result[:scopes].first local_scope[:variablesReference] = id = @var_map.size + 1 @var_map[id] = [:scope, frame_id] @ui.respond req, result when :scope tid = result.delete :tid register_vars result[:variables], tid @ui.respond req, result when :variable tid = result.delete :tid register_vars result[:variables], tid @ui.respond req, result when :evaluate = result.delete :message if @ui.respond req, success: false, message: else tid = result.delete :tid register_var result, tid @ui.respond req, result end when :completions @ui.respond req, result else raise "unsupported: #{args.inspect}" end end |
#deactivate ⇒ Object
203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/debug/session.rb', line 203 def deactivate get_thread_client.deactivate @thread_stopper.disable @tp_load_script.disable @tp_thread_begin.disable @bps.each_value{|bp| bp.disable} @th_clients.each_value{|thc| thc.close} @tracers.values.each{|t| t.disable} @q_evt.close @ui&.deactivate @ui = nil end |
#delete_bp(arg = nil) ⇒ Object
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 |
# File 'lib/debug/session.rb', line 1387 def delete_bp arg = nil case arg when nil @bps.each{|key, bp| bp.delete} @bps.clear else del_bp = nil iterate_bps{|key, bp, i| del_bp = bp if i == arg} if del_bp del_bp.delete @bps.delete del_bp.key return [arg, del_bp] end end end |
#enter_postmortem_session(exc) ⇒ Object
1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'lib/debug/session.rb', line 1850 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, postmortem_exc: exc ensure @postmortem = false end |
#fail_response(req, **kw) ⇒ Object
726 727 728 729 |
# File 'lib/debug/server_cdp.rb', line 726 def fail_response req, **result @ui.respond_fail req, **result return :retry end |
#find_waiting_tc(id) ⇒ Object
525 526 527 528 529 530 |
# File 'lib/debug/server_dap.rb', line 525 def find_waiting_tc id @th_clients.each{|th, tc| return tc if tc.id == id && tc.waiting? } return nil end |
#get_thread_client(th = Thread.current) ⇒ Object
can be called by other threads
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 |
# File 'lib/debug/session.rb', line 1626 def get_thread_client th = Thread.current if @th_clients.has_key? th @th_clients[th] else if Thread.current == @session_server create_thread_client th else ask_thread_client th end end end |
#get_type(obj) ⇒ Object
FIXME: unify this method with ThreadClient#propertyDescriptor.
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
# File 'lib/debug/server_cdp.rb', line 705 def get_type obj case obj when Array ['object', 'array'] when Hash ['object', 'map'] when String ['string'] when TrueClass, FalseClass ['boolean'] when Symbol ['symbol'] when Integer, Float ['number'] when Exception ['object', 'error'] else ['object'] end end |
#in_subsession? ⇒ Boolean
1715 1716 1717 |
# File 'lib/debug/session.rb', line 1715 def in_subsession? !@subsession_stack.empty? end |
#inspect ⇒ Object
371 372 373 |
# File 'lib/debug/session.rb', line 371 def inspect "DEBUGGER__::SESSION" end |
#intercept_trap_sigint(flag, &b) ⇒ Object
1949 1950 1951 1952 1953 1954 1955 |
# File 'lib/debug/session.rb', line 1949 def intercept_trap_sigint flag, &b prev = @intercept_trap_sigint @intercept_trap_sigint = flag yield ensure @intercept_trap_sigint = prev end |
#intercept_trap_sigint? ⇒ Boolean
1945 1946 1947 |
# File 'lib/debug/session.rb', line 1945 def intercept_trap_sigint? @intercept_trap_sigint end |
#intercept_trap_sigint_end ⇒ Object
1962 1963 1964 1965 1966 |
# File 'lib/debug/session.rb', line 1962 def intercept_trap_sigint_end @intercept_trap_sigint = false prev, @intercepted_sigint_cmd = @intercepted_sigint_cmd, nil prev end |
#intercept_trap_sigint_start(prev) ⇒ Object
1957 1958 1959 1960 |
# File 'lib/debug/session.rb', line 1957 def intercept_trap_sigint_start prev @intercept_trap_sigint = true @intercepted_sigint_cmd = prev end |
#iterate_bps ⇒ Object
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'lib/debug/session.rb', line 1328 def iterate_bps deleted_bps = [] i = 0 @bps.each{|key, bp| if !bp.deleted? yield key, bp, i i += 1 else deleted_bps << bp end } ensure deleted_bps.each{|bp| @bps.delete bp} end |
#managed_thread_clients ⇒ Object
1570 1571 1572 1573 |
# File 'lib/debug/session.rb', line 1570 def managed_thread_clients thcs, _unmanaged_ths = update_thread_list thcs end |
#method_added(tp) ⇒ Object
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 |
# File 'lib/debug/session.rb', line 1767 def method_added tp b = tp.binding if var_name = b.local_variables.first mid = b.local_variable_get(var_name) resolved = true @bps.each{|k, bp| case bp when MethodBreakpoint if bp.method.nil? if bp.sig_method_name == mid.to_s bp.try_enable(added: true) end end resolved = false if !bp.enabled? end } if resolved Session.deactivate_method_added_trackers end case mid when :method_added, :singleton_method_added Session.create_method_added_tracker(tp.self, mid) Session.activate_method_added_trackers unless resolved end end end |
#on_load(iseq, src) ⇒ Object
event
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 |
# File 'lib/debug/session.rb', line 1721 def on_load iseq, src DEBUGGER__.info "Load #{iseq.absolute_path || iseq.path}" file_path, reloaded = @sr.add(iseq, src) @ui.event :load, file_path, reloaded pending_line_breakpoints = @bps.find_all do |key, bp| LineBreakpoint === bp && !bp.iseq end pending_line_breakpoints.each do |_key, bp| if DEBUGGER__.compare_path(bp.path, (iseq.absolute_path || iseq.path)) bp.try_activate iseq end end if reloaded @bps.find_all do |key, bp| LineBreakpoint === bp && DEBUGGER__.compare_path(bp.path, file_path) end.each do |_key, bp| @bps.delete bp.key # to allow duplicate if nbp = LineBreakpoint.copy(bp, iseq) add_bp nbp end end end end |
#on_thread_begin(th) ⇒ Object
1601 1602 1603 1604 1605 1606 1607 |
# File 'lib/debug/session.rb', line 1601 def on_thread_begin th if @th_clients.has_key? th # TODO: NG? else create_thread_client th end end |
#pop_event ⇒ Object
229 230 231 |
# File 'lib/debug/session.rb', line 229 def pop_event @q_evt.pop end |
#postmortem=(is_enable) ⇒ Object
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 |
# File 'lib/debug/session.rb', line 1890 def postmortem=(is_enable) if is_enable unless @postmortem_hook @postmortem_hook = TracePoint.new(:raise){|tp| exc = tp.raised_exception frames = DEBUGGER__.capture_frames(__dir__) exc.instance_variable_set(:@__debugger_postmortem_frames, frames) } at_exit{ @postmortem_hook.disable if CONFIG[:postmortem] && (exc = $!) != nil exc = exc.cause while exc.cause begin @ui.puts "Enter postmortem mode with #{exc.inspect}" @ui.puts exc.backtrace.map{|e| ' ' + e} @ui.puts "\n" enter_postmortem_session exc rescue SystemExit exit! rescue Exception => e @ui = STDERR unless @ui @ui.puts "Error while postmortem console: #{e.inspect}" end end } end if !@postmortem_hook.enabled? @postmortem_hook.enable end else if @postmortem_hook && @postmortem_hook.enabled? @postmortem_hook.disable end end end |
#process_command(line) ⇒ Object
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 |
# File 'lib/debug/session.rb', line 1115 def process_command line if line.empty? if @repl_prev_line line = @repl_prev_line else return :retry end else @repl_prev_line = line end /([^\s]+)(?:\s+(.+))?/ =~ line cmd_name, cmd_arg = $1, $2 if cmd = @commands[cmd_name] check_postmortem if !cmd.postmortem check_unsafe if cmd.unsafe cancel_auto_continue if cmd.cancel_auto_continue @repl_prev_line = nil if !cmd.repeat cmd.block.call(cmd_arg) else @repl_prev_line = nil check_unsafe request_tc [:eval, :pp, line] end rescue Interrupt return :retry rescue SystemExit raise rescue PostmortemError => e @ui.puts e. return :retry rescue Exception => e @ui.puts "[REPL ERROR] #{e.inspect}" @ui.puts e.backtrace.map{|e| ' ' + e} return :retry end |
#process_event(evt) ⇒ Object
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
# File 'lib/debug/session.rb', line 245 def process_event evt # variable `@internal_info` is only used for test tc, output, ev, @internal_info, *ev_args = evt output.each{|str| @ui.puts str} if ev != :suspend # special event, tc is nil # and we don't want to set @tc to the newly created thread's ThreadClient if ev == :thread_begin th = ev_args.shift q = ev_args.shift on_thread_begin th q << true return end @tc = tc case ev when :init enter_subsession wait_command_loop when :load iseq, src = ev_args on_load iseq, src request_tc :continue when :trace trace_id, msg = ev_args if t = @tracers.values.find{|t| t.object_id == trace_id} t.puts msg end request_tc :continue when :suspend enter_subsession if ev_args.first != :replay output.each{|str| @ui.puts str} unless @ui.ignore_output_on_suspend? case ev_args.first when :breakpoint bp, i = bp_index ev_args[1] clean_bps unless bp @ui.event :suspend_bp, i, bp, @tc.id when :trap @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 registered as SIGINT handler." @ui.puts "`sigint` command execute it." end else @ui.event :suspended, @tc.id end if @displays.empty? wait_command_loop else request_tc [:eval, :display, @displays] end when :result raise "[BUG] not in subsession" if @subsession_stack.empty? case ev_args.first when :try_display failed_results = ev_args[1] if failed_results.size > 0 i, _msg = failed_results.last if i+1 == @displays.size @ui.puts "canceled: #{@displays.pop}" end end when :method_breakpoint, :watch_breakpoint bp = ev_args[1] if bp add_bp(bp) show_bps bp else # can't make a bp end when :trace_pass obj_id = ev_args[1] obj_inspect = ev_args[2] opt = ev_args[3] add_tracer ObjectTracer.new(@ui, obj_id, obj_inspect, **opt) else # ignore end wait_command_loop when :dap_result dap_event ev_args # server.rb wait_command_loop when :cdp_result cdp_event ev_args wait_command_loop end end |
#process_info ⇒ Object
1968 1969 1970 1971 1972 |
# File 'lib/debug/session.rb', line 1968 def process_info if @process_group.multi? "#{$0}\##{Process.pid}" end end |
#process_protocol_request(req) ⇒ Object
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'lib/debug/server_cdp.rb', line 734 def process_protocol_request req case req['method'] when 'Debugger.stepOver', 'Debugger.stepInto', 'Debugger.stepOut', 'Debugger.resume', 'Debugger.enable' request_tc [:cdp, :backtrace, req] when 'Debugger.evaluateOnCallFrame' frame_id = req.dig('params', 'callFrameId') group = req.dig('params', 'objectGroup') if fid = @frame_map[frame_id] expr = req.dig('params', 'expression') request_tc [:cdp, :evaluate, req, fid, expr, group] else fail_response req, code: INVALID_PARAMS, message: "'callFrameId' is an invalid" end when 'Runtime.getProperties', 'Runtime.getExceptionDetails' oid = req.dig('params', 'objectId') || req.dig('params', 'errorObjectId') if ref = @obj_map[oid] case ref[0] when 'local' frame_id = ref[1] fid = @frame_map[frame_id] request_tc [:cdp, :scope, req, fid] when 'global' vars = safe_global_variables.sort.map do |name| gv = eval(name.to_s) prop = { name: name, value: { description: gv.inspect }, configurable: true, enumerable: true } type, subtype = get_type(gv) prop[:value][:type] = type prop[:value][:subtype] = subtype if subtype prop end @ui.respond req, result: vars return :retry when 'properties' request_tc [:cdp, :properties, req, oid] when 'exception' request_tc [:cdp, :exception, req, oid] when 'script' # TODO: Support script and global types @ui.respond req, result: [] return :retry else raise "Unknown type: #{ref.inspect}" end else fail_response req, code: INVALID_PARAMS, message: "'objectId' is an invalid" end when 'Debugger.getScriptSource' s_id = req.dig('params', 'scriptId') if src = @src_map[s_id] @ui.respond req, scriptSource: src else fail_response req, code: INVALID_PARAMS, message: "'scriptId' is an invalid" end return :retry when 'Debugger.getPossibleBreakpoints' s_id = req.dig('params', 'start', 'scriptId') if src = @src_map[s_id] lineno = req.dig('params', 'start', 'lineNumber') end_line = src.lines.count lineno = end_line if lineno > end_line @ui.respond req, locations: [{ scriptId: s_id, lineNumber: lineno }] else fail_response req, code: INVALID_PARAMS, message: "'scriptId' is an invalid" end return :retry when 'Debugger.setBreakpointByUrl' path = req.dig('params', 'scriptId') if s_id = @scr_id_map[path] lineno = req.dig('params', 'lineNumber') b_id = req.dig('params', 'breakpointId') @ui.respond req, breakpointId: b_id, locations: [{ scriptId: s_id, lineNumber: lineno }] else fail_response req, code: INTERNAL_ERROR, message: 'The target script is not found...' end return :retry end end |
#prompt ⇒ Object
389 390 391 392 393 394 395 396 397 |
# File 'lib/debug/session.rb', line 389 def prompt if @postmortem '(rdbg:postmortem) ' elsif @process_group.multi? "(rdbg@#{process_info}) " else '(rdbg) ' end end |
#register_default_command ⇒ Object
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 |
# File 'lib/debug/session.rb', line 440 def register_default_command ### Control flow # * `s[tep]` # * Step in. Resume the program until next breakable point. # * `s[tep] <n>` # * Step in, resume the program at `<n>`th breakable point. register_command 's', 'step', repeat: true, cancel_auto_continue: true, postmortem: false do |arg| step_command :in, arg end # * `n[ext]` # * Step over. Resume the program until next line. # * `n[ext] <n>` # * Step over, same as `step <n>`. register_command 'n', 'next', repeat: true, cancel_auto_continue: true, postmortem: false do |arg| step_command :next, arg end # * `fin[ish]` # * Finish this frame. Resume the program until the current frame is finished. # * `fin[ish] <n>` # * Finish `<n>`th frames. register_command 'fin', 'finish', repeat: true, cancel_auto_continue: true, postmortem: false do |arg| if arg&.to_i == 0 raise 'finish command with 0 does not make sense.' end step_command :finish, arg end # * `u[ntil]` # * Similar to `next` command, but only stop later lines or the end of the current frame. # * Similar to gdb's `advance` command. # * `u[ntil] <[file:]line> # * Run til the program reaches given location or the end of the current frame. # * `u[ntil] <name> # * Run til the program invokes a method `<name>`. `<name>` can be a regexp with `/name/`. register_command 'u', 'until', repeat: true, cancel_auto_continue: true, postmortem: false do |arg| step_command :until, arg end # * `c` or `cont` or `continue` # * Resume the program. register_command 'c', 'cont', 'continue', repeat: true, cancel_auto_continue: true do |arg| leave_subsession :continue end # * `q[uit]` or `Ctrl-D` # * Finish debugger (with the debuggee process on non-remote debugging). register_command 'q', 'quit' do |arg| if ask 'Really quit?' @ui.quit arg.to_i do request_tc :quit end leave_subsession :continue else next :retry end end # * `q[uit]!` # * Same as q[uit] but without the confirmation prompt. register_command 'q!', 'quit!', unsafe: false do |arg| @ui.quit arg.to_i do request_tc :quit end leave_subsession :continue end # * `kill` # * Stop the debuggee process with `Kernel#exit!`. register_command 'kill' do |arg| if ask 'Really kill?' exit! (arg || 1).to_i else next :retry end end # * `kill!` # * Same as kill but without the confirmation prompt. register_command 'kill!', unsafe: false do |arg| exit! (arg || 1).to_i end # * `sigint` # * Execute SIGINT handler registered by the debuggee. # * Note that this command should be used just after stop by `SIGINT`. register_command 'sigint' do begin case cmd = @intercepted_sigint_cmd when nil, 'IGNORE', :IGNORE, 'DEFAULT', :DEFAULT # ignore when String eval(cmd) when Proc cmd.call end leave_subsession :continue rescue Exception => e @ui.puts "Exception: #{e}" @ui.puts e.backtrace.map{|line| " #{e}"} next :retry end end ### Breakpoint # * `b[reak]` # * Show all breakpoints. # * `b[reak] <line>` # * Set breakpoint on `<line>` at the current frame's file. # * `b[reak] <file>:<line>` or `<file> <line>` # * Set breakpoint on `<file>:<line>`. # * `b[reak] <class>#<name>` # * Set breakpoint on the method `<class>#<name>`. # * `b[reak] <expr>.<name>` # * Set breakpoint on the method `<expr>.<name>`. # * `b[reak] ... if: <expr>` # * break if `<expr>` is true at specified location. # * `b[reak] ... pre: <command>` # * break and run `<command>` before stopping. # * `b[reak] ... do: <command>` # * break and run `<command>`, and continue. # * `b[reak] ... path: <path>` # * break if the path matches to `<path>`. `<path>` can be a regexp with `/regexp/`. # * `b[reak] if: <expr>` # * break if: `<expr>` is true at any lines. # * Note that this feature is super slow. register_command 'b', 'break', postmortem: false, unsafe: false do |arg| if arg == nil show_bps next :retry else case bp = repl_add_breakpoint(arg) when :noretry when nil next :retry else show_bps bp next :retry end end end # * `catch <Error>` # * Set breakpoint on raising `<Error>`. # * `catch ... if: <expr>` # * stops only if `<expr>` is true as well. # * `catch ... pre: <command>` # * runs `<command>` before stopping. # * `catch ... do: <command>` # * stops and run `<command>`, and continue. # * `catch ... path: <path>` # * stops if the exception is raised from a `<path>`. `<path>` can be a regexp with `/regexp/`. register_command 'catch', postmortem: false, unsafe: false do |arg| if arg bp = repl_add_catch_breakpoint arg show_bps bp if bp else show_bps end :retry end # * `watch @ivar` # * Stop the execution when the result of current scope's `@ivar` is changed. # * Note that this feature is super slow. # * `watch ... if: <expr>` # * stops only if `<expr>` is true as well. # * `watch ... pre: <command>` # * runs `<command>` before stopping. # * `watch ... do: <command>` # * stops and run `<command>`, and continue. # * `watch ... path: <path>` # * stops if the path matches `<path>`. `<path>` can be a regexp with `/regexp/`. register_command 'wat', 'watch', postmortem: false, unsafe: false do |arg| if arg && arg.match?(/\A@\w+/) repl_add_watch_breakpoint(arg) else show_bps :retry end end # * `del[ete]` # * delete all breakpoints. # * `del[ete] <bpnum>` # * delete specified breakpoint. register_command 'del', 'delete', postmortem: false, unsafe: false do |arg| case arg when nil show_bps if ask "Remove all breakpoints?", 'N' delete_bp end when /\d+/ bp = delete_bp arg.to_i else nil end @ui.puts "deleted: \##{bp[0]} #{bp[1]}" if bp :retry end ### Information # * `bt` or `backtrace` # * Show backtrace (frame) information. # * `bt <num>` or `backtrace <num>` # * Only shows first `<num>` frames. # * `bt /regexp/` or `backtrace /regexp/` # * Only shows frames with method name or location info that matches `/regexp/`. # * `bt <num> /regexp/` or `backtrace <num> /regexp/` # * Only shows first `<num>` frames with method name or location info that matches `/regexp/`. register_command 'bt', 'backtrace', unsafe: false do |arg| case arg when /\A(\d+)\z/ request_tc [:show, :backtrace, arg.to_i, nil] when /\A\/(.*)\/\z/ pattern = $1 request_tc [:show, :backtrace, nil, Regexp.compile(pattern)] when /\A(\d+)\s+\/(.*)\/\z/ max, pattern = $1, $2 request_tc [:show, :backtrace, max.to_i, Regexp.compile(pattern)] else request_tc [:show, :backtrace, nil, nil] end end # * `l[ist]` # * Show current frame's source code. # * Next `list` command shows the successor lines. # * `l[ist] -` # * Show predecessor lines as opposed to the `list` command. # * `l[ist] <start>` or `l[ist] <start>-<end>` # * Show current frame's source code from the line <start> to <end> if given. register_command 'l', 'list', repeat: true, unsafe: false do |arg| case arg ? arg.strip : nil when /\A(\d+)\z/ request_tc [:show, :list, {start_line: arg.to_i - 1}] when /\A-\z/ request_tc [:show, :list, {dir: -1}] when /\A(\d+)-(\d+)\z/ request_tc [:show, :list, {start_line: $1.to_i - 1, end_line: $2.to_i}] when nil request_tc [:show, :list] else @ui.puts "Can not handle list argument: #{arg}" :retry end end # * `whereami` # * Show the current frame with source code. register_command 'whereami', unsafe: false do request_tc [:show, :whereami] end # * `edit` # * Open the current file on the editor (use `EDITOR` environment variable). # * Note that edited file will not be reloaded. # * `edit <file>` # * Open <file> on the editor. register_command 'edit' do |arg| if @ui.remote? @ui.puts "not supported on the remote console." next :retry end begin arg = resolve_path(arg) if arg rescue Errno::ENOENT @ui.puts "not found: #{arg}" next :retry end request_tc [:show, :edit, arg] end info_subcommands = nil info_subcommands_abbrev = nil # * `i[nfo]` # * Show information about current frame (local/instance variables and defined constants). # * `i[nfo]` <subcommand> # * `info` has the following sub-commands. # * Sub-commands can be specified with few letters which is unambiguous, like `l` for 'locals'. # * `i[nfo] l or locals or local_variables` # * Show information about the current frame (local variables) # * It includes `self` as `%self` and a return value as `_return`. # * `i[nfo] i or ivars or instance_variables` # * Show information about instance variables about `self`. # * `info ivars <expr>` shows the instance variables of the result of `<expr>`. # * `i[nfo] c or consts or constants` # * Show information about accessible constants except toplevel constants. # * `info consts <expr>` shows the constants of a class/module of the result of `<expr>` # * `i[nfo] g or globals or global_variables` # * Show information about global variables # * `i[nfo] th or threads` # * Show all threads (same as `th[read]`). # * `i[nfo] b or breakpoints or w or watchpoints` # * Show all breakpoints and watchpoints. # * `i[nfo] ... /regexp/` # * Filter the output with `/regexp/`. register_command 'i', 'info', unsafe: false do |arg| if /\/(.+)\/\z/ =~ arg pat = Regexp.compile($1) sub = $~.pre_match.strip else sub = arg end if /\A(.+?)\b(.+)/ =~ sub sub = $1 opt = $2.strip opt = nil if opt.empty? end if sub && !info_subcommands info_subcommands = { locals: %w[ locals local_variables ], ivars: %w[ ivars instance_variables ], consts: %w[ consts constants ], globals:%w[ globals global_variables ], threads:%w[ threads ], breaks: %w[ breakpoints ], watchs: %w[ watchpoints ], } require_relative 'abbrev_command' info_subcommands_abbrev = AbbrevCommand.new(info_subcommands) end if sub sub = info_subcommands_abbrev.search sub, :unknown do |candidates| # note: unreached now @ui.puts "Ambiguous command '#{sub}': #{candidates.join(' ')}" end end case sub when nil request_tc [:show, :default, pat] # something useful when :locals request_tc [:show, :locals, pat] when :ivars request_tc [:show, :ivars, pat, opt] when :consts request_tc [:show, :consts, pat, opt] when :globals request_tc [:show, :globals, pat] when :threads thread_list :retry when :breaks, :watchs show_bps :retry else @ui.puts "unrecognized argument for info command: #{arg}" show_help 'info' :retry end end # * `o[utline]` or `ls` # * Show you available methods, constants, local variables, and instance variables in the current scope. # * `o[utline] <expr>` or `ls <expr>` # * Show you available methods and instance variables of the given object. # * If the object is a class/module, it also lists its constants. register_command 'outline', 'o', 'ls', unsafe: false do |arg| request_tc [:show, :outline, arg] end # * `display` # * Show display setting. # * `display <expr>` # * Show the result of `<expr>` at every suspended timing. register_command 'display', postmortem: false do |arg| if arg && !arg.empty? @displays << arg request_tc [:eval, :try_display, @displays] else request_tc [:eval, :display, @displays] end end # * `undisplay` # * Remove all display settings. # * `undisplay <displaynum>` # * Remove a specified display setting. register_command 'undisplay', postmortem: false, unsafe: false do |arg| case arg when /(\d+)/ if @displays[n = $1.to_i] @displays.delete_at n end request_tc [:eval, :display, @displays] when nil if ask "clear all?", 'N' @displays.clear end :retry end end ### Frame control # * `f[rame]` # * Show the current frame. # * `f[rame] <framenum>` # * Specify a current frame. Evaluation are run on specified frame. register_command 'frame', 'f', unsafe: false do |arg| request_tc [:frame, :set, arg] end # * `up` # * Specify the upper frame. register_command 'up', repeat: true, unsafe: false do |arg| request_tc [:frame, :up] end # * `down` # * Specify the lower frame. register_command 'down', repeat: true, unsafe: false do |arg| request_tc [:frame, :down] end ### Evaluate # * `p <expr>` # * Evaluate like `p <expr>` on the current frame. register_command 'p' do |arg| request_tc [:eval, :p, arg.to_s] end # * `pp <expr>` # * Evaluate like `pp <expr>` on the current frame. register_command 'pp' do |arg| request_tc [:eval, :pp, arg.to_s] end # * `eval <expr>` # * Evaluate `<expr>` on the current frame. register_command 'eval', 'call' do |arg| if arg == nil || arg.empty? show_help 'eval' @ui.puts "\nTo evaluate the variable `#{cmd}`, use `pp #{cmd}` instead." :retry else request_tc [:eval, :call, arg] end end # * `irb` # * Invoke `irb` on the current frame. register_command 'irb' do |arg| if @ui.remote? @ui.puts "not supported on the remote console." :retry end request_tc [:eval, :irb] end ### Trace # * `trace` # * Show available tracers list. # * `trace line` # * Add a line tracer. It indicates line events. # * `trace call` # * Add a call tracer. It indicate call/return events. # * `trace exception` # * Add an exception tracer. It indicates raising exceptions. # * `trace object <expr>` # * Add an object tracer. It indicates that an object by `<expr>` is passed as a parameter or a receiver on method call. # * `trace ... /regexp/` # * Indicates only matched events to `/regexp/`. # * `trace ... into: <file>` # * Save trace information into: `<file>`. # * `trace off <num>` # * Disable tracer specified by `<num>` (use `trace` command to check the numbers). # * `trace off [line|call|pass]` # * Disable all tracers. If `<type>` is provided, disable specified type tracers. register_command 'trace', postmortem: false, unsafe: false do |arg| if (re = /\s+into:\s*(.+)/) =~ arg into = $1 arg.sub!(re, '') end if (re = /\s\/(.+)\/\z/) =~ arg pattern = $1 arg.sub!(re, '') end case arg when nil @ui.puts 'Tracers:' @tracers.values.each_with_index{|t, i| @ui.puts "* \##{i} #{t}" } @ui.puts :retry when /\Aline\z/ add_tracer LineTracer.new(@ui, pattern: pattern, into: into) :retry when /\Acall\z/ add_tracer CallTracer.new(@ui, pattern: pattern, into: into) :retry when /\Aexception\z/ add_tracer ExceptionTracer.new(@ui, pattern: pattern, into: into) :retry when /\Aobject\s+(.+)/ request_tc [:trace, :object, $1.strip, {pattern: pattern, into: into}] when /\Aoff\s+(\d+)\z/ if t = @tracers.values[$1.to_i] t.disable @ui.puts "Disable #{t.to_s}" else @ui.puts "Unmatched: #{$1}" end :retry when /\Aoff(\s+(line|call|exception|object))?\z/ @tracers.values.each{|t| if $2.nil? || t.type == $2 t.disable @ui.puts "Disable #{t.to_s}" end } :retry else @ui.puts "Unknown trace option: #{arg.inspect}" :retry end end # Record # * `record` # * Show recording status. # * `record [on|off]` # * Start/Stop recording. # * `step back` # * Start replay. Step back with the last execution log. # * `s[tep]` does stepping forward with the last log. # * `step reset` # * Stop replay . register_command 'record', postmortem: false, unsafe: false do |arg| case arg when nil, 'on', 'off' request_tc [:record, arg&.to_sym] else @ui.puts "unknown command: #{arg}" :retry end end ### Thread control # * `th[read]` # * Show all threads. # * `th[read] <thnum>` # * Switch thread specified by `<thnum>`. register_command 'th', 'thread', unsafe: false do |arg| case arg when nil, 'list', 'l' thread_list when /(\d+)/ switch_thread $1.to_i else @ui.puts "unknown thread command: #{arg}" end :retry end ### Configuration # * `config` # * Show all configuration with description. # * `config <name>` # * Show current configuration of <name>. # * `config set <name> <val>` or `config <name> = <val>` # * Set <name> to <val>. # * `config append <name> <val>` or `config <name> << <val>` # * Append `<val>` to `<name>` if it is an array. # * `config unset <name>` # * Set <name> to default. register_command 'config', unsafe: false do |arg| config_command arg :retry end # * `source <file>` # * Evaluate lines in `<file>` as debug commands. register_command 'source' do |arg| if arg begin cmds = File.readlines(path = File.(arg)) add_preset_commands path, cmds, kick: true, continue: false rescue Errno::ENOENT @ui.puts "File not found: #{arg}" end else show_help 'source' end :retry end # * `open` # * open debuggee port on UNIX domain socket and wait for attaching. # * Note that `open` command is EXPERIMENTAL. # * `open [<host>:]<port>` # * open debuggee port on TCP/IP with given `[<host>:]<port>` and wait for attaching. # * `open vscode` # * open debuggee port for VSCode and launch VSCode if available. # * `open chrome` # * open debuggee port for Chrome and wait for attaching. register_command 'open' do |arg| case arg&.downcase when '', nil ::DEBUGGER__.open nonstop: true when /\A(\d+)z/ ::DEBUGGER__.open_tcp host: nil, port: $1.to_i, nonstop: true when /\A(.+):(\d+)\z/ ::DEBUGGER__.open_tcp host: $1, port: $2.to_i, nonstop: true when 'tcp' ::DEBUGGER__.open_tcp host: CONFIG[:host], port: (CONFIG[:port] || 0), nonstop: true when 'vscode' CONFIG[:open] = 'vscode' ::DEBUGGER__.open nonstop: true when 'chrome', 'cdp' CONFIG[:open] = 'chrome' ::DEBUGGER__.open_tcp host: CONFIG[:host], port: (CONFIG[:port] || 0), nonstop: true else raise "Unknown arg: #{arg}" end :retry end ### Help # * `h[elp]` # * Show help for all commands. # * `h[elp] <command>` # * Show help for the given command. register_command 'h', 'help', '?', unsafe: false do |arg| show_help arg :retry end end |
#register_var(v, tid) ⇒ Object
710 711 712 713 714 715 716 |
# File 'lib/debug/server_dap.rb', line 710 def register_var v, tid if (tl_vid = v[:variablesReference]) > 0 vid = @var_map.size + 1 @var_map[vid] = [:variable, tid, tl_vid] v[:variablesReference] = vid end end |
#register_vars(vars, tid) ⇒ Object
718 719 720 721 722 723 |
# File 'lib/debug/server_dap.rb', line 718 def register_vars vars, tid raise tid.inspect unless tid.kind_of?(Integer) vars.each{|v| register_var v, tid } end |
#rehash_bps ⇒ Object
1358 1359 1360 1361 1362 1363 1364 |
# File 'lib/debug/session.rb', line 1358 def rehash_bps bps = @bps.values @bps.clear bps.each{|bp| add_bp bp } end |
#remote? ⇒ Boolean
154 155 156 |
# File 'lib/debug/session.rb', line 154 def remote? @ui.remote? end |
#repl_add_breakpoint(arg) ⇒ Object
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 |
# File 'lib/debug/session.rb', line 1430 def repl_add_breakpoint arg expr = parse_break 'break', arg.strip cond = expr[:if] cmd = expr[:cmd] path = expr[:path] case expr[:sig] when /\A(\d+)\z/ add_line_breakpoint @tc.location.path, $1.to_i, cond: cond, command: cmd when /\A(.+)[:\s+](\d+)\z/ add_line_breakpoint $1, $2.to_i, cond: cond, command: cmd when /\A(.+)([\.\#])(.+)\z/ request_tc [:breakpoint, :method, $1, $2, $3, cond, cmd, path] return :noretry when nil add_check_breakpoint cond, path, cmd else @ui.puts "Unknown breakpoint format: #{arg}" @ui.puts show_help 'b' end end |
#repl_add_catch_breakpoint(arg) ⇒ Object
1453 1454 1455 1456 1457 1458 1459 1460 1461 |
# File 'lib/debug/session.rb', line 1453 def repl_add_catch_breakpoint arg expr = parse_break 'catch', arg.strip cond = expr[:if] cmd = expr[:cmd] path = expr[:path] bp = CatchBreakpoint.new(expr[:sig], cond: cond, command: cmd, path: path) add_bp bp end |
#repl_add_watch_breakpoint(arg) ⇒ Object
1463 1464 1465 1466 1467 1468 1469 1470 |
# File 'lib/debug/session.rb', line 1463 def repl_add_watch_breakpoint arg expr = parse_break 'watch', arg.strip cond = expr[:if] cmd = expr[:cmd] path = Regexp.compile(expr[:path]) if expr[:path] request_tc [:breakpoint, :watch, expr[:sig], cond, cmd, path] end |
#request_tc(req) ⇒ Object
241 242 243 |
# File 'lib/debug/session.rb', line 241 def request_tc(req) @tc << req end |
#reset_ui(ui) ⇒ Object
216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/debug/session.rb', line 216 def reset_ui ui @ui.deactivate @ui = ui # activate new ui @tp_thread_begin.disable @ui.activate self if @ui.respond_to?(:reader_thread) && thc = get_thread_client(@ui.reader_thread) thc.mark_as_management end @tp_thread_begin.enable end |
#resolve_path(file) ⇒ Object
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 |
# File 'lib/debug/session.rb', line 1749 def resolve_path file File.realpath(File.(file)) rescue Errno::ENOENT case file when '-e', '-' return file else $LOAD_PATH.each do |lp| libpath = File.join(lp, file) return File.realpath(libpath) rescue Errno::ENOENT # next end end raise end |
#save_int_trap(cmd) ⇒ Object
1940 1941 1942 1943 |
# File 'lib/debug/session.rb', line 1940 def save_int_trap cmd prev, @intercepted_sigint_cmd = @intercepted_sigint_cmd, cmd prev end |
#session_server_main ⇒ Object
233 234 235 236 237 238 239 |
# File 'lib/debug/session.rb', line 233 def session_server_main while evt = pop_event process_event evt end ensure deactivate end |
#set_no_sigint_hook(old, new) ⇒ Object
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 |
# File 'lib/debug/session.rb', line 1929 def set_no_sigint_hook old, new return unless old != new return unless @ui.respond_to? :activate_sigint if old # no -> yes @ui.activate_sigint else @ui.deactivate_sigint end end |
#setup_threads ⇒ Object
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 |
# File 'lib/debug/session.rb', line 1588 def setup_threads prev_clients = @th_clients @th_clients = {} Thread.list.each{|th| if tc = prev_clients[th] @th_clients[th] = tc else create_thread_client(th) end } end |
#show_bps(specific_bp = nil) ⇒ Object
1343 1344 1345 1346 1347 |
# File 'lib/debug/session.rb', line 1343 def show_bps specific_bp = nil iterate_bps do |key, bp, i| @ui.puts "#%d %s" % [i, bp.to_s] if !specific_bp || bp == specific_bp end end |
#show_help(arg = nil) ⇒ Object
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 |
# File 'lib/debug/session.rb', line 1264 def show_help arg = nil instructions = (DEBUGGER__.commands.keys + DEBUGGER__.commands.values).uniq print_instructions = proc do |desc| desc.split("\n").each do |line| next if line.start_with?(" ") # workaround for step back formatted_line = line.gsub(/[\[\]\*]/, "").strip instructions.each do |inst| if formatted_line.start_with?("`#{inst}") desc.sub!(line, colorize(line, [:CYAN, :BOLD])) end end end @ui.puts desc end print_category = proc do |cat| @ui.puts "\n" @ui.puts colorize("### #{cat}", [:GREEN, :BOLD]) @ui.puts "\n" end DEBUGGER__.helps.each { |cat, cs| # categories if arg.nil? print_category.call(cat) else cs.each { |ws, _| if ws.include?(arg) print_category.call(cat) break end } end # instructions cs.each { |ws, desc| if arg.nil? || ws.include?(arg) print_instructions.call(desc.dup) return if arg end } } @ui.puts "not found: #{arg}" if arg end |
#source(iseq) ⇒ Object
363 364 365 366 367 368 369 |
# File 'lib/debug/session.rb', line 363 def source iseq if !CONFIG[:no_color] @sr.get_colored(iseq) else @sr.get(iseq) end end |
#step_command(type, arg) ⇒ Object
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 |
# File 'lib/debug/session.rb', line 1156 def step_command type, arg if type == :until leave_subsession [:step, type, arg] return end case arg when nil, /\A\d+\z/ if type == :in && @tc.recorder&. request_tc [:step, type, arg&.to_i] else leave_subsession [:step, type, arg&.to_i] end when /\A(back)\z/, /\A(back)\s+(\d+)\z/, /\A(reset)\z/ if type != :in @ui.puts "only `step #{arg}` is supported." :retry else type = $1.to_sym iter = $2&.to_i request_tc [:step, type, iter] end else @ui.puts "Unknown option: #{arg}" :retry end end |
#stop_stepping?(file, line, subsession_id = nil) ⇒ Boolean
158 159 160 161 162 163 164 165 166 |
# File 'lib/debug/session.rb', line 158 def stop_stepping? file, line, subsession_id = nil if @bps.has_key? [file, line] true elsif subsession_id && @subsession_id != subsession_id true else false end end |
#switch_thread(n) ⇒ Object
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 |
# File 'lib/debug/session.rb', line 1575 def switch_thread n thcs, _unmanaged_ths = update_thread_list if tc = thcs[n] if tc.waiting? @tc = tc else @ui.puts "#{tc.thread} is not controllable yet." end end thread_list end |
#thread_list ⇒ Object
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 |
# File 'lib/debug/session.rb', line 1556 def thread_list thcs, unmanaged_ths = update_thread_list thcs.each_with_index{|thc, i| @ui.puts "#{@tc == thc ? "--> " : " "}\##{i} #{thc}" } if !unmanaged_ths.empty? @ui.puts "The following threads are not managed yet by the debugger:" unmanaged_ths.each{|th| @ui.puts " " + th.to_s } end end |
#update_thread_list ⇒ Object
threads
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 |
# File 'lib/debug/session.rb', line 1538 def update_thread_list list = Thread.list thcs = [] unmanaged = [] list.each{|th| if thc = @th_clients[th] if !thc.management? thcs << thc end else unmanaged << th end } return thcs.sort_by{|thc| thc.id}, unmanaged end |
#wait_command ⇒ Object
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/debug/session.rb', line 399 def wait_command if @preset_command if @preset_command.commands.empty? if @preset_command.auto_continue @preset_command = nil leave_subsession :continue return else @preset_command = nil return :retry end else line = @preset_command.commands.shift @ui.puts "(rdbg:#{@preset_command.source}) #{line}" end else @ui.puts "INTERNAL_INFO: #{JSON.generate(@internal_info)}" if ENV['RUBY_DEBUG_TEST_UI'] == 'terminal' line = @ui.readline prompt end case line when String process_command line when Hash process_protocol_request line # defined in server.rb else raise "unexpected input: #{line.inspect}" end end |
#wait_command_loop ⇒ Object
375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/debug/session.rb', line 375 def wait_command_loop loop do case wait_command when :retry # nothing else break end rescue Interrupt @ui.puts "\n^C" retry end end |
#width ⇒ Object
1834 1835 1836 |
# File 'lib/debug/session.rb', line 1834 def width @ui.width end |