rbtrace 0.2.7 → 0.2.8

data/README.md

@@ -156,8 +156,12 @@ rbtrace works on ruby 1.8 and 1.9, running on linux or mac osx.
 
 * switch ipc to [msgpack](https://github.com/dhotson/msgpack/tree/master/c) instead of csv
 * add triggers to start tracing slow methods only inside another method
+* syntax check expressions before adding them
+* add special expressions for method args (_arg0_, _arguments_)
 * optimize local variable lookup to avoid instance_eval
-* use shared memory region for symbol table to avoid lookup on every event
-* use another shm for class name lookup, and wipe on every GC
+* 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

@@ -142,9 +142,11 @@ class RBTracer
       raise ArgumentError, 'pid is not listening for messages, did you `require "rbtrace"`'
     end
 
+    @klasses = {}
+    @methods = {}
     @tracers = Hash.new{ |h,k|
       h[k] = {
-        :name => nil,
+        :query => nil,
         :times => [],
         :names => [],
         :exprs => {},
@@ -152,12 +154,16 @@ class RBTracer
         :arglist => false
       }
     }
-    @nesting = 0
+    @max_nesting = @nesting = 0
     @last_tracer = nil
+
     @out = STDOUT
     @prefix = '  '
+
     @show_time = false
     @show_duration = true
+
+    attach
   end
 
   # Watch for method calls slower than a threshold.
@@ -184,6 +190,7 @@ class RBTracer
   def add(methods)
     Array(methods).each do |func|
       func = func.strip
+      next if func.empty?
 
       if func =~ /^(.+)\((.+)\)$/
         func, args = $1, $2
@@ -198,6 +205,18 @@ class RBTracer
     end
   end
 
+  # Attach to the process.
+  #
+  # Returns nothing.
+  def attach
+    send_cmd("attach,#{Process.pid}")
+    if wait_for{ @attached == true }
+      STDERR.puts "*** attached to process #{pid}"
+    else
+      raise ArgumentError, 'process already being traced?'
+    end
+  end
+
   # Detach from the traced process.
   #
   # Returns nothing.
@@ -209,13 +228,16 @@ class RBTracer
 
     puts
 
-    # drain queue
-    5.times do
-      begin
-        true while recv_cmd(false)
-      rescue
-      end
+    if wait_for{ @attached == false }
+      puts
+      STDERR.puts "*** detached from process #{pid}"
+    else
+      puts
+      STDERR.puts "*** could not detach cleanly from process #{pid}"
     end
+  rescue Errno::EINVAL, Errno::EIDRM
+    puts
+    STDERR.puts "*** process #{pid} is gone"
   end
 
   # Process events from the traced process.
@@ -224,26 +246,62 @@ class RBTracer
   def recv_loop
     while true
       # block until a message arrives
-      lines = [recv_cmd]
+      process_line(recv_cmd)
 
-      # check to see if there are more messages and pull them off
-      # so the queue doesn't fill up in kernel land
-      25.times do
-        break unless line = recv_cmd(false)
-        lines << line
-      end
+      # process any remaining messages
+      recv_lines
+    end
+  rescue Errno::EINVAL, Errno::EIDRM
+    # process went away
+  end
 
-      lines.each do |line|
-        process_line(line)
-      end
+  # Process events from the traced process, without blocking if
+  # there is nothing to do. This is a useful way to drain the buffer
+  # so messages do not accumulate in kernel land.
+  #
+  # Returns nothing.
+  def recv_lines
+    50.times do
+      break unless line = recv_cmd(false)
+      process_line(line)
     end
   end
 
   private
 
+  # 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)
+    wait = 0.05 # polling interval
+
+    (time/wait).to_i.times do
+      begin
+        recv_lines
+        sleep(wait)
+        time -= wait
+
+        return true if yield
+      rescue Interrupt
+        STDERR.puts "*** waiting to detach cleanly (#{time.to_i}s left)"
+        retry
+      end
+    end
+
+    false
+  end
+
   def send_cmd(msg)
-    MsgQ::EventMsg.send_cmd(@qo, msg)
+    begin
+      MsgQ::EventMsg.send_cmd(@qo, msg)
+    rescue Errno::EINTR
+      retry
+    end
     Process.kill 'URG', @pid
+    recv_lines
   end
 
   def recv_cmd(block=true)
@@ -263,19 +321,45 @@ class RBTracer
   end
 
   def process_line(line)
-    time, event, id, *args = line.strip.split(',')
+    time, event, _id, *args = line.strip.split(',')
     time = time.to_i
-    id = id.to_i
+    id = _id.to_i
+
+    case event
+    when 'attached'
+      @attached = true
+      if id != Process.pid
+        STDERR.puts "*** process #{pid} is already being traced"
+        exit!(-1)
+      end
+      return
+
+    when 'detached'
+      @attached = false
+      return
+    end
+
+    if !@attached
+      STDERR.puts "*** got #{event} before attaching"
+      return
+    end
+
     tracer = @tracers[id] if id > -1
 
     case event
+    when 'mid'
+      @methods[id.to_i] = args.first
+
+    when 'klass'
+      @klasses[_id.to_i(16)] = args.first
+
     when 'add'
       if id == -1
         puts line
       else
-        name = args.first
+        query = args.first
         @tracers.delete(id)
-        @tracers[id][:name] = name
+        @tracers[id][:query] = query
       end
 
     when 'remove'
@@ -294,7 +378,8 @@ class RBTracer
       end
 
     when 'exprval'
-      expr_id, val = *args
+      expr_id = args.shift
+      val = args.join(',')
       expr_id = expr_id.to_i
       expr = tracer[:exprs][expr_id]
 
@@ -311,8 +396,9 @@ class RBTracer
     when 'call','ccall'
       method, is_singleton, klass = *args
       is_singleton = (is_singleton == '1')
+      klass = @klasses[klass.to_i(16)]
       name = klass ? "#{klass}#{ is_singleton ? '.' : '#' }" : ''
-      name += method
+      name += @methods[method.to_i] || '(unknown)'
 
       tracer[:times] << time
       tracer[:names] << name
@@ -331,6 +417,7 @@ class RBTracer
       print name
 
       @nesting += 1
+      @max_nesting = @nesting if @nesting > @max_nesting
       @last_tracer = tracer
       tracer[:last] = name
 
@@ -351,7 +438,12 @@ class RBTracer
           print name
         end
         print ' <%f>' % (diff/1_000_000.0) if @show_duration
-        puts if @nesting == 0 and (tracer != @last_tracer || @last_tracer[:last] != name)
+
+        if @nesting == 0 and @max_nesting > 1
+          # unless tracer == @last_tracer and @last_tracer[:last] == name
+            puts
+          # end
+        end
       end
 
       tracer[:arglist] = false
@@ -362,8 +454,9 @@ class RBTracer
       diff = diff.to_i
 
       is_singleton = (is_singleton == '1')
+      klass = @klasses[klass.to_i(16)]
       name = klass ? "#{klass}#{ is_singleton ? '.' : '#' }" : ''
-      name += method
+      name += @methods[method.to_i] || '(unknown)'
 
       print @prefix*nesting if nesting > 0
       print name
@@ -390,7 +483,7 @@ class RBTracer
     parser = Trollop::Parser.new do
       version <<-EOS
 rbtrace: like strace, but for ruby code
-  version 0.2.7
+  version 0.2.8
   (c) 2011 Aman Gupta (tmm1)
   http://github.com/tmm1/rbtrace
 EOS
@@ -416,6 +509,10 @@ Tracers:
   rbtrace --slow=250       # trace method calls slower than 250ms
   rbtrace --methods a b c  # trace calls to given methods
 
+  rbtrace -c io            # trace common input/output functions
+  rbtrace -c eventmachine  # trace common eventmachine functions
+  rbtrace -c my.tracer     # trace all methods listed in my.tracer
+
 Method Selectors:
 
   sleep                    # any instance or class method named sleep
@@ -469,6 +566,10 @@ EOS
         :type => String,
         :short => '-o'
 
+      opt :append,
+        "append to output file instead of overwriting",
+        :short => '-a'
+
       opt :prefix,
         "prefix nested method calls with N spaces",
         :default => 2,
@@ -476,7 +577,7 @@ EOS
 
       opt :config,
         "config file",
-        :type => String,
+        :type => :strings,
         :short => '-c'
     end
 
@@ -485,6 +586,10 @@ EOS
       parser.parse(ARGV)
     end
 
+    if out = opts[:output]
+      file = File.open(out, opts[:append] ? 'a+' : 'w')
+    end
+
     slow = nil
     firehose = nil
     methods = nil
@@ -499,15 +604,25 @@ EOS
       methods = opts[:methods]
 
     elsif opts[:config_given]
-      if File.exists?(config = opts[:config])
-        methods = []
-        File.readlines(config).each do |line|
-          next if line =~ /^#/
-          methods << line.strip
+      methods = []
+
+      Array(opts[:config]).each do |config|
+        file = [
+          config,
+          File.expand_path("../../tracers/#{config}.tracer",__FILE__)
+        ].find{ |f| File.exists?(f) }
+
+        unless file
+          parser.die :config, '(file does not exist)'
         end
 
-      else
-        parser.die :config, "invalid config file"
+        File.readlines(file).each do |line|
+          line.strip!
+          next if line =~ /^#/
+          next if line.empty?
+
+          methods << line
+        end
       end
 
     else
@@ -520,7 +635,7 @@ EOS
       begin
         tracer = RBTracer.new(opts[:pid])
       rescue ArgumentError => e
-        parser.die :pid, "invalid (#{e.message})"
+        parser.die :pid, "(#{e.message})"
       end
 
       if slow
@@ -531,8 +646,8 @@ EOS
         tracer.add(methods)
       end
 
-      if out = opts[:output]
-        tracer.out = File.open(out,'w')
+      if file
+        tracer.out = file
       end
 
       tracer.prefix = ' ' * opts[:prefix]
@@ -540,14 +655,12 @@ EOS
       tracer.show_time = opts[:start_time]
 
       begin
-        STDERR.puts "*** attached to process #{tracer.pid}"
         tracer.recv_loop
       rescue Interrupt
       end
     ensure
       if tracer
         tracer.detach
-        STDERR.puts "*** detached from process #{tracer.pid}"
       end
     end
   end

data/ext/rbtrace.c

@@ -20,9 +20,11 @@
 #include <env.h>
 #include <intern.h>
 #include <node.h>
+#include <st.h>
 #define rb_sourcefile() (ruby_current_node ? ruby_current_node->nd_file : 0)
 #define rb_sourceline() (ruby_current_node ? nd_line(ruby_current_node) : 0)
 #else
+#include <ruby/st.h>
 // this is a nasty hack, and will probably break on anything except 1.9.2p136
 int rb_thread_method_id_and_class(void *th, ID *idp, VALUE *klassp);
 RUBY_EXTERN void *ruby_current_thread;
@@ -63,14 +65,17 @@ struct rbtracer_t {
 };
 typedef struct rbtracer_t rbtracer_t;
 
-
 struct event_msg {
   long mtype;
   char buf[BUF_SIZE];
 };
 
-
 static struct {
+  st_table *mid_tbl;
+  st_table *klass_tbl;
+
+  pid_t attached_pid;
+
   bool installed;
 
   bool firehose;
@@ -89,6 +94,11 @@ static struct {
   int mqi_id;
 }
 rbtracer = {
+  .mid_tbl = NULL,
+  .klass_tbl = NULL,
+
+  .attached_pid = 0,
+
   .installed = false,
 
   .firehose = false,
@@ -110,7 +120,7 @@ rbtracer = {
   if (false) {\
     fprintf(stderr, "%" PRIu64 "," format, usec, __VA_ARGS__);\
     fprintf(stderr, "\n");\
-  } else if (rbtracer.mqo_id != -1) {\
+  } else if (rbtracer.mqo_id != -1 && rbtracer.attached_pid) {\
     struct event_msg msg;\
     int ret = -1, n = 0;\
     \
@@ -119,8 +129,9 @@ rbtracer = {
     \
     for (n=0; n<10 && ret==-1; n++)\
       ret = msgsnd(rbtracer.mqo_id, &msg, sizeof(msg)-sizeof(long), IPC_NOWAIT);\
-    if (ret == -1) {\
-      fprintf(stderr, "msgsnd(): %s\n", strerror(errno));\
+    \
+    if (ret == -1 && rbtracer.mqo_id != -1 && errno != EINVAL) {\
+      fprintf(stderr, "msgsnd(%d): %s\n", rbtracer.mqo_id, strerror(errno));\
       struct msqid_ds stat;\
       msgctl(rbtracer.mqo_id, IPC_STAT, &stat);\
       fprintf(stderr, "cbytes: %lu, qbytes: %lu, qnum: %lu\n", stat.msg_cbytes, stat.msg_qbytes, stat.msg_qnum);\
@@ -128,6 +139,34 @@ rbtracer = {
   }\
 } while (0)
 
+static inline void
+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(
+      "mid,%lu,%s",
+      mid,
+      rb_id2name(mid)
+    );
+  }
+
+  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);
+    SEND_EVENT(
+      "klass,%p,%s",
+      (void*)klass,
+      rb_class2name(klass)
+    );
+  }
+}
+
 static void
 #ifdef RUBY_VM
 event_hook(rb_event_flag_t event, VALUE data, VALUE self, ID mid, VALUE klass)
@@ -191,14 +230,15 @@ 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(
-        "%s,-1,%" PRIu64 ",%d,%s,%d,%s",
+        "%s,-1,%" PRIu64 ",%d,%lu,%d,%p",
         event == RUBY_EVENT_RETURN ? "slow" : "cslow",
         diff,
         rbtracer.num_calls,
-        rb_id2name(mid),
+        mid,
         singleton,
-        klass ? rb_class2name(singleton ? self : klass) : ""
+        (void*)(singleton ? self : klass)
       );
     }
 
@@ -234,13 +274,14 @@ 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(
-        "%s,%d,%s,%d,%s",
+        "%s,%d,%lu,%d,%p",
         event == RUBY_EVENT_CALL ? "call" : "ccall",
         tracer ? tracer->id : 255, // hax
-        rb_id2name(mid),
+        mid,
         singleton,
-        klass ? rb_class2name(singleton ? self : klass) : ""
+        (void*)(singleton ? self : klass)
       );
 
       if (tracer && tracer->num_exprs) {
@@ -385,6 +426,14 @@ rbtracer_remove_all()
       rbtracer_remove(NULL, i);
     }
   }
+
+  if (rbtracer.mid_tbl)
+    st_free_table(rbtracer.mid_tbl);
+  rbtracer.mid_tbl = NULL;
+
+  if (rbtracer.klass_tbl)
+    st_free_table(rbtracer.klass_tbl);
+  rbtracer.klass_tbl = NULL;
 }
 
 static int
