stackprof 0.2.22 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e473c6b4408f04dc69f4abd425ab68896b4f705adadd467ded771003eb84da1
-  data.tar.gz: 5bfaa3c22d7e59271f65136b0237cddc4d1a97edf9650db4caf53c9b36fda55e
+  metadata.gz: 90e33127951d53147b6a65704446ec812999df9525d868865029ee1c7450445d
+  data.tar.gz: 19a5f104482f355cb1957b71b18b15b9ca9bb981cfcc109688366e53704c5711
 SHA512:
-  metadata.gz: eb0ffc8bac6c1c66b13ce67d89bac3fbd1c601754024c3e8455e194a35e58f3c515586aa0ffeee4e30985a6e140ce64724c0960dce8de67d8a3e0f0e912d3898
-  data.tar.gz: 4cfc9aa211ab10a7b0a0c222e94538311bd91950fa32fc0602e2535468df4c48158219cad2f2f6fee015f94a9b415c3a285406fcc66ab27676a6572492b2d7f9
+  metadata.gz: 17610238200852f97afcc730efd9171c46c3a001ff7d5b82cb65fc92f96d9d2b206474bcecc7eeee1981365d2a07fd4dad460edc54a8bc9c8b1e6c7412f7cde3
+  data.tar.gz: 35cc1394b526edd0782468b06d54f66eb1ff10e5741becf486f68f0b141511fad9db622816004a4ae2e1a59cff048abe2d5697848eff127640663e9246f33cca

data/bin/stackprof

@@ -2,31 +2,33 @@
 require 'optparse'
 require 'stackprof'
 
+banner = <<-END
+Usage: stackprof run [--mode=MODE|--out=FILE|--interval=INTERVAL|--format=FORMAT] -- COMMAND
+Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]
+END
+
 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]"
-
-    o.on('--mode', 'Mode of sampling: cpu, wall, object, default to wall') do |mode|
+  parser = OptionParser.new(banner) do |o|
+    o.on('--mode [MODE]', String, 'Mode of sampling: cpu, wall, object, default to wall') do |mode|
       env["STACKPROF_MODE"] = mode
     end
 
-    o.on('--out', 'The target file, which will be overwritten. Defaults to a random temporary file') do |out|
+    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
 
-    o.on('--interval', 'Mode-relative sample rate') do |interval|
-      env['STACKPROF_INTERVAL'] = Integer(interval).to_s
+    o.on('--interval [MILLISECONDS]', Integer, 'Mode-relative sample rate') do |interval|
+      env['STACKPROF_INTERVAL'] = interval.to_s
     end
 
-    o.on('--raw', 'collects the extra data required by the --flamegraph and --stackcollapse report types') do
-      env['STACKPROF_RAW'] = '1'
+    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
-      env['STACKPROF_IGNORE_GC'] = '1'
+    o.on('--ignore-gc', 'Ignore garbage collection frames') do |gc|
+      env['STACKPROF_IGNORE_GC'] = gc.to_s
     end
   end
   parser.parse!
@@ -37,10 +39,7 @@ if ARGV.first == "run"
 else
   options = {}
 
-  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(banner) do |o|
     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 }

data/ext/stackprof/stackprof.c

@@ -12,6 +12,7 @@
 #include <ruby/st.h>
 #include <ruby/io.h>
 #include <ruby/intern.h>
+#include <ruby/vm.h>
 #include <signal.h>
 #include <sys/time.h>
 #include <time.h>
@@ -32,6 +33,7 @@ static const char *fake_frame_cstrs[] = {
 };
 
 static int stackprof_use_postponed_job = 1;
+static int ruby_vm_running = 0;
 
 #define TOTAL_FAKE_FRAMES (sizeof(fake_frame_cstrs) / sizeof(char *))
 
@@ -125,6 +127,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 +223,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 +726,27 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
     _stackprof.overall_signals++;
 
     if (!_stackprof.running) return;
-    if (!ruby_native_thread_p()) return;
+
+    // There's a possibility that the signal handler is invoked *after* the Ruby
+    // VM has been shut down (e.g. after ruby_cleanup(0)). In this case, things
+    // that rely on global VM state (e.g. rb_during_gc) will segfault.
+    if (!ruby_vm_running) 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()) {
@@ -827,6 +852,12 @@ stackprof_use_postponed_job_l(VALUE self)
     return Qnil;
 }
 
+static void
+stackprof_at_exit(ruby_vm_t* vm)
+{
+    ruby_vm_running = 0;
+}
+
 void
 Init_stackprof(void)
 {
@@ -837,6 +868,9 @@ Init_stackprof(void)
     */
     stackprof_use_postponed_job = RUBY_API_VERSION_MAJOR < 3;
 
+    ruby_vm_running = 1;
+    ruby_vm_at_exit(stackprof_at_exit);
+
 #define S(name) sym_##name = ID2SYM(rb_intern(#name));
     S(object);
     S(custom);

data/lib/stackprof.rb

@@ -6,10 +6,15 @@ end
 
 if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
   StackProf.use_postponed_job!
+elsif RUBY_VERSION == "3.2.0"
+  # 3.2.0 crash is the signal is received at the wrong time.
+  # Fixed in https://github.com/ruby/ruby/pull/7116
+  # The fix is backported in 3.2.1: https://bugs.ruby-lang.org/issues/19336
+  StackProf.use_postponed_job!
 end
 
 module StackProf
-  VERSION = '0.2.22'
+  VERSION = '0.2.24'
 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.22'
+  s.version = '0.2.24'
   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.22
+  version: 0.2.24
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -99,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.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
+  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.24/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.24
+  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.24
 post_install_message: 
 rdoc_options: []
 require_paths: