rbtrace 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffdcce16c0cb92399ccb6684be8b23628703d420786b53ed035164d184e72488
-  data.tar.gz: 987b982955f4af23e247d4155a9ff134bdf2231e5443024a5357c7df14f581ef
+  metadata.gz: 9628477734dcb6ba5d9e02abbcb0c599b74764cf1b4cf385958adc77caafc21b
+  data.tar.gz: 9fe0cc77c6f3dc2a98e7890bbefae1058f7a1f5258d3f3443785ca970d524496
 SHA512:
-  metadata.gz: 536787701408f0763ccf9345e6e4715cc2bf057e99f6be69d00ad431dc7685898267a2a76235d29875128711c87192d91e1b281dbe889579779321da66b3c1ca
-  data.tar.gz: 1fc1fd4f82e5ac0808e7f95f518a2f989902c7fe424a9a67f63632aca41e6a47a405a46a77022b618f32664b476a5b550e8e4d0aa1c27fe630e3916d82b27c84
+  metadata.gz: b487fa9ff0ed5b62d9a030057f72e8a55279b2ede600a27376895f3497a0f073882ff2ef536c0d92a960703207b8337b1cb07245a23b8e4b1e856c8bef55a961
+  data.tar.gz: a9286d573871f902c7a73f1b9f9eaa5138d84835c7849bbd37ee460678f0cb02412fb0ce7d8760d1f0accdf20120cf6370147b4521dffd4a662964ae0eb72f5d

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        ruby: ["4.0", "3.4", "3.3", "3.2"]
+        ruby: ["ruby-head", "4.0", "3.4", "3.3", "3.2"]
     runs-on: ubuntu-latest
     steps:
       - name: Check out code

data/CHANGELOG

@@ -1,3 +1,10 @@
+- 0.5.5 - 07-08-2026
+
+- Add Ruby 4.1 support by using the current postponed-job and block callback APIs
+- Fix native command handling to validate MessagePack input, release native memory, and reject invalid tracer IDs
+- Fix traced expressions to avoid the deprecated ObjectSpace._id2ref API
+- Fix --heapdump and --shapesdump by loading objspace before using its dump APIs
+
 - 0.5.4 - 19-05-2026
 
 - Fix --interactive irb mode not printing eval results
@@ -5,21 +12,20 @@
 - 0.5.3 - 03-12-2025
 
 - Fix --interactive irb mode
-- Fix: Build failures with C23 (#100)
 
-- 0.5.2 - 05-13-2025
+- 0.5.2 - 13-05-2025
 
 - Specify void* argument in rbtrace_gc_mark()'s signature, as expected by rb_data_type_t.
   This was a warning before C23 but it's now an error, and GCC 15 defaults to C23.
 
 - 0.5.1 - 19-12-2023
 
-- Fix: RbTrace was used incorrectly instead of RBTrace, which lead to a broken build
+- Fix: RbTrace was used incorrectly instead of RBTrace, which led 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
+- Added --shapesdump 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

@@ -61,6 +61,8 @@ end
 
 have_func('rb_during_gc', 'ruby.h')
 have_func('rb_gc_add_event_hook', ['ruby.h', 'node.h'])
+have_func('rb_postponed_job_preregister', ['ruby.h', 'ruby/debug.h'])
+have_func('rb_postponed_job_trigger', ['ruby.h', 'ruby/debug.h'])
 have_func('rb_postponed_job_register_one', 'ruby.h')
 
 # warnings save lives

data/ext/rbtrace.c

@@ -307,6 +307,18 @@ rbtrace__send_names(ID mid, VALUE klass)
   }
 }
 
+typedef struct {
+  VALUE proc;
+  VALUE receiver;
+} expr_proc_call_t;
+
+static VALUE
+call_expr_proc(VALUE data)
+{
+  expr_proc_call_t *args = (expr_proc_call_t *)data;
+  return rb_funcall(args->proc, rb_intern("call"), 1, args->receiver);
+}
+
 static int in_event_hook = 0;
 
 static void
