rbtrace 0.4.10 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574f273f971a108d9e994a3f236c3722a649d13093f75a371249dbe6556bc6f0
-  data.tar.gz: 2aa00597a8016c8359276314b61d3bc43948f8db343423821b3015dcbe1be60b
+  metadata.gz: 4f3359258e6653201d552f93b489b28f9ed236f40cd97c25159b71c17ccce383
+  data.tar.gz: 34b549e2ef09227390289c04cdb0d0471cb7de47cbce122d0f10ec01508cd0d8
 SHA512:
-  metadata.gz: 1c79741a8c653395f4b371caf63f1e1e2c67aa109446ee6365543aad68bd58508808768c5c28ba96eae3db5fa760c2914dc68e66d095bf6806e130ea50511577
-  data.tar.gz: 7d4d8f89d2d6c63f635db87801d592a7bfffb2aa48f415e534a1ec3f9c30c55046315dd4394a804b91f7c81599d411ebab8f8168b3cbd8041b547d2b0c04a4ae
+  metadata.gz: fce946eecd139e0e99d8ce7f62e213a22426b8b291b3abe5a79840eecc467fd276b722850d76e3aff88cb151eb01151c641e90b9b719d72af5f1e8adf97110d6
+  data.tar.gz: 528a254aa1e7c5ced2d1d1306ae659e33c30dd39a612976de42822a417a77e88916b90138acc12905de4c9aaa6feabc124a091526f261286e4e00252320eb777

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+---
+name: Test
+on: [push, pull_request]
+
+jobs:
+  ruby:
+    name: Ruby ${{ matrix.ruby }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        ruby: ["3.2", "3.1", "3.0", "2.7", "2.6"]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Tests
+        run: ./test.sh

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 ext/src/msgpack*
 tmp/*
+Gemfile.lock

data/CHANGELOG

@@ -0,0 +1,11 @@
+- 0.5.1 - 19-12-2023
+
+- Fix: RbTrace was used incorrectly instead of RBTrace, which lead to a broken build
+
+- 0.5.0 - 02-12-2023
+
+- Improved --backtraces implementation
+- Added --shapedump which is useful for lighter weight object shape dumps on Ruby 3.2 and up
+- Move heap dumping to a fork for better performance
+- Use TypedData API which has been supported for a very long time
+- Update CI and fix some small errors

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
@@ -63,11 +63,6 @@ have_func('rb_during_gc', 'ruby.h')
 have_func('rb_gc_add_event_hook', ['ruby.h', 'node.h'])
 have_func('rb_postponed_job_register_one', 'ruby.h')
 
-# increase message size on linux
-if RUBY_PLATFORM =~ /linux/
-  $defs.push("-DBUF_SIZE=256")
-end
-
 # warnings save lives
 $CFLAGS << " -Wall "
 

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()
 {
@@ -73,7 +79,7 @@ timeofday_usec()
 #define MAX_TRACERS 100 // max method tracers
 #define MAX_EXPRS 10    // max expressions per tracer
 #ifndef BUF_SIZE        // msgq buffer size
-#define BUF_SIZE 120
+#define BUF_SIZE 1024
 #endif
 
 typedef struct {
@@ -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,18 @@ 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) {
+  return rb_funcall(exception, rb_intern("inspect"), 0);
+}
+
 static void
 rbtrace__process_event(msgpack_object cmd)
 {
@@ -871,7 +889,6 @@ rbtrace__process_event(msgpack_object cmd)
   static int last_tracer_id = -1; // hax
   char query[BUF_SIZE];
 
-  char code[BUF_SIZE+150];
   VALUE val = Qnil;
 
   msgpack_object_array ary;
@@ -1012,8 +1029,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 +1040,6 @@ rbtrace__process_event(msgpack_object cmd)
         's', RSTRING_PTR(val)
       );
     }
-
   }
 }
 
@@ -1102,12 +1120,38 @@ 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;
+}
+
+static const rb_data_type_t rbtrace_type = {
+    "RBTrace",
+    {
+        rbtrace_gc_mark,
+    }
+};
+
 void
 Init_rbtrace()
 {
+  rbtrace_module = rb_define_module("RBTrace");
+  VALUE output = rb_define_module_under(rbtrace_module, "OUT");
+
+  rb_const_set(rbtrace_module, rb_intern("BUF_SIZE"), INT2NUM(BUF_SIZE));
+
+  rb_define_singleton_method(output, "write", send_write, 1);
+
   // hook into the gc
-  gc_hook = Data_Wrap_Struct(rb_cObject, rbtrace_gc_mark, NULL, NULL);
   rb_global_variable(&gc_hook);
+  gc_hook = TypedData_Wrap_Struct(rb_cObject, &rbtrace_type, NULL);
 
   // catch signal telling us to read from the msgq
 #if defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE)

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}
@@ -225,10 +225,13 @@ EOS
         :default => "AUTO",
         :short => "-h"
 
+      opt :shapesdump,
+        "generate a shapes dump for the process in FILENAME",
+        :default => "AUTO"
     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
@@ -241,7 +244,7 @@ EOS
     end
 
     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 "Error: --slow, --slowcpu, --gc, --firehose, --methods, --interactive, --backtraces, --backtrace, --memory, --heapdump, --shapesdump or --config required."
       $stderr.puts "Try --help for help."
       exit(-1)
     end
@@ -273,7 +276,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)'
@@ -449,7 +452,7 @@ EOS
 
         delim = "146621c9d681409aa"
 
-        code = "Thread.list.map{|t| t.backtrace[0...#{num}].join(\"#{delim}\")}.join(\"#{delim*2}\")"
+        code = "Thread.list.reject { |t| t.name == '__RBTrace__' }.map{ |t| t.backtrace[0...#{num}].join(\"#{delim}\")}.join(\"#{delim*2}\")"
 
         if res = tracer.eval(code)
           tracer.puts res.split(delim).join("\n")
@@ -499,9 +502,47 @@ EOS
           temp.unlink
         end
 
-        tracer.eval("file = File.open('#{filename}', 'w'); ObjectSpace.dump_all(output: file); file.close")
+        tracer.eval(<<-RUBY)
+          Thread.new do
+            Thread.current.name = '__RBTrace__'
+            pid = ::Process.fork do
+              file = File.open('#{filename}.tmp', 'w')
+              ObjectSpace.dump_all(output: file)
+              file.close
+              File.rename('#{filename}.tmp', '#{filename}')
+              exit!(0)
+            end
+            Process.waitpid(pid)
+          end
+        RUBY
         puts "Heapdump being written to #{filename}"
 
+      elsif opts[:shapesdump_given]
+        filename = opts[:shapesdump]
+
+        if filename == "AUTO"
+          require 'tempfile'
+          temp = Tempfile.new("dump")
+          filename = temp.path
+          temp.close
+          temp.unlink
+        end
+
+        tracer.eval(<<-RUBY)
+          Thread.new do
+            Thread.current.name = '__RBTrace__'
+            pid = ::Process.fork do
+              file = File.open('#{filename}.tmp', 'w')
+              ObjectSpace.dump_shapes(output: file)
+              file.close
+              File.rename('#{filename}.tmp', '#{filename}')
+              exit!(0)
+            end
+            Process.waitpid(pid)
+          end
+        RUBY
+        puts "Shapes dump being written to #{filename}"
+
       elsif opts[:eval_given]
         if res = tracer.eval(code = opts[:eval])
           tracer.puts ">> #{code}"

data/lib/rbtrace/core_ext.rb

@@ -1,7 +1,3 @@
-class String
-  alias :bytesize :size
-end unless ''.respond_to?(:bytesize)
-
 module FFI::LastError
   Errnos = Errno::constants.map(&Errno.method(:const_get)).inject({}) do |hash, c|
     hash[ c.const_get(:Errno) ] = c

data/lib/rbtrace/msgq.rb

@@ -1,3 +1,4 @@
+require 'rbtrace'
 require 'ffi'
 
 module MsgQ
@@ -5,7 +6,7 @@ module MsgQ
   ffi_lib FFI::CURRENT_PROCESS
 
   class EventMsg < FFI::Struct
-    BUF_SIZE = RUBY_PLATFORM =~ /linux/ ? 256 : 120
+    BUF_SIZE = RBTrace::BUF_SIZE
     IPC_NOWAIT = 004000
 
     layout :mtype, :long,

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,11 @@ 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.
+      if msg.bytesize >= RBTrace::BUF_SIZE
+        raise ArgumentError, "command is too long (#{msg.bytesize}B >= #{MsgQ::EventMsg::BUF_SIZE}B)"
+      end
       MsgQ::EventMsg.send_cmd(@qo, msg)
     rescue Errno::EINTR
       retry
@@ -575,6 +579,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.10'
+  VERSION = "0.5.1"
 end

data/lib/rbtrace.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RBTrace
+  class << self
+    def eval_and_inspect(code)
+      t = Thread.new do
+        Thread.current.name = '__RBTrace__'
+        Thread.current[:output] = eval_context.eval(code).inspect
+      end
+      t.join
+      t[:output]
+    end
+
+    private
+
+    def eval_context
+      @eval_context ||= binding
+    end
+  end
+end
+
+require 'rbtrace.so'

data/rbtrace.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   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.add_development_dependency "rake"
 
   s.license = "MIT"
   s.summary = 'rbtrace: like strace but for ruby code'

data/server.rb

@@ -1,4 +1,5 @@
-require 'ext/rbtrace'
+require '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/test.sh

@@ -12,7 +12,7 @@ cd ..
 bundle check
 export RUBYOPT="-I.:lib"
 
-ruby server.rb &
+bundle exec ruby server.rb &
 export PID=$!
 
 trap cleanup INT TERM
@@ -23,11 +23,11 @@ cleanup() {
 
 trace() {
   echo ------------------------------------------
-  echo ./bin/rbtrace -p $PID $*
+  echo ./bin/rbtrace -p $PID "$@"
   echo ------------------------------------------
-  ./bin/rbtrace -p $PID $* &
+  bundle exec ./bin/rbtrace -p $PID "$@" &
   sleep 2
-  kill $!
+  kill $! || true
   wait $! || true
   echo
 }
@@ -37,6 +37,8 @@ trace -m sleep
 trace -m sleep Dir.chdir Dir.pwd Process.pid "String#gsub" "String#*"
 trace -m "Kernel#"
 trace -m "String#gsub(self,@test)" "String#*(self,__source__)" "String#multiply_vowels(self,self.length,num)"
+trace -e 'p(1 + 1)'
+trace -h
 trace --gc --slow=200
 trace --gc -m Dir.
 trace --slow=250

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.10
+  version: 0.5.1
 platform: ruby
 authors:
 - Aman Gupta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2023-12-19 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
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: rbtrace shows you method calls happening inside another ruby process
   in real time.
 email: aman@tmm1.net
@@ -75,9 +75,10 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- CHANGELOG
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -86,6 +87,7 @@ files:
 - ext/extconf.rb
 - ext/rbtrace.c
 - ext/src/msgpack-1.1.0.tar.gz
+- lib/rbtrace.rb
 - lib/rbtrace/cli.rb
 - lib/rbtrace/core_ext.rb
 - lib/rbtrace/interactive/irb.rb
@@ -108,7 +110,7 @@ homepage: http://github.com/tmm1/rbtrace
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,9 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: 'rbtrace: like strace but for ruby code'
 test_files: []

data/Gemfile.lock

@@ -1,25 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rbtrace (0.4.10)
-      ffi (>= 1.0.6)
-      msgpack (>= 0.4.3)
-      trollop (>= 1.16.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ffi (1.9.18)
-    msgpack (1.2.2)
-    rake (10.5.0)
-    trollop (2.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 10.0)
-  rbtrace!
-
-BUNDLED WITH
-   1.16.1