rbtrace 0.3.4 → 0.3.5

data/Gemfile.lock

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

data/README.md

@@ -186,15 +186,16 @@ for popular ruby libraries and functions.
 
 ## todo
 
-* allow slow tracing of specific methods (--slow + --methods)
+* 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
-* syntax check expressions before adding them
 * add special expressions for method args (_arg0_, _arguments_)
 * optimize local variable lookup to avoid instance_eval
 * run process via bin/rbtrace (to trace rubygems and bootup time)
-* let bin/rbtrace attach to multiple pids
-  * how to select on multiple msgrcv() targets?
-  * prefix pid to output in multiple pid mode
 * investigate mach_msg on osx since msgget(2) has hard kernel limits
 

data/bin/rbtrace

@@ -9,8 +9,13 @@ class String
 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
+    hash
+  end
+
   def self.exception
-    Errno::constants.map(&Errno.method(:const_get)).find{ |c| c.const_get(:Errno) == error }
+    Errnos[error]
   end
   def self.raise(msg=nil)
     Kernel.raise exception, msg
@@ -189,6 +194,13 @@ class RBTracer
     send_cmd(:firehose)
   end
 
+  # Turn on dev mode.
+  #
+  # Returns nothing.
+  def devmode
+    send_cmd(:devmode)
+  end
+
   # Turn on GC tracing.
   #
   # Returns nothing.
@@ -207,15 +219,20 @@ class RBTracer
       next if func.empty?
 
       if func =~ /^(.+)\((.+)\)$/
-        func, args = $1, $2
+        name, args = $1, $2
         args = args.split(',').map{ |a| a.strip }
       end
 
-      send_cmd(:add, func)
+      send_cmd(:add, name || func)
 
-      args.each do |arg|
-        send_cmd(:addexpr, arg)
-      end if args and args.any?
+      if args and args.any?
+        args.each do |arg|
+          if (err = valid_syntax?(arg)) != true
+            raise ArgumentError, "#{err.class} for expression #{arg.inspect} in method #{func.inspect}"
+          end
+          send_cmd(:addexpr, arg)
+        end
+      end
     end
   end
 
@@ -252,6 +269,10 @@ class RBTracer
   rescue Errno::EINVAL, Errno::EIDRM
     puts
     STDERR.puts "*** process #{pid} is gone"
+    STDERR.puts "*** #{$!.inspect}"
+    STDERR.puts $!.backtrace.join("\n  ")
+  rescue Interrupt, SignalException
+    retry
   end
 
   # Process events from the traced process.
@@ -328,6 +349,14 @@ class RBTracer
     retry
   end
 
+  def valid_syntax?(code)
+    begin
+      eval("#{code}\nBEGIN {return true}", nil, 'rbtrace_expression', 0)
+    rescue Exception => e
+      e
+    end
+  end
+
   def print(*args)
     @out.print(*args)
   end
@@ -499,8 +528,9 @@ class RBTracer
         print "<%f>" % (diff/1_000_000.0)
       end
       puts
-      puts if nesting == 0
+      puts if nesting == 0 and @max_nesting > 1
 
+      @max_nesting = nesting if nesting > @max_nesting
       @last_nesting = nesting
 
     when 'gc'
@@ -532,7 +562,7 @@ class RBTracer
     parser = Trollop::Parser.new do
       version <<-EOS
 rbtrace: like strace, but for ruby code
-  version 0.3.4
+  version 0.3.5
   (c) 2011 Aman Gupta (tmm1)
   http://github.com/tmm1/rbtrace
 EOS
@@ -585,7 +615,7 @@ All Options:\n
 EOS
       opt :pid,
         "pid of the ruby process to trace",
-        :type => :int,
+        :type => :ints,
         :short => '-p'
 
       opt :firehose,
@@ -632,6 +662,9 @@ EOS
         "config file",
         :type => :strings,
         :short => '-c'
+
+      opt :devmode,
+        "assume the ruby process is reloading classes and methods"
     end
 
     opts = Trollop.with_standard_exception_handling(parser) do
@@ -639,36 +672,23 @@ EOS
       parser.parse(ARGV)
     end
 
-    if out = opts[:output]
-      output = File.open(out, opts[:append] ? 'a+' : 'w')
-      output.sync = true
+    unless %w[ 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
 
-    slow = nil
-    firehose = nil
-    methods = nil
-    gc = nil
+    methods = []
 
-    if opts[:gc_given]
-      gc = true
+    if opts[:methods_given]
+      methods += opts[:methods]
     end
 
-    if opts[:slow_given]
-      slow = opts[:slow]
-
-    elsif opts[:firehose]
-      firehose = true
-
-    elsif opts[:methods]
-      methods = opts[:methods]
-
-    elsif opts[:config_given]
-      methods = []
-
+    if opts[:config_given]
       Array(opts[:config]).each do |config|
         file = [
           config,
-          File.expand_path("../../tracers/#{config}.tracer",__FILE__)
+          File.expand_path("../../tracers/#{config}.tracer", __FILE__)
         ].find{ |f| File.exists?(f) }
 
         unless file
@@ -683,30 +703,85 @@ EOS
           methods << line
         end
       end
+    end
 
-    elsif !gc
-      $stderr.puts "Error: --slow, --gc, --firehose, --methods or --config required."
-      $stderr.puts "Try --help for help."
-      exit(-1)
+    tracee = nil
+
+    if opts[:pid].size <= 1
+      tracee = opts[:pid].first
+
+    else
+      tracers = []
+
+      opts[:pid].each do |pid|
+        if child = fork
+          tracers << child
+        else
+          Process.setpgrp
+          STDIN.reopen '/dev/null'
+          $0 = "rbtrace -p #{pid} (parent: #{Process.ppid})"
+
+          opts[:output] += ".#{pid}" if opts[:output]
+          tracee = pid
+
+          # fall through and start tracing
+          break
+        end
+      end
+
+      if tracee.nil?
+        # this is the parent
+        while true
+          begin
+            break if tracers.empty?
+            if pid = Process.wait
+              tracers.delete(pid)
+            end
+          rescue Interrupt, SignalException
+            STDERR.puts "*** waiting on child tracers: #{tracers.inspect}"
+            tracers.each do |pid|
+              begin
+                Process.kill 'INT', pid
+              rescue Errno::ESRCH
+              end
+            end
+          end
+        end
+
+        exit!
+      end
+    end
+
+    if out = opts[:output]
+      output = File.open(out, opts[:append] ? 'a+' : 'w')
+      output.sync = true
     end
 
     begin
       begin
-        tracer = RBTracer.new(opts[:pid])
+        tracer = RBTracer.new(tracee)
       rescue ArgumentError => e
         parser.die :pid, "(#{e.message})"
       end
 
-      if gc
+      if opts[:devmode_given]
+        tracer.devmode
+      end
+
+      if opts[:gc_given]
         tracer.gc
       end
 
-      if slow
-        tracer.watch(slow)
-      elsif firehose
+      if opts[:firehose_given]
         tracer.firehose
-      elsif methods
-        tracer.add(methods)
+      else
+        if methods.any?
+          tracer.add(methods)
+        end
+
+        if opts[:slow_given]
+          tracer.watch(opts[:slow])
+        end
       end
 
       if output
@@ -719,7 +794,7 @@ EOS
 
       begin
         tracer.recv_loop
-      rescue Interrupt
+      rescue Interrupt, SignalException
       end
     ensure
       if tracer

data/ext/rbtrace.c

@@ -57,8 +57,12 @@ timeofday_usec()
 
 typedef struct {
   int id;
-
   char *query;
+
+  char *klass_name;
+  size_t klass_len;
+  bool is_singleton;
+
   VALUE self;
   VALUE klass;
   ID mid;
@@ -79,6 +83,7 @@ static struct {
   pid_t attached_pid;
 
   bool installed;
+  bool devmode;
 
   bool gc;
   bool firehose;
@@ -106,6 +111,7 @@ rbtracer = {
   .attached_pid = 0,
 
   .installed = false,
+  .devmode = false,
 
   .gc = false,
   .firehose = false,
@@ -126,6 +132,10 @@ rbtracer = {
   .msgpacker = NULL
 };
 
+static void
+  msgq_teardown(),
+  rbtracer_detach();
+
 static inline void
 rbtrace__send_event(int nargs, const char *name, ...)
 {
@@ -160,38 +170,38 @@ rbtrace__send_event(int nargs, const char *name, ...)
     for (n=0; n<nargs; n++) {
       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;
-
-        case 'b':
+        case 'b': // boolean
           if (va_arg(ap, int))
             msgpack_pack_true(pk);
           else
             msgpack_pack_false(pk);
           break;
 
-        case 'u':
+        case 'd': // signed int
+          sint = va_arg(ap, int);
+          msgpack_pack_int(pk, sint);
+          break;
+
+        case 'u': // unsigned int
           uint = va_arg(ap, uint32_t);
           msgpack_pack_uint32(pk, uint);
           break;
 
-        case 'l':
+        case 'l': // unsigned long (VALUE/ID)
           ulong = va_arg(ap, unsigned long);
           msgpack_pack_unsigned_long(pk, ulong);
           break;
 
-        case 'd':
-          sint = va_arg(ap, int);
-          msgpack_pack_int(pk, sint);
+        case 't': // unsigned long long (timestamps)
+          uint64 = va_arg(ap, uint64_t);
+          msgpack_pack_uint64(pk, uint64);
           break;
 
-        case 's':
+        case 'n': // current timestamp
+          msgpack_pack_uint64(pk, timeofday_usec());
+          break;
+
+        case 's': // string
           str = va_arg(ap, char *);
           if (!str)
             str = (char *)"";
@@ -222,7 +232,12 @@ rbtrace__send_event(int nargs, const char *name, ...)
   for (n=0; n<10 && ret==-1; n++)
     ret = msgsnd(rbtracer.mqo_id, &msg, sizeof(msg)-sizeof(long), IPC_NOWAIT);
 
-  if (ret == -1 && rbtracer.mqo_id != -1 && errno != EINVAL) {
+  if (ret == -1 && errno == EINVAL) {
+    fprintf(stderr, "msgsnd(%d): %s [detaching]\n", rbtracer.mqo_id, strerror(errno));
+
+    msgq_teardown();
+    rbtracer_detach();
+  } else if (ret == -1) {
     fprintf(stderr, "msgsnd(%d): %s\n", rbtracer.mqo_id, strerror(errno));
 
     struct msqid_ds stat;
@@ -259,35 +274,6 @@ rbtrace__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
@@ -326,7 +312,55 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     singleton = FL_TEST(klass, FL_SINGLETON);
   }
 
-  // are we watching for any slow methods?
+  rbtracer_t *tracer = NULL;
+
+  if (rbtracer.firehose) {
+    // trace everything
+
+  } else if (rbtracer.num > 0) {
+    // tracing only specific methods
+    int i, n;
+    for (i=0, n=0; i<MAX_TRACERS && n<rbtracer.num; i++) {
+      rbtracer_t *curr = &rbtracer.list[i];
+
+      if (curr->query) {
+        n++;
+
+        if (rbtracer.devmode) {
+          if ((!curr->mid        || curr->mid == mid) &&
+              (!curr->klass_name || (
+                (singleton == curr->is_singleton) &&
+                (0 == strncmp(rb_class2name(singleton ? self : klass), curr->klass_name, curr->klass_len)))))
+          {
+            tracer = curr;
+            break;
+          }
+        } else {
+          if ((!curr->mid   || curr->mid == mid) &&
+              (!curr->klass || curr->klass == klass) &&
+              (!curr->self  || curr->self == self))
+          {
+            tracer = curr;
+            break;
+          }
+        }
+      }
+    }
+
+    // no tracer for current method call
+    if (!tracer) goto out;
+
+  } else if (rbtracer.slow) {
+    // trace anything that's slow
+    // fall through to slow logic below, after the previous conditional
+    // selects specific methods we might be interested in
+
+  } else {
+    // what are we doing here?
+    goto out;
+  }
+
+  // are we watching for slow method calls?
   if (rbtracer.slow) {
     uint64_t usec = timeofday_usec(), diff = 0;
 
@@ -366,34 +400,6 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     goto out;
   }
 
-  int i, n;
-  rbtracer_t *tracer = NULL;
-
-  if (!rbtracer.firehose) {
-    // are there specific methods we're waiting for?
-    if (rbtracer.num == 0) goto out;
-
-    for (i=0, n=0; i<MAX_TRACERS && n<rbtracer.num; i++) {
-      rbtracer_t *curr = &rbtracer.list[i];
-
-      if (curr->query) {
-        n++;
-
-        if (!curr->mid || curr->mid == mid) {
-          if (!curr->klass || curr->klass == klass) {
-            if (!curr->self || curr->self == self) {
-              tracer = curr;
-              break;
-            }
-          }
-        }
-      }
-    }
-
-    // no matching method tracer found, so bail!
-    if (!tracer) goto out;
-  }
-
   switch (event) {
     case RUBY_EVENT_CALL:
     case RUBY_EVENT_C_CALL:
@@ -408,6 +414,7 @@ event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
       );
 
       if (tracer && tracer->num_exprs) {
+        int i;
         for (i=0; i<tracer->num_exprs; i++) {
           char *expr = tracer->exprs[i];
           size_t len = strlen(expr);
@@ -537,11 +544,14 @@ out:
 }
 
 static void
-rbtracer_remove_all()
+rbtracer_detach()
 {
+  rbtracer.attached_pid = 0;
+
   rbtracer.firehose = false;
   rbtracer.slow = false;
   rbtracer.gc = false;
+  rbtracer.devmode = false;
 
   int i;
   for (i=0; i<MAX_TRACERS; i++) {
@@ -577,22 +587,78 @@ rbtracer_add(char *query)
   }
   if (!tracer) goto out;
 
-  VALUE klass = 0, self = 0;
+  size_t
+    klass_begin = 0,
+    klass_end = 0;
+
+  bool is_singleton = false;
+
+  VALUE
+    klass = 0,
+    self = 0;
+
   ID mid = 0;
 
-  rbtracer__resolve_query(query, &klass, &self, &mid);
+  { // resolve query into its parts
+    char
+      *idx = NULL,
+      *method = NULL;
 
-  if (!mid && !klass && !self)
-    goto out;
+    if (NULL != (idx = rindex(query, '.'))) {
+      klass_begin = 0;
+      klass_end = idx - query;
+      is_singleton = true;
+
+      *idx = 0;
+      if (!rbtracer.devmode)
+        self = rb_eval_string_protect(query, 0);
+      *idx = '.';
+
+      method = idx+1;
+
+    } else if (NULL != (idx = rindex(query, '#'))) {
+      klass_begin = 0;
+      klass_end = idx - query;
+      is_singleton = false;
+
+      *idx = 0;
+      if (!rbtracer.devmode)
+        klass = rb_eval_string_protect(query, 0);
+      *idx = '#';
+
+      method = idx+1;
+
+    } else {
+      method = query;
+    }
+
+    if (method && *method) {
+      mid = rb_intern(method);
+    }
+  }
+
+  if (rbtracer.devmode) {
+    if (!mid && (klass_begin == klass_end))
+      goto out;
+  } else {
+    if (!mid && !klass && !self)
+      goto out;
+  }
 
   memset(tracer, 0, sizeof(*tracer));
 
   tracer->id = tracer_id;
+  tracer->query = strdup(query);
+
+  if (klass_end != klass_begin) {
+    tracer->klass_name = tracer->query + klass_begin;
+    tracer->klass_len = klass_end - klass_begin;
+  }
+  tracer->is_singleton = is_singleton;
+
   tracer->self = self;
   tracer->klass = klass;
   tracer->mid = mid;
-  tracer->query = strdup(query);
-  tracer->num_exprs = 0;
 
   if (rbtracer.num == 0)
     event_hook_install();
@@ -769,13 +835,14 @@ sigurg(int signal)
         );
 
       } else if (0 == strncmp("detach", str.ptr, str.size)) {
-        rbtrace__send_event(1,
-          "detached",
-          'u', (uint32_t) rbtracer.attached_pid
-        );
+        if (rbtracer.attached_pid) {
+          rbtrace__send_event(1,
+            "detached",
+            'u', (uint32_t) rbtracer.attached_pid
+          );
+        }
 
-        rbtracer.attached_pid = 0;
-        rbtracer_remove_all();
+        rbtracer_detach();
 
       } else if (0 == strncmp("watch", str.ptr, str.size)) {
         if (ary.size != 2 ||
@@ -814,6 +881,9 @@ sigurg(int signal)
       } else if (0 == strncmp("gc", str.ptr, str.size)) {
         rbtracer.gc = true;
 
+      } else if (0 == strncmp("devmode", str.ptr, str.size)) {
+        rbtracer.devmode = true;
+
       }
     }
   }

data/rbtrace.gemspec

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

data/server.rb

@@ -7,6 +7,15 @@ class String
   end
 end
 
+(reload_test = proc{
+  Object.send(:remove_const, :Test) if defined? Test
+  Test = Class.new do
+    def self.run
+      :abc
+    end
+  end
+}).call
+
 while true
   proc {
     Dir.chdir("/tmp") do
@@ -14,7 +23,11 @@ while true
       Process.pid
       'hello'.multiply_vowels(3){ :ohai }
       sleep rand*0.5
+
       GC.start
+
+      reload_test.call
+      Test.run
     end
   }.call
 end

data/test.sh

@@ -30,6 +30,7 @@ trace() {
   echo
 }
 
+trace -m Test.run --devmode
 trace -m sleep
 trace -m sleep Dir.chdir Dir.pwd Process.pid "String#gsub" "String#*"
 trace -m "Kernel#"
@@ -37,6 +38,7 @@ trace -m "String#gsub(self,@test)" "String#*(self,__source__)" "String#multiply_
 trace --gc --slow=200
 trace --gc -m Dir.
 trace --slow=250
+trace --slow=250 -m sleep
 trace --firehose
 
 cleanup

data/tracers/unicorn.tracer

@@ -0,0 +1 @@
+Unicorn::App::OldRails#call(env['PATH_INFO'])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbtrace
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Aman Gupta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-19 00:00:00 -08:00
+date: 2011-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,6 +91,7 @@ files:
 - tracers/eventmachine.tracer
 - tracers/io.tracer
 - tracers/redis.tracer
+- tracers/unicorn.tracer
 has_rdoc: true
 homepage: http://github.com/tmm1/rbtrace
 licenses: []