chrisa-ruby-dtrace 0.2.0

data/plugin/dtrace/public/stylesheets/dtrace.css

@@ -0,0 +1,48 @@
+body {
+  margin-bottom:25px;
+}
+
+#dtrace {
+  width:100%;
+}
+
+#dtrace td, #dtrace th, #dtrace div, #dtrace p {
+  text-align:left;
+}
+
+#dtrace a,
+#dtrace a:visited {
+  color:#005;
+  text-decoration:none;
+}
+
+#dtrace a:hover,
+#dtrace a:active {
+  text-decoration:underline;
+}
+
+#dtrace .dtrace-tab {
+  background-color:#fff;
+  padding:1em;
+  margin:0;
+}
+
+#dtrace-tabs {
+  width:100%;
+  height:25px;
+  margin:0; padding:0;
+  list-style-type:none;
+  background:#000;
+}
+
+#dtrace-tabs li {
+  float:left;
+}
+
+#dtrace-tabs li a,
+#dtrace-tabs li a:visited {
+  display:block;
+  line-height:25px;
+  margin:0 1em;
+  color:#fff;
+}

data/plugin/dtrace/scripts/default.d

@@ -0,0 +1,11 @@
+syscall:::entry
+/pid == $1/
+{
+        @syscalls[probefunc] = count();
+}
+
+END
+{
+        printf("System Calls");
+        printa(@syscalls);
+}

data/plugin/dtrace/scripts/rails_mysql.d

@@ -0,0 +1,29 @@
+pid$1::mysql_real_query:entry
+{
+        @queries[copyinstr(arg1)] = count();
+}
+
+ruby$1:::function-entry
+{
+        @rbclasses[this->class = copyinstr(arg0)] = count();
+        this->sep = strjoin(this->class, "#");
+        @rbmethods[strjoin(this->sep, copyinstr(arg1))] = count();
+}
+
+syscall:::entry
+/pid == $1/
+{
+        @syscalls[probefunc] = count();
+}
+
+END
+{
+        printf("MySQL Queries");
+        printa(@queries);
+        printf("System Calls");
+        printa(@syscalls);
+        printf("Ruby Classes");
+        printa(@rbclasses);
+        printf("Ruby Methods");
+        printa(@rbmethods);
+}

data/plugin/dtrace/tasks/dtrace.rake

@@ -0,0 +1,52 @@
+namespace :dtrace do
+
+  desc 'Set up dtrace in your rails application'
+  task :setup do
+    ['dtracer'].each do |script|
+      script_dest = "#{RAILS_ROOT}/script/#{script}"
+      script_src = File.dirname(__FILE__) + "/../bin/#{script}.rb"
+      
+      FileUtils.chmod 0774, script_src
+      
+      unless File.exists?(script_dest)
+        puts "Copying acts_as_encrypted script #{script}.rb to #{script_dest}"
+        FileUtils.cp_r(script_src, script_dest)
+      end
+    end
+
+    ['stylesheets/dtrace.css'].each do |asset|
+      asset_dest = "#{RAILS_ROOT}/public/#{asset}"
+      asset_src = File.dirname(__FILE__) + "/../public/#{asset}"
+      
+      FileUtils.chmod 0774, asset_src
+      
+      unless File.exists?(asset_dest)
+        puts "Copying acts_as_encrypted asset #{asset} to #{asset_dest}"
+        FileUtils.cp_r(asset_src, asset_dest)
+      end
+    end
+  end
+  
+  desc 'Remove dtrace from your rails application'
+  task :remove do 
+    ['dtracer'].each do |script|
+      script_dest = "#{RAILS_ROOT}/script/#{script}"
+
+      if File.exists?(script_dest)
+        puts "Removing #{script_dest} ..."
+        FileUtils.rm(script_dest, :force => true)
+      end
+    end
+
+    ['stylesheets/dtrace.css'].each do |asset|
+      asset_dest = "#{RAILS_ROOT}/public/#{asset}"
+
+      if File.exists?(asset_dest)
+        puts "Removing #{asset_dest} ..."
+        FileUtils.rm(asset_dest, :force => true)
+      end
+    end
+  end
+
+end
+    

data/plugin/dtrace/test/dtrace_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class DtraceTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/plugin/dtrace/views/dtrace/_report.rhtml

@@ -0,0 +1,26 @@
+<style type="text/css">
+  div#dtrace-report { background-color: #ddd; padding: 1em; margin: 1em; }
+  table.dtrace-report { background-color: #eee }
+</style>
+
+<% if controller.dtrace_report.length > 0 %>
+<div id="dtrace-report">
+  <h2>DTrace Report: <%=h controller.dtrace_script %></h2>
+  <% controller.dtrace_report.each do |r| %>
+  <table class="dtrace-report">
+    <% if r.respond_to? :data %>
+    <% r.data.sort {|a,b| b.value <=> a.value }.each do |agg| %>
+    <tr>
+      <td><%=h agg.tuple %></td>
+      <td><%=h agg.value %></td>
+    </tr>
+    <% end %>
+    <% else %>
+      <% if r.value != 0 %>
+      <h3><%=h r.value %></h3>
+      <% end %>
+    <% end %>
+  </table>
+  <% end %>
+</div>
+<% end %>

data/test/disabled_probe_effect.txt

@@ -0,0 +1,19 @@
+solaris-devx:~/ruby-dtrace-dof/ruby-dtrace chris$ ruby -Iext:lib test/test_disabled_probe_effect.rb
+Loaded suite test/test_disabled_probe_effect
+Started
+      user     system      total        real
+noprobes:  0.020000   0.020000   0.040000 (  0.042108)
+disabled:  0.120000   0.110000   0.230000 (  0.231237)
+enabled:   2.670000   0.260000   2.930000 (  2.940411)
+.
+Finished in 3.220336 seconds.
+
+1 tests, 1 assertions, 0 failures, 0 errors
+
+merge Dtrace::Probe and Dtrace::Stub:
+
+Started
+      user     system      total        real
+noprobes:  0.000000   0.010000   0.010000 (  0.020863)
+disabled:  0.090000   0.090000   0.180000 (  0.170912)
+enabled:   2.690000   0.330000   3.020000 (  3.027719)

data/test/test_disabled_probe_effect.rb

@@ -0,0 +1,60 @@
+#
+# Ruby-Dtrace
+# (c) 2008 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace'
+require 'dtrace/provider'
+require 'test/unit'
+require 'benchmark'
+
+class TestDisabledProbeEffect < Test::Unit::TestCase
+
+  def test_probe_no_args
+    
+    n = 20000
+    Benchmark.bm do |x|
+      
+      x.report "noprobes:" do 
+        # First time a loop with no probes created
+        (1..n).each do |i|
+          # no op
+        end
+      end
+      
+      x.report "disabled:" do 
+        # Second time a loop with probes created but not enabled.
+        Dtrace::Provider.create :dpe do |p|
+          p.probe :p1
+        end
+        
+        (1..n).each do |i|
+          Dtrace::Probe::Dpe.p1 { |p| p.fire }
+        end
+      end
+    
+      x.report "enabled: " do
+        # Third time a loop with probes enabled
+        t = Dtrace.new 
+        t.setopt("bufsize", "4m")
+        
+        progtext = <<EOD
+dpe*:ruby:test_probe_no_args:p1
+{
+}
+EOD
+        
+        prog = t.compile progtext
+        prog.execute
+        t.go
+        
+        (1..n).each do |i|
+          Dtrace::Probe::Dpe.p1 { |p| p.fire }
+        end
+      end
+    end
+
+    assert 1
+
+  end
+end

data/test/test_dof_generator.rb

@@ -0,0 +1,142 @@
+#
+# Ruby-Dtrace
+# (c) 2008 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace'
+require 'dtrace/dof'
+require 'test/unit'
+require 'pp'
+
+$dof_dir = File.dirname(__FILE__)
+
+# Tests for the Dtrace DOF generator
+
+class TestDofGenerator < Test::Unit::TestCase
+  include Dtrace::Dof::Constants
+
+  def test_generate_section_comments
+    s = Dtrace::Dof::Section.new(DOF_SECT_COMMENTS, 1)
+    s.data = "Ruby-Dtrace D 0.12"
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_utsname
+    s = Dtrace::Dof::Section.new(DOF_SECT_UTSNAME, 2)
+    dof = s.generate
+    assert dof
+  end
+    
+  def test_generate_section_probes
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROBES, 3)
+    s.data = [
+              {:enoffidx=>14,
+                :argidx=>16,
+                :nenoffs=>1,
+                :offidx=>14,
+                :name=>1,
+                :addr=>0x8082a78,
+                :nargc=>1,
+                :func=>5,
+                :xargc=>1,
+                :nargv=>3,
+                :noffs=>1,
+                :xargv=>3},
+              {:enoffidx=>15,
+                :argidx=>17,
+                :nenoffs=>1,
+                :offidx=>15,
+                :name=>4,
+                :addr=>0x807429c,
+                :nargc=>3,
+                :func=>9,
+                :xargc=>3,
+                :nargv=>6,
+                :noffs=>1,
+                :xargv=>7},
+             ]
+    
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_strtab
+    s = Dtrace::Dof::Section.new(DOF_SECT_STRTAB, 1)
+    s.data = ['foo', 'bar', 'baz']
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_prargs
+    s = Dtrace::Dof::Section.new(DOF_SECT_PRARGS, 1)
+    s.data = [ 1, 2 ]
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_proffs
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROFFS, 1)
+    s.data = [ 3, 4 ]
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_prenoffs
+    s = Dtrace::Dof::Section.new(DOF_SECT_PRENOFFS, 1)
+    s.data = [ 5, 6 ]
+    dof = s.generate
+    assert dof
+  end
+
+  def test_generate_section_provider
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROVIDER, 1)
+    data = {
+      :strtab => 1,
+      :probes => 2,
+      :prargs => 3,
+      :proffs => 4,
+      :prenoffs => 5,
+      :name => 1,
+      :provattr => { :name => 1, :data => 1, :class => 1 },
+      :modattr  => { :name => 1, :data => 1, :class => 1 },
+      :funcattr => { :name => 1, :data => 1, :class => 1 },
+      :nameattr => { :name => 1, :data => 1, :class => 1 },
+      :argsattr => { :name => 1, :data => 1, :class => 1 }
+    }
+    s.data = data
+    dof = s.generate
+    assert dof
+  end
+
+  def test_dof_generate_section_reltab
+    s = Dtrace::Dof::Section.new(DOF_SECT_RELTAB, 5)
+    data = [
+            { :name   => 20, # main
+              :type   => 1,  # setx?
+              :offset => 0,
+              :data   => 0,
+            }
+           ]
+    s.data = data
+    dof = s.generate
+    assert dof
+  end
+
+  def test_dof_generate_section_urelhdr
+    s = Dtrace::Dof::Section.new(DOF_SECT_URELHDR, 6)
+    data = {
+      :strtab => 0,
+      :relsec => 5,
+      :tgtsec => 1,
+    }
+    s.data = data
+    dof = s.generate
+    assert dof
+  end
+
+  def test_const
+    assert Dtrace::Dof::Constants::DOF_SECT_UTSNAME
+    assert DOF_SECT_UTSNAME
+  end
+end

data/test/test_dof_helper.rb

@@ -0,0 +1,106 @@
+#
+# Ruby-Dtrace
+# (c) 2008 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace'
+require 'dtrace/dof'
+require 'test/unit'
+
+$dof_dir = File.dirname(__FILE__)
+
+class TestDofHelper < Test::Unit::TestCase
+  include Dtrace::Dof::Constants
+  
+  def test_sun_dof
+    dof = File.read("#{$dof_dir}/dof")
+    f = Dtrace::Dof::File.new
+    f << dof
+    Dtrace::Dof.loaddof(f, 'testmodule')
+
+    t = Dtrace.new
+    matches = 0
+    t.each_probe do |p|
+      if p.to_s == "test#{$$}:testmodule:main:test"
+        matches += 1
+      end
+    end
+    assert_equal 1, matches
+  end
+  
+  def test_file
+    f = Dtrace::Dof::File.new
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_STRTAB, 0)
+    s.data = ['test', 'char *', 'char *', 'main', 'test']
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROBES, 1)
+    s.data = [
+              {:nargv=>6,
+               :noffs=>1,
+               :xargv=>13,
+               :enoffidx=>0,
+               :argidx=>0,
+               :name=>1,
+               :nenoffs=>0,
+               :offidx=>0,
+               :addr=>0,
+               :nargc=>1,
+               :func=>20,
+               :xargc=>1}
+             ]
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_PRARGS, 2)
+    s.data = [ 0 ]
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROFFS, 3)
+    s.data = [ 36 ]
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_PRENOFFS, 4)
+    s.data = [ 0 ]
+    f.sections << s
+    
+    s = Dtrace::Dof::Section.new(DOF_SECT_PROVIDER, 5)
+    s.data = {
+      :strtab => 0,
+      :probes => 1,
+      :prargs => 2,
+      :proffs => 3,
+      :prenoffs => 4,
+      :name => 25,
+      :provattr => { :name => 5, :data => 5, :class => 5 },
+      :modattr  => { :name => 1, :data => 1, :class => 5 },
+      :funcattr => { :name => 1, :data => 1, :class => 5 },
+      :nameattr => { :name => 5, :data => 5, :class => 5 },
+      :argsattr => { :name => 5, :data => 5, :class => 5 }
+    }
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_COMMENTS, 7)
+    s.flags = 0 # no load
+    s.data = "Ruby-Dtrace 0.12"
+    f.sections << s
+
+    s = Dtrace::Dof::Section.new(DOF_SECT_UTSNAME, 8)
+    s.flags = 0 # no load
+    f.sections << s
+
+    f.generate
+    Dtrace::Dof.loaddof(f, 'testmodule')
+
+    t = Dtrace.new
+    matches = 0
+    t.each_probe do |p|
+      if p.to_s == "test#{$$}:testmodule:main:test"
+        matches += 1
+      end
+    end
+    assert_equal 1, matches
+
+  end
+
+end

data/test/test_dof_parser.rb

@@ -0,0 +1,25 @@
+#
+# Ruby-Dtrace
+# (c) 2008 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace/dof'
+require 'test/unit'
+
+$dof_dir = File.dirname(__FILE__)
+
+# Tests for the Dtrace DOF parser
+
+class TestDofParser < Test::Unit::TestCase
+
+  def test_parse
+    assert File.exists?("#{$dof_dir}/dof")
+    dof = Dtrace::Dof::Parser.parse(IO.read("#{$dof_dir}/dof"))
+  end
+
+  def test_parse_apple_dof
+    assert File.exists?("#{$dof_dir}/apple-dof")
+    dof = Dtrace::Dof::Parser.parse(IO.read("#{$dof_dir}/apple-dof"))
+  end
+
+end