Module: DEBUGGER__
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Classes:
Breakpoint ,
CallTracer ,
CatchBreakpoint ,
CheckBreakpoint ,
Client ,
Config ,
Console ,
ExceptionTracer ,
FrameInfo ,
ISeqBreakpoint ,
LimitedPP ,
LineBreakpoint ,
LineTracer ,
MethodBreakpoint ,
ObjectTracer ,
PresetCommand ,
ProcessGroup ,
Session ,
SourceRepository ,
ThreadClient ,
Tracer ,
UI_Base ,
UI_LocalConsole ,
UI_ServerBase ,
UI_TcpServer ,
UI_UnixDomainServer ,
WatchIVarBreakpoint | |
Exceptions:
| |
Defined in: | lib/debug/client.rb, lib/debug/breakpoint.rb, lib/debug/color.rb, lib/debug/config.rb, lib/debug/console.rb, lib/debug/frame_info.rb, lib/debug/local.rb, lib/debug/server.rb, lib/debug/server_cdp.rb, lib/debug/server_dap.rb, lib/debug/session.rb, lib/debug/source_repository.rb, lib/debug/thread_client.rb, lib/debug/tracer.rb, lib/debug/version.rb |
Overview
$VERBOSE = true
Constant Summary
-
CONFIG =
# File 'lib/debug/config.rb', line 404 -
CONFIG_MAP =
# File 'lib/debug/config.rb', line 56CONFIG_SET.map{|k, (ev, _)| [k, ev]}.to_h.freeze
-
CONFIG_SET =
# File 'lib/debug/config.rb', line 13{ # UI setting log_level: ['RUBY_DEBUG_LOG_LEVEL', "UI: Log level same as Logger", :loglevel, "WARN"], show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint", :int, "10"], show_frames: ['RUBY_DEBUG_SHOW_FRAMES', "UI: Show n frames on breakpoint", :int, "2"], use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)", :bool, "false"], no_color: ['RUBY_DEBUG_NO_COLOR', "UI: Do not use colorize", :bool, "false"], no_sigint_hook: ['RUBY_DEBUG_NO_SIGINT_HOOK', "UI: Do not suspend on SIGINT", :bool, "false"], no_reline: ['RUBY_DEBUG_NO_RELINE', "UI: Do not use Reline library", :bool, "false"], no_hint: ['RUBY_DEBUG_NO_HINT', "UI: Do not show the hint on the REPL", :bool, "false"], # control setting skip_path: ['RUBY_DEBUG_SKIP_PATH', "CONTROL: Skip showing/entering frames for given paths", :path], skip_nosrc: ['RUBY_DEBUG_SKIP_NOSRC', "CONTROL: Skip on no source code lines", :bool, "false"], keep_alloc_site:['RUBY_DEBUG_KEEP_ALLOC_SITE',"CONTROL: Keep allocation site and p, pp shows it", :bool, "false"], postmortem: ['RUBY_DEBUG_POSTMORTEM', "CONTROL: Enable postmortem debug", :bool, "false"], fork_mode: ['RUBY_DEBUG_FORK_MODE', "CONTROL: Control which process activates a debugger after fork (both/parent/child)", :forkmode, "both"], sigdump_sig: ['RUBY_DEBUG_SIGDUMP_SIG', "CONTROL: Sigdump signal", :bool, "false"], # boot setting nonstop: ['RUBY_DEBUG_NONSTOP', "BOOT: Nonstop mode", :bool, "false"], stop_at_load: ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location", :bool, "false"], init_script: ['RUBY_DEBUG_INIT_SCRIPT', "BOOT: debug command script path loaded at first stop"], commands: ['RUBY_DEBUG_COMMANDS', "BOOT: debug commands invoked at first stop. commands should be separated by ';;'"], no_rc: ['RUBY_DEBUG_NO_RC', "BOOT: ignore loading ~/.rdbgrc(.rb)", :bool, "false"], history_file: ['RUBY_DEBUG_HISTORY_FILE',"BOOT: history file", :string, "~/.rdbg_history"], save_history: ['RUBY_DEBUG_SAVE_HISTORY',"BOOT: maximum save history lines", :int, "10000"], # remote setting port: ['RUBY_DEBUG_PORT', "REMOTE: TCP/IP remote debugging: port"], host: ['RUBY_DEBUG_HOST', "REMOTE: TCP/IP remote debugging: host", :string, "127.0.0.1"], sock_path: ['RUBY_DEBUG_SOCK_PATH', "REMOTE: UNIX Domain Socket remote debugging: socket path"], sock_dir: ['RUBY_DEBUG_SOCK_DIR', "REMOTE: UNIX Domain Socket remote debugging: socket directory"], local_fs_map: ['RUBY_DEBUG_LOCAL_FS_MAP', "REMOTE: Specify local fs map", :path_map], skip_bp: ['RUBY_DEBUG_SKIP_BP', "REMOTE: Skip breakpoints if no clients are attached", :bool, 'false'], cookie: ['RUBY_DEBUG_COOKIE', "REMOTE: Cookie for negotiation"], open_frontend: ['RUBY_DEBUG_OPEN_FRONTEND',"REMOTE: frontend used by open command (vscode, chrome, default: rdbg)."], chrome_path: ['RUBY_DEBUG_CHROME_PATH', "REMOTE: Platform dependent path of Chrome (For more information, See [here](https://github.com/ruby/debug/pull/334/files#diff-5fc3d0a901379a95bc111b86cf0090b03f857edfd0b99a0c1537e26735698453R55-R64))"], # obsolete parent_on_fork: ['RUBY_DEBUG_PARENT_ON_FORK', "OBSOLETE: Keep debugging parent process on fork", :bool, "false"], }.freeze
-
LOG_LEVELS =
# File 'lib/debug/config.rb', line 4{ UNKNOWN: 0, FATAL: 1, ERROR: 2, WARN: 3, INFO: 4, DEBUG: 5 }.freeze
-
M_CLASS =
# File 'lib/debug/thread_client.rb', line 11method(:class).unbind
-
M_INSTANCE_VARIABLES =
# File 'lib/debug/thread_client.rb', line 9method(:instance_variables).unbind
-
M_INSTANCE_VARIABLE_GET =
# File 'lib/debug/thread_client.rb', line 10method(:instance_variable_get).unbind
-
M_KIND_OF_P =
# File 'lib/debug/thread_client.rb', line 13method(:kind_of?).unbind
-
M_METHOD =
# File 'lib/debug/thread_client.rb', line 15method(:method).unbind
-
M_OBJECT_ID =
# File 'lib/debug/thread_client.rb', line 16method(:object_id).unbind
-
M_RESPOND_TO_P =
# File 'lib/debug/thread_client.rb', line 14method(:respond_to?).unbind
-
M_SINGLETON_CLASS =
# File 'lib/debug/thread_client.rb', line 12method(:singleton_class).unbind
-
SHORT_INSPECT_LENGTH =
Inspector
40
-
VERSION =
# File 'lib/debug/version.rb', line 4"1.6.3"
Class Method Summary
- .add_catch_breakpoint(pat)
-
.add_line_breakpoint(file, line, **kw)
manual configuration methods.
-
.check_dir_authority(path)
Unix domain socket configuration.
- .check_loglevel(level)
- .commands
-
.compare_path(a, b)
For case insensitive file system (like Windows) Note that this check is not enough because case sensitive/insensitive is depend on the file system.
- .create_unix_domain_socket_name(base_dir = unix_domain_socket_dir)
- .create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir)
- .debug(&b)
- .help
- .helps
- .info(msg)
- .load_rc
- .log(level, msg)
- .open(host: nil, port: , sock_path: nil, sock_dir: nil, nonstop: false, **kw)
- .open_tcp(host: nil, port:, nonstop: false, **kw)
- .open_unix(sock_path: nil, sock_dir: nil, nonstop: false, **kw)
-
.parse_help
Help.
-
.require_location
String for requiring location nil for -r.
- .safe_inspect(obj, max_length: SHORT_INSPECT_LENGTH, short: false)
-
.setup_initial_suspend
boot utilities.
-
.start(nonstop: false, **kw)
start methods.
- .step_in(&b)
- .unix_domain_socket_dir
- .unix_domain_socket_homedir
- .unix_domain_socket_tmpdir
- .warn(msg)
Class Method Details
.add_catch_breakpoint(pat)
[ GitHub ]# File 'lib/debug/session.rb', line 2004
def self.add_catch_breakpoint pat ::DEBUGGER__::SESSION.add_catch_breakpoint pat end
.add_line_breakpoint(file, line, **kw)
manual configuration methods
# File 'lib/debug/session.rb', line 2000
def self.add_line_breakpoint file, line, **kw ::DEBUGGER__::SESSION.add_line_breakpoint file, line, **kw end
.check_dir_authority(path)
Unix domain socket configuration
# File 'lib/debug/config.rb', line 408
def self. path fs = File.stat(path) unless (dir_uid = fs.uid) == (uid = Process.uid) raise "#{path} uid is #{dir_uid}, but Process.uid is #{uid}" end unless (dir_mode = fs.mode) == 040700 # 4: dir, 7:rwx raise "#{path}'s mode is #{dir_mode.to_s(8)} (should be 040700)" end path end
.check_loglevel(level)
[ GitHub ]# File 'lib/debug/session.rb', line 2188
def self.check_loglevel level lv = LOG_LEVELS[level] config_lv = LOG_LEVELS[CONFIG[:log_level]] lv <= config_lv end
.commands
[ GitHub ]# File 'lib/debug/config.rb', line 508
def self.commands (defined?(@commands) && @commands) || (parse_help; @commands) end
.compare_path(a, b)
For case insensitive file system (like Windows) Note that this check is not enough because case sensitive/insensitive is depend on the file system. So this check is only roughly estimation.
See additional method definition at line 2233.
# File 'lib/debug/session.rb', line 2237
def self.compare_path(a, b) a&.downcase == b&.downcase end
.create_unix_domain_socket_name(base_dir = unix_domain_socket_dir)
[ GitHub ]# File 'lib/debug/config.rb', line 466
def self.create_unix_domain_socket_name(base_dir = unix_domain_socket_dir) create_unix_domain_socket_name_prefix(base_dir) + "-#{Process.pid}" end
.create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir)
[ GitHub ]# File 'lib/debug/config.rb', line 461
def self.create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir) user = ENV['USER'] || 'UnknownUser' File.join(base_dir, "ruby-debug-#{user}") end
.debug(&b)
[ GitHub ]# File 'lib/debug/session.rb', line 2194
def self.debug(&b) if check_loglevel :DEBUG log :DEBUG, b.call end end
.help
[ GitHub ]# File 'lib/debug/config.rb', line 512
def self.help r = [] self.helps.each{|cat, cmds| r << "### #{cat}" r << '' cmds.each{|_, desc| r << desc } r << '' } r.join("\n") end
.helps
[ GitHub ]# File 'lib/debug/config.rb', line 504
def self.helps (defined?(@helps) && @helps) || parse_help end
.info(msg)
[ GitHub ]# File 'lib/debug/session.rb', line 2184
def self.info msg log :INFO, msg end
.load_rc
[ GitHub ]# File 'lib/debug/session.rb', line 2104
def self.load_rc [[File. ('~/.rdbgrc'), true], [File. ('~/.rdbgrc.rb'), true], # ['./.rdbgrc', true], # disable because of security concern [CONFIG[:init_script], false], ].each{|(path, rc)| next unless path next if rc && CONFIG[:no_rc] # ignore rc if File.file? path if path.end_with?('.rb') load path else ::DEBUGGER__::SESSION.add_preset_commands path, File.readlines(path) end elsif !rc warn "Not found: #{path}" end } # given debug commands if CONFIG[:commands] cmds = CONFIG[:commands].split(';;') ::DEBUGGER__::SESSION.add_preset_commands "commands", cmds, kick: false, continue: false end end
.log(level, msg)
[ GitHub ]# File 'lib/debug/session.rb', line 2200
def self.log level, msg if check_loglevel level @logfile = STDERR unless defined? @logfile if defined? SESSION pi = SESSION.process_info process_info = pi ? "[#{pi}]" : nil end if level == :WARN # :WARN on debugger is general information @logfile.puts "DEBUGGER#{process_info}: #{msg}" @logfile.flush else @logfile.puts "DEBUGGER#{process_info} (#{level}): #{msg}" @logfile.flush end end end
.open(host: nil, port: , sock_path: nil, sock_dir: nil, nonstop: false, **kw)
[ GitHub ]# File 'lib/debug/session.rb', line 2038
def self.open host: nil, port: CONFIG[:port], sock_path: nil, sock_dir: nil, nonstop: false, **kw CONFIG.set_config(**kw) require_relative 'server' if port || CONFIG[:open_frontend] == 'chrome' || (!::Addrinfo.respond_to?(:unix)) open_tcp host: host, port: (port || 0), nonstop: nonstop else open_unix sock_path: sock_path, sock_dir: sock_dir, nonstop: nonstop end end
.open_tcp(host: nil, port:, nonstop: false, **kw)
[ GitHub ]# File 'lib/debug/session.rb', line 2049
def self.open_tcp host: nil, port:, nonstop: false, **kw CONFIG.set_config(**kw) require_relative 'server' if defined? SESSION SESSION.reset_ui UI_TcpServer.new(host: host, port: port) else initialize_session{ UI_TcpServer.new(host: host, port: port) } end setup_initial_suspend unless nonstop end
.open_unix(sock_path: nil, sock_dir: nil, nonstop: false, **kw)
[ GitHub ]# File 'lib/debug/session.rb', line 2062
def self.open_unix sock_path: nil, sock_dir: nil, nonstop: false, **kw CONFIG.set_config(**kw) require_relative 'server' if defined? SESSION SESSION.reset_ui UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path) else initialize_session{ UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path) } end setup_initial_suspend unless nonstop end
.parse_help
Help
# File 'lib/debug/config.rb', line 472
def self.parse_help helps = Hash.new{|h, k| h[k] = []} desc = cat = nil cmds = Hash.new File.read(File.join(__dir__, 'session.rb'), encoding: Encoding::UTF_8).each_line do |line| case line when /\A\s*### (.+)/ cat = $1 break if $1 == 'END' when /\A when (.+)/ next unless cat next unless desc ws = $1.split(/,\s*/).map{|e| e.gsub('\'', '')} helps[cat] << [ws, desc] desc = nil max_w = ws.max_by{|w| w.length} ws.each{|w| cmds[w] = max_w } when /\A\s+# (\s*\*.+)/ if desc desc << "\n" + $1 else desc = $1 end end end @commands = cmds @helps = helps end
.require_location
String for requiring location nil for -r
# File 'lib/debug/session.rb', line 2010
def self.require_location locs = caller_locations dir_prefix = /#{Regexp.escape(__dir__)}/ locs.each do |loc| case loc.absolute_path when dir_prefix when %r{rubygems/core_ext/kernel_require\.rb} else return loc if loc.absolute_path end end nil end
.safe_inspect(obj, max_length: SHORT_INSPECT_LENGTH, short: false)
[ GitHub ]# File 'lib/debug/session.rb', line 2162
def self.safe_inspect obj, max_length: SHORT_INSPECT_LENGTH, short: false if short LimitedPP.pp(obj, max_length) else obj.inspect end rescue NoMethodError => e klass, oid = M_CLASS.bind_call(obj), M_OBJECT_ID.bind_call(obj) if obj == (r = e.receiver) "<\##{klass.name}#{oid} does not have \#inspect>" else rklass, roid = M_CLASS.bind_call(r), M_OBJECT_ID.bind_call(r) "<\##{klass.name}:#{roid} contains <\##{rklass}:#{roid} and it does not have #inspect>" end rescue Exception => e "<#inspect raises #{e.inspect}>" end
.setup_initial_suspend
boot utilities
# File 'lib/debug/session.rb', line 2077
def self.setup_initial_suspend if !CONFIG[:nonstop] case when CONFIG[:stop_at_load] add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true, hook_call: false nil # stop here when path = ENV['RUBY_DEBUG_INITIAL_SUSPEND_PATH'] add_line_breakpoint path, 0, oneshot: true, hook_call: false when loc = ::DEBUGGER__.require_location # require 'debug/start' or 'debug' add_line_breakpoint loc.absolute_path, loc.lineno + 1, oneshot: true, hook_call: false else # -r add_line_breakpoint $0, 0, oneshot: true, hook_call: false end end end
.start(nonstop: false, **kw)
start methods
# File 'lib/debug/session.rb', line 2027
def self.start nonstop: false, **kw CONFIG.set_config(**kw) unless defined? SESSION require_relative 'local' initialize_session{ UI_LocalConsole.new } end setup_initial_suspend unless nonstop end
.step_in(&b)
[ GitHub ]# File 'lib/debug/session.rb', line 2220
def self.step_in &b if defined?(SESSION) && SESSION.active? SESSION.add_iseq_breakpoint RubyVM::InstructionSequence.of(b), oneshot: true end yield end
.unix_domain_socket_dir
[ GitHub ]# File 'lib/debug/config.rb', line 448
def self.unix_domain_socket_dir case when path = CONFIG[:sock_dir] when path = ENV['XDG_RUNTIME_DIR'] when path = unix_domain_socket_tmpdir when path = unix_domain_socket_homedir else raise 'specify RUBY_DEBUG_SOCK_DIR environment variable.' end path end
.unix_domain_socket_homedir
[ GitHub ]# File 'lib/debug/config.rb', line 436
def self.unix_domain_socket_homedir if home = ENV['HOME'] path = File.join(home, '.ruby-debug-sock') unless File.exist?(path) Dir.mkdir(path, 0700) end (path) end end
.unix_domain_socket_tmpdir
[ GitHub ]# File 'lib/debug/config.rb', line 421
def self.unix_domain_socket_tmpdir require 'tmpdir' if tmpdir = Dir.tmpdir path = File.join(tmpdir, "ruby-debug-sock-#{Process.uid}") unless File.exist?(path) d = Dir.mktmpdir File.rename(d, path) end (path) end end
.warn(msg)
[ GitHub ]# File 'lib/debug/session.rb', line 2180
def self.warn msg log :WARN, msg end