@@ -491,8 +503,16 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
             val = rb_inspect(rb_ivar_get(self, rb_intern(expr)));
 
           } else {
-            snprintf(buffer, len+150, "(begin; ObjectSpace._id2ref(%ld).instance_eval{ %s }; rescue Exception => e; e; end).inspect", NUM2LONG(rb_obj_id(self)), expr);
-            val = rb_eval_string_protect(buffer, 0);
+            int state = 0;
+            VALUE expr_proc;
+            expr_proc_call_t args;
+            snprintf(buffer, len+150, "proc { |__rbtrace_receiver__| (begin; __rbtrace_receiver__.instance_eval { %s }; rescue Exception => e; e; end).inspect }", expr);
+            expr_proc = rb_eval_string_protect(buffer, &state);
+            if (state == 0) {
+              args.proc = expr_proc;
+              args.receiver = self;
+              val = rb_protect(call_expr_proc, (VALUE)&args, &state);
+            }
           }
 
           if (RTEST(val) && TYPE(val) == T_STRING) {
@@ -590,10 +610,12 @@ rbtracer_remove(char *query, int id)
       }
     }
   } else {
-    if (id >= MAX_TRACERS) goto out;
+    if (id < 0 || id >= MAX_TRACERS) goto out;
     tracer = &rbtracer.list[id];
   }
 
+  if (!tracer) goto out;
+
   if (tracer->query) {
     tracer_id = tracer->id;
     tracer->mid = 0;
@@ -735,10 +757,16 @@ rbtracer_add(char *query, bool is_slow)
       goto out;
   }
 
+  char *query_copy = strdup(query);
+  if (!query_copy) {
+    tracer_id = -1;
+    goto out;
+  }
+
   memset(tracer, 0, sizeof(*tracer));
 
   tracer->id = tracer_id;
-  tracer->query = strdup(query);
+  tracer->query = query_copy;
   tracer->is_slow = is_slow;
 
   if (klass_end != klass_begin) {
@@ -774,15 +802,19 @@ rbtracer_add_expr(int id, char *expr)
   int tracer_id = -1;
   rbtracer_t *tracer = NULL;
 
-  if (id >= MAX_TRACERS) goto out;
+  if (id < 0 || id >= MAX_TRACERS) goto out;
   tracer = &rbtracer.list[id];
 
   if (tracer->query) {
     tracer_id = tracer->id;
 
     if (tracer->num_exprs < MAX_EXPRS) {
-      expr_id = tracer->num_exprs++;
-      tracer->exprs[expr_id] = strdup(expr);
+      char *expr_copy = strdup(expr);
+      if (!expr_copy) goto out;
+
+      expr_id = tracer->num_exprs;
+      tracer->exprs[expr_id] = expr_copy;
+      tracer->num_exprs++;
     }
   }
 
@@ -1043,6 +1075,20 @@ rbtrace__process_event(msgpack_object cmd)
   }
 }
 
+static VALUE
+rbtrace__process_unpacked_event(VALUE data)
+{
+  rbtrace__process_event(*(msgpack_object *)data);
+  return Qnil;
+}
+
+static VALUE
+rbtrace__destroy_unpacked(VALUE data)
+{
+  msgpack_unpacked_destroy((msgpack_unpacked *)data);
+  return Qnil;
+}
+
 static void
 rbtrace__receive(void *data)
 {
@@ -1060,7 +1106,7 @@ rbtrace__receive(void *data)
   int n = 0;
 
   while (true) {
-    int ret = -1;
+    ssize_t ret = -1;
 
     for (n=0; n<10 && ret==-1; n++)
       ret = msgrcv(rbtracer.mqi_id, &msg, sizeof(msg)-sizeof(long), 0, IPC_NOWAIT);
@@ -1071,10 +1117,17 @@ rbtrace__receive(void *data)
       msgpack_unpacked unpacked;
       msgpack_unpacked_init(&unpacked);
 
-      bool success = msgpack_unpack_next(&unpacked, msg.buf, sizeof(msg.buf), NULL);
-      if (!success) continue;
+      msgpack_unpack_return unpack_result = msgpack_unpack_next(&unpacked, msg.buf, (size_t)ret, NULL);
+      if (unpack_result != MSGPACK_UNPACK_SUCCESS &&
+          unpack_result != MSGPACK_UNPACK_EXTRA_BYTES) {
+        msgpack_unpacked_destroy(&unpacked);
+        continue;
+      }
 
-      rbtrace__process_event(unpacked.data);
+      rb_ensure(
+        rbtrace__process_unpacked_event, (VALUE)&unpacked.data,
+        rbtrace__destroy_unpacked, (VALUE)&unpacked
+      );
     }
   }
 }