@@ -625,7 +674,27 @@ sigurg(int signal)
       } else if (0 == strncmp("unwatch", msg.buf, 7)) {
         rbtracer_unwatch();
 
+      } else if (0 == strncmp("attach,", msg.buf, 7)) {
+        pid_t pid = 0;
+
+        query = msg.buf + 7;
+        if (query && *query)
+          pid = (pid_t)atoi(query);
+
+        if (pid && rbtracer.attached_pid == 0)
+          rbtracer.attached_pid = pid;
+
+        SEND_EVENT(
+          "attached,%u",
+          rbtracer.attached_pid
+        );
+
       } else if (0 == strncmp("detach", msg.buf, 6)) {
+        SEND_EVENT(
+          "detached,%u",
+          rbtracer.attached_pid
+        );
+        rbtracer.attached_pid = 0;
         rbtracer_remove_all();
 
       }

data/rbtrace.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'rbtrace'
-  s.version = '0.2.7'
+  s.version = '0.2.8'
   s.homepage = 'http://github.com/tmm1/rbtrace'
 
-  s.authors = "Aman Gupta"
-  s.email   = "aman@tmm1.net"
+  s.authors = 'Aman Gupta'
+  s.email   = 'aman@tmm1.net'
 
   s.files = `git ls-files`.split("\n")
-  s.extensions = "ext/extconf.rb"
+  s.extensions = 'ext/extconf.rb'
 
   s.bindir = 'bin'
   s.executables << 'rbtrace'

data/tracers/activerecord.tracer

@@ -0,0 +1 @@
+ActiveRecord::ConnectionAdapters::MysqlAdapter#execute(sql)

data/tracers/eventmachine.tracer

@@ -0,0 +1,27 @@
+# incoming events
+post_init(@signature)
+connection_completed(@signature)
+receive_data(@signature)
+unbind(@signature)
+
+# connection methods
+EM::Connection#send_data(@signature, data.size, data[0..5])
+EM::Connection#send_datagram(@signature, data.size, data[0..5])
+EM::Connection#start_tls(@signature, args)
+EM::Connection#close_connection(@signature, after_writing)
+EM::Connection#proxy_incoming_to(@signature, conn, bufsize)
+EM::Connection#(@signature)
+
+# timers
+EM.add_periodic_timer(args, block)
+EM.add_timer(args, block)
+EM.cancel_timer(timer_or_sig,@timers.size)
+
+# event loop
+EM.stop
+
+# connections
+EM.start_server(server, port, handler)
+EM.stop_server
+EM.connect(server, port, handler)
+EM.reconnect(server, port, handler)

data/tracers/io.tracer

@@ -0,0 +1,4 @@
+IO.select
+IO#
+TCPSocket#
+TCPServer#

data/tracers/redis.tracer

@@ -0,0 +1 @@
+Redis::Client#process(commands)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbtrace
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Aman Gupta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -08:00
+date: 2011-02-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,10 @@ files:
 - rbtrace.gemspec
 - server.rb
 - test.sh
+- tracers/activerecord.tracer
+- tracers/eventmachine.tracer
+- tracers/io.tracer
+- tracers/redis.tracer
 has_rdoc: true
 homepage: http://github.com/tmm1/rbtrace
 licenses: []