jruby-profiler-callgrind-printer 1.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b24992a0511c20384c29de64017e79ac16d11a53
+  data.tar.gz: e784d2ee82590cfd94125f1dd6b88e91302664ed
+SHA512:
+  metadata.gz: bcc66ce47fb9fe38d1a98775a2727d4f4f0322cc88035c9f422027f973305761b56e969dd70678580ea6e33ebef17bc2b16c7d714e911ff33ba88242ae850f1e
+  data.tar.gz: fc26fdbed30f3f9360449a2ecd16f0f8ba51ca6614b674a993edf1e1da7631170e836d7a73e9438296eaf8d60466be9768dc685e31612f2e366469ec5a66eedb

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "bundler"
+  gem "jeweler"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Michael Ryan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# JRuby::Profiler::CallgrindPrinter
+
+## Summary
+
+This gem provides the similar functionality to that of [ruby-prof](https://github.com/ruby-prof/ruby-prof)'s [RubyProf::CallTreePrinter](https://github.com/ruby-prof/ruby-prof/blob/master/lib/ruby-prof/printers/call_tree_printer.rb), but for the JRuby's Profiler. Specifically, JRuby::Profiler::CallgrindPrinter will produce 'callgrind' formatted output for analysis in any tool that understands Valgrind's 'callgrind' file format, such as KCacheGrind and QCacheGrind.
+
+CallgrindPrinter has been written in pure-ruby, as opposed to Java, simply to see if it was possible (and it was). 
+
+## Usage
+
+
+For a runnable example, see examples/example1.rb. 
+
+Generally, you would do something like the following:
+```
+require 'jruby/profiler'
+require 'jruby/profiler/callgrind_printer'
+
+result = JRuby::Profiler.profile do 
+  # Do some expensive stuff.
+end
+
+printer = JRuby::Profiler::CallgrindPrinter.new(result)
+File.open("callgrind.out", "w") do |fio|
+  printer.printHeader(fio)
+  printer.printProfile(fio)
+  printer.printFooter(fio)
+end
+```
+
+and then run the above with 'jruby --profile.api your_code.rb'. You can then open up 'callgrind.out' with Kcachegrind or Qcachegrind. 
+
+## Important!
+The jruby profiler is disabled by default. You *must* run jruby with the '--profile.api' switch in order for any data to be gathered. Something along the lines of 'jruby --profile.api some_script.rb'
+
+If you don't enable the profiler, everything will run fine, but it will seem as though no data is being gathered, and somewhat empty outputs will be produced. 
+
+
+* [Callgrind Format Specification](http://valgrind.org/docs/manual/cl-format.html)
+
+
+
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "jruby-profiler-callgrind-printer"
+  gem.homepage = "http://github.com/justfalter/jruby-profiler-callgrind-printer"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides callgrind output for the JRuby profiler}
+  gem.description = %Q{Provides callgrind output for the JRuby profiler}
+  gem.email = "falter@gmail.com"
+  gem.authors = ["Mike Ryan"]
+  gem.platform = "java"
+  gem.files  = Dir.glob("lib/**/*.rb") + 
+              Dir.glob("examples/{*.rb,*.callgrind.out}") + 
+              %w(LICENSE.txt Gemfile README.md Rakefile VERSION)
+
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+#require 'rspec/core'
+#require 'rspec/core/rake_task'
+#RSpec::Core::RakeTask.new(:spec) do |spec|
+#  spec.pattern = FileList['spec/**/*_spec.rb']
+#end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/examples/example1.callgrind.out

@@ -0,0 +1,42 @@
+events: process_time
+
+fl=(jruby_runtime)
+fn=Fixnum#<=>
+0 8766488
+
+fl=example1.rb
+fn=Object#fibonacci
+8 256712
+cfl=example1.rb
+cfn=Object#fibonacci
+calls=57270 8
+8 0
+cfl=(jruby_runtime)
+cfn=Range#include?
+calls=57291 0
+0 51924983
+
+fl=(jruby_runtime)
+fn=Range#include?
+0 43158495
+cfl=(jruby_runtime)
+cfn=Fixnum#<=>
+calls=114582 0
+0 8766488
+
+fl=(jruby_runtime)
+fn=Integer#upto
+0 248929
+cfl=example1.rb
+cfn=Object#fibonacci
+calls=21 8
+8 114585076
+
+fl=(jruby_runtime)
+fn=(top)
+0 0
+cfl=(jruby_runtime)
+cfn=Integer#upto
+calls=1 0
+0 114834005
+

data/examples/example1.rb

@@ -0,0 +1,25 @@
+# To run:
+#   jruby --profile.api example1.rb
+#
+# This will produce 'example1.callgrind.out', which may be opened within Kcachegrind
+
+require 'jruby/profiler'
+require 'jruby/profiler/callgrind_printer'
+
+def fibonacci( n )
+  return  n  if ( 0..1 ).include? n
+  ( fibonacci( n - 1 ) + fibonacci( n - 2 ) )
+end
+
+result = JRuby::Profiler.profile do 
+  0.upto(20) do |i|
+    fibonacci(i)
+  end
+end
+
+printer = JRuby::Profiler::CallgrindPrinter.new(result)
+File.open("example1.callgrind.out", "w") do |fio|
+  printer.printHeader(fio)
+  printer.printProfile(fio)
+  printer.printFooter(fio)
+end

data/lib/jruby/profiler/callgrind_printer.rb

@@ -0,0 +1,68 @@
+module JRuby
+  module Profiler
+    class CallgrindPrinter < org.jruby.runtime.profile.ProfilePrinter
+      # @param [IO] out
+      def printHeader(out)
+        out.puts("events: process_time")
+        out.puts()
+      end
+
+      # @param [IO] out
+      def printFooter(out)
+      end
+
+      # @param [IO] out Where we want to write our output
+      # @param [Boolean] is_first (false) Does nothing, at the moment
+      def printProfile(out, is_first=false)
+        ti = getTopInvocation()
+        methods = self.class.methodData(ti);
+
+        methods.entrySet.each do |entry|
+          serial = entry.key
+          method_data = entry.value
+          file, line, method_name = get_info(serial)
+          out.puts("fl=#{file}")
+          out.puts("fn=#{method_name}")
+          out.puts("#{line} #{method_data.selfTime}")
+
+          method_data.children.to_a().each do |child_id|
+            next if self.isThisProfilerInvocation(child_id)
+            f, l, n = get_info(child_id)
+            invs = method_data.rootInvocationsOfChild(child_id)
+            num_calls = method_data.invocationsOfChild(child_id).totalCalls
+            out.puts("cfl=#{f}")
+            out.puts("cfn=#{n}")
+            out.puts("calls=#{num_calls} #{l}")
+            out.puts("#{l} #{invs.totalTime()}")
+          end
+
+          out.puts()
+        end
+      end
+
+      # @param [Integer]
+      # @return filename, line number, method_name 
+      def get_info(serial)
+        name = self.methodName(serial)
+        file = '(jruby_runtime)'
+        line = 0
+
+        if pm = self.getProfileData().getProfiledMethods().get(serial)
+          if m = pm.getMethod
+            if m.respond_to?(:getFile)
+              file = m.getFile
+            end
+
+            if m.respond_to?(:getLine)
+              line = m.getLine
+            end
+          end
+        end
+
+        return [file, line, name]
+      end
+
+    end
+  end
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: jruby-profiler-callgrind-printer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: java
+authors:
+- Mike Ryan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Provides callgrind output for the JRuby profiler
+email: falter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/example1.callgrind.out
+- examples/example1.rb
+- lib/jruby/profiler/callgrind_printer.rb
+homepage: http://github.com/justfalter/jruby-profiler-callgrind-printer
+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.1.9
+signing_key:
+specification_version: 4
+summary: Provides callgrind output for the JRuby profiler
+test_files: []