stackprof 0.2.21 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a342cae97be870781375a647e95936c6a6016ae711f27d60e41a891cb809f4
-  data.tar.gz: 867d55b7c7cdfc928ae35b3c36474bdda41ed4c4dc8e8b661b0c6580890b0b28
+  metadata.gz: db2506be248e74ed4aefacbb3b7adc4936c88b1acb3517fde5510a225704b6bf
+  data.tar.gz: 55aaefff3de2d6887cb9a861eb615faa85e48411eeadf778990bc1439e7c456e
 SHA512:
-  metadata.gz: 255835983ab93b52f7d1118a076f1881511c27b82a6db9e3f5db909f888bb563b26b855fc49dacbd0ef0b41f77af6c7638bf15721ff5085d012e916d4871592f
-  data.tar.gz: 7520e06a5bdf8fb240538b9a333f265675cc4056bc24b88c06d0d8c2e7cd5185346be6268707fe00f7f41bf6f8c8d70abc3925e53ac6684889ef4dc9e3ef6afd
+  metadata.gz: e761d5f7da7687ecb51ecc493c3dc4ff8e86798b57cd65c429b90e29e4021827df58525b5ddd2d21d597cba4a31e251909daa33d518157d63c53e74944784fde
+  data.tar.gz: a8c9da37e92aa2bcc64b2532367f749e5568cfa4e02758dca80d3d3f1b4f399b860dd215f880cea814356d50766103dc684f0192a04660075b5be6e43a7db121

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=MODE|--out=FILE|--interval=INTERVAL|--format=FORMAT] -- 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]', String, '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 [FILENAME]', String, '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 [MILLISECONDS]', Integer, 'Mode-relative sample rate') do |interval|
+      env['STACKPROF_INTERVAL'] = 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 |raw|
+      env['STACKPROF_RAW'] = raw.to_s
+    end
+
+    o.on('--ignore-gc', 'Ignore garbage collection frames') do |gc|
+      env['STACKPROF_IGNORE_GC'] = gc.to_s
+    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/stackprof.c

@@ -125,6 +125,8 @@ static struct {
     sample_time_t buffer_time;
     VALUE frames_buffer[BUF_SIZE];
     int lines_buffer[BUF_SIZE];
+
+    pthread_t target_thread;
 } _stackprof;
 
 static VALUE sym_object, sym_wall, sym_cpu, sym_custom, sym_name, sym_file, sym_line;
@@ -219,6 +221,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
     _stackprof.ignore_gc = ignore_gc;
     _stackprof.metadata = metadata;
     _stackprof.out = out;
+    _stackprof.target_thread = pthread_self();
 
     if (raw) {
 	capture_timestamp(&_stackprof.last_sample_at);
@@ -721,7 +724,22 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
     _stackprof.overall_signals++;
 
     if (!_stackprof.running) return;
-    if (!ruby_native_thread_p()) return;
+
+    if (_stackprof.mode == sym_wall) {
+        // In "wall" mode, the SIGALRM signal will arrive at an arbitrary thread.
+        // In order to provide more useful results, especially under threaded web
+        // servers, we want to forward this signal to the original thread
+        // StackProf was started from.
+        // According to POSIX.1-2008 TC1 pthread_kill and pthread_self should be
+        // async-signal-safe.
+        if (pthread_self() != _stackprof.target_thread) {
+            pthread_kill(_stackprof.target_thread, sig);
+            return;
+        }
+    } else {
+        if (!ruby_native_thread_p()) return;
+    }
+
     if (pthread_mutex_trylock(&lock)) return;
 
     if (!_stackprof.ignore_gc && rb_during_gc()) {

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.rb

@@ -9,7 +9,7 @@ if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
 end
 
 module StackProf
-  VERSION = '0.2.21'
+  VERSION = '0.2.23'
 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.21'
+  s.version = '0.2.23'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.23
 platform: ruby
 authors:
 - Aman Gupta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -76,6 +76,7 @@ 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
@@ -98,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.21/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.21
-  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.21
+  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.23/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.23
+  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.23
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.23
 signing_key:
 specification_version: 4
 summary: sampling callstack-profiler for ruby 2.2+