@@ -1092,11 +1145,20 @@ rbtrace_gc_mark(void *ptr)
 
 static VALUE gc_hook;
 
-#if defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE) || !defined(RUBY_VM)
+#if defined(HAVE_RB_POSTPONED_JOB_PREREGISTER) && defined(HAVE_RB_POSTPONED_JOB_TRIGGER)
+#define RBTRACE_USE_PREREGISTERED_POSTPONED_JOB 1
+static rb_postponed_job_handle_t rbtrace_postponed_job_handle = POSTPONED_JOB_HANDLE_INVALID;
+#endif
+
+#if defined(RBTRACE_USE_PREREGISTERED_POSTPONED_JOB) || defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE) || !defined(RUBY_VM)
 static void
 sigurg(int signal)
 {
-#if defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE)
+#if defined(RBTRACE_USE_PREREGISTERED_POSTPONED_JOB)
+  if (rbtrace_postponed_job_handle != POSTPONED_JOB_HANDLE_INVALID) {
+    rb_postponed_job_trigger(rbtrace_postponed_job_handle);
+  }
+#elif defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE)
   rb_postponed_job_register_one(0, rbtrace__receive, 0);
 #else
   rbtrace__receive(0);
@@ -1104,10 +1166,10 @@ sigurg(int signal)
 }
 #endif
 
-#if !defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE) && defined(RUBY_VM)
+#if defined(RUBY_VM) && (defined(RBTRACE_USE_PREREGISTERED_POSTPONED_JOB) || !defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE))
 static VALUE signal_handler_proc;
 static VALUE
-signal_handler_wrapper(VALUE arg, VALUE ctx)
+signal_handler_wrapper(RB_BLOCK_CALL_FUNC_ARGLIST(arg, ctx))
 {
   static int in_signal_handler = 0;
   if (in_signal_handler) return Qnil;
@@ -1118,6 +1180,14 @@ signal_handler_wrapper(VALUE arg, VALUE ctx)
 
   return Qnil;
 }
+
+static void
+install_ruby_sigurg_handler(void)
+{
+  signal_handler_proc = rb_proc_new(signal_handler_wrapper, Qnil);
+  rb_global_variable(&signal_handler_proc);
+  rb_funcall(Qnil, rb_intern("trap"), 2, rb_str_new_cstr("URG"), signal_handler_proc);
+}
 #endif
 
 static VALUE
@@ -1154,12 +1224,25 @@ Init_rbtrace()
   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)
+#if defined(RBTRACE_USE_PREREGISTERED_POSTPONED_JOB)
+  rbtrace_postponed_job_handle = rb_postponed_job_preregister(0, rbtrace__receive, 0);
+  if (rbtrace_postponed_job_handle == POSTPONED_JOB_HANDLE_INVALID) {
+
+#ifdef RUBY_VM
+    rb_warn("rbtrace: failed to preregister postponed job; falling back to Ruby SIGURG handler");
+    install_ruby_sigurg_handler();
+#else
+    rb_raise(rb_eRuntimeError, "rbtrace: failed to preregister postponed job");
+#endif
+
+  } else {
+    signal(SIGURG, sigurg);
+  }
+
+#elif defined(HAVE_RB_POSTPONED_JOB_REGISTER_ONE)
   signal(SIGURG, sigurg);
 #elif defined(RUBY_VM)
-  signal_handler_proc = rb_proc_new(signal_handler_wrapper, Qnil);
-  rb_global_variable(&signal_handler_proc);
-  rb_funcall(Qnil, rb_intern("trap"), 2, rb_str_new_cstr("URG"), signal_handler_proc);
+  install_ruby_sigurg_handler();
 #else
   signal(SIGURG, sigurg);
 #endif

data/lib/rbtrace/cli.rb

@@ -243,7 +243,7 @@ EOS
       ARGV.clear
     end
 
-    unless %w[ fork eval interactive backtrace backtraces slow slowcpu firehose methods config gc memory heapdump].find{ |n| opts[:"#{n}_given"] }
+    unless %w[ fork eval interactive backtrace backtraces slow slowcpu firehose methods config gc memory heapdump shapesdump].find{ |n| opts[:"#{n}_given"] }
       $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)
