stackprof 0.2.20 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e627bf7fbeca0cb94e8be863b0a1db9160534d5172c1409ba4306e0f16a57ae0
-  data.tar.gz: f881ec5ab3267f3b48f57794c3bce910b39f890db32817655b4e5253733fc466
+  metadata.gz: 8e473c6b4408f04dc69f4abd425ab68896b4f705adadd467ded771003eb84da1
+  data.tar.gz: 5bfaa3c22d7e59271f65136b0237cddc4d1a97edf9650db4caf53c9b36fda55e
 SHA512:
-  metadata.gz: 514c6697e4465fbce7990fffc2a71ca5aa544e1f526b338fde343c14bc801bb5056534e371e4d8fd5642f1b73b92126b2a5e476eb5292dde23bd0da734d7e236
-  data.tar.gz: bed130e196f1004b3e74d2db466732fa8b23e582df3fcf944161112036053e95a5a05a3ed2ac175a6603e1f3b28b6062491aef89f4d30b764be3886aaf586b19
+  metadata.gz: eb0ffc8bac6c1c66b13ce67d89bac3fbd1c601754024c3e8455e194a35e58f3c515586aa0ffeee4e30985a6e140ce64724c0960dce8de67d8a3e0f0e912d3898
+  data.tar.gz: 4cfc9aa211ab10a7b0a0c222e94538311bd91950fa32fc0602e2535468df4c48158219cad2f2f6fee015f94a9b415c3a285406fcc66ab27676a6572492b2d7f9

data/.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ ruby-head, '3.1', '3.0', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2' ]
+        ruby: [ ruby-head, '3.1', '3.0', '2.7', '2.6', '2.5', '2.4', '2.3', '2.2', truffleruby ]
     steps:
       - name: Checkout
         uses: actions/checkout@v2

data/Rakefile

@@ -7,11 +7,21 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
-require "rake/extensiontask"
+if RUBY_ENGINE == "truffleruby"
+  task :compile do
+    # noop
+  end
 
-Rake::ExtensionTask.new("stackprof") do |ext|
-  ext.ext_dir = "ext/stackprof"
-  ext.lib_dir = "lib/stackprof"
+  task :clean do
+    # noop
+  end
+else
+  require "rake/extensiontask"
+
+  Rake::ExtensionTask.new("stackprof") do |ext|
+    ext.ext_dir = "ext/stackprof"
+    ext.lib_dir = "lib/stackprof"
+  end
 end
 
 task default: %i(compile test)

data/bin/stackprof

@@ -2,94 +2,129 @@
 require 'optparse'
 require 'stackprof'
 
-options = {}
+if ARGV.first == "run"
+  ARGV.shift
+  env = {}
+  parser = OptionParser.new(ARGV) do |o|
+    o.banner = "Usage: stackprof run [--mode|--out|--interval] -- COMMAND"
+    o.banner = "Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]"
 
-parser = OptionParser.new(ARGV) do |o|
-  o.banner = "Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]"
+    o.on('--mode', 'Mode of sampling: cpu, wall, object, default to wall') do |mode|
+      env["STACKPROF_MODE"] = mode
+    end
 
-  o.on('--text', 'Text summary per method (default)'){ options[:format] = :text }
-  o.on('--json', 'JSON output (use with web viewers)'){ options[:format] = :json }
-  o.on('--files', 'List of files'){ |f| options[:format] = :files }
-  o.on('--limit [num]', Integer, 'Limit --text, --files, or --graphviz output to N entries'){ |n| options[:limit] = n }
-  o.on('--sort-total', "Sort --text or --files output on total samples\n\n"){ options[:sort] = true }
-  o.on('--method [grep]', 'Zoom into specified method'){ |f| options[:format] = :method; options[:filter] = f }
-  o.on('--file [grep]', "Show annotated code for specified file"){ |f| options[:format] = :file; options[:filter] = f }
-  o.on('--walk', "Walk the stacktrace interactively\n\n"){ |f| options[:walk] = true }
-  o.on('--callgrind', 'Callgrind output (use with kcachegrind, stackprof-gprof2dot.py)'){ options[:format] = :callgrind }
-  o.on('--graphviz', "Graphviz output (use with dot)"){ options[:format] = :graphviz }
-  o.on('--node-fraction [frac]', OptionParser::DecimalNumeric, 'Drop nodes representing less than [frac] fraction of samples'){ |n| options[:node_fraction] = n }
-  o.on('--stackcollapse', 'stackcollapse.pl compatible output (use with stackprof-flamegraph.pl)'){ options[:format] = :stackcollapse }
-  o.on('--timeline-flamegraph', "timeline-flamegraph output (js)"){ options[:format] = :timeline_flamegraph }
-  o.on('--alphabetical-flamegraph', "alphabetical-flamegraph output (js)"){ options[:format] = :alphabetical_flamegraph }
-  o.on('--flamegraph', "alias to --timeline-flamegraph"){ options[:format] = :timeline_flamegraph }
-  o.on('--flamegraph-viewer [f.js]', String, "open html viewer for flamegraph output"){ |file|
-    puts("open file://#{File.expand_path('../../lib/stackprof/flamegraph/viewer.html', __FILE__)}?data=#{File.expand_path(file)}")
-    exit
-  }
-  o.on('--d3-flamegraph', "flamegraph output (html using d3-flame-graph)\n\n"){ options[:format] = :d3_flamegraph }
-  o.on('--select-files []', String, 'Show results of matching files'){ |path| (options[:select_files] ||= []) << File.expand_path(path) }
-  o.on('--reject-files []', String, 'Exclude results of matching files'){ |path| (options[:reject_files] ||= []) << File.expand_path(path) }
-  o.on('--select-names []', Regexp, 'Show results of matching method names'){ |regexp| (options[:select_names] ||= []) << regexp }
-  o.on('--reject-names []', Regexp, 'Exclude results of matching method names'){ |regexp| (options[:reject_names] ||= []) << regexp }
-  o.on('--dump', 'Print marshaled profile dump (combine multiple profiles)'){ options[:format] = :dump }
-  o.on('--debug', 'Pretty print raw profile data'){ options[:format] = :debug }
-end
+    o.on('--out', 'The target file, which will be overwritten. Defaults to a random temporary file') do |out|
+      env['STACKPROF_OUT'] = out
+    end
 
-parser.parse!
-parser.abort(parser.help) if ARGV.empty?
+    o.on('--interval', 'Mode-relative sample rate') do |interval|
+      env['STACKPROF_INTERVAL'] = Integer(interval).to_s
+    end
 
-reports = []
-while ARGV.size > 0
-  begin
-    file = ARGV.pop
-    reports << StackProf::Report.from_file(file)
-  rescue TypeError => e
-    STDERR.puts "** error parsing #{file}: #{e.inspect}"
+    o.on('--raw', 'collects the extra data required by the --flamegraph and --stackcollapse report types') do
+      env['STACKPROF_RAW'] = '1'
+    end
+
+    o.on('--ignore-gc', 'Ignore garbage collection frames') do
+      env['STACKPROF_IGNORE_GC'] = '1'
+    end
   end
-end
-report = reports.inject(:+)
+  parser.parse!
+  parser.abort(parser.help) if ARGV.empty?
+  stackprof_path = File.expand_path('../lib', __dir__)
+  env['RUBYOPT'] = "-I #{stackprof_path} -r stackprof/autorun #{ENV['RUBYOPT']}"
+  Kernel.exec(env, *ARGV)
+else
+  options = {}
 
-default_options = {
-  :format => :text,
-  :sort => false,
-  :limit => 30
-}
+  parser = OptionParser.new(ARGV) do |o|
+    o.banner = "Usage: stackprof run [--mode|--out|--interval] -- COMMAND"
+    o.banner = "Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]"
 
-if options[:format] == :graphviz
-  default_options[:limit] = 120
-  default_options[:node_fraction] = 0.005
-end
+    o.on('--text', 'Text summary per method (default)'){ options[:format] = :text }
+    o.on('--json', 'JSON output (use with web viewers)'){ options[:format] = :json }
+    o.on('--files', 'List of files'){ |f| options[:format] = :files }
+    o.on('--limit [num]', Integer, 'Limit --text, --files, or --graphviz output to N entries'){ |n| options[:limit] = n }
+    o.on('--sort-total', "Sort --text or --files output on total samples\n\n"){ options[:sort] = true }
+    o.on('--method [grep]', 'Zoom into specified method'){ |f| options[:format] = :method; options[:filter] = f }
+    o.on('--file [grep]', "Show annotated code for specified file"){ |f| options[:format] = :file; options[:filter] = f }
+    o.on('--walk', "Walk the stacktrace interactively\n\n"){ |f| options[:walk] = true }
+    o.on('--callgrind', 'Callgrind output (use with kcachegrind, stackprof-gprof2dot.py)'){ options[:format] = :callgrind }
+    o.on('--graphviz', "Graphviz output (use with dot)"){ options[:format] = :graphviz }
+    o.on('--node-fraction [frac]', OptionParser::DecimalNumeric, 'Drop nodes representing less than [frac] fraction of samples'){ |n| options[:node_fraction] = n }
+    o.on('--stackcollapse', 'stackcollapse.pl compatible output (use with stackprof-flamegraph.pl)'){ options[:format] = :stackcollapse }
+    o.on('--timeline-flamegraph', "timeline-flamegraph output (js)"){ options[:format] = :timeline_flamegraph }
+    o.on('--alphabetical-flamegraph', "alphabetical-flamegraph output (js)"){ options[:format] = :alphabetical_flamegraph }
+    o.on('--flamegraph', "alias to --timeline-flamegraph"){ options[:format] = :timeline_flamegraph }
+    o.on('--flamegraph-viewer [f.js]', String, "open html viewer for flamegraph output"){ |file|
+      puts("open file://#{File.expand_path('../../lib/stackprof/flamegraph/viewer.html', __FILE__)}?data=#{File.expand_path(file)}")
+      exit
+    }
+    o.on('--d3-flamegraph', "flamegraph output (html using d3-flame-graph)\n\n"){ options[:format] = :d3_flamegraph }
+    o.on('--select-files []', String, 'Show results of matching files'){ |path| (options[:select_files] ||= []) << File.expand_path(path) }
+    o.on('--reject-files []', String, 'Exclude results of matching files'){ |path| (options[:reject_files] ||= []) << File.expand_path(path) }
+    o.on('--select-names []', Regexp, 'Show results of matching method names'){ |regexp| (options[:select_names] ||= []) << regexp }
+    o.on('--reject-names []', Regexp, 'Exclude results of matching method names'){ |regexp| (options[:reject_names] ||= []) << regexp }
+    o.on('--dump', 'Print marshaled profile dump (combine multiple profiles)'){ options[:format] = :dump }
+    o.on('--debug', 'Pretty print raw profile data'){ options[:format] = :debug }
+  end
 
-options = default_options.merge(options)
-options.delete(:limit) if options[:limit] == 0
+  parser.parse!
+  parser.abort(parser.help) if ARGV.empty?
 
-case options[:format]
-when :text
-  report.print_text(options[:sort], options[:limit], options[:select_files], options[:reject_files], options[:select_names], options[:reject_names])
-when :json
-  report.print_json
-when :debug
-  report.print_debug
-when :dump
-  report.print_dump
-when :callgrind
-  report.print_callgrind
-when :graphviz
-  report.print_graphviz(options)
-when :stackcollapse
-  report.print_stackcollapse
-when :timeline_flamegraph
-  report.print_timeline_flamegraph
-when :alphabetical_flamegraph
-  report.print_alphabetical_flamegraph
-when :d3_flamegraph
-  report.print_d3_flamegraph
-when :method
-  options[:walk] ? report.walk_method(options[:filter]) : report.print_method(options[:filter])
-when :file
-  report.print_file(options[:filter])
-when :files
-  report.print_files(options[:sort], options[:limit])
-else
-  raise ArgumentError, "unknown format: #{options[:format]}"
+  reports = []
+  while ARGV.size > 0
+    begin
+      file = ARGV.pop
+      reports << StackProf::Report.from_file(file)
+    rescue TypeError => e
+      STDERR.puts "** error parsing #{file}: #{e.inspect}"
+    end
+  end
+  report = reports.inject(:+)
+
+  default_options = {
+    :format => :text,
+    :sort => false,
+    :limit => 30
+  }
+
+  if options[:format] == :graphviz
+    default_options[:limit] = 120
+    default_options[:node_fraction] = 0.005
+  end
+
+  options = default_options.merge(options)
+  options.delete(:limit) if options[:limit] == 0
+
+  case options[:format]
+  when :text
+    report.print_text(options[:sort], options[:limit], options[:select_files], options[:reject_files], options[:select_names], options[:reject_names])
+  when :json
+    report.print_json
+  when :debug
+    report.print_debug
+  when :dump
+    report.print_dump
+  when :callgrind
+    report.print_callgrind
+  when :graphviz
+    report.print_graphviz(options)
+  when :stackcollapse
+    report.print_stackcollapse
+  when :timeline_flamegraph
+    report.print_timeline_flamegraph
+  when :alphabetical_flamegraph
+    report.print_alphabetical_flamegraph
+  when :d3_flamegraph
+    report.print_d3_flamegraph
+  when :method
+    options[:walk] ? report.walk_method(options[:filter]) : report.print_method(options[:filter])
+  when :file
+    report.print_file(options[:filter])
+  when :files
+    report.print_files(options[:sort], options[:limit])
+  else
+    raise ArgumentError, "unknown format: #{options[:format]}"
+  end
 end

data/ext/stackprof/extconf.rb

@@ -1,4 +1,10 @@
 require 'mkmf'
+
+if RUBY_ENGINE == 'truffleruby'
+  File.write('Makefile', dummy_makefile($srcdir).join(""))
+  return
+end
+
 if have_func('rb_postponed_job_register_one') &&
    have_func('rb_profile_frames') &&
    have_func('rb_tracepoint_new') &&

data/ext/stackprof/stackprof.c

@@ -146,6 +146,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
     VALUE opts = Qnil, mode = Qnil, interval = Qnil, metadata = rb_hash_new(), out = Qfalse;
     int ignore_gc = 0;
     int raw = 0, aggregate = 1;
+    VALUE metadata_val;
 
     if (_stackprof.running)
 	return Qfalse;
@@ -160,7 +161,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
 	    ignore_gc = 1;
 	}
 
-	VALUE metadata_val = rb_hash_aref(opts, sym_metadata);
+	metadata_val = rb_hash_aref(opts, sym_metadata);
 	if (RTEST(metadata_val)) {
 	    if (!RB_TYPE_P(metadata_val, T_HASH))
 		rb_raise(rb_eArgError, "metadata should be a hash");
@@ -597,14 +598,15 @@ stackprof_record_sample_for_stack(int num, uint64_t sample_timestamp, int64_t ti
 void
 stackprof_buffer_sample(void)
 {
+    uint64_t start_timestamp = 0;
+    int64_t timestamp_delta = 0;
+    int num;
+
     if (_stackprof.buffer_count > 0) {
 	// Another sample is already pending
 	return;
     }
 
-    uint64_t start_timestamp = 0;
-    int64_t timestamp_delta = 0;
-    int num;
     if (_stackprof.raw) {
 	struct timestamp_t t;
 	capture_timestamp(&t);
@@ -828,15 +830,13 @@ stackprof_use_postponed_job_l(VALUE self)
 void
 Init_stackprof(void)
 {
+    size_t i;
    /*
     * As of Ruby 3.0, it should be safe to read stack frames at any time, unless YJIT is enabled
     * See https://github.com/ruby/ruby/commit/0e276dc458f94d9d79a0f7c7669bde84abe80f21
     */
-    #if RUBY_API_VERSION_MAJOR < 3
-    stackprof_use_postponed_job = 0;
-    #endif
+    stackprof_use_postponed_job = RUBY_API_VERSION_MAJOR < 3;
 
-    size_t i;
 #define S(name) sym_##name = ID2SYM(rb_intern(#name));
     S(object);
     S(custom);

data/lib/stackprof/autorun.rb

@@ -0,0 +1,19 @@
+require "stackprof"
+
+options = {}
+options[:mode] = ENV["STACKPROF_MODE"].to_sym if ENV.key?("STACKPROF_MODE")
+options[:interval] = Integer(ENV["STACKPROF_INTERVAL"]) if ENV.key?("STACKPROF_INTERVAL")
+options[:raw] = true if ENV["STACKPROF_RAW"]
+options[:ignore_gc] = true if ENV["STACKPROF_IGNORE_GC"]
+
+at_exit do
+  StackProf.stop
+  output_path = ENV.fetch("STACKPROF_OUT") do
+    require "tempfile"
+    Tempfile.create(["stackprof", ".dump"]).path
+  end
+  StackProf.results(output_path)
+  $stderr.puts("StackProf results dumped at: #{output_path}")
+end
+
+StackProf.start(**options)

data/lib/stackprof/report.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'pp'
-require 'digest/md5'
+require 'digest/sha2'
 require 'json'
 
 module StackProf
@@ -52,7 +52,7 @@ module StackProf
     def normalized_frames
       id2hash = {}
       @data[:frames].each do |frame, info|
-        id2hash[frame.to_s] = info[:hash] = Digest::MD5.hexdigest("#{info[:name]}#{info[:file]}#{info[:line]}")
+        id2hash[frame.to_s] = info[:hash] = Digest::SHA256.hexdigest("#{info[:name]}#{info[:file]}#{info[:line]}")
       end
       @data[:frames].inject(Hash.new) do |hash, (frame, info)|
         info = hash[id2hash[frame.to_s]] = info.dup
@@ -225,7 +225,7 @@ module StackProf
           end
         else
           frame = @data[:frames][val]
-          child_name = "#{ frame[:name] } : #{ frame[:file] }"
+          child_name = "#{ frame[:name] } : #{ frame[:file] } : #{ frame[:line] }"
           child_data = convert_to_d3_flame_graph_format(child_name, child_stacks, depth + 1)
           weight += child_data["value"]
           children << child_data

data/lib/stackprof/truffleruby.rb

@@ -0,0 +1,37 @@
+module StackProf
+  # Define the same methods as stackprof.c
+  class << self
+    def running?
+      false
+    end
+
+    def run(*args)
+      unimplemented
+    end
+
+    def start(*args)
+      unimplemented
+    end
+
+    def stop
+      unimplemented
+    end
+
+    def results(*args)
+      unimplemented
+    end
+
+    def sample
+      unimplemented
+    end
+
+    def use_postponed_job!
+      # noop
+    end
+
+    private def unimplemented
+      raise "Use --cpusampler=flamegraph or --cpusampler instead of StackProf on TruffleRuby.\n" \
+            "See https://www.graalvm.org/tools/profiling/ and `ruby --help:cpusampler` for more details."
+    end
+  end
+end

data/lib/stackprof.rb

@@ -1,11 +1,15 @@
-require "stackprof/stackprof"
+if RUBY_ENGINE == 'truffleruby'
+  require "stackprof/truffleruby"
+else
+  require "stackprof/stackprof"
+end
 
 if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
   StackProf.use_postponed_job!
 end
 
 module StackProf
-  VERSION = '0.2.20'
+  VERSION = '0.2.22'
 end
 
 StackProf.autoload :Report, "stackprof/report.rb"

data/stackprof.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.20'
+  s.version = '0.2.22'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'

data/test/test_stackprof.rb

@@ -308,4 +308,4 @@ class StackProfTest < MiniTest::Test
     r.close
     w.close
   end
-end
+end unless RUBY_ENGINE == 'truffleruby'

data/test/test_truffleruby.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'stackprof'
+require 'minitest/autorun'
+
+if RUBY_ENGINE == 'truffleruby'
+  class StackProfTruffleRubyTest < MiniTest::Test
+    def test_error
+      error = assert_raises RuntimeError do
+        StackProf.run(mode: :cpu) do
+          unreacheable
+        end
+      end
+
+      assert_match(/TruffleRuby/, error.message)
+      assert_match(/--cpusampler/, error.message)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.2.22
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -76,10 +76,12 @@ files:
 - ext/stackprof/extconf.rb
 - ext/stackprof/stackprof.c
 - lib/stackprof.rb
+- lib/stackprof/autorun.rb
 - lib/stackprof/flamegraph/flamegraph.js
 - lib/stackprof/flamegraph/viewer.html
 - lib/stackprof/middleware.rb
 - lib/stackprof/report.rb
+- lib/stackprof/truffleruby.rb
 - sample.rb
 - stackprof.gemspec
 - test/fixtures/profile.dump
@@ -87,6 +89,7 @@ files:
 - test/test_middleware.rb
 - test/test_report.rb
 - test/test_stackprof.rb
+- test/test_truffleruby.rb
 - vendor/FlameGraph/README
 - vendor/FlameGraph/flamegraph.pl
 - vendor/gprof2dot/gprof2dot.py
@@ -96,9 +99,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/tmm1/stackprof/issues
-  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.20/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.20
-  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.20
+  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.22/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.22
+  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.22
 post_install_message: 
 rdoc_options: []
 require_paths: