ruby-dtrace-consumer 0.4.0

data/lib/dtrace/data.rb

@@ -0,0 +1,85 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+# The object returned from a consumer when a probe fires.  Accumulates
+# records from the callbacks, and is yielded when the data is complete.
+class DTrace
+  class Data
+    attr_reader :data
+    attr_reader :probe
+    attr_reader :cpu, :indent, :prefix, :flow
+
+    def initialize(types)
+      @types = types
+      @data = []
+      @curraggset = nil
+      @curragg    = nil
+    end
+
+    def add_data(d)
+      if @types.length == 0 || @types.include?(d.class)
+        @data << d
+      end
+    end
+
+    def finish
+      if @curraggset
+        add_data(@curraggset)
+        @curraggset = nil
+      end
+    end
+
+    def add_recdata(rec)
+      if @curraggset
+        add_data(@curraggset)
+        @curraggset = nil
+      end
+      if rec.action == "printa"
+        @curraggset = DTrace::AggregateSet.new
+      end
+    end
+
+    def add_probedata(probedata)
+      probedata.each_record do |p|
+        add_data(p)
+      end
+
+      # Record the probe that fired, and CPU/indent/prefix/flow
+      @probe  = probedata.probe
+      @cpu    = probedata.cpu
+      @indent = probedata.indent
+      @prefix = probedata.prefix
+      @flow   = probedata.flow
+    end
+
+    def add_bufdata(buf)
+      r = buf.record
+
+      p r
+
+      # buf records can be empty (trace();)
+      if r
+        case r.class.to_s
+        when DTrace::StackRecord.to_s
+          add_data(r)
+        when DTrace::Record.to_s
+          add_data(r)
+        when DTrace::PrintfRecord.to_s
+          add_data(r)
+        when DTrace::AggData.to_s
+          if @curragg == nil
+            @curragg = DTrace::Aggregate.new
+          end
+          if agg = @curragg.add_record(r)
+            if @curraggset
+              @curraggset.add_aggregate(@curragg)
+            end
+            @curragg = nil
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/dtrace/dof.rb

@@ -0,0 +1,8 @@
+#
+# Ruby-DTrace
+# (c) 2008 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dof/dof_api'
+require 'dtrace/dof/section'
+require 'dtrace/dof/file'

data/lib/dtrace/printfrecord.rb

@@ -0,0 +1,10 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+# A DTrace record for the formatted part of a printf() action. 
+class DTrace
+  class PrintfRecord
+    attr_accessor :value
+  end
+end

data/lib/dtrace/probedata.rb

@@ -0,0 +1,23 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+class DTrace
+  class ProbeData
+    
+    def records
+      records = Array.new
+      self.each_record do |rec|
+        records << rec
+      end
+      records
+    end
+
+    def to_s
+      rs = self.records
+      rs.map {|r| r.value }.join ', '
+    end
+
+  end
+end

data/lib/dtrace/probedesc.rb

@@ -0,0 +1,15 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+class DTrace
+  class ProbeDesc
+    
+    def to_s
+      "#{provider}:#{mod}:#{func}:#{name}"
+    end
+
+  end
+end
+    

data/lib/dtrace/record.rb

@@ -0,0 +1,11 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+# A scalar DTrace record. Its value is as set by the DTrace action
+# which triggered it.
+class DTrace
+  class Record
+    attr_accessor :value
+  end
+end

data/lib/dtrace/stackrecord.rb

@@ -0,0 +1,31 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+# A record representing the result of a stack() or ustack()
+# action. Its value is a list of symbolic stack frames:
+# 
+#   #<DTraceStackRecord:0x14e24 @value=
+#           ["libSystem.B.dylib`__sysctl+0xa",
+#            "libdtrace.dylib`dt_aggregate_go+0x9a",
+#            "dtrace_api.bundle`dtrace_hdl_go+0x30",
+#            "libruby.1.dylib`rb_eval_string_wrap+0x40fd",
+#            "libruby.1.dylib`rb_eval_string_wrap+0x4cdb",
+#            ...
+#            "libruby.1.dylib`rb_apply+0x392",
+#            "libruby.1.dylib`rb_eval_string_wrap+0xe82"]>
+#
+class DTrace
+  class StackRecord
+    attr_reader :value
+
+    # Given a stack as a string returned from DTrace, set the value of
+    # this record to a list of stack frames.
+    def parse(raw)
+      frames = raw.split(/\n/)
+      @value = frames.map {|f| f.lstrip }.select {|f| f.length > 0 }
+    end
+
+  end
+end

data/lib/dtrace/tracer.rb

@@ -0,0 +1,35 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+# Leopard's ruby-probe is DTracer, Solaris's is Tracer.
+
+class DTrace
+  class Tracer
+    
+    class NullTracer
+      def self.fire(arg0, arg1)
+        puts "NullTracer: #{arg0} #{arg1}"
+      end
+    end
+
+    @@tracer = nil
+    def self.fire(*args)
+      if @@tracer == nil
+        begin
+          # Avoid getting ourselves here:
+          @@tracer = Module.const_get('Tracer')
+        rescue NameError
+          begin
+            @@tracer = DTracer
+          rescue NameError
+            @@tracer = DTrace::Tracer::NullTracer
+          end
+        end
+      end
+      @@tracer.fire(*args)
+    end
+          
+  end
+end

data/lib/dtrace/version.rb

@@ -0,0 +1,8 @@
+#
+# Ruby-DTrace
+# (c) 2007-2012 Chris Andrews <chris@nodnol.org>
+#
+
+class DTrace
+  VERSION = '0.4.0'
+end

data/lib/dtrace/version.rb~

@@ -0,0 +1,8 @@
+#
+# Ruby-DTrace
+# (c) 2007-2012 Chris Andrews <chris@nodnol.org>
+#
+
+class DTrace
+  VERSION = '0.3.0'
+end

data/lib/dtraceconsumer.rb

@@ -0,0 +1,9 @@
+#
+# Ruby-DTrace
+# (c) 2007 Chris Andrews <chris@nodnol.org>
+#
+
+require 'dtrace/consumer'
+
+# Interface preservation - see DTrace::Consumer.
+class DTraceConsumer < DTrace::Consumer; end

data/test/test_aggregates.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class TestAggregates < DTraceTest
+
+  def test_aggregate_group
+    progtext =<<EOD
+profile-1000
+{
+  @a[execname] = count();
+  @b[execname] = count();
+}
+
+profile-1
+{
+  printa(@a);
+  printa(@b);
+}
+EOD
+
+    prog = @dtp.compile progtext
+    prog.execute
+    @dtp.go
+
+    sleep 3
+
+    c = DTrace::Consumer.new(@dtp)
+    assert c
+
+    data = []
+    c.consume_once do |d|
+      data << d
+    end
+
+    assert data.length > 0
+    data.each do |d|
+      assert d
+      assert_equal DTrace::Data, d.class
+      d.data.each do |agg|
+        assert_equal DTrace::AggregateSet, agg.class
+      end
+    end
+
+  end
+
+end

data/test/test_drops_errors.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+
+# Tests for the DropData record.
+
+class TestDropsErrors < DTraceTest
+
+  def test_drops
+    @dtp.setopt("bufsize", "512")
+    @dtp.setopt("strsize", "1024")
+
+    # drp.DTRACEDROP_PRINCIPAL.d
+    progtext = <<EOD
+BEGIN
+{
+	trace("Harding");
+	trace("Hoover");
+	trace("Nixon");
+	trace("Bush");
+}
+
+BEGIN
+{
+	exit(0);
+}
+EOD
+
+    prog = @dtp.compile progtext
+    prog.execute
+
+    c = DTrace::Consumer.new(@dtp)
+    assert c
+
+    i = 0
+    c.drophandler do |d|
+      assert_match(/1 drop on CPU [0-9]+/, d.msg)
+      assert_equal "drop to principal buffer", d.kind
+      assert_not_nil d.cpu
+      assert_equal 1, d.drops
+      assert_not_nil d.total
+      i = 1
+    end
+
+    @dtp.go
+    c.consume do |d|
+    end
+
+    assert_equal 1, i
+  end
+
+  def test_error_handler_too_late
+    progtext = <<EOD
+BEGIN
+{
+   *(char *)NULL;
+}
+EOD
+
+    prog = @dtp.compile progtext
+    prog.execute
+    @dtp.go
+
+    c = DTrace::Consumer.new(@dtp)
+    assert c
+
+    # since we've already said "go", we now can't apply an error
+    # handler (DTrace will let us, but won't call it).
+    assert_raise(DTrace::Exception) do
+      c.errhandler do |d|
+        # nothing
+      end
+    end
+
+  end
+
+  def test_errors
+    progtext = <<EOD
+BEGIN
+{
+   *(char *)NULL;
+}
+EOD
+
+    prog = @dtp.compile progtext
+    prog.execute
+
+    c = DTrace::Consumer.new(@dtp)
+    assert c
+
+    i = 0
+    c.errhandler do |d|
+      assert_match(/error on enabled probe ID [0-9]+ \(ID [0-9]+: dtrace:::BEGIN\): invalid address \(0x0\) in action #1 at DIF offset 16/, d.msg)
+      assert_not_nil d.cpu
+      assert d.action
+      assert d.offset
+      assert d.fault
+      assert_not_nil d.addr
+      i = 1
+    end
+
+    @dtp.go
+    c.consume_once do |d|
+    end
+
+    assert_equal 1, i
+  end
+
+  def test_error_and_drop_handler
+    @dtp.setopt("bufsize", "512")
+    @dtp.setopt("strsize", "1024")
+
+    progtext = <<EOD
+BEGIN
+{
+	trace("Harding");
+	trace("Hoover");
+	trace("Nixon");
+	trace("Bush");
+}
+
+BEGIN
+{
+   *(char *)NULL;
+}
+
+ERROR
+{
+    exit(0);
+}
+EOD
+
+    prog = @dtp.compile progtext
+    prog.execute
+
+    c = DTrace::Consumer.new(@dtp)
+    assert c
+
+    errors = 0
+    c.errhandler do |d|
+      assert_match(/error on enabled probe ID [0-9]+ \(ID [0-9]+: dtrace:::BEGIN\): invalid address \(0x0\) in action #1 at DIF offset 16/, d.msg)
+      assert_not_nil d.cpu
+      assert d.action
+      assert d.offset
+      assert d.fault
+      assert_not_nil d.addr
+      errors = 1
+    end
+
+    drops = 0
+    c.drophandler do |d|
+      assert_match(/1 drop on CPU [0-9]+/, d.msg)
+      assert_equal "drop to principal buffer", d.kind
+      assert_not_nil d.cpu
+      assert_equal 1, d.drops
+      assert_not_nil d.total
+      drops = 1
+    end
+
+    @dtp.go
+    c.consume do |d|
+    end
+
+    assert_equal 1, errors
+    assert_equal 1, drops
+  end
+
+end