rbtrace 0.4.9 → 0.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8cd3dd5d2826625fbf017e93f76f52edbaa0b83
-  data.tar.gz: 50b49986ffdeab614a9076c5f861738c9d4e4a70
+SHA256:
+  metadata.gz: 78fc8aa96b3b20a4663ceaef1253f41443689e85f344a9efecb60c240e85183b
+  data.tar.gz: 2f2ab561dfe12096dcbe28ff188d07e34af48bbed936f09bbc0dd23309132bea
 SHA512:
-  metadata.gz: ab75bcf6469ae23f80ec62e520e840710ef912e7080ef69474821e38077a9893a1a16d812048d3d47d990ffbe79e4d2dc075ed9367484835e240b35257f22dee
-  data.tar.gz: 9a2ce4b26b191f1064ba30601a37f4b0f8e6490bb1dec9776720bbcd4935653c823db45f1381d09d0f00b9735a8c0bab31e772985da0524c7f72b7ed17d4ebf1
+  metadata.gz: 1710793189ea23b9048c68ff61c1c7f52202b4e7770991e4c049f9b1b069dbbe4fd71f59e2e79a06d34c4c15628073d0498175fcbb64572152c22b9636557a09
+  data.tar.gz: 315c8c2bc040cf790e4964a93ee9f50b97f9b2b7718f71790e8af36cb2d1fe01d529da06fd6b346747e45fc82b52b2fde6fd62bf9053010e8e93d38f76e575fe

data/.gitignore

@@ -1,3 +1,5 @@
 *.gem
 .bundle
 ext/src/msgpack*
+tmp/*
+Gemfile.lock

data/README.md

@@ -14,6 +14,11 @@ in production.
     % gem install rbtrace
     % rbtrace --help
 
+## supported Rubies
+
+rbtrace supports all stable versions of Ruby MRI, as of 23-01-2018 this is
+Ruby version 2.2 and later.
+
 ## tracer types
 
 rbtrace has several different tracing modes.
@@ -34,6 +39,14 @@ rbtrace has several different tracing modes.
 
     % rbtrace -p <PID> --gc
 
+### memory: produce a basic memory report regarding process (including GC.stat and ObjectSpace stats)
+
+    % rbtrace -p <PID> --memory
+
+### backtraces: return backtraces for all active threads in a process
+
+    % rbtrace -p <PID> --backtraces
+
 ### notes
 
 `--firehose` is not reliable on osx.
@@ -193,6 +206,7 @@ for popular ruby libraries and functions.
 
 ## todo
 
+* correct irb implementation so it establishes a dedicated channel
 * add triggers to start tracing slow methods only inside another method
 * add watch expressions to fire tracers only when an expression is true
 * add special expressions for method args (_arg0_, _arguments_)

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+desc "Compile the c extension"
+task :compile do
+  if File.exist?("ext/Makefile")
+    system "(cd ext && make clean)"
+  end
+  system "(cd ext && ruby extconf.rb)"
+  system "(cd ext && make)"
+end
+
+task :build => :compile
+
+

data/ext/extconf.rb

@@ -13,7 +13,7 @@ require 'fileutils'
 
 libdir = File.basename RbConfig::CONFIG['libdir']
 
-unless File.exists?("#{CWD}/dst/#{libdir}/libmsgpackc.a")
+unless File.exist?("#{CWD}/dst/#{libdir}/libmsgpackc.a")
   Logging.message "Building msgpack\n"
 
   msgpack = File.basename('msgpack-1.1.0.tar.gz')
@@ -28,7 +28,7 @@ unless File.exists?("#{CWD}/dst/#{libdir}/libmsgpackc.a")
   end
 
   Dir.chdir('src') do
-    FileUtils.rm_rf(dir) if File.exists?(dir)
+    FileUtils.rm_rf(dir) if File.exist?(dir)
 
     sys("tar zxvfo #{msgpack}")
     Dir.chdir(dir) do

data/ext/rbtrace.c

@@ -22,6 +22,7 @@
 
 #include <msgpack.h>
 #include <ruby.h>
+#include <ruby/debug.h>
 
 #ifndef RUBY_VM
 #include <env.h>
@@ -51,6 +52,11 @@
 #endif
 
 
+// The SUN_LEN macro is not available on Android
+#ifndef SUN_LEN
+#define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) + strlen((ptr)->sun_path))
+#endif
+
 static uint64_t
 ru_utime_usec()
 {
@@ -688,7 +694,7 @@ rbtracer_add(char *query, bool is_slow)
       *idx = NULL,
       *method = NULL;
 
-    if (NULL != (idx = rindex(query, '.'))) {
+    if (NULL != (idx = strrchr(query, '.'))) {
       klass_begin = 0;
       klass_end = idx - query;
       is_singleton = true;
@@ -700,7 +706,7 @@ rbtracer_add(char *query, bool is_slow)
 
       method = idx+1;
 
-    } else if (NULL != (idx = rindex(query, '#'))) {
+    } else if (NULL != (idx = strrchr(query, '#'))) {
       klass_begin = 0;
       klass_end = idx - query;
       is_singleton = false;
@@ -862,6 +868,20 @@ msgq_setup()
 #endif
 }
 
+static VALUE rbtrace_module;
+
+static VALUE
+eval_inspect(VALUE rb_code) {
+  return rb_funcall(rbtrace_module, rb_intern("eval_and_inspect"), 1, rb_code);
+}
+
+static VALUE
+rescue_inspect(VALUE arg) {
+  VALUE exception = rb_errinfo(); /* get last exception */
+  rb_set_errinfo(Qnil);
+  return rb_funcall(exception, rb_intern("inspect"), 0);
+}
+
 static void
 rbtrace__process_event(msgpack_object cmd)
 {
@@ -1012,8 +1032,10 @@ rbtrace__process_event(msgpack_object cmd)
     strncpy(query, str.ptr, str.size);
     query[str.size] = 0;
 
-    snprintf(code, BUF_SIZE+150, "(begin; %s; rescue Exception => e; e; end).inspect", query);
-    val = rb_eval_string_protect(code, 0);
+    VALUE rb_code;
+    rb_code = rb_str_new2(query);
+
+    val = rb_rescue(eval_inspect, rb_code, rescue_inspect, Qnil);
 
     if (TYPE(val) == T_STRING) {
       rbtrace__send_event(1,
@@ -1021,7 +1043,6 @@ rbtrace__process_event(msgpack_object cmd)
         's', RSTRING_PTR(val)
       );
     }
-
   }
 }
 
@@ -1102,9 +1123,40 @@ signal_handler_wrapper(VALUE arg, VALUE ctx)
 }
 #endif
 
+static VALUE
+send_write(VALUE klass, VALUE val) {
+  if (TYPE(val) == T_STRING) {
+    rbtrace__send_event(1,
+      "write",
+      's', RSTRING_PTR(val)
+    );
+  }
+
+  return Qnil;
+}
+
 void
 Init_rbtrace()
 {
+  rbtrace_module = rb_define_module("RBTrace");
+  VALUE output = rb_define_module_under(rbtrace_module, "OUT");
+
+  rb_define_singleton_method(output, "write", send_write, 1);
+
+  rb_eval_string(
+    "module RBTrace\n"
+    "  def self.eval_context\n"
+    "    @eval_context ||= binding\n"
+    "  end\n"
+
+    "  def self.eval_and_inspect(code)\n"
+    "    t = Thread.new { Thread.current[:output] = eval_context.eval(code).inspect }\n"
+    "    t.join\n"
+    "    t[:output]\n"
+    "  end\n"
+    "end\n"
+  );
+
   // hook into the gc
   gc_hook = Data_Wrap_Struct(rb_cObject, rbtrace_gc_mark, NULL, NULL);
   rb_global_variable(&gc_hook);

data/lib/rbtrace/cli.rb

@@ -1,4 +1,4 @@
-require 'trollop'
+require 'optimist'
 require 'rbtrace/rbtracer'
 require 'rbtrace/version'
 
@@ -12,7 +12,7 @@ class RBTraceCLI
   #
   # Returns nothing.
   def self.check_msgmnb
-    if File.exists?(msgmnb = "/proc/sys/kernel/msgmnb")
+    if File.exist?(msgmnb = "/proc/sys/kernel/msgmnb")
       curr = File.read(msgmnb).to_i
       max = 1024*1024
       cmd = "sysctl kernel.msgmnb=#{max}"
@@ -34,7 +34,7 @@ class RBTraceCLI
   # Returns nothing.
   def self.cleanup_queues
     if (pids = `ps ax -o pid`.split("\n").map{ |p| p.strip.to_i }).any?
-      ipcs = `ipcs -q`.split("\n").grep(/^(q|0x)/).map{ |line| line[/(0x[a-f0-9]+)/,1] }
+      ipcs = `ipcs -q`.split("\n").grep(/^(q|0x)/).map{ |line| line[/(0x[a-f0-9]+)/,1] }.compact
       ipcs.each do |ipci|
         next if ipci.match(/^0xf/)
 
@@ -54,7 +54,7 @@ class RBTraceCLI
     check_msgmnb
     cleanup_queues
 
-    parser = Trollop::Parser.new do
+    parser = Optimist::Parser.new do
       version <<-EOS
 rbtrace: like strace, but for ruby code
   version #{RBTracer::VERSION}
@@ -197,6 +197,12 @@ EOS
         :default => 'irb',
         :short => '-i'
 
+      opt :backtraces,
+        "get backtraces for all threads in current process, -1 denotes all frames",
+        :type => String,
+        :default => '-1',
+        :short => '-b'
+
       opt :backtrace,
         "get lines from the current backtrace in the process",
         :type => :int
@@ -209,10 +215,20 @@ EOS
       opt :timeout,
         "seconds to wait before giving up on attach/detach/eval",
         :default => 5
+
+      opt :memory,
+        "report on process memory usage"
+
+
+      opt :heapdump,
+        "generate a heap dump for the process in FILENAME",
+        :default => "AUTO",
+        :short => "-h"
+
     end
 
-    opts = Trollop.with_standard_exception_handling(parser) do
-      raise Trollop::HelpNeeded if ARGV.empty?
+    opts = Optimist.with_standard_exception_handling(parser) do
+      raise Optimist::HelpNeeded if ARGV.empty?
       parser.stop_on '--exec'
       parser.parse(ARGV)
     end
@@ -224,8 +240,8 @@ EOS
       ARGV.clear
     end
 
-    unless %w[ fork eval interactive backtrace slow slowcpu firehose methods config gc ].find{ |n| opts[:"#{n}_given"] }
-      $stderr.puts "Error: --slow, --slowcpu, --gc, --firehose, --methods, --interactive or --config required."
+    unless %w[ fork eval interactive backtrace backtraces slow slowcpu firehose methods config gc memory heapdump].find{ |n| opts[:"#{n}_given"] }
+      $stderr.puts "Error: --slow, --slowcpu, --gc, --firehose, --methods, --interactive, --backtraces, --backtrace, --memory, --heapdump or --config required."
       $stderr.puts "Try --help for help."
       exit(-1)
     end
@@ -257,7 +273,7 @@ EOS
         file = [
           config,
           File.expand_path("../../../tracers/#{config}.tracer", __FILE__)
-        ].find{ |f| File.exists?(f) }
+        ].find{ |f| File.exist?(f) }
 
         unless file
           parser.die :config, '(file does not exist)'
