rbtrace 0.3.3 → 0.3.4

data/Gemfile.lock

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

data/README.md

@@ -29,6 +29,10 @@ rbtrace has several different tracing modes:
 
     % rbtrace -p <PID> --methods "Kernel#sleep" "Proc#call"
 
+### gc: trace garbage collections
+
+    % rbtrace -p <PID> --gc
+
 ## predefined tracers
 
 rbtrace also includes a set of [predefined tracers](https://github.com/tmm1/rbtrace/tree/master/tracers)
@@ -182,7 +186,9 @@ for popular ruby libraries and functions.
 
 ## todo
 
+* allow slow tracing of specific methods (--slow + --methods)
 * add triggers to start tracing slow methods only inside another method
+* add watch expressions to fire tracers only when an expression is true
 * syntax check expressions before adding them
 * add special expressions for method args (_arg0_, _arguments_)
 * optimize local variable lookup to avoid instance_eval

data/bin/rbtrace

@@ -22,7 +22,7 @@ module MsgQ
   ffi_lib 'c'
 
   class EventMsg < FFI::Struct
-    BUF_SIZE = RUBY_PLATFORM =~ /linux/ ? 256 : 64
+    BUF_SIZE = RUBY_PLATFORM =~ /linux/ ? 256 : 120
     IPC_NOWAIT = 004000
 
     layout :mtype, :long,
@@ -159,7 +159,7 @@ class RBTracer
         :arglist => false
       }
     }
-    @max_nesting = @nesting = 0
+    @max_nesting = @last_nesting = @nesting = 0
     @last_tracer = nil
 
     @out = STDOUT
@@ -167,6 +167,7 @@ class RBTracer
 
     @show_time = false
     @show_duration = true
+    @watch_slow = false
 
     attach
   end
@@ -177,6 +178,7 @@ class RBTracer
   #
   # Returns nothing.
   def watch(msec)
+    @watch_slow = true
     send_cmd(:watch, msec)
   end
 
@@ -187,6 +189,13 @@ class RBTracer
     send_cmd(:firehose)
   end
 
+  # Turn on GC tracing.
+  #
+  # Returns nothing.
+  def gc
+    send_cmd(:gc)
+  end
+
   # Add tracers for the given list of methods.
   #
   # methods - The String or Array of method selectors to trace.
@@ -342,9 +351,9 @@ class RBTracer
 
     case event
     when 'attached'
-      tracer_pid = *cmd
+      tracer_pid, = *cmd
       if tracer_pid != Process.pid
-        STDERR.puts "*** process #{pid} is already being traced"
+        STDERR.puts "*** process #{pid} is already being traced (#{tracer_pid} != #{Process.pid})"
         exit!(-1)
       end
 
@@ -352,7 +361,7 @@ class RBTracer
       return
 
     when 'detached'
-      tracer_pid = *cmd
+      tracer_pid, = *cmd
       if tracer_pid != Process.pid
         STDERR.puts "*** process #{pid} detached #{tracer_pid}, but we are #{Process.pid}"
       else
@@ -435,6 +444,7 @@ class RBTracer
 
       @nesting += 1
       @max_nesting = @nesting if @nesting > @max_nesting
+      @last_nesting = @nesting
       @last_tracer = tracer
       tracer[:last] = name
 
@@ -467,14 +477,21 @@ class RBTracer
       end
 
       tracer[:arglist] = false
+      @last_nesting = @nesting
 
     when 'slow', 'cslow'
-      diff, nesting, mid, is_singleton, klass = *cmd
+      time, diff, nesting, mid, is_singleton, klass = *cmd
 
       klass = @klasses[klass]
       name = klass ? "#{klass}#{ is_singleton ? '.' : '#' }" : ''
       name += @methods[mid] || '(unknown)'
 
+      if @show_time
+        t = Time.at(time/1_000_000)
+        print t.strftime("%H:%M:%S.")
+        print "%06d " % (time - t.to_f*1_000_000).round
+      end
+
       print @prefix*nesting if nesting > 0
       print name
       if @show_duration
@@ -484,8 +501,23 @@ class RBTracer
       puts
       puts if nesting == 0
 
+      @last_nesting = nesting
+
+    when 'gc'
+      time, = *cmd
+
+      puts unless @watch_slow
+      if @show_time
+        t = Time.at(time/1_000_000)
+        print t.strftime("%H:%M:%S.")
+        print "%06d " % (time - t.to_f*1_000_000).round
+      end
+      print @prefix*@last_nesting if @last_nesting > 0
+      print "garbage_collect"
+      puts if @watch_slow
+
     else
-      puts "unknown event: #{line}"
+      puts "unknown event #{event}: #{cmd.inspect}"
 
     end
   rescue => e
@@ -500,7 +532,7 @@ class RBTracer
     parser = Trollop::Parser.new do
       version <<-EOS
 rbtrace: like strace, but for ruby code
-  version 0.3.3
+  version 0.3.4
   (c) 2011 Aman Gupta (tmm1)
   http://github.com/tmm1/rbtrace
 EOS
@@ -525,6 +557,7 @@ Tracers:
   rbtrace --firehose       # trace all method calls
   rbtrace --slow=250       # trace method calls slower than 250ms
   rbtrace --methods a b c  # trace calls to given methods
+  rbtrace --gc             # trace garbage collections
 
   rbtrace -c io            # trace common input/output functions
   rbtrace -c eventmachine  # trace common eventmachine functions
@@ -569,6 +602,9 @@ EOS
         :type => :strings,
         :short => '-m'
 
+      opt :gc,
+        "trace garbage collections"
+
       opt :start_time,
         "show start time for each method call",
         :short => '-t'
@@ -605,11 +641,17 @@ EOS
 
     if out = opts[:output]
       output = File.open(out, opts[:append] ? 'a+' : 'w')
+      output.sync = true
     end
 
     slow = nil
     firehose = nil
     methods = nil
+    gc = nil
+
+    if opts[:gc_given]
+      gc = true
+    end
 
     if opts[:slow_given]
       slow = opts[:slow]
@@ -642,8 +684,8 @@ EOS
         end
       end
 
-    else
-      $stderr.puts "Error: --slow, --firehose, --methods or --config required."
+    elsif !gc
+      $stderr.puts "Error: --slow, --gc, --firehose, --methods or --config required."
       $stderr.puts "Try --help for help."
       exit(-1)
     end
@@ -655,6 +697,10 @@ EOS
         parser.die :pid, "(#{e.message})"
       end
 
+      if gc
+        tracer.gc
+      end
+
       if slow
         tracer.watch(slow)
       elsif firehose

data/ext/extconf.rb

@@ -11,18 +11,20 @@ end
 require 'mkmf'
 require 'fileutils'
 
-Logging.message "Building msgpack\n"
+unless File.exists?("#{CWD}/dst/lib/libmsgpackc.a")
+  Logging.message "Building msgpack\n"
 
-msgpack = File.basename('msgpack-0.5.4.tar.gz')
-dir = File.basename(msgpack, '.tar.gz')
+  msgpack = File.basename('msgpack-0.5.4.tar.gz')
+  dir = File.basename(msgpack, '.tar.gz')
 
-Dir.chdir('src') do
-  FileUtils.rm_rf(dir) if File.exists?(dir)
+  Dir.chdir('src') do
+    FileUtils.rm_rf(dir) if File.exists?(dir)
 
-  sys("tar zxvf #{msgpack}")
-  Dir.chdir(dir) do
-    sys("./configure --disable-shared --with-pic --prefix=#{CWD}/dst/")
-    sys("make install")
+    sys("tar zxvf #{msgpack}")
+    Dir.chdir(dir) do
+      sys("./configure --disable-shared --with-pic --prefix=#{CWD}/dst/")
+      sys("make install")
+    end
   end
 end
 

data/ext/rbtrace.c

@@ -1,3 +1,4 @@
+#include <assert.h>
 #include <inttypes.h>
 #include <errno.h>
 #include <signal.h>
