rbtrace 0.3.5 → 0.3.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbtrace (0.3.5)
+    rbtrace (0.3.6)
       ffi (>= 1.0.5)
       msgpack (>= 0.4.3)
       trollop (>= 1.16.2)

data/README.md

@@ -15,7 +15,7 @@ in production.
 
 ## tracer types
 
-rbtrace has several different tracing modes:
+rbtrace has several different tracing modes.
 
 ### firehose: show everything
 
@@ -33,6 +33,12 @@ rbtrace has several different tracing modes:
 
     % rbtrace -p <PID> --gc
 
+### notes
+
+`--firehose` is not reliable on osx.
+
+`--slow`, `--gc` and `--methods` can be combined.
+
 ## predefined tracers
 
 rbtrace also includes a set of [predefined tracers](https://github.com/tmm1/rbtrace/tree/master/tracers)
@@ -186,12 +192,6 @@ for popular ruby libraries and functions.
 
 ## todo
 
-* write some real tests (that assert things)
-* more expressive selectors (.*Controller#)
-* include date in show time (-t)
-* add --eval
-* add --forkgdb
-* add --strace mode/expression
 * 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/bin/rbtrace

@@ -142,7 +142,7 @@ class RBTracer
       raise ArgumentError, 'could not signal process, are you running as root?'
     end
 
-    Process.kill 'URG', @pid
+    signal
     sleep 0.25 # wait for process to create msgqs
 
     @qi = MsgQ.msgget( pid, 0666)
@@ -169,6 +169,7 @@ class RBTracer
 
     @out = STDOUT
     @prefix = '  '
+    @printed_newline = true
 
     @show_time = false
     @show_duration = true
@@ -201,6 +202,35 @@ class RBTracer
     send_cmd(:devmode)
   end
 
+  # Fork the process and return the copy's pid.
+  #
+  # Returns a Fixnum pid.
+  def fork
+    send_cmd(:fork)
+    if wait_for(30, 'for fork'){ !!@forked_pid }
+      @forked_pid
+    else
+      STDERR.puts '*** timed out waiting for fork'
+    end
+  end
+
+  # Evaluate some ruby code.
+  #
+  # Returns the String result.
+  def eval(code)
+    if (err = valid_syntax?(code)) != true
+      raise ArgumentError, "#{err.class} for expression #{code.inspect}"
+    end
+
+    send_cmd(:eval, code)
+
+    if wait_for(10, 'for eval response'){ !!@eval_result }
+      @eval_result
+    else
+      STDERR.puts '*** timed out waiting for eval response'
+    end
+  end
+
   # Turn on GC tracing.
   #
   # Returns nothing.
@@ -257,17 +287,17 @@ class RBTracer
     rescue Errno::ESRCH
     end
 
-    puts
+    newline
 
     if wait_for{ @attached == false }
-      puts
+      newline
       STDERR.puts "*** detached from process #{pid}"
     else
-      puts
+      newline
       STDERR.puts "*** could not detach cleanly from process #{pid}"
     end
   rescue Errno::EINVAL, Errno::EIDRM
-    puts
+    newline
     STDERR.puts "*** process #{pid} is gone"
     STDERR.puts "*** #{$!.inspect}"
     STDERR.puts $!.backtrace.join("\n  ")
@@ -302,15 +332,24 @@ class RBTracer
     end
   end
 
+  def puts(arg=nil)
+    @printed_newline = true
+    arg ? @out.puts(arg) : @out.puts
+  end
+
   private
 
+  def signal
+    Process.kill 'URG', @pid
+  end
+
   # Process incoming events until either a timeout or a condition becomes true.
   #
   # time - The Fixnum timeout in seconds.
   # block - The Block that is checked every 50ms until it returns true.
   #
   # Returns true when the condition was met, or false on a timeout.
-  def wait_for(time=5)
+  def wait_for(time=5, reason='to detach cleanly')
     wait = 0.05 # polling interval
 
     (time/wait).to_i.times do
@@ -321,7 +360,7 @@ class RBTracer
 
         return true if yield
       rescue Interrupt
-        STDERR.puts "*** waiting to detach cleanly (#{time.to_i}s left)"
+        STDERR.puts "*** waiting #{reason} (#{time.to_i}s left)"
         retry
       end
     end
@@ -337,7 +376,7 @@ class RBTracer
     rescue Errno::EINTR
       retry
     end
-    Process.kill 'URG', @pid
+    signal
     recv_lines
   end
 
@@ -351,18 +390,20 @@ class RBTracer
 
   def valid_syntax?(code)
     begin
-      eval("#{code}\nBEGIN {return true}", nil, 'rbtrace_expression', 0)
+      Kernel.eval("#{code}\nBEGIN {return true}", nil, 'rbtrace_expression', 0)
     rescue Exception => e
       e
     end
   end
 
-  def print(*args)
-    @out.print(*args)
+  def print(arg)
+    @printed_newline = false
+    @out.print(arg)
   end
 
-  def puts(*args)
-    @out.puts(*args)
+  def newline
+    puts unless @printed_newline
+    @printed_newline = true
   end
 
   def parse_cmd(line)
@@ -379,6 +420,11 @@ class RBTracer
     event = cmd.shift
 
     case event
+    when 'during_gc'
+      sleep 0.01
+      signal
+      return
+
     when 'attached'
       tracer_pid, = *cmd
       if tracer_pid != Process.pid
@@ -406,6 +452,14 @@ class RBTracer
     end
 
     case event
+    when 'forked'
+      pid, = *cmd
+      @forked_pid = pid
+
+    when 'evaled'
+      res, = *cmd
+      @eval_result = res
+
     when 'mid'
       mid, name = *cmd
       @methods[mid] = name
@@ -562,7 +616,7 @@ class RBTracer
     parser = Trollop::Parser.new do
       version <<-EOS
 rbtrace: like strace, but for ruby code
-  version 0.3.5
+  version 0.3.6
   (c) 2011 Aman Gupta (tmm1)
   http://github.com/tmm1/rbtrace
 EOS
@@ -665,6 +719,14 @@ EOS
 
       opt :devmode,
         "assume the ruby process is reloading classes and methods"
+
+      opt :fork,
+        "fork a copy of the process for debugging (so you can attach gdb.rb)"
+
+      opt :eval,
+        "evaluate a ruby expression in the process",
+        :type => String,
+        :short => '-e'
     end
 
     opts = Trollop.with_standard_exception_handling(parser) do
@@ -672,12 +734,16 @@ EOS
       parser.parse(ARGV)
     end
 
-    unless %w[ slow firehose methods config gc ].find{ |n| opts[:"#{n}_given"] }
+    unless %w[ fork eval slow firehose methods config gc ].find{ |n| opts[:"#{n}_given"] }
       $stderr.puts "Error: --slow, --gc, --firehose, --methods or --config required."
       $stderr.puts "Try --help for help."
       exit(-1)
     end
 
+    if opts[:fork_given] and opts[:pid].size != 1
+      parser.die :fork, '(can only be invoked with one pid)'
+    end
+
     methods = []
 
     if opts[:methods_given]
@@ -764,37 +830,35 @@ EOS
         parser.die :pid, "(#{e.message})"
       end
 
-      if opts[:devmode_given]
-        tracer.devmode
-      end
-
-      if opts[:gc_given]
-        tracer.gc
-      end
-
-      if opts[:firehose_given]
-        tracer.firehose
-      else
-        if methods.any?
-          tracer.add(methods)
-        end
+      if opts[:fork_given]
+        pid = tracer.fork
+        STDERR.puts "*** forked off a busy looping copy at #{pid} (make sure to kill -9 it when you're done)"
 
-        if opts[:slow_given]
-          tracer.watch(opts[:slow])
+      elsif opts[:eval_given]
+        if res = tracer.eval(code = opts[:eval])
+          tracer.puts ">> #{code}"
+          tracer.puts "=> #{res}"
         end
-      end
 
-      if output
-        tracer.out = output
-      end
+      else
+        tracer.out = output if output
+        tracer.prefix = ' ' * opts[:prefix]
+        tracer.show_time = opts[:start_time]
+        tracer.show_duration = !opts[:no_duration]
 
-      tracer.prefix = ' ' * opts[:prefix]
-      tracer.show_duration = !opts[:no_duration]
-      tracer.show_time = opts[:start_time]
+        tracer.devmode if opts[:devmode_given]
+        tracer.gc if opts[:gc_given]
 
-      begin
-        tracer.recv_loop
-      rescue Interrupt, SignalException
+        if opts[:firehose_given]
+          tracer.firehose
+        else
+          tracer.add(methods)       if methods.any?
+          tracer.watch(opts[:slow]) if opts[:slow_given]
+        end
+        begin
+          tracer.recv_loop
+        rescue Interrupt, SignalException
+        end
       end
     ensure
       if tracer

data/ext/extconf.rb

@@ -35,6 +35,8 @@ unless have_library('msgpackc_ext') and have_header('msgpack.h')
   raise 'msgpack build failed'
 end
 
+have_func('rb_during_gc', 'ruby.h')
+
 # increase message size on linux
 if RUBY_PLATFORM =~ /linux/
   $defs.push("-DBUF_SIZE=256")

data/ext/rbtrace.c

@@ -21,7 +21,6 @@
 
 #ifndef RUBY_VM
 #include <env.h>
-#include <intern.h>
 #include <node.h>
 #include <st.h>
 #define rb_sourcefile() (ruby_current_node ? ruby_current_node->nd_file : 0)
@@ -264,8 +263,10 @@ rbtrace__send_names(ID mid, VALUE klass)
   if (!rbtracer.klass_tbl)
     rbtracer.klass_tbl = st_init_numtable();
 
-  if (!st_is_member(rbtracer.klass_tbl, klass)) {
-    st_insert(rbtracer.klass_tbl, (st_data_t)klass, (st_data_t)1);
+  if (rbtracer.devmode || !st_is_member(rbtracer.klass_tbl, klass)) {
+    if (!rbtracer.devmode)
+      st_insert(rbtracer.klass_tbl, (st_data_t)klass, (st_data_t)1);
+
     rbtrace__send_event(2,
       "klass",
       'l', klass,
@@ -715,26 +716,17 @@ rbtracer_watch(uint32_t threshold)
   }
 }
 
-static void
-rbtracer_unwatch()
-{
-  if (rbtracer.slow) {
-    event_hook_remove();
-
-    rbtracer.firehose = false;
-    rbtracer.slow = false;
-  }
-}
-
 static void
 msgq_teardown()
 {
-  if (rbtracer.mqo_id != -1) {
+  pid_t pid = getpid();
+
+  if (rbtracer.mqo_id != -1 && rbtracer.mqo_key == (key_t)pid) {
     msgctl(rbtracer.mqo_id, IPC_RMID, NULL);
     rbtracer.mqo_id = -1;
     rbtracer.mqo_key = 0;
   }
-  if (rbtracer.mqi_id != -1) {
+  if (rbtracer.mqi_id != -1 && rbtracer.mqi_key == (key_t)-pid) {
     msgctl(rbtracer.mqi_id, IPC_RMID, NULL);
     rbtracer.mqi_id = -1;
     rbtracer.mqi_key = 0;
@@ -774,117 +766,188 @@ msgq_setup()
 }
 
 static void
-sigurg(int signal)
+rbtrace__process_event(msgpack_object cmd)
 {
+  if (cmd.type != MSGPACK_OBJECT_ARRAY)
+    return;
+
   static int last_tracer_id = -1; // hax
-  msgq_setup();
-  if (rbtracer.mqi_id == -1) return;
+  char query[BUF_SIZE];
 
-  event_msg_t msg;
-  int n = 0;
+  char code[BUF_SIZE+150];
+  VALUE val = Qnil;
 
-  while (true) {
-    int ret = -1;
+  msgpack_object_array ary;
+  msgpack_object_raw str;
 
-    for (n=0; n<10 && ret==-1; n++)
-      ret = msgrcv(rbtracer.mqi_id, &msg, sizeof(msg)-sizeof(long), 0, IPC_NOWAIT);
+  /* fprintf(stderr, "GOT: ");*/
+  /* msgpack_object_print(stderr, cmd);*/
+  /* fprintf(stderr, "\n");*/
 
-    if (ret == -1) {
-      break;
-    } else {
-      char query[sizeof(msg.buf)];
+  ary = cmd.via.array;
+
+  if (ary.size < 1 ||
+      ary.ptr[0].type != MSGPACK_OBJECT_RAW)
+    return;
 
-      msgpack_object cmd;
-      msgpack_object_array ary;
-      msgpack_object_raw str;
+  str = ary.ptr[0].via.raw;
 
-      msgpack_unpacked unpacked;
-      msgpack_unpacked_init(&unpacked);
+  if (0 == strncmp("attach", str.ptr, str.size)) {
+    if (ary.size != 2 ||
+        ary.ptr[1].type != MSGPACK_OBJECT_POSITIVE_INTEGER)
+      return;
 
-      bool success = msgpack_unpack_next(&unpacked, msg.buf, sizeof(msg.buf), NULL);
-      cmd = unpacked.data;
+    pid_t pid = (pid_t) ary.ptr[1].via.u64;
+
+    if (pid && rbtracer.attached_pid == 0)
+      rbtracer.attached_pid = pid;
 
-      if (!success || cmd.type != MSGPACK_OBJECT_ARRAY)
-        continue;
+    rbtrace__send_event(1,
+        "attached",
+        'u', (uint32_t) rbtracer.attached_pid
+        );
+
+  } else if (0 == strncmp("detach", str.ptr, str.size)) {
+    if (rbtracer.attached_pid) {
+      rbtrace__send_event(1,
+          "detached",
+          'u', (uint32_t) rbtracer.attached_pid
+          );
+    }
 
-      /* fprintf(stderr, "GOT: ");*/
-      /* msgpack_object_print(stderr, cmd);*/
-      /* fprintf(stderr, "\n");*/
+    rbtracer_detach();
 
-      ary = cmd.via.array;
+  } else if (0 == strncmp("watch", str.ptr, str.size)) {
+    if (ary.size != 2 ||
+        ary.ptr[1].type != MSGPACK_OBJECT_POSITIVE_INTEGER)
+      return;
 
-      if (ary.size < 1 ||
-          ary.ptr[0].type != MSGPACK_OBJECT_RAW)
-        continue;
+    unsigned int msec = ary.ptr[1].via.u64;
+    rbtracer_watch(msec);
 
-      str = ary.ptr[0].via.raw;
+  } else if (0 == strncmp("firehose", str.ptr, str.size)) {
+    rbtracer.firehose = true;
+    event_hook_install();
 
-      if (0 == strncmp("attach", str.ptr, str.size)) {
-        if (ary.size != 2 ||
-            ary.ptr[1].type != MSGPACK_OBJECT_POSITIVE_INTEGER)
-          continue;
+  } else if (0 == strncmp("add", str.ptr, str.size)) {
+    if (ary.size != 2 ||
+        ary.ptr[1].type != MSGPACK_OBJECT_RAW)
+      return;
 
-        pid_t pid = (pid_t) ary.ptr[1].via.u64;
+    str = ary.ptr[1].via.raw;
 
-        if (pid && rbtracer.attached_pid == 0)
-          rbtracer.attached_pid = pid;
+    strncpy(query, str.ptr, str.size);
+    query[str.size] = 0;
+    last_tracer_id = rbtracer_add(query);
 
-        rbtrace__send_event(1,
-          "attached",
-          'u', (uint32_t) rbtracer.attached_pid
-        );
+  } else if (0 == strncmp("addexpr", str.ptr, str.size)) {
+    if (ary.size != 2 ||
+        ary.ptr[1].type != MSGPACK_OBJECT_RAW)
+      return;
 
-      } else if (0 == strncmp("detach", str.ptr, str.size)) {
-        if (rbtracer.attached_pid) {
-          rbtrace__send_event(1,
-            "detached",
-            'u', (uint32_t) rbtracer.attached_pid
+    str = ary.ptr[1].via.raw;
+
+    strncpy(query, str.ptr, str.size);
+    query[str.size] = 0;
+    rbtracer_add_expr(last_tracer_id, query);
+
+  } else if (0 == strncmp("gc", str.ptr, str.size)) {
+    rbtracer.gc = true;
+
+  } else if (0 == strncmp("devmode", str.ptr, str.size)) {
+    rbtracer.devmode = true;
+
+  } else if (0 == strncmp("fork", str.ptr, str.size)) {
+    pid_t outer = fork();
+
+    if (outer == 0) {
+      rb_eval_string_protect("$0 = \"[DEBUG] #{Process.ppid}\"", 0);
+      setpgrp();
+      pid_t inner = fork();
+
+      if (inner == 0) {
+        // a ruby process will never have more than 20k
+        // open file descriptors, right?
+        int fd;
+        for (fd=3; fd<20000; fd++)
+          close(fd);
+
+        // busy loop
+        while (1) sleep(1);
+
+        // don't return to ruby
+        _exit(0);
+      }
+
+      rbtrace__send_event(1,
+          "forked",
+          inner == -1 ? 'b' : 'u',
+          inner == -1 ? false : (uint32_t) inner
           );
-        }
 
-        rbtracer_detach();
+      // kill off outer fork
+      _exit(0);
+    }
 
-      } else if (0 == strncmp("watch", str.ptr, str.size)) {
-        if (ary.size != 2 ||
-            ary.ptr[1].type != MSGPACK_OBJECT_POSITIVE_INTEGER)
-          continue;
+    if (outer != -1) {
+      waitpid(outer, NULL, 0);
+    }
 
-        unsigned int msec = ary.ptr[1].via.u64;
-        rbtracer_watch(msec);
+  } else if (0 == strncmp("eval", str.ptr, str.size)) {
+    if (ary.size != 2 ||
+        ary.ptr[1].type != MSGPACK_OBJECT_RAW)
+      return;
 
-      } else if (0 == strncmp("firehose", str.ptr, str.size)) {
-        rbtracer.firehose = true;
-        event_hook_install();
+    str = ary.ptr[1].via.raw;
 
-      } else if (0 == strncmp("add", str.ptr, str.size)) {
-        if (ary.size != 2 ||
-            ary.ptr[1].type != MSGPACK_OBJECT_RAW)
-          continue;
+    strncpy(query, str.ptr, str.size);
+    query[str.size] = 0;
 
-        str = ary.ptr[1].via.raw;
+    snprintf(code, BUF_SIZE+150, "(begin; %s; rescue Exception => e; e; end).inspect", query);
+    val = rb_eval_string_protect(code, 0);
 
-        strncpy(query, str.ptr, str.size);
-        query[str.size] = 0;
-        last_tracer_id = rbtracer_add(query);
+    if (TYPE(val) == T_STRING) {
+      rbtrace__send_event(1,
+        "evaled",
+        's', RSTRING_PTR(val)
+      );
+    }
 
-      } else if (0 == strncmp("addexpr", str.ptr, str.size)) {
-        if (ary.size != 2 ||
-            ary.ptr[1].type != MSGPACK_OBJECT_RAW)
-          continue;
+  }
+}
 
-        str = ary.ptr[1].via.raw;
+static void
+sigurg(int signal)
+{
+  msgq_setup();
+  if (rbtracer.mqi_id == -1) return;
 
-        strncpy(query, str.ptr, str.size);
-        query[str.size] = 0;
-        rbtracer_add_expr(last_tracer_id, query);
+#ifdef HAVE_RB_DURING_GC
+  if (rb_during_gc()) {
+    rbtrace__send_event(0, "during_gc");
+    return;
+  }
+#endif
 
-      } else if (0 == strncmp("gc", str.ptr, str.size)) {
-        rbtracer.gc = true;
+  event_msg_t msg;
+  int n = 0;
 
-      } else if (0 == strncmp("devmode", str.ptr, str.size)) {
-        rbtracer.devmode = true;
+  while (true) {
+    int ret = -1;
 
-      }
+    for (n=0; n<10 && ret==-1; n++)
+      ret = msgrcv(rbtracer.mqi_id, &msg, sizeof(msg)-sizeof(long), 0, IPC_NOWAIT);
+
+    if (ret == -1) {
+      break;
+    } else {
+      msgpack_unpacked unpacked;
+      msgpack_unpacked_init(&unpacked);
+
+      bool success = msgpack_unpack_next(&unpacked, msg.buf, sizeof(msg.buf), NULL);
+      if (!success) continue;
+
+      rbtrace__process_event(unpacked.data);
     }
   }
 }

data/rbtrace.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rbtrace'
-  s.version = '0.3.5'
+  s.version = '0.3.6'
   s.homepage = 'http://github.com/tmm1/rbtrace'
 
   s.authors = 'Aman Gupta'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbtrace
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Aman Gupta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-21 00:00:00 -08:00
+date: 2011-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency