ruby-dtrace 0.0.1

data/ext/dtrace_probe.c

@@ -0,0 +1,78 @@
+/* Ruby-Dtrace
+ * (c) 2007 Chris Andrews <chris@nodnol.org>
+ */
+
+#include "dtrace_api.h"
+
+/* :nodoc: */
+VALUE dtraceprobe_init(VALUE self)
+{
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  return self;
+}
+
+/*
+ * Returns the id of the probe. Corresponds to the ID displayed by
+ * dtrace -l
+ */
+VALUE dtraceprobe_probe_id(VALUE self)
+{
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  return INT2NUM(pdp->dtpd_id);
+}
+
+/*
+ * Returns the name of the probe's provider.
+ */
+VALUE dtraceprobe_provider(VALUE self)
+{
+  VALUE string;
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  string = rb_str_new2(pdp->dtpd_provider);
+  return string;
+}
+
+/*
+ * Returns the name of the module where the probe is defined.
+ */
+VALUE dtraceprobe_mod(VALUE self)
+{
+  VALUE string;
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  string = rb_str_new2(pdp->dtpd_mod);
+  return string;
+}
+
+/*
+ * Returns the name of the function where the probe is defined.
+ */
+VALUE dtraceprobe_func(VALUE self)
+{
+  VALUE string;
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  string = rb_str_new2(pdp->dtpd_func);
+  return string;
+}
+
+/*
+ * Returns the name of the probe.
+ */
+VALUE dtraceprobe_name(VALUE self)
+{
+  VALUE string;
+  dtrace_probedesc_t *pdp;
+
+  Data_Get_Struct(self, dtrace_probedesc_t, pdp);
+  string = rb_str_new2(pdp->dtpd_name);
+  return string;
+}

data/ext/dtrace_program.c

@@ -0,0 +1,57 @@
+/* Ruby-Dtrace
+ * (c) 2007 Chris Andrews <chris@nodnol.org>
+ */
+
+#include "dtrace_api.h"
+
+RUBY_EXTERN VALUE eDtraceException;
+RUBY_EXTERN VALUE cDtraceProgramInfo;
+
+/* :nodoc: */
+VALUE dtraceprogram_init(VALUE self)
+{
+  dtrace_prog_t *prog;
+
+  Data_Get_Struct(self, dtrace_prog_t, prog);
+  return self;
+}
+
+/*
+ * Execute the D program. Returns a DtraceProgramInfo object if
+ * successful, otherwise raises a DtraceException.
+ */
+VALUE dtraceprogram_exec(VALUE self)
+{
+  dtrace_prog_t *prog;
+  dtrace_proginfo_t *proginfo;
+  dtrace_hdl_t *handle;
+  VALUE dtrace;
+  VALUE dtraceprograminfo;
+  int ret;
+
+  Data_Get_Struct(self, dtrace_prog_t, prog);
+  dtrace = rb_iv_get(self, "@dtrace");
+  Data_Get_Struct(dtrace, dtrace_hdl_t, handle);
+  
+  proginfo = ALLOC(dtrace_proginfo_t);
+  ret = dtrace_program_exec(handle, prog, proginfo);
+
+  if (ret == 0) {
+    dtraceprograminfo = Data_Wrap_Struct(cDtraceProgramInfo, 0, NULL, proginfo);
+    rb_iv_set(self, "@proginfo", dtraceprograminfo);
+  }
+
+  if (ret < 0)
+    rb_raise(eDtraceException, dtrace_errmsg(handle, dtrace_errno(handle)));
+  
+  return Qnil;
+}
+
+/*
+ * Return this program's DtraceProgramInfo object. Returns nil unless
+ * the program has been executed.
+ */
+VALUE dtraceprogram_info(VALUE self)
+{
+  return rb_iv_get(self, "@proginfo");
+}

data/ext/dtrace_programinfo.c

@@ -0,0 +1,60 @@
+/* Ruby-Dtrace
+ * (c) 2007 Chris Andrews <chris@nodnol.org>
+ */
+
+#include "dtrace_api.h"
+
+/* :nodoc: */
+VALUE dtraceprograminfo_init(VALUE self)
+{
+  dtrace_proginfo_t *proginfo;
+
+  Data_Get_Struct(self, dtrace_proginfo_t, proginfo);
+  return self;
+}
+
+/*
+ * Returns the number of aggregates associated with this program.
+ */
+VALUE dtraceprograminfo_aggregates_count(VALUE self) 
+{
+  dtrace_proginfo_t *proginfo;
+
+  Data_Get_Struct(self, dtrace_proginfo_t, proginfo);
+  return INT2NUM(proginfo->dpi_aggregates);
+}
+
+/*
+ * Returns the number of record generating probes associated with this
+ * program.
+ */
+VALUE dtraceprograminfo_recgens_count(VALUE self)
+{
+  dtrace_proginfo_t *proginfo;
+
+  Data_Get_Struct(self, dtrace_proginfo_t, proginfo);
+  return INT2NUM(proginfo->dpi_recgens);
+}
+
+/*
+ * Returns the number of probes matched by this program.
+ */
+VALUE dtraceprograminfo_matches_count(VALUE self)
+{
+  dtrace_proginfo_t *proginfo;
+
+  Data_Get_Struct(self, dtrace_proginfo_t, proginfo);
+  return INT2NUM(proginfo->dpi_matches);
+}
+
+/*
+ * Returns the number of speculations specified by this program.
+ */
+VALUE dtraceprograminfo_speculations_count(VALUE self)
+{
+  dtrace_proginfo_t *proginfo;
+
+  Data_Get_Struct(self, dtrace_proginfo_t, proginfo);
+  return INT2NUM(proginfo->dpi_speculations);
+}
+

data/ext/dtrace_recdesc.c

@@ -0,0 +1,38 @@
+/* Ruby-Dtrace
+ * (c) 2007 Chris Andrews <chris@nodnol.org>
+ */
+
+#include "dtrace_api.h"
+
+/* :nodoc: */
+VALUE dtracerecdesc_init(VALUE self)
+{
+  dtrace_recdesc_t *recdesc;
+
+  Data_Get_Struct(self, dtrace_recdesc_t, recdesc);
+  return self;
+}
+
+/*
+ * Return the data for this record.
+ */
+VALUE dtracerecdesc_data(VALUE self)
+{
+  VALUE dtraceaggdata;
+  dtrace_recdesc_t *recdesc;
+  dtrace_aggdata_t *aggdata;
+
+  Data_Get_Struct(self, dtrace_recdesc_t, recdesc);
+
+  dtraceaggdata = rb_iv_get(self, "@aggdata");
+  Data_Get_Struct(dtraceaggdata, dtrace_aggdata_t, aggdata);
+  
+  if (recdesc->dtrd_size == 256) {
+    char *c = aggdata->dtada_data + recdesc->dtrd_offset;
+    return rb_str_new2(c);
+  }
+  else {
+    uint64_t n = *((uint64_t *)(aggdata->dtada_data + recdesc->dtrd_offset));
+    return INT2FIX(n);
+  }
+}

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+$CFLAGS += " -D_LONGLONG_TYPE"
+have_library("dtrace", "dtrace_open")
+create_makefile("dtrace_api")

data/lib/dtrace.rb

@@ -0,0 +1,11 @@
+#
+# Ruby-Dtrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace_api'
+
+class Dtrace
+  VERSION = '0.0.1'
+end
+

data/plugin/dtrace/README

@@ -0,0 +1,4 @@
+Dtrace
+======
+
+Description goes here

data/plugin/dtrace/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the dtrace plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the dtrace plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dtrace'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/plugin/dtrace/bin/dtracer.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'drb'
+require 'pathname'
+
+# allow running standalone or in a rails app
+script_dir = Pathname.new(File.dirname(__FILE__)).realpath
+rails_script = script_dir + '../vendor/plugins/dtrace/bin'
+plugin_script = script_dir + '../../../../vendor/plugins/dtrace/bin'
+if rails_script.directory?
+  rails_root = script_dir + '../'
+elsif plugin_script.directory?
+  rails_root = script_dir + '../../../..'
+end
+$LOAD_PATH << File.join(rails_root + 'vendor/plugins/dtrace/lib')
+
+require 'dtracer'
+
+here = "druby://localhost:2999"
+tracer = Dtracer.new
+DRb.start_service here, tracer
+DRb.thread.join
+

data/plugin/dtrace/init.rb

@@ -0,0 +1,7 @@
+require 'dtrace_report'
+ActionController::Base.class_eval do
+  include DtraceReport
+  before_filter :enable_dtrace if RAILS_ENV == 'development'
+  after_filter :append_dtrace_report if RAILS_ENV == 'development'
+end
+

data/plugin/dtrace/lib/dtrace_helper.rb

@@ -0,0 +1,2 @@
+module DtraceHelper
+end

data/plugin/dtrace/lib/dtrace_report.rb

@@ -0,0 +1,47 @@
+require 'dtracer'
+require 'dtracer_client'
+
+module DtraceReport
+
+  def self.included(base)
+    base.extend DtraceMacro
+  end
+
+  module DtraceMacro
+    def dtrace(enable=:on, options={})
+      if enable == :on
+        if options[:tracer] == :self
+          DtraceReport.tracer = Dtracer.new
+        elsif options[:tracer] == :helper
+          DtracerReport.tracer = DtracerClient.new
+        else
+          raise "tracer option is self or helper"
+        end
+      end
+    end
+  end
+
+  attr_reader :dtrace_report
+
+  protected
+  def self.tracer=(tracer)
+    @@tracer = tracer
+  end
+  
+  def enable_dtrace
+    @@tracer.start_dtrace($$)
+  end
+
+  def append_dtrace_report
+    @dtrace_report = @@tracer.end_dtrace
+    # yuck!
+    old_template_root = @template.base_path
+    begin
+      @template.view_paths = File.join(RAILS_ROOT, 'vendor/plugins/dtrace/views')
+      response.body.gsub!(/<\/body/, @template.render(:partial => 'dtrace/report') + '</body')
+    ensure
+      @template.view_paths = old_template_root
+    end
+  end
+  
+end

data/plugin/dtrace/lib/dtrace_tracer.rb

@@ -0,0 +1,34 @@
+require 'dtrace'
+
+class Dtracer
+  
+  def start_dtrace(pid)
+    @d = Dtrace.new
+    @d.setopt("aggsize", "4m")
+    @d.setopt("bufsize", "4m")
+    progtext = 'ruby$1:::function-entry{ @[strjoin(strjoin(copyinstr(arg0),"."),copyinstr(arg1))] = count(); }'
+    begin
+      prog = @d.compile(progtext, pid.to_s)
+      prog.execute
+      @d.go
+    rescue DtraceException => e
+      puts "start: #{e.message}"
+    end
+  end
+  
+  def end_dtrace(pid)
+    begin
+      @d.stop
+      @d.aggregate_snap
+      
+      dtrace_report = Hash.new
+      @d.each_aggregate do |agg|
+        dtrace_report[agg[1].data] = agg[2].data
+      end
+    rescue DtraceException => e
+      puts "end: #{e.message}"
+    end
+
+    return dtrace_report
+  end
+end

data/plugin/dtrace/lib/dtracer.rb

@@ -0,0 +1,43 @@
+require 'dtrace'
+
+class Dtracer
+  
+  def start_dtrace(pid)
+    progtext = 'ruby$1:::function-entry{ @[strjoin(strjoin(copyinstr(arg0),"."),copyinstr(arg1))] = count(); }'
+
+    begin
+      @d = Dtrace.new
+      @d.setopt("aggsize", "4m")
+      @d.setopt("bufsize", "4m")
+    rescue DtraceException => e
+      puts "start setup: #{e.message}"
+      return
+    end
+
+    begin
+      prog = @d.compile(progtext, pid.to_s)
+      prog.execute
+      @d.go
+    rescue DtraceException => e
+      puts "start: #{e.message}"
+    end
+
+  end
+  
+  def end_dtrace
+    return {} unless @d
+
+    begin
+      @d.stop
+      @d.aggregate_snap
+      dtrace_report = Hash.new
+      @d.each_aggregate do |agg|
+        dtrace_report[agg[1].data] = agg[2].data
+      end
+    rescue DtraceException => e
+      puts "end: #{e.message}"
+    end
+
+    return dtrace_report
+  end
+end