yarv-prof 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5d67e8ac138faae3a64a5dcfbf51e8884b7f2d1
-  data.tar.gz: ccb8273915b075b0b8dec96618438038d269d314
+  metadata.gz: cf79c062e09422f12edf490b663ab78eb4bbde16
+  data.tar.gz: 80e3d804620ee77bdbb2362c3049b44d31811a4a
 SHA512:
-  metadata.gz: 6a2c20570f872587c569853617f4f3400b6b4ca388996fe72182f2d3ee29504c7a679e5bc19bd1a539eac44a74eaf1d930278bc6ca6b403eef64413a33bbeccf
-  data.tar.gz: 0eaeaf451efb07b4363f612a94ff153fa17b6a7ee2cec5965c19493e58d226835d7eca6103a616031f7b93d8d0cb9e799682fc0c48a03966ab35fafce9f5637a
+  metadata.gz: eb7d594ca3f22fb6bb30276127b7cc062e5af4d53751d76142beaab9366a8ce4b86946b00721a51810a7238f997b355924f1933a673f77df494f78f8e7a71028
+  data.tar.gz: 98c58b317cc56144a2a3fc68de01e90a4be866a76a5c3fbc92a26dad9958a328dcf98dc9122f6f7597b38d43a874e6964da442ac7e511f7767c90c05ff7acbc9

data/README.md

@@ -1,6 +1,6 @@
 ## Prerequisite
 
-- DTrace must be installed on your System
+- 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)
 
 ```
@@ -40,21 +40,34 @@ branchunless                           1(3%)           15042(1%)     15042
 
 ## Usage
 
+#### Step1: Recording
+
+This is the sample usage of YarvProf in your code.
+
 ```
 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#start can take following 3 optional keyword args.
+
+- `clock` is for the flag to switch measurement mode(`:cpu` or `:wall`)
+- `out` is to specify the target directory path which the dump file will be stored in.
+- `opt` is to give arbitrary CLI option when yarv-prof trigger dtrace command(e.g. `opt:'-x bufsize=20m'`).
+
+#### Step2: Reporting
+
+Here is the sample usage of yarv-prof CLI command, which is specifically designed to parse and view dumped data.
 
 ```
 $ 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.
+yarv-prof command can take following options.
 
 ```
+$ yarvprof -h
 Usage: yarv-prof [options]
     -v, --version                    Print version
         --load=FILENAME              Load .dump file

data/lib/yarv-prof.rb

@@ -3,34 +3,31 @@ require 'tempfile'
 
 class YarvProf
   class << self
-    def start(clock: :wall, out:'/tmp/yarv-prof/')
+    def start(clock: :wall, out:'/tmp/yarv-prof/', opt:'-x bufsize=20m')
       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
+      measure_mode = clock == :cpu ? "vtimestamp" : "timestamp"
       @file = Tempfile.new('.yarv-prof.d')
       @file.puts <<EOS
 dtrace:::BEGIN{
-  printf("insn,#{@measure_mode}\\n");
+  printf("insn,#{measure_mode}\\n");
 }
 
 ruby#{Process.pid}:::insn{
-  printf("%s,%d\\n", copyinstr(arg0), #{@measure_mode});
+  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
+      FileUtils.mkdir out if !File.directory?(out)
+      dumpfile = out + Time.now.strftime('%Y%m%d_%H%M%S.dump')
+      @pid = Process.spawn("dtrace -q -s '#{@file.path}' #{opt}", :err => :out,:out => dumpfile)
+      `size=0;while [ $size -le 10 ];do size=$(wc -c < #{dumpfile});sleep 0.01;done`
     end
 
     def end
+      sleep 1 # sleep here otherwise the log file will be empty
       Process.kill(:TERM, @pid) if !@pid.nil?
     end
   end

data/lib/yarv-prof/version.rb

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

data/yarv-prof.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables = 'yarv-prof'
 
   s.summary = 'A DTrace-based YARV profiler'
-  s.description = 'A DTrace-based YARV profiler'
+  s.description = "yarv-prof does nothing special to profile YARV behavior, just heavily depends on Ruby's DTrace probes support. If you are looking for something useful to utilize Ruby's DTrace feature, yarv-prof may work for you."
   s.license = 'MIT'
 
   s.add_dependency "enumerable-statistics"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarv-prof
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kei Sawada(@remore)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: enumerable-statistics
@@ -24,7 +24,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A DTrace-based YARV profiler
+description: yarv-prof does nothing special to profile YARV behavior, just heavily
+  depends on Ruby's DTrace probes support. If you are looking for something useful
+  to utilize Ruby's DTrace feature, yarv-prof may work for you.
 email: k@swd.cc
 executables:
 - yarv-prof