airbnb-ruby-prof 0.0.1

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require "rubygems/package_task"
+require "rake/extensiontask"
+require "rake/testtask"
+require "rdoc/task"
+require "date"
+require "rake/clean"
+begin
+  require "bundler/setup"
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  $stderr.puts "Install bundler to get support for simplified gem publishing"
+end
+
+GEM_NAME = 'ruby-prof'
+SO_NAME = 'ruby_prof'
+
+default_spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+# specify which versions/builds to cross compile
+Rake::ExtensionTask.new do |ext|
+  ext.gem_spec = default_spec
+  ext.name = SO_NAME
+  ext.ext_dir = "ext/#{SO_NAME}"
+  ext.lib_dir = "lib/#{RUBY_VERSION}"
+end
+
+# Rake task to build the default package
+Gem::PackageTask.new(default_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+task :default => :test
+
+for file in Dir['lib/**/*.{o,so,bundle}']
+  CLEAN.include file
+end
+CLEAN.reject!{|f| !File.exist?(f)}
+task :clean do
+  # remove tmp dir contents completely after cleaning
+  FileUtils.rm_rf('tmp/*')
+end
+
+desc 'Run the ruby-prof test suite'
+Rake::TestTask.new do |t|
+  t.libs += %w(lib ext test)
+  t.test_files = Dir['test/**_test.rb']
+  t.verbose = true
+  t.warning = true
+end

data/bin/ruby-prof

@@ -0,0 +1,279 @@
+#! /usr/bin/env ruby
+
+# == Synopsis
+#
+# Profiles a Ruby program.
+#
+# == Usage
+#
+# ruby_prof [options] <script.rb> [--] [script-options]"
+#
+# Various options:
+#        run "$ ruby-prof --help" to see them
+#
+# See also the readme "reports" section for the various outputs
+
+# First require ruby-prof
+require 'rubygems'
+require 'ruby-prof'
+
+# Now setup option parser
+require 'ostruct'
+require 'optparse'
+
+module RubyProf
+  class Cmd
+    attr_accessor :options
+
+    def initialize
+      setup_options
+      parse_args
+
+      load_pre_libs
+      load_pre_execs
+    end
+
+    def setup_options
+      @options = OpenStruct.new
+      options.printer = RubyProf::FlatPrinter
+      options.min_percent = 0
+      options.file = nil
+      options.replace_prog_name = false
+      options.specialized_instruction = false
+
+      options.pre_libs = Array.new
+      options.pre_execs = Array.new
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
+            "Usage: ruby-prof [options] <script.rb> [--] [profiled-script-command-line-options]"
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on('-p printer', '--printer=printer', [:flat, :flat_with_line_numbers, :graph, :graph_html, :call_tree, :call_stack, :dot, :multi],
+                'Select a printer:',
+                '  flat - Prints a flat profile as text (default).',
+                '  flat_with_line_numbers - same as flat, with line numbers.',
+                '  graph - Prints a graph profile as text.',
+                '  graph_html - Prints a graph profile as html.',
+                '  call_tree - format for KCacheGrind',
+                '  call_stack - prints a HTML visualization of the call tree',
+                '  dot - Prints a graph profile as a dot file',
+                '  multi - Creates several reports in output directory'
+        ) do |printer|
+
+
+          case printer
+          when :flat
+            options.printer = RubyProf::FlatPrinter
+          when :flat_with_line_numbers
+            options.printer = RubyProf::FlatPrinterWithLineNumbers
+          when :graph
+            options.printer = RubyProf::GraphPrinter
+          when :graph_html
+            options.printer = RubyProf::GraphHtmlPrinter
+          when :call_tree
+            options.printer = RubyProf::CallTreePrinter
+          when :call_stack
+            options.printer = RubyProf::CallStackPrinter
+          when :dot
+            options.printer = RubyProf::DotPrinter
+          when :multi
+            options.printer = RubyProf::MultiPrinter
+          end
+        end
+
+        opts.on('-m min_percent', '--min_percent=min_percent', Float,
+                'The minimum percent a method must take before ',
+                '  being included in output reports.',
+                '  this option is not supported for call tree.') do |min_percent|
+          options.min_percent = min_percent
+        end
+
+        opts.on('-f path', '--file=path',
+                'Output results to a file instead of standard out.') do |file|
+          options.file = file
+          options.old_wd = Dir.pwd
+        end
+
+        opts.on('--mode=measure_mode',
+                [:process, :wall, :cpu, :allocations, :memory, :gc_runs, :gc_time],
+                'Select what ruby-prof should measure:',
+                '  wall - Wall time (default).',
+                '  process - Process time.',
+                '  cpu - CPU time (Pentium and PowerPCs only).',
+                '  allocations - Object allocations (requires patched Ruby interpreter).',
+                '  memory - Allocated memory in KB (requires patched Ruby interpreter).',
+                '  gc_runs - Number of garbage collections (requires patched Ruby interpreter).',
+                '  gc_time - Time spent in garbage collection (requires patched Ruby interpreter).') do |measure_mode|
+
+          case measure_mode
+          when :wall
+            options.measure_mode = RubyProf::WALL_TIME
+          when :process
+            options.measure_mode = RubyProf::PROCESS_TIME
+          when :cpu
+            options.measure_mode = RubyProf::CPU_TIME
+          when :allocations
+            options.measure_mode = RubyProf::ALLOCATIONS
+          when :memory
+            options.measure_mode = RubyProf::MEMORY
+          when :gc_runs
+            options.measure_mode = RubyProf::GC_RUNS
+          when :gc_time
+            options.measure_mode = RubyProf::GC_TIME
+          end
+        end
+
+        opts.on('-s sort_mode', '--sort=sort_mode', [:total, :self, :wait, :child],
+                'Select how ruby-prof results should be sorted:',
+                '  total - Total time',
+                '  self - Self time',
+                '  wait - Wait time',
+                '  child - Child time') do |sort_mode|
+
+          options.sort_method = case sort_mode
+                                when :total
+                                  :total_time
+                                when :self
+                                  :self_time
+                                when :wait
+                                  :wait_time
+                                when :child
+                                  :children_time
+                                end
+        end
+
+        opts.on("--replace-progname", "Replace $0 when loading the .rb files.") do
+          options.replace_prog_name = true
+        end
+
+        if defined?(RubyVM)
+          opts.on("--specialized-instruction", "Turn on specified instruction.") do
+            options.specialized_instruction = true
+          end
+        end
+
+        opts.on_tail("-h", "--help", "Show help message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version #{RubyProf::VERSION}") do
+          puts "ruby_prof " + RubyProf::VERSION
+          exit
+        end
+
+        opts.on("-v","Show version, set $VERBOSE to true, profile script if option given") do
+          puts "ruby version: " + [RUBY_PATCHLEVEL, RUBY_PLATFORM, RUBY_VERSION].join(' ')
+          $VERBOSE = true
+        end
+
+        opts.on("-d", "Set $DEBUG to true") do
+          $DEBUG = true
+        end
+
+        opts.on('-R lib', '--require-noprof lib', 'require a specific library (not profiled)') do |lib|
+          options.pre_libs << lib
+        end
+
+        opts.on('-E code', '--eval-noprof code', 'execute the ruby statements (not profiled)') do |code|
+          options.pre_execs << code
+        end
+      end
+    end
+
+
+    def parse_args
+      # Make sure the user specified at least one file
+      if ARGV.length < 1 and not options.exec
+        puts self.option_parser
+        puts ""
+        puts "Must specify a script to run"
+        exit(-1)
+      end
+
+      self.option_parser.parse! ARGV
+
+      if options.printer == RubyProf::MultiPrinter
+        options.file ||= "."
+        options.old_wd ||= Dir.pwd
+      end
+    rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument => e
+      puts self.option_parser
+      puts e.message
+      exit(-1)
+    end
+
+    def load_pre_libs
+      options.pre_libs.each do |lib|
+        require lib
+      end
+    end
+
+    def load_pre_execs
+      options.pre_execs.each do |exec|
+        eval(exec)
+      end
+    end
+
+    def run
+      # Get the script we will execute
+      script = ARGV.shift
+      if options.replace_prog_name
+        $0 = File.expand_path(script)
+      end
+
+      # Set VM compile option
+      if defined?(RubyVM)
+        RubyVM::InstructionSequence.compile_option = {
+            :trace_instruction => true,
+            :specialized_instruction => options.specialized_instruction
+        }
+      end
+
+      # Set the measure mode
+      RubyProf.measure_mode = options.measure_mode if options.measure_mode
+      RubyProf.start_script(script)
+    end
+  end
+end
+
+# Parse command line options
+cmd = RubyProf::Cmd.new
+
+# Install at_exit handler.  It is important that we do this
+# before loading the scripts so our at_exit handler run
+# *after* any other one that will be installed.
+
+at_exit {
+  # Stop profiling
+  result = RubyProf.stop
+
+  # Create a printer
+  printer = cmd.options.printer.new(result)
+  printer_options = {:min_percent => cmd.options.min_percent, :sort_method => cmd.options.sort_method}
+
+  # Get output
+  if cmd.options.file
+    # write it relative to the dir they *started* in, as it's a bit surprising to write it in the dir they end up in.
+    Dir.chdir(cmd.options.old_wd) do
+      if printer.is_a?(RubyProf::MultiPrinter)
+        printer.print(printer_options.merge(:path => cmd.options.file))
+      else
+        File.open(cmd.options.file, 'w') do |file|
+          printer.print(file, printer_options)
+        end
+      end
+    end
+  else
+    # Print out results
+    printer.print(STDOUT, printer_options)
+  end
+}
+
+# Now profile some code
+cmd.run

data/bin/ruby-prof-check-trace

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+stacks = Hash.new{|h,k| h[k] = Hash.new{|h,k| h[k] = []}}
+i = 0
+File.open(ARGV[0]).each_line do |l|
+  i += 1
+  unless l =~ /^(\d+):(\d+): *\d+ms *([^ ]+) *(.*): *(\d+) *(.+)$/
+    next if l =~/^ *$/
+    puts "line doesn't match: #{l}"
+    next
+  end
+  details = $1.to_i, $2.to_i, $3, $4, $5.to_i, $6
+  thread, fiber, event, file, line, method = *details
+  # puts method
+  stack = stacks[thread][fiber]
+  case event
+  when 'call', 'c-call'
+    stack << method
+  when 'return', 'c-return'
+    last_method = stack.pop
+    if last_method != method
+      puts "LINE #{i}: return event without call: #{method}"
+      puts "STACK: #{stack.inspect}"
+      if stack.find(method)
+        puts "fixing stack"
+        while (popped = stack.pop) && (popped != method)
+          puts "popped #{popped}"
+        end
+      else
+        raise "stack unfixable"
+      end
+      # stack << last_method
+    end
+  when 'line'
+    last_method = stack[-1]
+    if last_method != method
+      unless stack.find(method)
+        raise "LINE #{i}: line event without call: #{method}"
+      end
+    end
+  else
+    puts "unkown event"
+  end
+end
+puts stacks.inspect

data/examples/flat.txt

@@ -0,0 +1,50 @@
+= Flat Profiles
+
+Flat profiles show the total amount of time spent in each method.
+As an example, here is the output from running printers_test.rb.
+
+Measure Mode: wall_time
+Thread ID: 70355159212340
+Fiber ID: 70355171633140
+Total: 0.060485
+Sort by: self_time
+
+ %self      total      self      wait     child     calls  name
+ 97.07      0.059     0.059     0.000     0.000     1001   Integer#upto
+  0.92      0.059     0.001     0.000     0.059     1000   Object#is_prime
+  0.66      0.060     0.000     0.000     0.059        1   Array#select
+  0.59      0.000     0.000     0.000     0.000     1000   Kernel#rand
+  0.50      0.001     0.000     0.000     0.000        1   Array#each_index
+  0.20      0.000     0.000     0.000     0.000     1000   Kernel#respond_to_missing?
+  0.01      0.000     0.000     0.000     0.000        1   Object#find_largest
+  0.01      0.060     0.000     0.000     0.060        1   PrintersTest#setup
+  0.01      0.060     0.000     0.000     0.060        1   Object#find_primes
+  0.01      0.000     0.000     0.000     0.000        1   Class#new
+  0.01      0.060     0.000     0.000     0.060        1   Object#run_primes
+  0.00      0.000     0.000     0.000     0.000        1   Array#first
+  0.00      0.001     0.000     0.000     0.001        1   Object#make_random_array
+  0.00      0.000     0.000     0.000     0.000        1   Array#initialize
+
+All values are in seconds.
+
+The columns are:
+
+   %self - The percentage of time spent in this method, derived from self_time/total_time
+   total - The time spent in this method and its children.
+   self  - The time spent in this method.
+   wait  - amount of time this method waited for other threads
+   child - The time spent in this method's children.
+   calls - The number of times this method was called.
+   name  - The name of the method.
+
+Methods are sorted based on %self, therefore the methods that execute the longest are listed
+first.
+
+For example, wee can see that Integer#upto took the most time, 0.059
+seconds.  Method Object#is_prime calls this method, so the 0.59
+seconds appear as child time for Object#is_prime.
+
+The interpretation of method names is:
+* MyObject#test - An instance method "test" of the class "MyObject"
+* <Object:MyObject>#test - The <> characters indicate a singleton method on a singleton class.
+

data/examples/graph.dot

@@ -0,0 +1,84 @@
+digraph "Profile" {
+labelloc=t;
+labeljust=l;
+subgraph "Thread 70140045951280" {
+70140046535720 [label="setup\n(100%)"];
+70140046535720 -> 70140046535660 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535660 [label="run_primes\n(100%)"];
+70140046535660 -> 70140046534940 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535660 -> 70140046535640 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535660 -> 70140046534640 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046534940 [label="find_primes\n(93%)"];
+70140046534940 -> 70140046534920 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046534920 [label="select\n(93%)"];
+70140046534920 -> 70140046534840 [label="200/200" fontsize=10 fontcolor="#666666"];
+70140046534840 [label="is_prime\n(90%)"];
+70140046534840 -> 70140046534820 [label="200/201" fontsize=10 fontcolor="#666666"];
+70140046534820 [label="upto\n(87%)"];
+70140046535640 [label="make_random_array\n(7%)"];
+70140046535640 -> 70140046535500 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535640 -> 70140046535600 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535500 [label="each_index\n(6%)"];
+70140046535500 -> 70140046535140 [label="200/200" fontsize=10 fontcolor="#666666"];
+70140046535140 [label="rand\n(4%)"];
+70140046535140 -> 70140046535100 [label="200/200" fontsize=10 fontcolor="#666666"];
+70140046535100 [label="respond_to_missing?\n(1%)"];
+70140046534640 [label="find_largest\n(1%)"];
+70140046534640 -> 70140046534820 [label="1/201" fontsize=10 fontcolor="#666666"];
+70140046534640 -> 70140046534620 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535600 [label="new\n(0%)"];
+70140046535600 -> 70140046535580 [label="1/1" fontsize=10 fontcolor="#666666"];
+70140046535580 [label="initialize\n(0%)"];
+70140046534620 [label="first\n(0%)"];
+}
+subgraph cluster_70140046962360 {
+label = "PrintersTest";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046535720;
+}
+subgraph cluster_70140046962240 {
+label = "Object";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046535660;
+70140046535640;
+70140046534940;
+70140046534840;
+70140046534640;
+}
+subgraph cluster_70140046962040 {
+label = "Class";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046535600;
+}
+subgraph cluster_70140046961920 {
+label = "Array";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046535580;
+70140046535500;
+70140046534920;
+70140046534620;
+}
+subgraph cluster_70140046961720 {
+label = "Kernel";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046535140;
+70140046535100;
+}
+subgraph cluster_70140046961280 {
+label = "Integer";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+70140046534820;
+}
+}