ruby-prof 0.4.0

data/lib/ruby-prof.rb

@@ -0,0 +1,38 @@
+require "ruby_prof.so"
+
+require "ruby-prof/flat_printer"
+require "ruby-prof/graph_printer"
+require "ruby-prof/graph_html_printer"
+
+module RubyProf
+  # See if the user specified the clock mode via 
+  # the RUBY_PROF_CLOCK_MODE environment variable
+  def self.figure_clock_mode
+    case ENV["RUBY_PROF_CLOCK_MODE"]
+	  when "wall" || "wall_time"
+		  RubyProf.clock_mode = RubyProf::WALL_TIME
+	  when "cpu" || "cpu_time"
+  	  if ENV.key?("RUBY_PROF_CPU_FREQUENCY")
+   		  RubyProf.cpu_frequency = ENV["RUBY_PROF_CPU_FREQUENCY"].to_f
+  	  else
+   		  begin
+     		  open("/proc/cpuinfo") do |f|
+       		  f.each_line do |line|
+         		  s = line.slice(/cpu MHz\s*:\s*(.*)/, 1)
+         		  if s
+           		  RubyProf.cpu_frequency = s.to_f * 1000000
+           		  break
+         		  end
+       		  end
+     		  end
+   		  rescue Errno::ENOENT
+   		  end
+  	  end
+  	  RubyProf.clock_mode = RubyProf::CPU_TIME
+	  else
+  	  RubyProf.clock_mode = RubyProf::PROCESS_TIME
+  	end
+ 	end
+end
+
+RubyProf::figure_clock_mode

data/lib/ruby-prof/flat_printer.rb

@@ -0,0 +1,76 @@
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text. 
+  # To use the flat printer:
+  #
+	# 	result = RubyProf.profile do
+  #			[code to profile]
+  #		end
+  #
+  # 	printer = RubyProf::FlatPrinter.new(result)
+  # 	printer.print(STDOUT, 0)
+  #
+	class FlatPrinter
+  	# Create a FlatPrinter.  Result is a RubyProf::Result	
+  	# object generated from a profiling run.
+    def initialize(result)
+  	  @result = result
+ 	  end
+
+  	# Print a flat profile report to the provided output.
+  	# 
+  	# output - Any IO oject, including STDOUT or a file. 
+  	# The default value is STDOUT.
+  	# 
+  	# min_percent - The minimum %self (the methods 
+  	# self time divided by the overall total time) that
+  	# a method must take for it to be printed out in 
+  	# the report. Default value is 0.
+ 	  def print(output = STDOUT, min_percent = 0)
+  	  @min_percent = min_percent
+      @output = output
+      print_threads
+		end      
+		
+		private 
+		
+ 	  def print_threads
+      # sort assumes that spawned threads have higher object_ids
+			@result.threads.sort.each do |thread_id, methods|
+				print_methods(thread_id, methods)
+				@output << "\n" * 2
+			end
+    end
+    
+    def print_methods(thread_id, methods)
+      toplevel = @result.toplevel(thread_id)
+      total_time = toplevel.total_time
+
+      methods = methods.values.sort do |method1, method2|
+        method1.self_time <=> method2.self_time
+     	end
+     	methods.reverse!
+      
+  	  sum = 0
+  	  @output << "Thread ID: " << thread_id << "\n"
+  	  @output << " %self  cumulative  total     self   children  calls self/call total/call  name\n"
+
+  	  for method in methods
+        self_percent = (method.self_time / total_time) * 100
+        next if self_percent < @min_percent
+        
+    	  sum += method.self_time
+    	  @output.printf("%6.2f %8.2f  %8.2f %8.2f %8.2f %8d %8.2f %8.2f     %s\n",
+	                    method.self_time / total_time * 100, # %self
+	                    sum,                                 # cumulative
+	                    method.total_time,                   # total
+	                    method.self_time,                    # self
+	                    method.children_time,                # children
+	                    method.called,                        # calls
+  	                  method.self_time  / method.called,    # self/call
+  	                  method.total_time  / method.called,   # total/call
+    	                method.name)                         # name
+  	  end
+	  end
+  end
+end	
+

data/lib/ruby-prof/graph_html_printer.rb

@@ -0,0 +1,227 @@
+require "erb"
+
+module RubyProf
+  # Generates graph[link:files/examples/graph_html.html] profile reports as html. 
+  # To use the grap html printer:
+  #
+	# 	result = RubyProf.profile do
+  #			[code to profile]
+  #		end
+  #
+  # 	printer = RubyProf::GraphHtmlPrinter.new(result, 5)
+  # 	printer.print(STDOUT, 0)
+  #
+  # The constructor takes two arguments.  The first is
+  # a RubyProf::Result object generated from a profiling
+  # run.  The second is the minimum %total (the methods 
+  # total time divided by the overall total time) that
+  # a method must take for it to be printed out in 
+  # the report.  Use this parameter to eliminate methods
+  # that are not important to the overall profiling results.
+  
+  class GraphHtmlPrinter
+	  PERCENTAGE_WIDTH = 8
+	  TIME_WIDTH = 10
+	  CALL_WIDTH = 20
+	
+  	# Create a GraphPrinter.  Result is a RubyProf::Result	
+  	# object generated from a profiling run.
+    def initialize(result)
+  	  @result = result
+ 	  end
+
+  	# Print a graph html report to the provided output.
+  	# 
+  	# output - Any IO oject, including STDOUT or a file. 
+  	# The default value is STDOUT.
+  	# 
+  	# min_percent - The minimum %total (the methods 
+  	# total time divided by the overall total time) that
+  	# a method must take for it to be printed out in 
+  	# the report. Default value is 0.
+ 	  def print(output = STDOUT, min_percent = 0)
+      @output = output
+      @min_percent = min_percent
+      
+      _erbout = @output
+      erb = ERB.new(template, nil, nil)
+      @output << erb.result(binding)
+    end
+
+    # These methods should be private but then ERB doesn't
+    # work.  Turn off RDOC though 
+    #--
+    def total_time(thread_id)
+			toplevel = @result.toplevel(thread_id)
+			total_time = toplevel.total_time
+			total_time = 0.01 if total_time == 0
+			return total_time
+    end
+   
+    def total_percent(method)
+      overall_time = self.total_time(method.thread_id)
+      (method.total_time/overall_time) * 100
+    end
+    
+    def self_percent(method)
+      overall_time = self.total_time(method.thread_id)
+			(method.self_time/overall_time) * 100
+    end
+
+    # Creates a link to a method.  Note that we do not create
+    # links to methods which are under the min_perecent 
+    # specified by the user, since they will not be
+    # printed out.
+		def create_link(thread_id, name)
+      # Get method
+      method = @result.threads[thread_id][name]
+      
+      if self.total_percent(method) < @min_percent
+        # Just return name
+        name
+      else
+        # Create link
+        "<a href=\"##{link_name(thread_id, name)}\">#{name}</a>" 
+			end
+  	end
+  	
+		def link_name(thread_id, name)\
+    	name.gsub(/[><#\.\?=:]/,"_") + "_" + thread_id.to_s
+  	end
+    
+ 	  def template
+'
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <style media="all" type="text/css">
+    table {
+	    border-collapse: collapse;
+	    border: 1px solid #CCC;
+	    font-family: Verdana, Arial, Helvetica, sans-serif;
+	    font-size: 9pt;
+	    line-height: normal;
+    }
+
+    th {
+	    text-align: center;
+	    border-top: 1px solid #FB7A31;
+	    border-bottom: 1px solid #FB7A31;
+	    background: #FFC;
+	    padding: 0.3em;
+	    border-left: 1px solid silver;
+    }
+
+		tr.break td {
+		  border: 0;
+	    border-top: 1px solid #FB7A31;
+			padding: 0;
+			margin: 0;
+		}
+
+    tr.method td {
+			font-weight: bold;
+    }
+
+    td {
+	    padding: 0.3em;
+    }
+
+    td:first-child {
+	    width: 190px;
+	    }
+
+    td {
+	    border-left: 1px solid #CCC;
+	    text-align: center;
+    }	
+  </style>
+	</head>
+	<body>
+		<h1>Profile Report</h1>
+		<!-- Threads Table -->
+		<table>
+			<tr>
+				<th>Thread ID</th>
+				<th>Total Time</th>
+			</tr>
+			<% for thread_id, methods in @result.threads %>
+			<tr>
+				<td><a href="#<%= thread_id %>"><%= thread_id %></a></td>
+				<td><%= @result.toplevel(thread_id).total_time %></td>
+			</tr>
+			<% end %>
+		</table>
+
+		<!-- Methods Tables -->
+		<% for thread_id, methods in @result.threads %>
+			<h2><a name="<%= thread_id %>">Thread <%= thread_id %></a></h2>
+
+			<table>
+				<tr>
+					<th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Total") %></th>
+					<th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Self") %></th>
+					<th><%= sprintf("%#{TIME_WIDTH}s", "Total") %></th>
+					<th><%= sprintf("%#{TIME_WIDTH}s", "Self") %></th>
+					<th><%= sprintf("%#{TIME_WIDTH+2}s", "Children") %></th>
+					<th><%= sprintf("%#{CALL_WIDTH}s", "Calls") %></th>
+					<th>Name</th>
+				</tr>
+
+				<% methods = methods.values.sort.reverse %>
+				<% for method in methods %>
+					<% method_total_percent = self.total_percent(method) %>
+					<% next if method_total_percent < @min_percent %>
+					<% method_self_percent = self.self_percent(method) %>
+					
+						<!-- Parents -->
+						<% for name, call_info in method.parents %> 
+							<tr>
+								<td>&nbsp;</td>
+								<td>&nbsp;</td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.total_time) %></td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.self_time) %></td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.children_time) %></td>
+								<% called = "#{call_info.called}/#{method.called}" %>
+								<td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
+								<td><%= create_link(thread_id, name) %></td>
+							</tr>
+						<% end %>
+
+						<tr class="method">
+							<td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", method_total_percent) %></td>
+							<td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", method_self_percent) %></td>
+							<td><%= sprintf("%#{TIME_WIDTH}.2f", method.total_time) %></td>
+							<td><%= sprintf("%#{TIME_WIDTH}.2f", method.self_time) %></td>
+							<td><%= sprintf("%#{TIME_WIDTH}.2f", method.children_time) %></td>
+							<td><%= sprintf("%#{CALL_WIDTH}i", method.called) %></td>
+							<td><a name="<%= link_name(thread_id, method.name) %>"><%= method.name %></a></td>
+						</tr>
+
+						<!-- Children -->
+						<% for name, call_info in method.children %> 
+							<% methods = @result.threads[thread_id] %>
+							<% child = methods[name] %>
+
+							<tr>
+								<td>&nbsp;</td>
+								<td>&nbsp;</td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.total_time) %></td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.self_time) %></td>
+								<td><%= sprintf("%#{TIME_WIDTH}.2f", call_info.children_time) %></td>
+								<% called = "#{call_info.called}/#{child.called}" %>
+								<td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
+								<td><%= create_link(thread_id, name) %></td>
+							</tr>
+						<% end %>
+						<!-- Create divider row -->
+						<tr class="break"><td colspan="7"></td></tr>
+				<% end %>
+			</table>
+		<% end %>
+	</body>
+</html>'
+		end
+  end
+end	
+

data/lib/ruby-prof/graph_printer.rb

@@ -0,0 +1,142 @@
+module RubyProf
+  # Generates graph[link:files/examples/graph_txt.html] profile reports as text. 
+  # To use the graph printer:
+  #
+	# 	result = RubyProf.profile do
+  #			[code to profile]
+  #		end
+  #
+  # 	printer = RubyProf::GraphPrinter.new(result, 5)
+  # 	printer.print(STDOUT, 0)
+  #
+  # The constructor takes two arguments.  The first is
+  # a RubyProf::Result object generated from a profiling
+  # run.  The second is the minimum %total (the methods 
+  # total time divided by the overall total time) that
+  # a method must take for it to be printed out in 
+  # the report.  Use this parameter to eliminate methods
+  # that are not important to the overall profiling results.
+
+  class GraphPrinter
+	  PERCENTAGE_WIDTH = 8
+	  TIME_WIDTH = 10
+	  CALL_WIDTH = 20
+	
+  	# Create a GraphPrinter.  Result is a RubyProf::Result	
+  	# object generated from a profiling run.
+    def initialize(result, min_percent = 0)
+  	  @result = result
+  	  @min_percent = min_percent
+ 	  end
+
+  	# Print a graph report to the provided output.
+  	# 
+  	# output - Any IO oject, including STDOUT or a file. 
+  	# The default value is STDOUT.
+  	# 
+  	# min_percent - The minimum %total (the methods 
+  	# total time divided by the overall total time) that
+  	# a method must take for it to be printed out in 
+  	# the report. Default value is 0.
+ 	  def print(output = STDOUT, min_percent = 0)
+      @output = output
+      @min_percent = min_percent
+
+      	print_threads
+    end
+
+    private 
+ 	  def print_threads
+      # sort assumes that spawned threads have higher object_ids
+			@result.threads.sort.each do |thread_id, methods|
+				print_methods(thread_id, methods)
+				@output << "\n" * 2
+			end
+    end
+    
+    def print_methods(thread_id, methods)
+	    toplevel = @result.toplevel(thread_id)
+	    total_time = toplevel.total_time
+      if total_time == 0
+    	  total_time = 0.01
+      end
+      
+      print_heading(thread_id)
+    
+      # Get methods and sort by time
+      methods = methods.values.sort.reverse
+    
+      # Print each method
+      methods.each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+        self_percentage = (method.self_time/total_time) * 100
+        
+        next if total_percentage < @min_percent
+        
+        @output << "-" * 80 << "\n"
+
+        print_parents(thread_id, method)
+    
+        # 1 is for % sign
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", total_percentage)
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", self_percentage)
+    	  @output << sprintf("%#{TIME_WIDTH}.2f", method.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", method.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.2f", method.children_time)
+        @output << sprintf("%#{CALL_WIDTH}i", method.called)
+        @output << sprintf("     %s", method.name)
+        @output << "\n"
+    
+        print_children(thread_id, method)
+  	  end
+	  end
+  
+	  def print_heading(thread_id)
+      @output << "Thread ID: #{thread_id}\n"
+			# 1 is for % sign
+			@output << sprintf("%#{PERCENTAGE_WIDTH}s", "%total")
+			@output << sprintf("%#{PERCENTAGE_WIDTH}s", "%self")
+			@output << sprintf("%#{TIME_WIDTH}s", "total")
+			@output << sprintf("%#{TIME_WIDTH}s", "self")
+			@output << sprintf("%#{TIME_WIDTH+2}s", "children")
+			@output << sprintf("%#{CALL_WIDTH-2}s", "calls")
+			@output << "   Name"
+			@output << "\n"
+    end
+    
+    def print_parents(thread_id, method)
+		  method.parents.each do |name, call_info|
+	      @output << " " * 2 * PERCENTAGE_WIDTH
+    	  @output << sprintf("%#{TIME_WIDTH}.2f", call_info.total_time)
+    	  @output << sprintf("%#{TIME_WIDTH}.2f", call_info.self_time)
+  	    @output << sprintf("%#{TIME_WIDTH}.2f", call_info.children_time)
+	  
+  	    call_called = "#{call_info.called}/#{method.called}"
+  	    @output << sprintf("%#{CALL_WIDTH}s", call_called)
+	      @output << sprintf("     %s", name)
+	      @output << "\n"
+   	  end
+    end
+  
+    def print_children(thread_id, method)
+      a = method.children
+		  method.children.each do |name, call_info|
+        # Get children method
+        methods = @result.threads[thread_id]
+        children = methods[name]
+        
+	      @output << " " * 2 * PERCENTAGE_WIDTH
+	      
+    	  @output << sprintf("%#{TIME_WIDTH}.2f", call_info.total_time)
+    	  @output << sprintf("%#{TIME_WIDTH}.2f", call_info.self_time)
+  	    @output << sprintf("%#{TIME_WIDTH}.2f", call_info.children_time)
+
+  	    call_called = "#{call_info.called}/#{children.called}"
+  	    @output << sprintf("%#{CALL_WIDTH}s", call_called)
+	      @output << sprintf("     %s", name)
+	      @output << "\n"
+   	  end
+    end
+  end
+end	
+