ruby-prof 1.4.4-x64-mingw-ucrt

data/Rakefile

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require "rubygems/package_task"
+require "rake/extensiontask"
+require "rake/testtask"
+require "rdoc/task"
+require "date"
+require "rake/clean"
+
+# To release a version of ruby-prof:
+#   * Update lib/ruby-prof/version.rb
+#   * Update CHANGES
+#   * 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 (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")
+
+# specify which versions/builds to cross compile
+Rake::ExtensionTask.new do |ext|
+  ext.gem_spec = default_spec
+  ext.name = SO_NAME
+  ext.ext_dir = "ext/#{SO_NAME}"
+  ext.lib_dir = "lib/#{Gem::Version.new(RUBY_VERSION).segments[0..1].join('.')}"
+  ext.cross_compile = true
+  ext.cross_platform = ['x64-mingw32']
+end
+
+# Rake task to build the default package
+Gem::PackageTask.new(default_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+# make sure rdoc has been built when packaging
+# why do we ship rdoc as part of the gem?
+Rake::Task[:package].enhance [:rdoc]
+
+# Setup Windows Gem
+if RUBY_PLATFORM.match(/mswin|mingw/)
+  # Windows specification
+  win_spec = default_spec.clone
+  win_spec.platform = Gem::Platform::CURRENT
+  win_spec.files += Dir.glob('lib/**/*.so')
+
+  # 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"
+RDoc::Task.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ruby-prof"
+  # Show source inline with line numbers
+  rdoc.options << "--line-numbers"
+  # Make the readme file the start page for the generated html
+  rdoc.options << '--main' << 'README.md'
+  rdoc.rdoc_files.include('bin/*',
+                          'doc/*.rdoc',
+                          'lib/**/*.rb',
+                          'ext/ruby_prof/*.c',
+                          'ext/ruby_prof/*.h',
+                          'README.md',
+                          'LICENSE')
+end
+
+task :default => :test
+
+for file in Dir['lib/**/*.{o,so,bundle}']
+  CLEAN.include file
+end
+for file in Dir['doc/**/*.{txt,dat,png,html}']
+  CLEAN.include file
+end
+CLEAN.reject!{|f| !File.exist?(f)}
+task :clean do
+  # remove tmp dir contents completely after cleaning
+  FileUtils.rm_rf('tmp/*')
+end
+
+desc 'Run the ruby-prof test suite'
+Rake::TestTask.new do |t|
+  t.libs += %w(lib ext test)
+  t.test_files = Dir['test/**_test.rb']
+  t.verbose = true
+  t.warning = true
+end

data/bin/ruby-prof

@@ -0,0 +1,328 @@
+#! /usr/bin/env ruby
+
+# First require ruby-prof
+require 'ruby-prof'
+
+# Now setup option parser
+require 'ostruct'
+require 'optparse'
+
+module RubyProf
+  # == Synopsis
+  #
+  # Profiles a Ruby program.
+  #
+  # == Usage
+  # ruby-prof [options] <script.rb> [--] [profiled-script-command-line-options]
+  #
+  # Options:
+  #    -p, --printer=printer            Select a printer:
+  #                                       flat - Prints a flat profile as text (default).
+  #                                       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
+  #                                       multi - Creates several reports in output directory
+  #    -m, --min_percent=min_percent    The minimum percent a method must take before
+  #                                       being included in output reports.
+  #                                       This option is not supported for call tree.
+  #    -f, --file=path                  Output results to a file instead of standard out.
+  #        --mode=measure_mode          Select what ruby-prof should measure:
+  #                                       wall - Wall time (default).
+  #                                       process - Process time.
+  #                                       allocations - Object allocations (requires patched Ruby interpreter).
+  #                                       memory - Allocated memory in KB (requires patched Ruby interpreter).
+  #    -s, --sort=sort_mode             Select how ruby-prof results should be sorted:
+  #                                       total - Total time
+  #                                       self - Self time
+  #                                       wait - Wait time
+  #                                       child - Child time
+  #        --allow_exceptions           Raise exceptions encountered during profiling (true) or suppress them (false)
+  #    -R, --require-noprof=lib         require a specific library (not profiled)
+  #    -E, --eval-noprof=code           execute the ruby statements (not profiled)
+  #        --exclude=methods    A comma separated list of methods to exclude.
+  #                                       Specify instance methods via # (Integer#times)
+  #                                       Specify class methods via . (Integer.superclass)
+  #        --exclude-common             Remove common methods from the profile
+  #    -h, --help                       Show help message
+  #    -v, --version version            Show version (1.1.0)
+
+  class Cmd
+    # :enddoc:
+    attr_accessor :options
+    attr_reader :profile
+
+    def initialize
+      setup_options
+      parse_args
+
+      load_pre_libs
+      load_pre_execs
+    end
+
+    def setup_options
+      @options = OpenStruct.new
+      options.printer = RubyProf::FlatPrinter
+      options.measure_mode = RubyProf::WALL_TIME
+      options.min_percent = 0
+      options.file = nil
+      options.allow_exceptions = false
+      options.exclude_common = false
+      options.exclude = Array.new
+      options.pre_libs = Array.new
+      options.pre_execs = Array.new
+    end
+
+    # This is copied from ActiveSupport:
+    def constantize(camel_cased_word)
+      if !camel_cased_word.include?("::")
+        Object.const_get(camel_cased_word)
+      else
+        names = camel_cased_word.split("::")
+
+        # Trigger a built-in NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check if it is owned directly. The check
+            # stops when we reach Object or the end of ancestors tree.
+            constant = constant.ancestors.inject(constant) do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = "ruby_prof #{RubyProf::VERSION}\n" +
+            "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, :call_stack, :dot, :multi],
+                'Select a printer:',
+                '  flat - Prints a flat profile as text (default).',
+                '  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',
+                '  multi - Creates several reports in output directory'
+        ) do |printer|
+
+          case printer
+          when :flat
+            options.printer = RubyProf::FlatPrinter
+          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
+          when :multi
+            options.printer = RubyProf::MultiPrinter
+          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, :allocations, :memory],
+                'Select what ruby-prof should measure:',
+                '  wall - Wall time (default).',
+                '  process - Process time.',
+                '  allocations - Object allocations (requires patched Ruby interpreter).',
+                '  memory - Allocated memory in KB (requires patched Ruby interpreter).') do |measure_mode|
+
+          case measure_mode
+          when :wall
+            options.measure_mode = RubyProf::WALL_TIME
+          when :process
+            options.measure_mode = RubyProf::PROCESS_TIME
+          when :allocations
+            options.measure_mode = RubyProf::ALLOCATIONS
+          when :memory
+            options.measure_mode = RubyProf::MEMORY
+          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_tail("-h", "--help", "Show help message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("-v version", "--version", "Show version (#{RubyProf::VERSION})") do
+          puts "ruby_prof " + RubyProf::VERSION
+          exit
+        end
+
+        opts.on('--allow_exceptions', 'Raise exceptions encountered during profiling (true) or suppress them (false)') do
+          options.allow_exceptions = true
+        end
+
+        opts.on('-R lib', '--require-noprof=lib', 'require a specific library (not profiled)') do |lib|
+          options.pre_libs << lib
+        end
+
+        opts.on('-E code', '--eval-noprof=code', 'execute the ruby statements (not profiled)') do |code|
+          options.pre_execs << code
+        end
+
+        opts.on('--exclude=methods', String,
+                'A comma separated list of methods to exclude.',
+                '  Specify instance methods via # (Integer#times)',
+                '  Specify class methods via . (Integer.superclass)') do |exclude_string|
+          exclude_string.split(',').each do |string|
+            match = string.strip.match(/(.*)(#|\.)(.*)/)
+            klass = constantize(match[1])
+            if match[2] == '.'
+              klass = klass.singleton_class
+            end
+            method = match[3].to_sym
+            options.exclude << [klass, method]
+          end
+        end
+
+        opts.on('--exclude-common', 'Remove common methods from the profile') do
+          options.exclude_common = true
+        end
+      end
+    end
+
+    def parse_args
+      # Make sure the user specified at least one file
+      if ARGV.length < 1 and not options.exec
+        puts self.option_parser
+        puts ""
+        puts "Must specify a script to run"
+        exit(-1)
+      end
+
+      self.option_parser.parse! ARGV
+
+      if options.printer.needs_dir?
+        options.file ||= "."
+        options.old_wd ||= Dir.pwd
+        if !File.directory?(options.file)
+          puts "'#{options.file}' is not a directory"
+          puts "#{options.printer} needs an existing directory path to put profiles under."
+          exit(-1)
+        end
+      end
+    rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument => e
+      puts self.option_parser
+      puts e.message
+      exit(-1)
+    end
+
+    def load_pre_libs
+      options.pre_libs.each do |lib|
+        require lib
+      end
+    end
+
+    def load_pre_execs
+      options.pre_execs.each do |exec|
+        eval(exec)
+      end
+    end
+
+    def run
+      script = ARGV.shift
+      @profile = Profile.new(options.to_h)
+      options.exclude.each do |klass, method|
+        @profile.exclude_method!(klass, method)
+      end
+
+      profile.profile do
+       load script
+      end
+    end
+  end
+end
+
+# Parse command line options
+cmd = RubyProf::Cmd.new
+
+# 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 {
+  # Create a printer
+  printer = cmd.options.printer.new(cmd.profile)
+  printer_options = {:min_percent => cmd.options.min_percent, :sort_method => cmd.options.sort_method}
+
+  # Get output
+  if cmd.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(cmd.options.old_wd) do
+      if printer.class.needs_dir?
+        printer.print(printer_options.merge(:path => cmd.options.file))
+      else
+        File.open(cmd.options.file, 'w') do |file|
+          printer.print(file, printer_options)
+        end
+      end
+    end
+  else
+    # Print out results
+    printer.print(STDOUT, printer_options)
+  end
+}
+
+# Now profile some code
+cmd.run

data/bin/ruby-prof-check-trace

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+stacks = Hash.new{|h,k| h[k] = Hash.new{|h,k| h[k] = []}}
+i = 0
+File.open(ARGV[0]).each_line do |l|
+  i += 1
+  unless l =~ /^(\d+):(\d+): *\d+ms *([^ ]+) *(.*): *(\d+) *(.+)$/
+    next if l =~/^ *$/
+    puts "line doesn't match: #{l}"
+    next
+  end
+  details = $1.to_i, $2.to_i, $3, $4, $5.to_i, $6
+  thread, fiber, event, file, line, method = *details
+  # puts method
+  stack = stacks[thread][fiber]
+  case event
+  when 'call', 'c-call'
+    stack << method
+  when 'return', 'c-return'
+    last_method = stack.pop
+    if last_method != method
+      puts "LINE #{i}: return event without call: #{method}"
+      puts "STACK: #{stack.inspect}"
+      if stack.find(method)
+        puts "fixing stack"
+        while (popped = stack.pop) && (popped != method)
+          puts "popped #{popped}"
+        end
+      else
+        raise "stack unfixable"
+      end
+      # stack << last_method
+    end
+  when 'line'
+    last_method = stack[-1]
+    if last_method != method
+      unless stack.find(method)
+        raise "LINE #{i}: line event without call: #{method}"
+      end
+    end
+  else
+    puts "unkown event"
+  end
+end
+puts stacks.inspect

data/ext/ruby_prof/extconf.rb

@@ -0,0 +1,22 @@
+require "mkmf"
+
+# Let's go with a modern version of C! want to intermix declarations and code (ie, don't define
+# all variables at the top of the method). If using Visual Studio, you'll need 2019 version
+# 16.8 or higher
+if RUBY_PLATFORM =~ /mswin/
+  $CFLAGS += ' /std:c11'
+else
+  $CFLAGS += ' -std=c11'
+end
+
+# For gcc add -s to strip symbols, reducing library size from 17MB to 78KB (at least on Windows with mingw64)
+if RUBY_PLATFORM !~ /mswin/
+  $LDFLAGS += ' -s'
+end
+
+# And since we are using C99 we want to disable Ruby sending these warnings to gcc
+if CONFIG['warnflags']
+  CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
+end
+
+create_makefile("ruby_prof")

data/ext/ruby_prof/rp_aggregate_call_tree.c

@@ -0,0 +1,59 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#include "rp_aggregate_call_tree.h"
+
+VALUE cRpAggregateCallTree;
+
+void prof_aggregate_call_tree_mark(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+
+    if (call_tree->object != Qnil)
+        rb_gc_mark(call_tree->object);
+
+    if (call_tree->source_file != Qnil)
+        rb_gc_mark(call_tree->source_file);
+
+    prof_measurement_mark(call_tree->measurement);
+}
+
+static void prof_aggregate_call_tree_ruby_gc_free(void* data)
+{
+    prof_call_tree_t* call_tree = (prof_call_tree_t*)data;
+    prof_call_tree_free(call_tree);
+}
+
+size_t prof_aggregate_call_tree_size(const void* data)
+{
+    return sizeof(prof_call_tree_t);
+}
+
+static const rb_data_type_t aggregate_call_tree_type =
+{
+    .wrap_struct_name = "Aggregate_CallTree",
+    .function =
+    {
+        .dmark = prof_aggregate_call_tree_mark,
+        .dfree = prof_aggregate_call_tree_ruby_gc_free,
+        .dsize = prof_aggregate_call_tree_size,
+    },
+    .data = NULL,
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+VALUE prof_aggregate_call_tree_wrap(prof_call_tree_t* call_tree)
+{
+    if (call_tree->object == Qnil)
+    {
+        call_tree->object = TypedData_Wrap_Struct(cRpAggregateCallTree, &aggregate_call_tree_type, call_tree);
+    }
+    return call_tree->object;
+}
+
+void rp_init_aggregate_call_tree()
+{
+    // AggregateCallTree
+    cRpAggregateCallTree = rb_define_class_under(mProf, "AggregateCallTree", cRpCallTree);
+    rb_undef_method(CLASS_OF(cRpAggregateCallTree), "new");
+}

data/ext/ruby_prof/rp_aggregate_call_tree.h

@@ -0,0 +1,13 @@
+/* Copyright (C) 2005-2019 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
+   Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RP_AGGREGATE_CALL_TREE_H__
+#define __RP_AGGREGATE_CALL_TREE_H__
+
+#include "ruby_prof.h"
+#include "rp_call_tree.h"
+
+void rp_init_aggregate_call_tree(void);
+VALUE prof_aggregate_call_tree_wrap(prof_call_tree_t* call_tree);
+
+#endif //__RP_AGGREGATE_CALL_TREE_H__