profile 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89b239c449c5e0c5ba1806075b167dd3cb3be09819936abc723e46bab1d93341
+  data.tar.gz: c49ab1d4bd239002a8671116d119b1395f9d1503edc11ad96931c3abb98d9f1c
+SHA512:
+  metadata.gz: 4ad235224dde987ebfbecd3c654e6181423b4ce661ca59ded8d001e8d00f03e9fdeb42e294aa056bbe5501efbcd5a1710876aaf62ea5c938e391861a7c0b6390
+  data.tar.gz: f4a666e2779dce2d6e5f4c33bb53728d4d5c53771f1ac167445422389488fc59acdb0ab3762177443065fc81b16b17ec48f22c185afd32c558a81cee4ce31a4f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in profile.gemspec
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# Profile
+
+Profile provides a way to Profile your Ruby application.
+
+Profiling your program is a way of determining which methods are called and
+how long each method takes to complete.  This way you can detect which
+methods are possible bottlenecks.
+
+Profiling your program will slow down your execution time considerably,
+so activate it only when you need it.  Don't confuse benchmarking with
+profiling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'profile'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install profile
+
+## Usage
+
+There are two ways to activate Profiling:
+
+### Command line
+
+Run your Ruby script with <code>-rprofile</code>:
+
+```bash
+$ ruby -rprofile example.rb
+```
+
+If you're profiling an executable in your <code>$PATH</code> you can use
+<code>ruby -S</code>:
+
+```bash
+$ ruby -rprofile -S some_executable
+```
+
+### From code
+
+Just require 'profile':
+
+```ruby
+require 'profile'
+
+def slow_method
+  5000.times do
+    9999999999999999*999999999
+  end
+end
+
+def fast_method
+  5000.times do
+    9999999999999999+999999999
+  end
+end
+
+slow_method
+fast_method
+```
+
+The output in both cases is a report when the execution is over:
+
+```
+$ ruby -rprofile example.rb
+
+ %   cumulative   self              self     total
+time   seconds   seconds    calls  ms/call  ms/call  name
+68.42     0.13      0.13        2    65.00    95.00  Integer#times
+15.79     0.16      0.03     5000     0.01     0.01  Fixnum#*
+15.79     0.19      0.03     5000     0.01     0.01  Fixnum#+
+ 0.00     0.19      0.00        2     0.00     0.00  IO#set_encoding
+ 0.00     0.19      0.00        1     0.00   100.00  Object#slow_method
+ 0.00     0.19      0.00        2     0.00     0.00  Module#method_added
+ 0.00     0.19      0.00        1     0.00    90.00  Object#fast_method
+ 0.00     0.19      0.00        1     0.00   190.00  #toplevel
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/profile.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "profile"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/profile.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'profiler'
+
+RubyVM::InstructionSequence.compile_option = {
+  :trace_instruction => true,
+  :specialized_instruction => false
+}
+END {
+  Profiler__::print_profile(STDERR)
+}
+Profiler__::start_profile

data/lib/profile/version.rb

@@ -0,0 +1,3 @@
+module Profile
+  VERSION = "0.4.0"
+end

data/lib/profiler.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+# Profile provides a way to Profile your Ruby application.
+#
+# Profiling your program is a way of determining which methods are called and
+# how long each method takes to complete.  This way you can detect which
+# methods are possible bottlenecks.
+#
+# Profiling your program will slow down your execution time considerably,
+# so activate it only when you need it.  Don't confuse benchmarking with
+# profiling.
+#
+# There are two ways to activate Profiling:
+#
+# == Command line
+#
+# Run your Ruby script with <code>-rprofile</code>:
+#
+#   ruby -rprofile example.rb
+#
+# If you're profiling an executable in your <code>$PATH</code> you can use
+# <code>ruby -S</code>:
+#
+#   ruby -rprofile -S some_executable
+#
+# == From code
+#
+# Just require 'profile':
+#
+#   require 'profile'
+#
+#   def slow_method
+#     5000.times do
+#       9999999999999999*999999999
+#     end
+#   end
+#
+#   def fast_method
+#     5000.times do
+#       9999999999999999+999999999
+#     end
+#   end
+#
+#   slow_method
+#   fast_method
+#
+# The output in both cases is a report when the execution is over:
+#
+#   ruby -rprofile example.rb
+#
+#     %   cumulative   self              self     total
+#    time   seconds   seconds    calls  ms/call  ms/call  name
+#    68.42     0.13      0.13        2    65.00    95.00  Integer#times
+#    15.79     0.16      0.03     5000     0.01     0.01  Fixnum#*
+#    15.79     0.19      0.03     5000     0.01     0.01  Fixnum#+
+#     0.00     0.19      0.00        2     0.00     0.00  IO#set_encoding
+#     0.00     0.19      0.00        1     0.00   100.00  Object#slow_method
+#     0.00     0.19      0.00        2     0.00     0.00  Module#method_added
+#     0.00     0.19      0.00        1     0.00    90.00  Object#fast_method
+#     0.00     0.19      0.00        1     0.00   190.00  #toplevel
+
+module Profiler__
+  class Wrapper < Struct.new(:defined_class, :method_id, :hash) # :nodoc:
+    private :defined_class=, :method_id=, :hash=
+
+    def initialize(klass, mid)
+      super(klass, mid, nil)
+      self.hash = Struct.instance_method(:hash).bind(self).call
+    end
+
+    def to_s
+      "#{defined_class.inspect}#".sub(/\A\#<Class:(.*)>#\z/, '\1.') << method_id.to_s
+    end
+    alias inspect to_s
+  end
+
+  # internal values
+  @@start = nil # the start time that profiling began
+  @@stacks = nil # the map of stacks keyed by thread
+  @@maps = nil # the map of call data keyed by thread, class and id. Call data contains the call count, total time,
+  PROFILE_CALL_PROC = TracePoint.new(*%i[call c_call b_call]) {|tp| # :nodoc:
+    now = Process.times[0]
+    stack = (@@stacks[Thread.current] ||= [])
+    stack.push [now, 0.0]
+  }
+  PROFILE_RETURN_PROC = TracePoint.new(*%i[return c_return b_return]) {|tp| # :nodoc:
+    now = Process.times[0]
+    key = Wrapper.new(tp.defined_class, tp.method_id)
+    stack = (@@stacks[Thread.current] ||= [])
+    if tick = stack.pop
+      threadmap = (@@maps[Thread.current] ||= {})
+      data = (threadmap[key] ||= [0, 0.0, 0.0, key])
+      data[0] += 1
+      cost = now - tick[0]
+      data[1] += cost
+      data[2] += cost - tick[1]
+      stack[-1][1] += cost if stack[-1]
+    end
+  }
+module_function
+  # Starts the profiler.
+  #
+  # See Profiler__ for more information.
+  def start_profile
+    @@start = Process.times[0]
+    @@stacks = {}
+    @@maps = {}
+    PROFILE_CALL_PROC.enable
+    PROFILE_RETURN_PROC.enable
+  end
+  # Stops the profiler.
+  #
+  # See Profiler__ for more information.
+  def stop_profile
+    PROFILE_CALL_PROC.disable
+    PROFILE_RETURN_PROC.disable
+  end
+  # Outputs the results from the profiler.
+  #
+  # See Profiler__ for more information.
+  def print_profile(f)
+    stop_profile
+    total = Process.times[0] - @@start
+    if total == 0 then total = 0.01 end
+    totals = {}
+    @@maps.values.each do |threadmap|
+      threadmap.each do |key, data|
+        total_data = (totals[key] ||= [0, 0.0, 0.0, key])
+        total_data[0] += data[0]
+        total_data[1] += data[1]
+        total_data[2] += data[2]
+      end
+    end
+
+    # Maybe we should show a per thread output and a totals view?
+
+    data = totals.values
+    data = data.sort_by{|x| -x[2]}
+    sum = 0
+    f.printf "  %%   cumulative   self              self     total\n"
+    f.printf " time   seconds   seconds    calls  ms/call  ms/call  name\n"
+    for d in data
+      sum += d[2]
+      f.printf "%6.2f %8.2f  %8.2f %8d ", d[2]/total*100, sum, d[2], d[0]
+      f.printf "%8.2f %8.2f  %s\n", d[2]*1000/d[0], d[1]*1000/d[0], d[3]
+    end
+    f.printf "%6.2f %8.2f  %8.2f %8d ", 0.0, total, 0.0, 1     # ???
+    f.printf "%8.2f %8.2f  %s\n", 0.0, total*1000, "#toplevel" # ???
+  end
+end

data/profile.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "profile/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "profile"
+  spec.version       = Profile::VERSION
+  spec.authors       = ["Yukihiro Matsumoto"]
+  spec.email         = ["matz@ruby-lang.org"]
+
+  spec.summary       = %q{Profile provides a way to Profile your Ruby application.}
+  spec.description   = %q{Profile provides a way to Profile your Ruby application.}
+  spec.homepage      = "https://github.com/ruby/profile"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ruby/profile.git"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: profile
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Yukihiro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Profile provides a way to Profile your Ruby application.
+email:
+- matz@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/profile.rb
+- lib/profile/version.rb
+- lib/profiler.rb
+- profile.gemspec
+homepage: https://github.com/ruby/profile
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ruby/profile
+  source_code_uri: https://github.com/ruby/profile.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.pre1
+signing_key: 
+specification_version: 4
+summary: Profile provides a way to Profile your Ruby application.
+test_files: []