acunote-ruby-prof 0.9.2

data/Rakefile

@@ -0,0 +1,148 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'date'
+
+# ------- Version ----
+# Read version from header file
+version_header = File.read('ext/ruby_prof/version.h')
+match = version_header.match(/RUBY_PROF_VERSION\s*["](\d.+)["]/)
+raise(RuntimeError, "Could not determine RUBY_PROF_VERSION") if not match
+RUBY_PROF_VERSION = match[1]
+
+
+# ------- Default Package ----------
+FILES = FileList[
+  'Rakefile',
+  'README.rdoc',
+  'LICENSE',
+  'CHANGES',
+  'bin/*',
+  'doc/**/*',
+  'examples/*',
+  'ext/ruby_prof/*.c',
+  'ext/ruby_prof/*.h',
+  'ext/ruby_prof/mingw/Rakefile',
+  'ext/ruby_prof/mingw/build.rake',
+  'ext/vc/*.sln',
+  'ext/vc/*.vcproj',
+  'lib/**/*',
+  'rails/**/*',
+  'test/*'
+]
+
+# Default GEM Specification
+default_spec = Gem::Specification.new do |spec|
+  spec.name = "acunote-ruby-prof"
+
+  spec.homepage = "http://rubyforge.org/projects/ruby-prof/"
+  spec.summary = "Fast Ruby profiler"
+  spec.description = <<-EOF
+ruby-prof is a fast code profiler for Ruby. It is a C extension and
+therefore is many times faster than the standard Ruby profiler. It
+supports both flat and graph profiles.  For each method, graph profiles
+show how long the method ran, which methods called it and which
+methods it called. RubyProf generate both text and html and can output
+it to standard out or to a file.
+EOF
+
+  spec.version = RUBY_PROF_VERSION
+
+  spec.author = "Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes"
+  spec.email = "shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com, skaes@railsexpress.de"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "lib"
+  spec.bindir = "bin"
+  spec.executables = ["ruby-prof"]
+  spec.extensions = ["ext/ruby_prof/extconf.rb"]
+  spec.files = FILES.to_a
+  spec.test_files = Dir["test/test_*.rb"]
+  spec.required_ruby_version = '>= 1.8.4'
+  spec.date = DateTime.now
+  spec.rubyforge_project = 'ruby-prof'
+  spec.add_development_dependency 'os'
+  spec.add_development_dependency 'rake-compiler'
+
+end
+
+
+desc 'build native .gem files -- use like "native_gems clobber cross native gem"--for non native gem creation use "native_gems clobber" then "clean gem"'
+task :native_gems do
+  ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new('ruby_prof', default_spec) do |ext|
+    ext.cross_compile = true
+    ext.cross_platform = ['x86-mswin32-60', 'x86-mingw32-60']
+  end
+end
+
+# Rake task to build the default package
+Rake::GemPackageTask.new(default_spec) do |pkg|
+  pkg.need_tar = true
+  #pkg.need_zip = true
+end
+
+
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ruby-prof"
+  # Show source inline with line numbers
+  rdoc.options << "--inline-source" << "--line-numbers"
+  # Make the readme file the start page for the generated html
+  rdoc.options << '--main' << 'README.rdoc'
+  rdoc.rdoc_files.include('bin/**/*',
+                          'doc/*.rdoc',
+                          'examples/flat.txt',
+                          'examples/graph.txt',
+                          'examples/graph.html',
+                          'lib/**/*.rb',
+                          'ext/ruby_prof/ruby_prof.c',
+                          'ext/ruby_prof/version.h',
+                          'ext/ruby_prof/measure_*.h',
+                          'README.rdoc',
+                          'LICENSE')
+end
+
+task :default => :package
+
+desc 'Run the ruby-prof test suite'
+Rake::TestTask.new do |t|
+  t.libs += %w(lib ext test)
+  t.test_files = Dir['test/test_suite.rb']
+  t.verbose = true
+  t.warning = true
+end
+
+require 'fileutils'
+
+desc 'Build ruby_prof.so'
+task :build do
+ Dir.chdir('ext/ruby_prof') do
+  unless File.exist? 'Makefile'
+    system(Gem.ruby + " extconf.rb")
+    system("make clean")
+  end
+  system("make")
+  FileUtils.cp 'ruby_prof.so', '../../lib' if File.exist? 'lib/ruby_prof.so'
+  FileUtils.cp 'ruby_prof.bundle', '../../lib' if File.exist? 'lib/ruby_prof.bundle'
+ end
+end
+
+desc 'clean stuff'
+task :cleanr do
+ FileUtils.rm 'lib/ruby_prof.so' if File.exist? 'lib/ruby_prof.so'
+ FileUtils.rm 'lib/ruby_prof.bundle' if File.exist? 'lib/ruby_prof.bundle'
+ Dir.chdir('ext/ruby_prof') do
+  if File.exist? 'Makefile'
+    system("make clean")
+    FileUtils.rm 'Makefile'
+  end
+  Dir.glob('*~') do |file|
+    FileUtils.rm file
+  end
+ end
+ system("rm -rf pkg")
+end

data/bin/ruby-prof

@@ -0,0 +1,236 @@
+#! /usr/bin/env ruby
+
+# == Synopsis
+#
+# Profiles a Ruby program.
+#
+# == Usage
+#
+# ruby_prof [options] <script.rb> [--] [script-options]"
+#
+# Options:
+#     -p, --printer=printer            Select a printer:
+#                                        flat - Prints a flat profile as text (default).
+#                                        flat_with_line_numbers - Above, 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
+#     -f, --file=path                  Output results to a file instead of standard out.
+#     -m, --min_percent=min_percent    The minimum percent a method must take before ',
+#                                      being included in output reports.  Should be an
+#                                      integer between 1 and 100.  0 means all methods are printed.
+#         --mode=measure_mode          Select a measurement mode:
+#                                        process - Use process time (default).
+#                                        wall - Use wall time.
+#                                        cpu - Use the CPU clock counter
+#                                              (only supported on Pentium and PowerPCs).
+#                                        allocations - Tracks object allocations
+#                                              (requires a patched Ruby interpreter).
+#                                        memory - Tracks total memory size
+#                                              (requires a patched Ruby interpreter).
+#                                        gc_runs - Tracks number of garbage collection runs
+#                                              (requires a patched Ruby interpreter).
+#                                        gc_time - Tracks time spent doing garbage collection
+#                                              (requires a patched Ruby interpreter).
+#         --replace-progname           Replace $0 when loading the .rb files.
+#         --specialized-instruction    Turn on specialized instruction.
+#     -h, --help                       Show help message
+#         --version                    Show version
+#     -v                               Show version, set $VERBOSE to true, run file
+#     -d                               Set $DEBUG to true
+# 
+#
+# See also: {flat profiles}[link:files/examples/flat_txt.html], {graph profiles}[link:files/examples/graph_txt.html], {html graph profiles}[link:files/examples/graph_html.html]
+#
+
+require 'ostruct'
+require 'optparse'
+require 'ruby-prof'
+
+options = OpenStruct.new
+options.measure_mode = RubyProf::PROCESS_TIME
+options.printer = RubyProf::FlatPrinter
+options.min_percent = 0
+options.file = nil
+options.replace_prog_name = false
+options.specialized_instruction = false
+
+opts = OptionParser.new do |opts|
+  opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
+                "Usage: ruby_prof [options] <script.rb> [--] [script-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],
+          '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'
+           ) 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
+    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:',
+      '  process - Process time (default).',
+      '  wall - Wall 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 :process
+        options.measure_mode = RubyProf::PROCESS_TIME     
+      when :wall
+        options.measure_mode = RubyProf::WALL_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("--replace-progname", "Replace $0 when loading the .rb files.") do
+          options.replace_prog_name = true
+  end
+
+  if defined?(VM)
+    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") do
+      puts "ruby_prof " + RubyProf::VERSION
+      puts "ruby " + RUBY_DESCRIPTION
+      $VERBOSE= true
+  end
+  
+  opts.on("-d", "Set $DEBUG to true") do
+    $DEBUG = true
+  end
+end
+
+begin
+  opts.parse! ARGV
+rescue OptionParser::InvalidOption, OptionParser::InvalidArgument,
+       OptionParser::MissingArgument => e
+  puts opts
+  puts
+  puts e.message
+  exit(-1)
+end
+
+# Make sure the user specified at least one file
+if ARGV.length < 1
+  puts opts
+  puts ""
+  puts "Must specify a script to run"
+  exit(-1)
+end
+
+
+# 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 = options.printer.new(result)
+
+  # Get output
+  if 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(options.old_wd) do
+      File.open(options.file, 'w') do |file|
+        printer.print(file, {:min_percent => options.min_percent})
+      end
+    end
+  else
+    # Print out results 
+    printer.print(STDOUT, {:min_percent => options.min_percent})
+  end
+}
+
+# Now set measure mode
+RubyProf.measure_mode = options.measure_mode
+
+# Set VM compile option
+if defined?(VM)
+  VM::InstructionSequence.compile_option = {
+    :trace_instruction => true,
+    :specialized_instruction => options.specialized_instruction
+  }
+end
+
+# Get the script we will execute
+script = ARGV.shift
+if options.replace_prog_name
+  $0 = File.expand_path(script)
+end
+
+# Start profiling
+RubyProf.start 
+
+# Load the script
+load script

data/examples/flat.txt

@@ -0,0 +1,55 @@
+= 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.
+
+Thread ID: 21277412
+ %self  cumulative  total     self   children  calls self/call total/call  name
+ 46.34     4.06      8.72     4.06     4.66      501     0.01     0.02     Integer#upto
+ 23.89     6.16      2.09     2.09     0.00       61     0.03     0.03     Kernel.sleep
+ 15.12     7.48      1.33     1.33     0.00   250862     0.00     0.00     Fixnum#%
+ 14.13     8.72      1.24     1.24     0.00   250862     0.00     0.00     Fixnum#==
+  0.18     8.74      0.02     0.02     0.00        1     0.02     0.02     Array#each_index
+  0.17     8.75      6.64     0.01     6.63      500     0.00     0.01     Object#is_prime
+  0.17     8.77      6.66     0.01     6.64        1     0.01     6.66     Array#select
+  0.00     8.77      0.00     0.00     0.00      501     0.00     0.00     Fixnum#-
+  0.00     8.77      0.00     0.00     0.00        1     0.00     0.00     Array#first
+  0.00     8.77      0.00     0.00     0.00        1     0.00     0.00     Array#length
+  0.00     8.77      0.00     0.00     0.00        1     0.00     0.00     Array#initialize
+  0.00     8.77      8.77     0.00     8.77        1     0.00     8.77     Object#run_primes
+  0.00     8.77      0.00     0.00     0.00        1     0.00     0.00     Integer#to_int
+  0.00     8.77      6.66     0.00     6.66        1     0.00     6.66     Object#find_primes
+  0.00     8.77      2.09     0.00     2.09        1     0.00     2.09     Object#find_largest
+  0.00     8.77      0.02     0.00     0.02        1     0.00     0.02     Object#make_random_array
+  0.00     8.77      0.00     0.00     0.00        1     0.00     0.00     Class#new
+  0.00     8.77      0.00     0.00     0.00      500     0.00     0.00     Array#[]=
+  0.00     8.77      0.00     0.00     0.00       61     0.00     0.00     Fixnum#>
+  0.00     8.77      0.00     0.00     0.00       61     0.00     0.00     Array#[]
+  0.00     8.77      8.77     0.00     8.77        1     0.00     8.77     #toplevel
+  0.00     8.77      0.00     0.00     0.00      500     0.00     0.00     Kernel.rand
+
+All values are in seconds. 
+
+The columns are:
+
+	%self        - The percentage of time spent in this method, derived from self_time/total_time
+	cumulative   - The sum of the time spent in this method and all the methods listed above it.
+	total        - The time spent in this method and its children.
+	self         - The time spent in this method.
+	children     - The time spent in this method's children.
+	calls        - The number of times this method was called.
+	self/call    - The average time spent per call in this method.
+  total/call   - The average time spent per call in this method and its children.
+  name         - The name of the method.
+
+Methods are sorted based on %self, therefore the methods that execute the longest are listed
+first.
+
+The interpretation of method names is:
+* #toplevel - The root method that calls all other methods
+* MyObject#test - An instance method "test" of the class "MyObject"
+* <Object:MyObject>#test - The <> characters indicate a singleton method on a singleton class.
+
+For example, wee can see that Integer#upto took the most time, 4.06 seconds.  An additional
+4.66 seconds were spent in its children, for a total time of 8.72 seconds.
+

data/examples/graph.dot

@@ -0,0 +1,106 @@
+digraph "Profile" {
+label="WALL_TIME >=0%\nTotal: 1.382985";
+labelloc=t;
+labeljust=l;
+subgraph "Thread 2148237740" {
+2159427600 [label="[]=\n(0%)"];
+2159427680 [label="%\n(15%)"];
+2159427760 [label="run_primes\n(100%)"];
+2159427760 -> 2159428600 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159427760 -> 2159428300 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159427840 [label="new\n(0%)"];
+2159427840 -> 2159428080 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159427840 -> 2159428760 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159427920 [label="rand\n(0%)"];
+2159428000 [label="-\n(0%)"];
+2159428080 [label="initialize\n(0%)"];
+2159428160 [label="each_index\n(1%)"];
+2159428160 -> 2159427920 [label="20000/20000" fontsize=10 fontcolor="#666666"];
+2159428160 -> 2159427600 [label="20000/20000" fontsize=10 fontcolor="#666666"];
+2159428220 [label="go\n(49%)"];
+2159428220 -> 2159427760 [label="1/2" fontsize=10 fontcolor="#666666"];
+2159428300 [label="make_random_array\n(1%)"];
+2159428300 -> 2159428160 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159428300 -> 2159427840 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159428360 [label="setup\n(100%)"];
+2159428360 -> 2159427760 [label="1/2" fontsize=10 fontcolor="#666666"];
+2159428360 -> 2159428220 [label="1/1" fontsize=10 fontcolor="#666666"];
+2159428440 [label="select\n(99%)"];
+2159428440 -> 2159428520 [label="20000/20000" fontsize=10 fontcolor="#666666"];
+2159428520 [label="is_prime\n(98%)"];
+2159428520 -> 2159428680 [label="20000/20000" fontsize=10 fontcolor="#666666"];
+2159428520 -> 2159428000 [label="20000/20000" fontsize=10 fontcolor="#666666"];
+2159428600 [label="find_primes\n(99%)"];
+2159428600 -> 2159428440 [label="2/2" fontsize=10 fontcolor="#666666"];
+2159428680 [label="upto\n(97%)"];
+2159428680 -> 2159427680 [label="1562487/1562487" fontsize=10 fontcolor="#666666"];
+2159428680 -> 2159428920 [label="1562487/1562487" fontsize=10 fontcolor="#666666"];
+2159428760 [label="allocate\n(0%)"];
+2159428920 [label="==\n(12%)"];
+}
+subgraph cluster_2159103200 {
+label = "Object";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428600;
+2159428520;
+2159428300;
+2159427760;
+}
+subgraph cluster_2159103260 {
+label = "Integer";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428680;
+}
+subgraph cluster_2159103060 {
+label = "PrintersTest";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428360;
+2159428220;
+}
+subgraph cluster_2159103120 {
+label = "Array";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428440;
+2159428160;
+2159428080;
+2159427600;
+}
+subgraph cluster_2159103340 {
+label = "<Class::Array>";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428760;
+}
+subgraph cluster_2159102840 {
+label = "Class";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159427840;
+}
+subgraph cluster_2159102980 {
+label = "Kernel";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159427920;
+}
+subgraph cluster_2159103400 {
+label = "Fixnum";
+fontcolor = "#666666";
+fontsize = 16;
+color = "#666666";
+2159428920;
+2159428000;
+2159427680;
+}
+}