@@ -51,7 +52,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 64
+#define BUF_SIZE 120
 #endif
 
 typedef struct {
@@ -79,6 +80,7 @@ static struct {
 
   bool installed;
 
+  bool gc;
   bool firehose;
 
   bool slow;
@@ -105,6 +107,7 @@ rbtracer = {
 
   .installed = false,
 
+  .gc = false,
   .firehose = false,
 
   .slow = false,
@@ -124,7 +127,7 @@ rbtracer = {
 };
 
 static inline void
-SEND_EVENT(int nargs, char *name, ...)
+rbtrace__send_event(int nargs, const char *name, ...)
 {
   if (!rbtracer.attached_pid ||
       !rbtracer.sbuf ||
@@ -144,8 +147,10 @@ SEND_EVENT(int nargs, char *name, ...)
 
   if (nargs > 0) {
     int type;
-    uint32_t uint;
+
     int sint;
+    uint32_t uint;
+    uint64_t uint64;
     unsigned long ulong;
     char *str;
 
@@ -156,6 +161,11 @@ SEND_EVENT(int nargs, char *name, ...)
       type = va_arg(ap, int);
       switch (type) {
         case 't':
+          uint64 = va_arg(ap, uint64_t);
+          msgpack_pack_uint64(pk, uint64);
+          break;
+
+        case 'n':
           msgpack_pack_uint64(pk, timeofday_usec());
           break;
 
@@ -184,14 +194,14 @@ SEND_EVENT(int nargs, char *name, ...)
         case 's':
           str = va_arg(ap, char *);
           if (!str)
-            str = "";
+            str = (char *)"";
 
           msgpack_pack_raw(pk, strlen(str));
           msgpack_pack_raw_body(pk, str, strlen(str));
           break;
 
         default:
-          fprintf(stderr, "unknown type (%c) passed to SEND_EVENT\n", (char)type);
+          fprintf(stderr, "unknown type (%c) passed to rbtrace__send_event\n", (char)type);
       }
     }
 
@@ -202,7 +212,7 @@ SEND_EVENT(int nargs, char *name, ...)
   msg.mtype = 1;
 
   if (rbtracer.sbuf->size > sizeof(msg.buf)) {
-    fprintf(stderr, "SEND_EVENT(): message is too large (%zd > %lu)\n", rbtracer.sbuf->size, sizeof(msg.buf));
+    fprintf(stderr, "rbtrace__send_event(): message is too large (%zd > %lu)\n", rbtracer.sbuf->size, sizeof(msg.buf));
     return;
   }
 
@@ -222,14 +232,14 @@ SEND_EVENT(int nargs, char *name, ...)
 }
 
 static inline void
-SEND_NAMES(ID mid, VALUE klass)
+rbtrace__send_names(ID mid, VALUE klass)
 {
   if (!rbtracer.mid_tbl)
     rbtracer.mid_tbl = st_init_numtable();
 
   if (!st_is_member(rbtracer.mid_tbl, mid)) {
     st_insert(rbtracer.mid_tbl, (st_data_t)mid, (st_data_t)1);
-    SEND_EVENT(2,
+    rbtrace__send_event(2,
       "mid",
       'l', mid,
       's', rb_id2name(mid)
@@ -241,7 +251,7 @@ SEND_NAMES(ID mid, VALUE klass)
 
   if (!st_is_member(rbtracer.klass_tbl, klass)) {
     st_insert(rbtracer.klass_tbl, (st_data_t)klass, (st_data_t)1);
-    SEND_EVENT(2,
+    rbtrace__send_event(2,
       "klass",
       'l', klass,
       's', rb_class2name(klass)
@@ -249,6 +259,37 @@ SEND_NAMES(ID mid, VALUE klass)
   }
 }
 
+static void
+rbtracer__resolve_query(char *query, VALUE *klass, VALUE *self, ID *mid)
+{
+  char *idx = NULL, *method = NULL;
+
+  assert(klass && self && mid);
+  *klass = *self = *mid = 0;
+
+  if (NULL != (idx = rindex(query, '.'))) {
+    *idx = 0;
+    *self = rb_eval_string_protect(query, 0);
+    *idx = '.';
+
+    method = idx+1;
+  } else if (NULL != (idx = rindex(query, '#'))) {
+    *idx = 0;
+    *klass = rb_eval_string_protect(query, 0);
+    *idx = '#';
+
+    method = idx+1;
+  } else {
+    method = query;
+  }
+
+  if (method && *method) {
+    *mid = rb_intern(method);
+  }
+}
+
+static int in_event_hook = 0;
+
 static void
 #ifdef RUBY_VM
 event_hook(rb_event_flag_t event, VALUE data, VALUE self, ID mid, VALUE klass)
@@ -256,8 +297,6 @@ event_hook(rb_event_flag_t event, VALUE data, VALUE self, ID mid, VALUE klass)
 event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
 #endif
 {
-  static int in_event_hook = 0;
-
   // do not re-enter this function
   // after this, must `goto out` instead of `return`
   if (in_event_hook) return;
@@ -266,8 +305,8 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
   // skip allocators
   if (mid == ID_ALLOCATOR) goto out;
 
-  // some serious 1.9.2 hax
 #ifdef RUBY_VM
+  // some serious 1.9.2 hax
   if (mid == 0 && ruby_current_thread) {
     ID _mid;
     VALUE _klass;
@@ -312,9 +351,10 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     }
 
     if (diff > rbtracer.threshold * 1e3) {
-      SEND_NAMES(mid, singleton ? self : klass);
-      SEND_EVENT(5,
+      rbtrace__send_names(mid, singleton ? self : klass);
+      rbtrace__send_event(6,
         event == RUBY_EVENT_RETURN ? "slow" : "cslow",
+        't', rbtracer.call_times[ rbtracer.num_calls ],
         'u', diff,
         'u', rbtracer.num_calls,
         'l', mid,
@@ -334,13 +374,15 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     if (rbtracer.num == 0) goto out;
 
     for (i=0, n=0; i<MAX_TRACERS && n<rbtracer.num; i++) {
-      if (rbtracer.list[i].query) {
+      rbtracer_t *curr = &rbtracer.list[i];
+
+      if (curr->query) {
         n++;
 
-        if (!rbtracer.list[i].mid || rbtracer.list[i].mid == mid) {
-          if (!rbtracer.list[i].klass || rbtracer.list[i].klass == klass) {
-            if (!rbtracer.list[i].self || rbtracer.list[i].self == self) {
-              tracer = &rbtracer.list[i];
+        if (!curr->mid || curr->mid == mid) {
+          if (!curr->klass || curr->klass == klass) {
+            if (!curr->self || curr->self == self) {
+              tracer = curr;
               break;
             }
           }
@@ -355,10 +397,10 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
   switch (event) {
     case RUBY_EVENT_CALL:
     case RUBY_EVENT_C_CALL:
-      SEND_NAMES(mid, singleton ? self : klass);
-      SEND_EVENT(5,
+      rbtrace__send_names(mid, singleton ? self : klass);
+      rbtrace__send_event(5,
         event == RUBY_EVENT_CALL ? "call" : "ccall",
-        't',
+        'n',
         'd', tracer ? tracer->id : 255, // hax
         'l', mid,
         'b', singleton,
@@ -394,7 +436,7 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
           }
 
           if (result && *result) {
-            SEND_EVENT(3,
+            rbtrace__send_event(3,
               "exprval",
               'd', tracer->id,
               'd', i,
@@ -407,9 +449,9 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
 
     case RUBY_EVENT_RETURN:
     case RUBY_EVENT_C_RETURN:
-      SEND_EVENT(2,
+      rbtrace__send_event(2,
         event == RUBY_EVENT_RETURN ? "return" : "creturn",
-        't',
+        'n',
         'd', tracer ? tracer->id : 255 // hax
       );
       break;
@@ -486,7 +528,7 @@ rbtracer_remove(char *query, int id)
   }
 
 out:
-  SEND_EVENT(2,
+  rbtrace__send_event(2,
     "remove",
     'd', tracer_id,
     's', query
@@ -499,6 +541,7 @@ rbtracer_remove_all()
 {
   rbtracer.firehose = false;
   rbtracer.slow = false;
+  rbtracer.gc = false;
 
   int i;
   for (i=0; i<MAX_TRACERS; i++) {
@@ -534,34 +577,13 @@ rbtracer_add(char *query)
   }
   if (!tracer) goto out;
 
-  char *idx, *method;
   VALUE klass = 0, self = 0;
   ID mid = 0;
 
-  if (NULL != (idx = rindex(query, '.'))) {
-    *idx = 0;
-    self = rb_eval_string_protect(query, 0);
-    *idx = '.';
+  rbtracer__resolve_query(query, &klass, &self, &mid);
 
-    method = idx+1;
-  } else if (NULL != (idx = rindex(query, '#'))) {
-    *idx = 0;
-    klass = rb_eval_string_protect(query, 0);
-    *idx = '#';
-
-    method = idx+1;
-  } else {
-    method = query;
-  }
-
-  if (method && *method) {
-    mid = rb_intern(method);
-    if (!mid) goto out;
-  } else if (klass || self) {
-    mid = 0;
-  } else {
+  if (!mid && !klass && !self)
     goto out;
-  }
 
   memset(tracer, 0, sizeof(*tracer));
 
@@ -578,7 +600,7 @@ rbtracer_add(char *query)
   rbtracer.num++;
 
 out:
-  SEND_EVENT(2,
+  rbtrace__send_event(2,
     "add",
     'd', tracer_id,
     's', query
@@ -606,7 +628,7 @@ rbtracer_add_expr(int id, char *expr)
   }
 
 out:
-  SEND_EVENT(3,
+  rbtrace__send_event(3,
     "newexpr",
     'd', tracer_id,
     'd', expr_id,
@@ -719,6 +741,10 @@ sigurg(int signal)
       if (!success || cmd.type != MSGPACK_OBJECT_ARRAY)
         continue;
 
+      /* fprintf(stderr, "GOT: ");*/
+      /* msgpack_object_print(stderr, cmd);*/
+      /* fprintf(stderr, "\n");*/
+
       ary = cmd.via.array;
 
       if (ary.size < 1 ||
@@ -737,13 +763,13 @@ sigurg(int signal)
         if (pid && rbtracer.attached_pid == 0)
           rbtracer.attached_pid = pid;
 
-        SEND_EVENT(1,
+        rbtrace__send_event(1,
           "attached",
           'u', (uint32_t) rbtracer.attached_pid
         );
 
       } else if (0 == strncmp("detach", str.ptr, str.size)) {
-        SEND_EVENT(1,
+        rbtrace__send_event(1,
           "detached",
           'u', (uint32_t) rbtracer.attached_pid
         );
@@ -785,14 +811,34 @@ sigurg(int signal)
         query[str.size] = 0;
         rbtracer_add_expr(last_tracer_id, query);
 
+      } else if (0 == strncmp("gc", str.ptr, str.size)) {
+        rbtracer.gc = true;
+
       }
     }
   }
 }
 
+static void
+rbtrace_gc_mark()
+{
+  if (rbtracer.gc && !in_event_hook) {
+    rbtrace__send_event(1,
+      "gc",
+      'n'
+    );
+  }
+}
+
+static VALUE gc_hook;
+
 void
 Init_rbtrace()
 {
+  // hook into the gc
+  gc_hook = Data_Wrap_Struct(rb_cObject, rbtrace_gc_mark, NULL, NULL);
+  rb_global_variable(&gc_hook);
+
   // setup msgpack
   rbtracer.sbuf = msgpack_sbuffer_new();
   rbtracer.msgpacker = msgpack_packer_new(rbtracer.sbuf, msgpack_sbuffer_write);

data/rbtrace.gemspec

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

data/server.rb

@@ -14,6 +14,7 @@ while true
       Process.pid
       'hello'.multiply_vowels(3){ :ohai }
       sleep rand*0.5
+      GC.start
     end
   }.call
 end

data/test.sh

@@ -1,7 +1,15 @@
 #!/bin/sh
 set -e
 
-make -C ext 2>&1 >/dev/null
+cd ext
+[ -f Makefile ] && make clean
+ruby extconf.rb
+make
+cd ..
+
+bundle check
+export RUBYOPT="-I."
+
 ruby server.rb &
 export PID=$!
 
@@ -26,6 +34,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 --gc --slow=200
+trace --gc -m Dir.
 trace --slow=250
 trace --firehose
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbtrace
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Aman Gupta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-18 00:00:00 -08:00
+date: 2011-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency