ruby-prof 0.8.1-x86-mingw32 → 0.11.0.rc1-x86-mingw32

data/Rakefile

@@ -1,99 +1,67 @@
-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',
-  '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 = "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"
-  spec.email = "shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com"
-  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
-
-require 'rake/extensiontask'
-
-desc 'build native .gem files -- use like native_gems clobber cross native gem RUBY_CC_VERSION=1.8.6:1.9.1--for non native use native_gems clobber && clean gem'
-task :native_gems do
-  Rake::ExtensionTask.new('ruby_prof', default_spec) do |ext|
-    ext.cross_compile = true
-    ext.cross_platform = ['x86-mswin32', 'i386-mingw32']
-  end
+# encoding: utf-8
+
+require "rubygems/package_task"
+require "rake/extensiontask"
+require "rake/testtask"
+require "rdoc/task"
+require "date"
+
+# To release a version of ruby-prof:
+#   * Update version.h
+#   * Update CHANGES
+#   * Update rdocs
+#   * git  commit to commit files
+#   * rake clobber to remove extra files
+#   * rake compile to build windows gems
+#   * rake package to create the gems
+#   * Tag the release in git (tag 0.10.1)
+#   * Push to ruybgems.org (gem push pkg/<gem files>)
+
+GEM_NAME = 'ruby-prof'
+SO_NAME = 'ruby_prof'
+
+default_spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+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.sub(/\.\d$/, '')}"
+  ext.cross_compile = true
+  ext.cross_platform = ['x86-mswin32-60', 'x86-mingw32-60']
 end
 
 # Rake task to build the default package
-Rake::GemPackageTask.new(default_spec) do |pkg|
+Gem::PackageTask.new(default_spec) do |pkg|
   pkg.need_tar = true
-  #pkg.need_zip = true
 end
 
+# Setup Windows Gem
+if RUBY_PLATFORM.match(/win32|mingw32/)
+  # Windows specification
+  win_spec = default_spec.clone
+  win_spec.platform = Gem::Platform::CURRENT
+  win_spec.files += Dir.glob('lib/**/*.so')
+  win_spec.instance_variable_set(:@cache_file, nil) # Hack to work around gem issue
 
+  # Unset extensions
+  win_spec.extensions = nil
 
+  # Rake task to build the windows package
+  Gem::PackageTask.new(win_spec) do |pkg|
+    pkg.need_tar = false
+  end
+end
 
 # ---------  RDoc Documentation ------
 desc "Generate rdoc documentation"
-Rake::RDocTask.new("rdoc") do |rdoc|
+RDoc::Task.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.options << '--main' << 'README.rdoc'
   rdoc.rdoc_files.include('bin/**/*',
                           'doc/*.rdoc',
                           'examples/flat.txt',
@@ -103,7 +71,7 @@ Rake::RDocTask.new("rdoc") do |rdoc|
                           'ext/ruby_prof/ruby_prof.c',
                           'ext/ruby_prof/version.h',
                           'ext/ruby_prof/measure_*.h',
-                          'README',
+                          'README.rdoc',
                           'LICENSE')
 end
 
@@ -115,45 +83,4 @@ Rake::TestTask.new do |t|
   t.test_files = Dir['test/test_suite.rb']
   t.verbose = true
   t.warning = true
-end
-
-require 'fileutils'
-
-desc 'Buildr ruby_prof.so'
-task :build do
- build(false)
-end
-
-def build(with_debug)
- Dir.chdir('ext/ruby_prof') do
-  unless File.exist? 'Makefile'
-    if with_debug
-      system(Gem.ruby + " -d extconf.rb")
-    else
-      system(Gem.ruby + " extconf.rb")
-    end
-    system("make clean")
-  end
-  system("make")
-  FileUtils.cp 'ruby_prof.so', '../../lib' 
- end
-end
-
-desc 'build ruby_prof.so with verbose debugging enabled'
-task :build_debug do
- build(true)
-end
-
-task :cleanr do
- FileUtils.rm 'lib/ruby_prof.so' if File.exist? 'lib/ruby_prof.so'
- 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
+end

data/bin/ruby-prof

@@ -8,44 +8,14 @@
 #
 # 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
-#     -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]
+# Various options:
+#        run "$ ruby-prof --help" to see them
 #
+# See also the readme "reports" section for the various outputs
 
 require 'ostruct'
 require 'optparse'
-require 'ruby-prof'
+require File.expand_path('../../lib/ruby-prof', __FILE__)
 
 options = OpenStruct.new
 options.measure_mode = RubyProf::PROCESS_TIME
@@ -57,19 +27,21 @@ options.specialized_instruction = false
 
 opts = OptionParser.new do |opts|
   opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
-                "Usage: ruby_prof [options] <script.rb> [--] [script-options]"
+                "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],
+  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_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|
 
           
@@ -84,6 +56,10 @@ opts = OptionParser.new do |opts|
         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
     
@@ -97,6 +73,7 @@ opts = OptionParser.new do |opts|
   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',
@@ -127,7 +104,26 @@ opts = OptionParser.new do |opts|
         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
@@ -148,15 +144,34 @@ opts = OptionParser.new do |opts|
       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
+  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 ||= []
+      options.pre_libs << lib
+  end
+
+  opts.on('-E code', '--eval-noprof code', 'execute the ruby statements (not profiled)') do |code|
+      options.pre_exec ||= []
+      options.pre_exec << code
+  end
+
+  opts.on('-r lib', '--require lib', 'require a specific library') do |lib|
+      options.libs ||= []
+      options.libs << lib
+  end
+
+  opts.on('-e code', '--eval', 'execute the ruby statements') do |code|
+      options.exec ||= []
+      options.exec << code
+  end
 end
 
 begin
@@ -170,7 +185,7 @@ rescue OptionParser::InvalidOption, OptionParser::InvalidArgument,
 end
 
 # Make sure the user specified at least one file
-if ARGV.length < 1
+if ARGV.length < 1 and not options.exec
   puts opts
   puts ""
   puts "Must specify a script to run"
@@ -188,15 +203,19 @@ at_exit {
 
   # Create a printer
   printer = options.printer.new(result)
+  printer_options = {:min_percent => options.min_percent, :sort_method => options.sort_method}
 
   # Get output
   if options.file
-    File.open(options.file, 'w') do |file|
-      printer.print(file, {:min_percent => options.min_percent})
+    # 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, printer_options)
+      end
     end
   else
     # Print out results 
-    printer.print(STDOUT, {:min_percent => options.min_percent})
+    printer.print(STDOUT, printer_options)
   end
 }
 
@@ -217,8 +236,28 @@ if options.replace_prog_name
   $0 = File.expand_path(script)
 end
 
+if options.pre_libs
+  options.pre_libs.each { |l| require l }
+end
+
+if options.pre_exec
+  options.pre_exec.each { |c| eval c }
+end
+
+# do not pollute profiling report with OpenStruct#libs
+ol = options.libs
+oe = options.exec
+
 # Start profiling
 RubyProf.start 
 
+if ol
+  ol.each { |l| require l }
+end
+
+if oe
+  oe.each { |c| eval c }
+end
+
 # Load the script
-load script
+load script if script

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;
+}
+}