@@ -285,18 +301,32 @@ EOS
       if filtered.size > 0
         max_len = filtered.size.to_s.size
 
-        STDERR.puts "*** found #{filtered.size} processes matching #{opts[:ps].inspect}"
+        STDERR.puts "*** found #{filtered.size} process#{filtered.size == 1 ? "" : "es"} matching #{opts[:ps].inspect}"
         filtered.each_with_index do |line, i|
-          STDERR.puts "   [#{(i+1).to_s.rjust(max_len)}]   #{line.strip}"
+          prefix = "   [#{(i+1).to_s.rjust(max_len)}]   "
+          if filtered.length == 1
+            prefix = ""
+          end
+          STDERR.puts "#{prefix}#{line.strip}"
+        end
+
+        if filtered.length > 1
+          STDERR.puts   "   [#{'0'.rjust(max_len)}]   all #{filtered.size} processes"
         end
-        STDERR.puts   "   [#{'0'.rjust(max_len)}]   all #{filtered.size} processes"
 
         while true
           STDERR.sync = true
-          STDERR.print "*** trace which processes? (0/1,4): "
+
+          if filtered.length > 1
+            STDERR.print "*** trace which processes? (0/1,4): "
+          end
 
           begin
-            input = gets
+            if filtered.length == 1
+              input = "1"
+            else
+              input = gets
+            end
           rescue Interrupt
             exit 1
           end
@@ -372,9 +402,9 @@ EOS
             end
           rescue Interrupt, SignalException
             STDERR.puts "*** waiting on child tracers: #{tracers.inspect}"
-            tracers.each do |pid|
+            tracers.each do |pid1|
               begin
-                Process.kill 'INT', pid
+                Process.kill 'INT', pid1
               rescue Errno::ESRCH
               end
             end
@@ -413,6 +443,65 @@ EOS
           tracer.puts res[1..-2].split('|').join("\n  ")
         end
 
+      elsif opts[:backtraces_given]
+        num = opts[:backtraces].to_i
+        num = -1 if num == 0
+
+        delim = "146621c9d681409aa"
+
+        code = "Thread.list.map{|t| t.backtrace[0...#{num}].join(\"#{delim}\")}.join(\"#{delim*2}\")"
+
+        if res = tracer.eval(code)
+          tracer.puts res.split(delim).join("\n")
+        end
+
+      elsif opts[:memory_given]
+        memory_report = File.expand_path('../memory_report.rb', __FILE__)
+
+        require 'tempfile'
+        output = Tempfile.new("output")
+        output.close
+
+        begin
+          code = "Thread.new do; begin; output = '#{output.path}'; eval(File.read('#{memory_report}')); end; end"
+          tracer.eval(code)
+
+          File.open(output.path, 'r') do |f|
+            while true
+              begin
+                unless line = f.readline
+                  sleep 0.1
+                  next
+                end
+
+                if line.strip == "__END__"
+                  break
+                else
+                  print line
+                end
+              rescue EOFError
+                sleep 0.1
+              end
+            end
+          end
+        ensure
+          output.unlink
+        end
+
+      elsif opts[:heapdump_given]
+        filename = opts[:heapdump]
+
+        if filename == "AUTO"
+          require 'tempfile'
+          temp = Tempfile.new("dump")
+          filename = temp.path
+          temp.close
+          temp.unlink
+        end
+
+        tracer.eval("file = File.open('#{filename}', 'w'); ObjectSpace.dump_all(output: file); file.close")
+        puts "Heapdump being written to #{filename}"
+
       elsif opts[:eval_given]
         if res = tracer.eval(code = opts[:eval])
           tracer.puts ">> #{code}"

data/lib/rbtrace/memory_report.rb

@@ -0,0 +1,20 @@
+output
+fork do
+  file = File.new(output, 'w')
+
+  file.puts "GC Stats",""
+  GC.stat.each do |k, v|
+    file.puts "#{k}: #{v}"
+  end
+
+  file.puts "", "Object Stats", ""
+  require 'objspace'
+  ObjectSpace.count_objects.sort{|a,b| b[1] <=> a[1]}.each do |k, v|
+    file.puts "#{k}: #{v}"
+  end
+
+
+  file.puts "__END__"
+  file.flush
+  file.close
+end

data/lib/rbtrace/rbtracer.rb

@@ -96,7 +96,7 @@ class RBTracer
   end
 
   def clean_socket_path
-    FileUtils.rm(socket_path) if File.exists?(socket_path)
+    FileUtils.rm(socket_path) if File.exist?(socket_path)
   end
 
   # Watch for method calls slower than a threshold.
@@ -321,7 +321,9 @@ class RBTracer
   def send_cmd(*cmd)
     begin
       msg = cmd.to_msgpack
-      raise ArgumentError, 'command is too long' if msg.bytesize > MsgQ::EventMsg::BUF_SIZE
+      # A message is null-terminated, but bytesize gives the unterminated
+      # length.
+      raise ArgumentError, 'command is too long' if msg.bytesize >= MsgQ::EventMsg::BUF_SIZE
       MsgQ::EventMsg.send_cmd(@qo, msg)
     rescue Errno::EINTR
       retry
@@ -575,6 +577,10 @@ class RBTracer
         puts if @watch_slow
       end
 
+    when 'write'
+      data, = *cmd
+      STDOUT.write(data)
+
     else
       puts "unknown event #{event}: #{cmd.inspect}"
 

data/lib/rbtrace/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RBTracer
-  VERSION = '0.4.9'
+  VERSION = '0.4.14'
 end

data/rbtrace.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('../lib/rbtrace/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -8,15 +10,20 @@ Gem::Specification.new do |s|
   s.authors = 'Aman Gupta'
   s.email   = 'aman@tmm1.net'
 
+  s.require_paths = ['lib', 'ext']
+
   s.files = `git ls-files`.split("\n")
   s.extensions = 'ext/extconf.rb'
 
   s.bindir = 'bin'
   s.executables << 'rbtrace'
 
-  s.add_dependency 'ffi',     '>= 1.0.6'
-  s.add_dependency 'trollop', '>= 1.16.2'
-  s.add_dependency 'msgpack', '>= 0.4.3'
+
+  s.add_dependency 'ffi',      '>= 1.0.6'
+  s.add_dependency 'optimist', '>= 3.0.0'
+  s.add_dependency 'msgpack',  '>= 0.4.3'
+
+  s.add_development_dependency "rake", "~> 10.0"
 
   s.license = "MIT"
   s.summary = 'rbtrace: like strace but for ruby code'

data/server.rb

@@ -1,4 +1,5 @@
 require 'ext/rbtrace'
+require 'tmpdir'
 
 class String
   def multiply_vowels(num)
@@ -26,19 +27,21 @@ end
 
 while true
   proc {
-    Dir.chdir("/tmp") do
-      Dir.pwd
-      Process.pid
-      'hello'.multiply_vowels(3){ :ohai }
-      sleep rand*0.5
+    Dir.mktmpdir do |tmp|
+      Dir.chdir(tmp) do
+        Dir.pwd
+        Process.pid
+        'hello'.multiply_vowels(3){ :ohai }
+        sleep rand*0.5
 
-      ENV['blah']
-      GC.start
+        ENV['blah']
+        GC.start
 
-      reload_test.call
-      Test.run
+        reload_test.call
+        Test.run
 
-      #fib(1024*100)
+        #fib(1024*100)
+      end
     end
   }.call
 end

data/tracers/activerecord.tracer

@@ -1,3 +1,4 @@
+ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter#execute(sql)
 ActiveRecord::ConnectionAdapters::MysqlAdapter#execute(sql)
 ActiveRecord::ConnectionAdapters::PostgreSQLAdapter#execute(sql)
 ActiveRecord::ConnectionAdapters::SQLiteAdapter#execute(sql)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbtrace
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.14
 platform: ruby
 authors:
 - Aman Gupta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.6
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: rbtrace shows you method calls happening inside another ruby process
   in real time.
 email: aman@tmm1.net
@@ -63,9 +77,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/rbtrace
 - ext/.gitignore
 - ext/extconf.rb
@@ -75,6 +89,7 @@ files:
 - lib/rbtrace/core_ext.rb
 - lib/rbtrace/interactive/irb.rb
 - lib/rbtrace/interactive/rib.rb
+- lib/rbtrace/memory_report.rb
 - lib/rbtrace/msgq.rb
 - lib/rbtrace/rbtracer.rb
 - lib/rbtrace/version.rb
@@ -92,10 +107,11 @@ homepage: http://github.com/tmm1/rbtrace
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: 'rbtrace: like strace but for ruby code'
 test_files: []

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rbtrace (0.4.7)
-      ffi (>= 1.0.6)
-      msgpack (>= 0.4.3)
-      trollop (>= 1.16.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ffi (1.9.8)
-    msgpack (0.6.0)
-    trollop (2.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rbtrace!