RubyGems - ruby-prof - Versions diffs - 0.13.1 → 1.4.2 - Mend

ruby-prof 0.13.1 → 1.4.2

Files changed (209) hide show

checksums.yaml +5 -5
data/CHANGES +579 -371
data/LICENSE +24 -23
data/README.rdoc +5 -433
data/Rakefile +98 -110
data/bin/ruby-prof +328 -329
data/bin/ruby-prof-check-trace +45 -0
data/ext/ruby_prof/extconf.rb +16 -59
data/ext/ruby_prof/rp_aggregate_call_tree.c +59 -0
data/ext/ruby_prof/rp_aggregate_call_tree.h +13 -0
data/ext/ruby_prof/rp_allocation.c +287 -0
data/ext/ruby_prof/rp_allocation.h +31 -0
data/ext/ruby_prof/rp_call_tree.c +369 -0
data/ext/ruby_prof/rp_call_tree.h +43 -0
data/ext/ruby_prof/rp_call_trees.c +288 -0
data/ext/ruby_prof/rp_call_trees.h +28 -0
data/ext/ruby_prof/rp_measure_allocations.c +50 -65
data/ext/ruby_prof/rp_measure_memory.c +42 -73
data/ext/ruby_prof/rp_measure_process_time.c +65 -71
data/ext/ruby_prof/rp_measure_wall_time.c +64 -42
data/ext/ruby_prof/rp_measurement.c +237 -0
data/ext/ruby_prof/rp_measurement.h +50 -0
data/ext/ruby_prof/rp_method.c +491 -420
data/ext/ruby_prof/rp_method.h +62 -57
data/ext/ruby_prof/rp_profile.c +908 -0
data/ext/ruby_prof/rp_profile.h +35 -0
data/ext/ruby_prof/rp_stack.c +212 -128
data/ext/ruby_prof/rp_stack.h +53 -51
data/ext/ruby_prof/rp_thread.c +362 -268
data/ext/ruby_prof/rp_thread.h +39 -27
data/ext/ruby_prof/ruby_prof.c +52 -695
data/ext/ruby_prof/ruby_prof.h +26 -55
data/ext/ruby_prof/vc/ruby_prof.sln +28 -21
data/ext/ruby_prof/vc/{ruby_prof_20.vcxproj → ruby_prof.vcxproj} +56 -8
data/lib/ruby-prof.rb +52 -67
data/lib/ruby-prof/assets/call_stack_printer.html.erb +710 -0
data/lib/ruby-prof/assets/call_stack_printer.png +0 -0
data/lib/ruby-prof/assets/graph_printer.html.erb +355 -0
data/lib/ruby-prof/call_tree.rb +57 -0
data/lib/ruby-prof/call_tree_visitor.rb +36 -0
data/lib/ruby-prof/compatibility.rb +99 -169
data/lib/ruby-prof/exclude_common_methods.rb +198 -0
data/lib/ruby-prof/measurement.rb +17 -0
data/lib/ruby-prof/method_info.rb +78 -131
data/lib/ruby-prof/printers/abstract_printer.rb +137 -85
data/lib/ruby-prof/printers/call_info_printer.rb +53 -41
data/lib/ruby-prof/printers/call_stack_printer.rb +180 -773
data/lib/ruby-prof/printers/call_tree_printer.rb +151 -92
data/lib/ruby-prof/printers/dot_printer.rb +132 -132
data/lib/ruby-prof/printers/flat_printer.rb +53 -69
data/lib/ruby-prof/printers/graph_html_printer.rb +63 -255
data/lib/ruby-prof/printers/graph_printer.rb +113 -116
data/lib/ruby-prof/printers/multi_printer.rb +127 -56
data/lib/ruby-prof/profile.rb +37 -77
data/lib/ruby-prof/rack.rb +62 -15
data/lib/ruby-prof/task.rb +147 -147
data/lib/ruby-prof/thread.rb +10 -12
data/lib/ruby-prof/version.rb +3 -0
data/lib/unprof.rb +10 -10
data/ruby-prof.gemspec +65 -61
data/test/abstract_printer_test.rb +26 -0
data/test/alias_test.rb +126 -0
data/test/basic_test.rb +43 -128
data/test/call_tree_visitor_test.rb +32 -0
data/test/call_trees_test.rb +66 -0
data/test/duplicate_names_test.rb +32 -32
data/test/dynamic_method_test.rb +53 -74
data/test/enumerable_test.rb +21 -16
data/test/exceptions_test.rb +24 -16
data/test/exclude_methods_test.rb +151 -0
data/test/exclude_threads_test.rb +53 -54
data/test/fiber_test.rb +129 -65
data/test/gc_test.rb +90 -0
data/test/inverse_call_tree_test.rb +175 -0
data/test/line_number_test.rb +158 -71
data/test/marshal_test.rb +113 -0
data/test/measure_allocations.rb +30 -0
data/test/measure_allocations_test.rb +375 -25
data/test/measure_allocations_trace_test.rb +375 -0
data/test/measure_memory_trace_test.rb +1101 -0
data/test/measure_process_time_test.rb +785 -62
data/test/measure_times.rb +56 -0
data/test/measure_wall_time_test.rb +434 -254
data/test/multi_printer_test.rb +71 -82
data/test/no_method_class_test.rb +15 -15
data/test/pause_resume_test.rb +175 -166
data/test/prime.rb +54 -54
data/test/prime_script.rb +6 -0
data/test/printer_call_stack_test.rb +27 -0
data/test/printer_call_tree_test.rb +30 -0
data/test/printer_flat_test.rb +99 -0
data/test/printer_graph_html_test.rb +59 -0
data/test/printer_graph_test.rb +40 -0
data/test/printers_test.rb +141 -257
data/test/printing_recursive_graph_test.rb +81 -0
data/test/profile_test.rb +16 -0
data/test/rack_test.rb +93 -0
data/test/recursive_test.rb +206 -215
data/test/singleton_test.rb +38 -38
data/test/stack_printer_test.rb +64 -78
data/test/start_stop_test.rb +109 -112
data/test/test_helper.rb +13 -115
data/test/thread_test.rb +144 -178
data/test/unique_call_path_test.rb +120 -224
data/test/yarv_test.rb +56 -0
metadata +77 -133
data/doc/LICENSE.html +0 -155
data/doc/README_rdoc.html +0 -648
data/doc/Rack.html +0 -167
data/doc/Rack/RubyProf.html +0 -319
data/doc/RubyProf.html +0 -1000
data/doc/RubyProf/AbstractPrinter.html +0 -580
data/doc/RubyProf/AggregateCallInfo.html +0 -570
data/doc/RubyProf/CallInfo.html +0 -512
data/doc/RubyProf/CallInfoPrinter.html +0 -190
data/doc/RubyProf/CallInfoVisitor.html +0 -332
data/doc/RubyProf/CallStackPrinter.html +0 -1600
data/doc/RubyProf/CallTreePrinter.html +0 -413
data/doc/RubyProf/Cmd.html +0 -669
data/doc/RubyProf/DotPrinter.html +0 -312
data/doc/RubyProf/FlatPrinter.html +0 -229
data/doc/RubyProf/FlatPrinterWithLineNumbers.html +0 -267
data/doc/RubyProf/GraphHtmlPrinter.html +0 -630
data/doc/RubyProf/GraphPrinter.html +0 -209
data/doc/RubyProf/MethodInfo.html +0 -713
data/doc/RubyProf/MultiPrinter.html +0 -407
data/doc/RubyProf/Profile.html +0 -821
data/doc/RubyProf/ProfileTask.html +0 -532
data/doc/RubyProf/Test.html +0 -578
data/doc/RubyProf/Thread.html +0 -262
data/doc/created.rid +0 -32
data/doc/examples/flat_txt.html +0 -191
data/doc/examples/graph_txt.html +0 -305
data/doc/images/add.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +0 -647
data/doc/js/darkfish.js +0 -155
data/doc/js/jquery.js +0 -18
data/doc/js/navigation.js +0 -142
data/doc/js/search.js +0 -94
data/doc/js/search_index.js +0 -1
data/doc/js/searcher.js +0 -228
data/doc/rdoc.css +0 -543
data/doc/table_of_contents.html +0 -462
data/examples/empty.png +0 -0
data/examples/flat.txt +0 -55
data/examples/graph.dot +0 -106
data/examples/graph.html +0 -823
data/examples/graph.png +0 -0
data/examples/graph.txt +0 -170
data/examples/minus.png +0 -0
data/examples/multi.flat.txt +0 -23
data/examples/multi.graph.html +0 -906
data/examples/multi.grind.dat +0 -194
data/examples/multi.stack.html +0 -573
data/examples/plus.png +0 -0
data/examples/stack.html +0 -573
data/ext/ruby_prof/rp_call_info.c +0 -407
data/ext/ruby_prof/rp_call_info.h +0 -48
data/ext/ruby_prof/rp_measure.c +0 -48
data/ext/ruby_prof/rp_measure.h +0 -45
data/ext/ruby_prof/rp_measure_cpu_time.c +0 -112
data/ext/ruby_prof/rp_measure_gc_runs.c +0 -65
data/ext/ruby_prof/rp_measure_gc_time.c +0 -57
data/ext/ruby_prof/vc/ruby_prof_18.vcxproj +0 -108
data/ext/ruby_prof/vc/ruby_prof_19.vcxproj +0 -110
data/ext/ruby_prof/version.h +0 -7
data/lib/ruby-prof/aggregate_call_info.rb +0 -72
data/lib/ruby-prof/call_info.rb +0 -89
data/lib/ruby-prof/call_info_visitor.rb +0 -44
data/lib/ruby-prof/images/empty.png +0 -0
data/lib/ruby-prof/images/minus.png +0 -0
data/lib/ruby-prof/images/plus.png +0 -0
data/lib/ruby-prof/printers/flat_printer_with_line_numbers.rb +0 -57
data/lib/ruby-prof/test.rb +0 -150
data/test/aggregate_test.rb +0 -136
data/test/call_info_test.rb +0 -78
data/test/call_info_visitor_test.rb +0 -31
data/test/exec_test.rb +0 -14
data/test/measure_cpu_time_test.rb +0 -220
data/test/measure_gc_runs_test.rb +0 -32
data/test/measure_gc_time_test.rb +0 -36
data/test/measure_memory_test.rb +0 -31
data/test/method_elimination_test.rb +0 -84
data/test/module_test.rb +0 -45
data/test/stack_test.rb +0 -138
data/test/test_suite.rb +0 -37

@@ -1,648 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-<title>README - ruby-prof</title>
-<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
-<body class="file">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="./index.html">Home</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-  <div id="project-metadata">
-    <nav id="fileindex-section" class="section project-section">
-  <h3 class="section-header">Pages</h3>
-  <ul>
-    <li class="file"><a href="./LICENSE.html">LICENSE</a>
-    <li class="file"><a href="./README_rdoc.html">README</a>
-    <li class="file"><a href="./examples/flat_txt.html">flat</a>
-    <li class="file"><a href="./examples/graph_txt.html">graph</a>
-  </ul>
-</nav>
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-  <ul class="link-list">
-    <li><a href="./RubyProf.html">RubyProf</a>
-    <li><a href="./RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a>
-    <li><a href="./RubyProf/AggregateCallInfo.html">RubyProf::AggregateCallInfo</a>
-    <li><a href="./RubyProf/CallInfo.html">RubyProf::CallInfo</a>
-    <li><a href="./RubyProf/CallInfoPrinter.html">RubyProf::CallInfoPrinter</a>
-    <li><a href="./RubyProf/CallInfoVisitor.html">RubyProf::CallInfoVisitor</a>
-    <li><a href="./RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a>
-    <li><a href="./RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a>
-    <li><a href="./RubyProf/Cmd.html">RubyProf::Cmd</a>
-    <li><a href="./RubyProf/DotPrinter.html">RubyProf::DotPrinter</a>
-    <li><a href="./RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a>
-    <li><a href="./RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a>
-    <li><a href="./RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a>
-    <li><a href="./RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a>
-    <li><a href="./RubyProf/MethodInfo.html">RubyProf::MethodInfo</a>
-    <li><a href="./RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a>
-    <li><a href="./RubyProf/Profile.html">RubyProf::Profile</a>
-    <li><a href="./RubyProf/ProfileTask.html">RubyProf::ProfileTask</a>
-    <li><a href="./RubyProf/Test.html">RubyProf::Test</a>
-    <li><a href="./RubyProf/Thread.html">RubyProf::Thread</a>
-    <li><a href="./Rack.html">Rack</a>
-    <li><a href="./Rack/RubyProf.html">Rack::RubyProf</a>
-  </ul>
-</nav>
-  </div>
-</nav>
-<div id="documentation" class="description">
-<h1 id="label-ruby-prof">ruby-prof</h1>
-<p><a href="https://travis-ci.org/ruby-prof/ruby-prof"><img
-src="https://travis-ci.org/ruby-prof/ruby-prof.png?branch=master"
-alt="Build Status" /></a></p>
-<h2 id="label-Overview">Overview</h2>
-<p>ruby-prof is a fast code profiler for Ruby.  Its features include:</p>
-<ul><li>
-<p>Speed - it is a C extension and therefore many times faster than the
-standard Ruby profiler.</p>
-</li><li>
-<p>Modes - Ruby prof can measure a number of different parameters, including
-call times, memory usage and object allocations.</p>
-</li><li>
-<p>Reports - can generate text and cross-referenced html reports</p>
-<ul><li>
-<p>Flat Profiles - similar to the reports generated by the standard Ruby
-profiler</p>
-</li><li>
-<p>Graph profiles - similar to GProf, these show how long a method runs, which
-methods call it and which methods it calls.</p>
-</li><li>
-<p>Call tree profiles - outputs results in the calltree format suitable for
-the KCacheGrind profiling tool.</p>
-</li><li>
-<p>Many more – see reports section of this <a
-href="README_rdoc.html">README</a>.</p>
-</li></ul>
-</li><li>
-<p>Threads - supports profiling multiple threads simultaneously</p>
-</li></ul>
-<h2 id="label-Requirements">Requirements</h2>
-<p>ruby-prof requires Ruby 1.8.7 or 1.9.2 and higher.</p>
-<p>If you are running Linux or Unix you&#39;ll need a C compiler so the
-extension can be compiled when it is installed.</p>
-<p>If you are running Windows, then you may need to install the Windows
-specific RubyGem which includes an already built extension (see Install
-section).</p>
-<h2 id="label-Install">Install</h2>
-<p>The easiest way to install ruby-prof is by using Ruby Gems.  To install:</p>
-<pre>gem install ruby-prof</pre>
-<p>If you&#39;re on windows then a prebuilt binary gem is available.  You may
-of course compile it yourself via use of devkit on MinGW.</p>
-<h2 id="label-Usage">Usage</h2>
-<p>There are two ways of running ruby-prof, via the command line or via its
-API.</p>
-<h3 id="label-ruby-prof+executable">ruby-prof executable</h3>
-<p>The first is to use ruby-prof to run the Ruby program you want to profile.
-For more information refer to the documentation of the ruby-prof command.</p>
-<h3 id="label-ruby-prof+API">ruby-prof API</h3>
-<p>The second way is to use the ruby-prof API to profile particular segments
-of code.</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;ruby-prof&#39;</span>
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start</span>
-<span class="ruby-operator">...</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-operator">...</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-<span class="ruby-comment"># Print a flat profile to text</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>)
-</pre>
-<p>Alternatively, you can use a block to tell ruby-prof what to profile:</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;ruby-prof&#39;</span>
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">profile</span> <span class="ruby-keyword">do</span>
-  <span class="ruby-operator">...</span>
-  [<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-  <span class="ruby-operator">...</span>
-<span class="ruby-keyword">end</span>
-<span class="ruby-comment"># Print a graph profile to text</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>, {})
-</pre>
-<p>ruby-prof also supports pausing and resuming profiling runs.</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;ruby-prof&#39;</span>
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">pause</span>
-[<span class="ruby-identifier">other</span> <span class="ruby-identifier">code</span>]
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">resume</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-</pre>
-<p>Note that resume will automatically call start if a profiling run has not
-yet started.  In addition, resume can also take a block:</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;ruby-prof&#39;</span>
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">resume</span> <span class="ruby-keyword">do</span>
-  [<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-keyword">end</span>
-<span class="ruby-identifier">data</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-</pre>
-<p>With this usage, resume will automatically call pause at the end of the
-block.</p>
-<h2 id="label-Method+and+Thread+Elimination">Method and Thread Elimination</h2>
-<p>ruby-prof supports eliminating specific methods and threads from profiling
-results. This is useful for reducing connectivity in the call graph, making
-it easier to identify the source of performance problems when using a graph
-printer.</p>
-<p>For example, consider Integer#times: it&#39;s hardly ever useful to know
-how much time is spent in the method itself. We&#39;re much more interested
-in how much the passed in block contributes to the time spent in the method
-which contains the Integer#times call.</p>
-<p>Methods are eliminated from the collected data by calling
-`eliminate_methods!` on the profiling result, before submitting it to a
-printer.</p>
-<pre>result = RubyProf.stop
-result.eliminate_methods!([/Integer#times/])</pre>
-<p>The argument given to `eliminate_methods!` is either an array of regular
-expressions, or the name of a file containing a list of regular expressions
-(line separated text).</p>
-<p>After eliminating methods the resulting profile will appear exactly as if
-those methods had been inlined at their call sites.</p>
-<p>In a similar manner, threads can be excluded so they are not profiled at
-all.  To do this, pass an array of threads to exclude to ruby-prof:</p>
-<pre>RubyProf::exclude_threads = [ thread2 ]
-RubyProf.start</pre>
-<p>Note that the excluded threads must be specified <strong>before</strong>
-profiling.</p>
-<h2 id="label-Benchmarking+full+load+time+including+rubygems+startup+cost+%3D%3D">Benchmarking full load time including rubygems startup cost ==</h2>
-<p>If you want to get a more accurate measurement of what takes all of a
-gem&#39;s bin/xxx command to load, you may want to also measure
-rubygems&#39; startup penalty. You can do this by calling into
-bin/ruby-prof directly, ex:</p>
-<p>$ gem which ruby-prof</p>
-<pre>g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/lib/ruby-prof.rb</pre>
-<p>now run it thus (substitute lib/ruby-prof.rb with bin/ruby-prof):</p>
-<p>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof
-g:192binsome_installed_gem_command</p>
-<p>or</p>
-<p>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof
-./some_file_that_does_a_require_rubygems_at_the_beginning.rb</p>
-<h2 id="label-Profiling+Tests">Profiling Tests</h2>
-<p>ruby-prof supports profiling tests cases written using Ruby&#39;s built-in
-unit test framework (ie, test derived from Test::Unit::TestCase).  To
-enable profiling simply add the following line of code to within your test
-class:</p>
-<pre>include RubyProf::Test</pre>
-<p>Each test method is profiled separately.  ruby-prof will run each test
-method once as a warmup and then ten additional times to gather profile
-data. Note that the profile data will <strong>not</strong> include the
-class&#39;s setup or teardown methods.</p>
-<p>Separate reports are generated for each method and saved, by default, in
-the test process&#39;s working directory.  To change this, or other
-profiling options, modify your test class&#39;s PROFILE_OPTIONS hash table.
-To globally change test profiling options, modify
-RubyProf::Test::PROFILE_OPTIONS.</p>
-<h2 id="label-Profiling+Rails">Profiling Rails</h2>
-<p>To profile a Rails application it is vital to run it using production like
-settings (cache classes, cache view lookups, etc.).  Otherwise, Rail&#39;s
-dependency loading code will overwhelm any time spent in the application
-itself (our tests show that Rails dependency loading causes a roughly 6x
-slowdown).  The best way to do this is create a new Rails environment,
-profile.rb.</p>
-<p>So to profile Rails:</p>
-<ol><li>
-<p>Create a new profile.rb environment.  Make sure to turn on cache_classes
-and cache_template_loading.  Otherwise your profiling results will be
-overwhelemed by the time Rails spends loading required files.  You should
-likely turn off caching.</p>
-</li><li>
-<p>Add the ruby-prof to your gemfile:</p>
-<pre>group :profile do
-  gem &#39;ruby-prof&#39;
-end</pre>
-</li><li>
-<p>Add the ruby prof rack adapter to your middleware stack.  One way to do
-this is by adding the following code to config.ru:</p>
-<pre class="ruby"><span class="ruby-keyword">if</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">env</span>.<span class="ruby-identifier">profile?</span>
-  <span class="ruby-identifier">use</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span>, :<span class="ruby-identifier">path</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;/temp/profile&#39;</span>
-<span class="ruby-keyword">end</span>
-</pre>
-<p>The path is where you want profiling results to be stored.  By default the
-rack adapter will generate a html call graph report and flat text report.</p>
-</li><li>
-<p>Now make a request to your running server.  New profiling information will
-be generated for each request.  Note that each request will overwrite the
-profiling reports created by the previous request!</p>
-</li></ol>
-<h2 id="label-Reports">Reports</h2>
-<p>ruby-prof can generate a number of different reports:</p>
-<ul><li>
-<p>Flat Reports</p>
-</li><li>
-<p>Graph Reports</p>
-</li><li>
-<p>HTML Graph Reports</p>
-</li><li>
-<p>Call graphs</p>
-</li><li>
-<p>Call stack reports</p>
-</li><li>
-<p>More!</p>
-</li></ul>
-<p>Flat profiles show the overall time spent in each method. They are a good
-of quickly identifying which methods take the most time. An example of a
-flat profile and an explanation can be found in <a
-href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/flat.txt">examples/flat.txt</a>.</p>
-<p>There are several varieties of these – run $ ruby-prof –help</p>
-<p>Graph profiles also show the overall time spent in each method. In
-addition, they also show which methods call the current method and which
-methods its calls.  Thus they are good for understanding how methods gets
-called and provide insight into the flow of your program. An example text
-graph profile is located at <a
-href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/graph.txt">examples/graph.txt</a>.</p>
-<p>HTML Graph profiles are the same as graph profiles, except output is
-generated in hyper-linked HTML. Since graph profiles can be quite large,
-the embedded links make it much easier to navigate the results. An example
-html graph profile is located at <a
-href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/graph.html">examples/graph.html</a>.</p>
-<p>Call graphs output results in the calltree profile format which is used by
-KCachegrind. Call graph support was generously donated by Carl Shimer. More
-information about the format can be found at the <a
-href="http://kcachegrind.sourceforge.net/cgi-bin/show.cgi/KcacheGrindCalltreeFormat">KCachegrind</a>
-site.</p>
-<p>Call stack reports produce a HTML visualization of the time spent in each
-execution path of the profiled code. An example can be found at <a
-href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/call_stack.html">examples/stack.html</a>.</p>
-<p>Another good example: [<a
-href="http://twitpic.com/28z94a">twitpic.com/28z94a</a>]</p>
-<p>Finally, there&#39;s a so called MultiPrinter which can generate several
-reports in one profiling run. See <a
-href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/multi.stack.html">examples/multi.stack.html</a>.</p>
-<p>There is also a graphviz .dot visualiser.</p>
-<h2 id="label-Printers">Printers</h2>
-<p>Reports are created by printers.  Supported printers include:</p>
-<ul><li>
-<p><a href="RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a> - Creates a
-flat report in text format</p>
-</li><li>
-<p><a
-href="RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a>
-- same as above but more verbose</p>
-</li><li>
-<p><a href="RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a> - Creates a
-call graph report in text format</p>
-</li><li>
-<p><a href="RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a> -
-Creates a call graph report in HTML (separate files per thread)</p>
-</li><li>
-<p><a href="RubyProf/DotPrinter.html">RubyProf::DotPrinter</a> - Creates a
-call graph report in GraphViz&#39;s DOT format which can be converted to an
-image</p>
-</li><li>
-<p><a href="RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a> -
-Creates a call tree report compatible with KCachegrind.</p>
-</li><li>
-<p><a href="RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a> -
-Creates a HTML visualization of the Ruby stack</p>
-</li><li>
-<p><a href="RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a> - Uses the
-other printers to create several reports in one profiling run</p>
-</li><li>
-<p>More!</p>
-</li></ul>
-<p>To use a printer:</p>
-<pre class="ruby"><span class="ruby-operator">...</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>, :<span class="ruby-identifier">min_percent</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">2</span>)
-</pre>
-<p>The first parameter is any writable IO object such as STDOUT or a file. The
-second parameter, specifies the minimum percentage a method must take to be
-printed.  Percentages should be specified as integers in the range 0 to
-100. For more information please see the documentation for the different
-printers.</p>
-<p>The other option is :print_file =&gt; true (default false), which adds the
-filename to the output (GraphPrinter only).</p>
-<p>The MultiPrinter differs from the other printers in that it requires a
-directory path and a basename for the files it produces.</p>
-<pre class="ruby"><span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MultiPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(:<span class="ruby-identifier">path</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;.&quot;</span>, :<span class="ruby-identifier">profile</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;profile&quot;</span>)
-</pre>
-<h2 id="label-Measurements">Measurements</h2>
-<p>Depending on the mode and platform, ruby-prof can measure various aspects
-of a Ruby program.  Supported measurements include:</p>
-<ul><li>
-<p>process time (RubyProf::PROCESS_TIME)</p>
-</li><li>
-<p>wall time (RubyProf::WALL_TIME)</p>
-</li><li>
-<p>cpu time (RubyProf::CPU_TIME)</p>
-</li><li>
-<p>object allocations (RubyProf::ALLOCATIONS)</p>
-</li><li>
-<p>memory usage (RubyProf::MEMORY)</p>
-</li><li>
-<p>garbage collections runs (RubyProf::GC_RUNS)</p>
-</li><li>
-<p>garbage collection time (RubyProf::GC_TIME)</p>
-</li></ul>
-<p>Process time measures the time used by a process between any two moments.
-It is unaffected by other processes concurrently running on the system.
-Note that Windows does not support measuring process times - therefore,
-measurements on Windows defaults to wall time.</p>
-<p>Wall time measures the real-world time elapsed between any two moments. If
-there are other processes concurrently running on the system that use
-significant CPU or disk time during a profiling run then the reported
-results will be too large.</p>
-<p>CPU time uses the CPU clock counter to measure time.  The returned values
-are dependent on the correctly setting the CPU&#39;s frequency. This mode
-is only supported on Pentium or PowerPC platforms (linux only).</p>
-<p>Object allocation reports show how many objects each method in a program
-allocates.  This support was added by Sylvain Joyeux and requires a patched
-Ruby interpreter.  For more information and the patch, please see: <a
-href="http://rubyforge.org/tracker/index.php?func=detail&aid=11497&group_id=426&atid=1700">rubyforge.org/tracker/index.php?func=detail&aid=11497&group_id=426&atid=1700</a></p>
-<p>Memory usage reports show how much memory each method in a program uses.
-This support was added by Alexander Dymo and requires a patched Ruby
-interpreter.  For more information, see: <a
-href="http://rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062">rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062</a></p>
-<p>Garbage collection runs report how many times Ruby&#39;s garbage collector
-is invoked during a profiling session.  This support was added by Jeremy
-Kemper and requires a patched Ruby interpreter.  For more information, see:
-<a
-href="http://rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062">rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062</a></p>
-<p>Garbage collection time reports how much time is spent in Ruby&#39;s
-garbage collector during a profiling session.  This support was added by
-Jeremy Kemper and requires a patched Ruby interpreter.  For more
-information, see: <a
-href="http://rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062">rubyforge.org/tracker/index.php?func=detail&aid=17676&group_id=1814&atid=7062</a></p>
-<p>To set the measurement:</p>
-<ul><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::PROCESS_TIME</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::WALL_TIME</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::CPU_TIME</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::ALLOCATIONS</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::MEMORY</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::GC_RUNS</p>
-</li><li>
-<p><a href="RubyProf.html#method-c-measure_mode">RubyProf.measure_mode</a> =
-RubyProf::GC_TIME</p>
-</li></ul>
-<p>The default value is RubyProf::PROCESS_TIME.</p>
-<p>You may also specify the measure_mode by using the RUBY_PROF_MEASURE_MODE
-environment variable:</p>
-<ul><li>
-<p>export RUBY_PROF_MEASURE_MODE=process</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=wall</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=cpu</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=allocations</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=memory</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=gc_runs</p>
-</li><li>
-<p>export RUBY_PROF_MEASURE_MODE=gc_time</p>
-</li></ul>
-<p>On Linux, process time is measured using the clock method provided by the C
-runtime library. Note that the clock method does not report time spent in
-the kernel or child processes and therefore does not measure time spent in
-methods such as Kernel.sleep method. If you need to measure these values,
-then use wall time.  Wall time is measured using the gettimeofday kernel
-method.</p>
-<p>On Windows, timings default to wall times.  If you set the clock mode to
-PROCESS_TIME, then timing are read using the clock method provided by the C
-runtime library.  Note though, these values are wall times on Windows and
-not process times like on Linux. Wall time is measured using the
-GetLocalTime API.</p>
-<p>If you use wall time, the results will be affected by other processes
-running on your computer, network delays, disk access, etc.  As result, for
-the best results, try to make sure your computer is only performing your
-profiling run and is otherwise quiescent.</p>
-<p>On both platforms, cpu time is measured using the RDTSC assembly function
-provided by the Pentium and PowerPC platforms. CPU time is dependent on the
-cpu&#39;s frequency.  On Linux, ruby-prof attempts to read this value from
-“/proc/cpuinfo.”  On Windows, you must manually specify the clock
-frequency.  This can be done using the RUBY_PROF_CPU_FREQUENCY environment
-variable:</p>
-<pre>export RUBY_PROF_CPU_FREQUENCY=&lt;value&gt;</pre>
-<p>You can also directly set the cpu frequency by calling:</p>
-<pre>RubyProf.cpu_frequency = &lt;value&gt;</pre>
-<h2 id="label-Multi-threaded+Applications">Multi-threaded Applications</h2>
-<p>Unfortunately, Ruby does not provide an internal api for detecting thread
-context switches in 1.8.  As a result, the timings ruby-prof reports for
-each thread may be slightly inaccurate.  In particular, this will happen
-for newly spawned threads that go to sleep immediately (their first call).
-For instance, if you use Ruby&#39;s timeout library to wait for 2 seconds,
-the 2 seconds will be assigned to the foreground thread and not the newly
-created background thread.  These errors can largely be avoided if the
-background thread performs any operation before going to sleep.</p>
-<h2 id="label-Performance">Performance</h2>
-<p>Significant effort has been put into reducing ruby-prof&#39;s overhead as
-much as possible.  Our tests show that the overhead associated with
-profiling code varies considerably with the code being profiled.  Most
-programs will run approximately twice as slow while highly recursive
-programs (like the fibonacci series test) will run three times slower.</p>
-<h2 id="label-License">License</h2>
-<p>See <a href="LICENSE.html">LICENSE</a> for license information.</p>
-<h2 id="label-Development">Development</h2>
-<p>Code is located at <a
-href="https://github.com/ruby-prof/ruby-prof">github.com/ruby-prof/ruby-prof</a></p>
-<p>Google group/mailing list: <a
-href="http://groups.google.com/group/ruby-optimization">groups.google.com/group/ruby-optimization</a>
-or start a github issue.</p>
-</div>
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>