@@ -505,6 +505,7 @@ EOS
         tracer.eval(<<-RUBY)
           Thread.new do
             Thread.current.name = '__RBTrace__'
+            require 'objspace'
             pid = ::Process.fork do
               file = File.open('#{filename}.tmp', 'w')
               ObjectSpace.dump_all(output: file)
@@ -531,6 +532,7 @@ EOS
         tracer.eval(<<-RUBY)
           Thread.new do
             Thread.current.name = '__RBTrace__'
+            require 'objspace'
             pid = ::Process.fork do
               file = File.open('#{filename}.tmp', 'w')
               ObjectSpace.dump_shapes(output: file)

data/lib/rbtrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RBTracer
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

data/server.rb

@@ -32,6 +32,7 @@ while true
         Dir.pwd
         Process.pid
         'hello'.multiply_vowels(3){ :ohai }
+        'hello'.upcase
         sleep rand*0.5
 
         ENV['blah']

data/test.sh

@@ -15,10 +15,13 @@ export RUBYOPT="-I.:lib"
 bundle exec ruby server.rb &
 export PID=$!
 
-trap cleanup INT TERM
+trap cleanup EXIT INT TERM
 cleanup() {
-  kill $PID
-  wait $PID || true
+  if [ -n "${PID:-}" ]; then
+    kill "$PID" 2>/dev/null || true
+    wait "$PID" 2>/dev/null || true
+    PID=
+  fi
 }
 
 trace() {
@@ -32,13 +35,84 @@ trace() {
   echo
 }
 
+assert_trace() {
+  expected="$1"
+  shift
+
+  echo ------------------------------------------
+  echo ./bin/rbtrace -p $PID "$@"
+  echo ------------------------------------------
+  if ! output=$(bundle exec ./bin/rbtrace -p $PID "$@" 2>&1); then
+    echo "$output"
+    return 1
+  fi
+  echo "$output"
+  echo "$output" | grep -F "$expected" >/dev/null
+  echo
+}
+
+assert_dump() {
+  dump_type="$1"
+  dump=$(mktemp)
+  rm -f "$dump"
+
+  echo ------------------------------------------
+  echo ./bin/rbtrace -p $PID --"$dump_type"="$dump"
+  echo ------------------------------------------
+  if ! output=$(bundle exec ./bin/rbtrace -p $PID --"$dump_type"="$dump" 2>&1); then
+    echo "$output"
+    rm -f "$dump" "$dump.tmp"
+    return 1
+  fi
+  echo "$output"
+
+  tries=0
+  while [ "$tries" -lt 50 ] && [ ! -s "$dump" ]; do
+    sleep 0.1
+    tries=$((tries + 1))
+  done
+
+  if [ ! -s "$dump" ]; then
+    echo "Expected $dump_type to be written to $dump"
+    rm -f "$dump" "$dump.tmp"
+    return 1
+  fi
+
+  rm -f "$dump" "$dump.tmp"
+  echo
+}
+
+assert_timed_trace() {
+  expected="$1"
+  shift
+  output=$(mktemp)
+
+  echo ------------------------------------------
+  echo ./bin/rbtrace -p $PID "$@"
+  echo ------------------------------------------
+  bundle exec ./bin/rbtrace -p $PID "$@" >"$output" 2>&1 &
+  tracer_pid=$!
+  sleep 2
+  kill "$tracer_pid" 2>/dev/null || true
+  wait "$tracer_pid" 2>/dev/null || true
+  cat "$output"
+  if ! grep -F "$expected" "$output" >/dev/null; then
+    rm -f "$output"
+    return 1
+  fi
+  rm -f "$output"
+  echo
+}
+
 trace -m Test.run --devmode
 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
+assert_timed_trace 'String#upcase(self.class=String)' -m 'String#upcase(self.class)'
+assert_trace '=> 2' -e 'p(1 + 1)'
+assert_dump heapdump
+assert_dump shapesdump
 trace --gc --slow=200
 trace --gc -m Dir.
 trace --slow=250

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbtrace
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Aman Gupta
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.6.9
 specification_version: 4
 summary: 'rbtrace: like strace but for ruby code'
 test_files: []