yarv-prof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d67e8ac138faae3a64a5dcfbf51e8884b7f2d1
+  data.tar.gz: ccb8273915b075b0b8dec96618438038d269d314
+SHA512:
+  metadata.gz: 6a2c20570f872587c569853617f4f3400b6b4ca388996fe72182f2d3ee29504c7a679e5bc19bd1a539eac44a74eaf1d930278bc6ca6b403eef64413a33bbeccf
+  data.tar.gz: 0eaeaf451efb07b4363f612a94ff153fa17b6a7ee2cec5965c19493e58d226835d7eca6103a616031f7b93d8d0cb9e799682fc0c48a03966ab35fafce9f5637a

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+## Prerequisite
+
+- DTrace must be installed on your System
+- You need to edit MRI source code as follows(since pre-compiled MRI doesn't provide `insn` probe, you need to enable this  manually, as of Ruby2.4.0)
+
+```
+$ git clone https://github.com/ruby/ruby.git
+$ cd ruby && autoconf
+$ ./configure
+$ vi vm_opts.h # set the VM_COLLECT_USAGE_DETAILS flag to 1 manually
+$ make && make install
+$ ./ruby -v
+```
+
+## Getting Started
+
+Since we use custom built MRI binary, the profiling command will look like following(unless you have installed custom built MRI and rubygems onto your system)
+
+```
+$ gem install yarv-prof
+$ sudo ./ruby -I `gem env gemdir`/gems/yarv-prof*/lib/ -r yarv-prof -e "YarvProf.start; p :hello; YarvProf.end"
+$ yarv-prof --load /tmp/yarv-prof/20161128_214131.dump
+total number of instruction calls: 26
+insn                                   count      total_walltime      mean        variance    stdev
+---------------------------------------------------------------------------------------------------
+opt_send_without_block                4(15%)         298567(33%)     74642      2362231992    48603
+trace                                 4(15%)         139888(15%)     34972       566184557    23795
+getinlinecache                         2(7%)           76616(8%)     38308      1093622912    33070
+getconstant                            2(7%)           65426(7%)     32713       674546450    25972
+setinlinecache                         2(7%)           51301(5%)     25650       218718612    14789
+leave                                  2(7%)           46497(5%)     23248        54444612     7379
+putobject                              2(7%)           44293(4%)     22146       182576940    13512
+getinstancevariable                    2(7%)           42118(4%)     21059        94146642     9703
+pop                                    2(7%)           41412(4%)     20706         2056392     1434
+opt_not                                1(3%)           30059(3%)     30059             NaN      NaN
+jump                                   1(3%)           27644(3%)     27644             NaN      NaN
+putself                                1(3%)           23844(2%)     23844             NaN      NaN
+branchunless                           1(3%)           15042(1%)     15042             NaN      NaN
+```
+
+## Usage
+
+```
+YarvProf.start(clock: :cpu, out:'~/log/')
+p :hello
+YarvProf.end
+```
+
+This is the sample usage of YarvProf in your code. YarvProf#start can take 2 keyword args, one is for the flag to switch measurement mode (:cpu or :wall), and the other one is to specify the target directory the dump file will be seved in.
+
+```
+$ yarvprof --load ./result.dump --insn getlocal_OP__WC__1
+```
+
+And this is the sample usage of yarv-prof CLI command, which is specifically designed to parse and view dumped data. yarv-prof command can take following options.
+
+```
+Usage: yarv-prof [options]
+    -v, --version                    Print version
+        --load=FILENAME              Load .dump file
+        --csv                        Report with csv format
+        --raw                        Show raw log data with time series alignment
+        --insn=VALUE                 Show a specific instruction only
+```
+
+## TBD in future
+
+- More detailed information regarding YARV instructions
+- Improve performance
+- System Tap support for linux environment(only if needed)
+- Sampling profiler mode(if needed)
+- Docker support etc
+
+## Other resources
+
+- You may want to refer [my presentation slide](TBD) at RubyConf Taiwan 2016
+
+## License
+
+MIT

data/bin/yarv-prof

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+
+if !ARGV.index('-d') then
+  require 'rubygems'
+else
+  Encoding.default_external = 'UTF-8'
+  ['..', '../lib'].each do |path|
+    $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), path))
+  end
+  ARGV.delete('-d')
+end
+
+require 'yarv-prof'
+require 'optparse'
+require 'enumerable/statistics'
+
+class DatasetBase
+  attr_reader :instructions, :total_time, :total_count, :measure_mode
+  def initialize
+    @total_time = 0
+    @total_count = 0
+  end
+
+  def add_entry(insn, elapsed_time)
+    @total_time = @total_time + elapsed_time
+    @total_count = @total_count + 1
+  end
+
+  def set_measure_mode(label)
+    @measure_mode = label == "vtimestamp" ? "cputime" : "walltime"
+  end
+end
+
+class SummaryDataset < DatasetBase
+  def initialize
+    @instructions = {}
+    super
+  end
+
+  def add_entry(insn, elapsed_time)
+    @instructions[insn] = [] if @instructions[insn].nil?
+    @instructions[insn] << elapsed_time
+    super
+  end
+end
+
+class TimeSeriesDataset < DatasetBase
+  def initialize
+    @instructions = []
+    super
+  end
+
+  def add_entry(insn, elapsed_time)
+    @instructions << [insn, elapsed_time]
+    super
+  end
+end
+
+class DumpLogParser
+  attr_reader :dataset
+  def initialize(filename, dataset)
+    @filename = filename
+    @dataset = dataset
+  end
+  def parse(insn=nil)
+    prev = nil
+    File.read(@filename).each_line{|line|
+      line.chomp!
+      next if line.empty?
+      if line.split(",")[0] == "insn" then
+        @dataset.set_measure_mode line.split(",")[1]
+      else
+        if !prev.nil? && (insn.nil? || insn==prev[0])
+          @dataset.add_entry prev[0], (line.split(",")[1].to_i - prev[1].to_i)
+        end
+        prev = line.split(",")
+      end
+    }
+  end
+
+end
+
+class Presentation
+  attr_accessor :filename, :csv, :raw, :insn
+
+  def make
+    @parser = DumpLogParser.new(@filename, @raw || @insn ? TimeSeriesDataset.new : SummaryDataset.new )
+    @parser.parse(@insn)
+  end
+
+  def display
+    ds = @parser.dataset
+    if ds.class == TimeSeriesDataset
+      if @csv
+        puts "insn,#{ds.measure_mode}"
+        ds.instructions.each{|e|
+          puts "%s,%d" % [e[0], e[1]]
+        }
+      else
+        puts "isns".ljust(30)+ds.measure_mode.rjust(15)
+        puts "-"*45
+        ds.instructions.each{|e|
+          puts ("%s" % e[0]).ljust(30) + ("%d" % e[1]).rjust(15)
+        }
+      end
+    else
+      if @csv
+        puts "insn,count,total_#{ds.measure_mode},mean,variance,stdev"
+        ds.instructions.each{|insn, values|
+          puts "%s,%d,%d,%.0f,%.0f,%.0f" % [insn, values.count, values.inject(:+), values.mean, values.variance, values.stdev]
+        }
+      else
+        puts "total number of instruction calls: #{ds.total_count}"
+        presentation = []
+        puts "insn".ljust(30) + "count".rjust(14) + "total_#{ds.measure_mode}".rjust(20) + "mean".rjust(10) + "variance".rjust(16) + "stdev".rjust(9)
+        puts "-"*99
+        ds.instructions.each{|insn, values|
+          #presentation << [values.inject(:+), "%s:\n    count=%d(%d%s), total=%d(%d%s), mean=%.0f, variance=%.0f, stdev=%.0f\n" % [insn, values.count, (values.count*100/@parser.dataset.total_count), "%%", values.inject(:+), (values.inject(:+)*100/@parser.dataset.total_time), "%%", values.mean, values.variance, values.stdev] ]
+          presentation << [values.inject(:+), "%s%s%s%s%s%s\n" % [
+            insn.ljust(30),
+            ("%d(%d%s)" % [values.count, (values.count*100/ds.total_count), "%%"]).rjust(15),
+            ("%d(%d%s)" % [values.inject(:+), (values.inject(:+)*100/ds.total_time), "%%"]).rjust(21),
+            ("%.0f" % values.mean).rjust(10),
+            ("%.0f" % values.variance).rjust(16),
+            ("%.0f" % values.stdev).rjust(9)
+          ]]
+        }
+        presentation.sort{|a,b|
+          b[0] <=> a[0]
+        }.each{|e|
+          printf e[1]
+        }
+      end
+    end
+  end
+end
+
+if ARGV.empty?
+  raise "Use -h option to know what commands are available"
+else
+  report = Presentation.new
+  Options = OptionParser.new do |opts|
+    opts.on("-v", "--version", "Print version") {|v| puts YarvProf::VERSION; exit 0}
+    opts.on("--load=FILENAME", "Load .dump file") {|filename| report.filename = filename}
+    opts.on("--csv", "Report with csv format") {report.csv = true}
+    opts.on("--raw", "Show raw log data with time series alignment") {report.raw = true}
+    opts.on("--insn=VALUE", "Show a specific instruction only") { |insn| report.insn = insn }
+  end
+  Options.parse!(ARGV)
+  report.make
+  report.display
+end

data/lib/yarv-prof/version.rb

@@ -0,0 +1,3 @@
+class YarvProf
+  VERSION = "0.1.0"
+end

data/lib/yarv-prof.rb

@@ -0,0 +1,37 @@
+require 'yarv-prof/version'
+require 'tempfile'
+
+class YarvProf
+  class << self
+    def start(clock: :wall, out:'/tmp/yarv-prof/')
+      at_exit do
+        Process.kill(:TERM, @pid) if !@pid.nil?
+        FileUtils.remove_entry @file.path if File.exists?(@file.path)
+      end
+      @measure_mode = clock == :cpu ? "vtimestamp" : "timestamp"
+      @dump_to = out
+      @file = Tempfile.new('.yarv-prof.d')
+      @file.puts <<EOS
+dtrace:::BEGIN{
+  printf("insn,#{@measure_mode}\\n");
+}
+
+ruby#{Process.pid}:::insn{
+  printf("%s,%d\\n", copyinstr(arg0), #{@measure_mode});
+}
+EOS
+      @file.close
+      FileUtils.mkdir @dump_to if !File.directory?(@dump_to)
+      dumpfile = Time.now.strftime('%Y%m%d_%H%M%S.dump')
+      @pid = Process.spawn("dtrace -q -s '#{@file.path}'", :err => :out,:out => @dump_to + dumpfile)
+      #while File.read(DUMPTO+dumpfile).size < 10 do
+      #  sleep 0.01
+      #end
+      sleep 0.5
+    end
+
+    def end
+      Process.kill(:TERM, @pid) if !@pid.nil?
+    end
+  end
+end

data/yarv-prof.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yarv-prof/version'
+
+Gem::Specification.new do |s|
+  s.name = 'yarv-prof'
+  s.version = YarvProf::VERSION
+  s.homepage = 'https://github.com/remore/yarv-prof'
+
+  s.authors = 'Kei Sawada(@remore)'
+  s.email   = 'k@swd.cc'
+
+  s.files = `git ls-files`.split("\n")
+  s.bindir = 'bin'
+  s.executables = 'yarv-prof'
+
+  s.summary = 'A DTrace-based YARV profiler'
+  s.description = 'A DTrace-based YARV profiler'
+  s.license = 'MIT'
+
+  s.add_dependency "enumerable-statistics"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: yarv-prof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kei Sawada(@remore)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: enumerable-statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A DTrace-based YARV profiler
+email: k@swd.cc
+executables:
+- yarv-prof
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/yarv-prof
+- lib/yarv-prof.rb
+- lib/yarv-prof/version.rb
+- yarv-prof.gemspec
+homepage: https://github.com/remore/yarv-prof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A DTrace-based YARV profiler
+test_files: []