stackprof 0.2.26 → 0.2.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3165c34411b9287741eb15e8c84bec239792a81aaf30695d2e735b0bee41a9d8
-  data.tar.gz: 6cf3bd55b6b14fcd880facfb281ded85e03d1ec9d79fc1b0c4fcb5b592df014d
+  metadata.gz: 79a87e448ec4d0147b81316179de34549210e7d0e4dc5ed88a0e29ac2a29f78e
+  data.tar.gz: 7379be750f5818a56a00e8170802bfb56444efff17b2a663a4da86789405e329
 SHA512:
-  metadata.gz: '086238ddefcd029b17a7de36d0bdce624b8cda367c1dd5ab55348f9332388c49fc326f01ba66d7d11d31d0014210d1474013aa106d1432da4605334551772ba2'
-  data.tar.gz: a4c203dc55aa3da32744114a2f899982d548ce1c4c90daf4da3808bcae725fcff21775a4fee3d303724f96418b5bd1c748807dce7d28e84dcde8fbd61ea90932
+  metadata.gz: 3f87238f0afb0690fc26e09eb4d8c3d4ac4da173080852aee353967239dd98058be39303072db2e0f192311b4aabb58691765ae1a38d16cc0c45a7674aba2954
+  data.tar.gz: 03babedcf6978a18f801bd88c804924468c379692617cb5429b6453bae6db34c76293ef0f4aff7ca74cb415031a5c6476dc92f873e4cfe2b1ab0379f3edf465a

data/.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ ruby-head, '3.2', '3.1', '3.0', '2.7', truffleruby ]
+        ruby: [ ruby-head, '3.4', '3.3','3.2', '3.1', '3.0', truffleruby ]
     steps:
       - name: Checkout
         uses: actions/checkout@v2

data/ext/stackprof/extconf.rb

@@ -5,7 +5,8 @@ if RUBY_ENGINE == 'truffleruby'
   return
 end
 
-if have_func('rb_postponed_job_register_one') &&
+if (have_func('rb_postponed_job_preregister') ||
+    have_func('rb_postponed_job_register_one')) &&
    have_func('rb_profile_frames') &&
    have_func('rb_tracepoint_new') &&
    have_const('RUBY_INTERNAL_EVENT_NEWOBJ')

data/ext/stackprof/stackprof.c

@@ -26,6 +26,16 @@
 #define FAKE_FRAME_MARK  INT2FIX(1)
 #define FAKE_FRAME_SWEEP INT2FIX(2)
 
+#ifdef HAVE_RB_POSTPONED_JOB_PREREGISTER
+static rb_postponed_job_handle_t job_record_gc, job_sample_and_record, job_record_buffer;
+
+# define preregister_job(job) (job = rb_postponed_job_preregister(0, stackprof_##job, (void*)0))
+# define trigger_job(job) rb_postponed_job_trigger(job)
+#else
+# define preregister_job(job) ((void*)0)
+# define trigger_job(job) rb_postponed_job_register_one(0, stackprof_##job, (void*)0)
+#endif
+
 static const char *fake_frame_cstrs[] = {
 	"(garbage collection)",
 	"(marking)",
@@ -91,7 +101,19 @@ typedef struct {
     int64_t delta_usec;
 } sample_time_t;
 
+/* We need to ensure that various memory operations are visible across
+ * threads.  Ruby doesn't offer a portable way to do this sort of detection
+ * across all the Ruby versions we support, so we use something that casts a
+ * wide net (Clang, along with ICC, defines __GNUC__). */
+#if defined(__GNUC__) && defined(__ATOMIC_SEQ_CST)
+#define STACKPROF_HAVE_ATOMICS 1
+#else
+#define STACKPROF_HAVE_ATOMICS 0
+#endif
+
 static struct {
+    /* Access this field with the `STACKPROF_RUNNING` macro, below, since we
+     * can't properly express that this field has an atomic type. */
     int running;
     int raw;
     int aggregate;
@@ -133,6 +155,12 @@ static struct {
     pthread_t target_thread;
 } _stackprof;
 
+#if STACKPROF_HAVE_ATOMICS
+#define STACKPROF_RUNNING() __atomic_load_n(&_stackprof.running, __ATOMIC_ACQUIRE)
+#else
+#define STACKPROF_RUNNING() _stackprof.running
+#endif
+
 static VALUE sym_object, sym_wall, sym_cpu, sym_custom, sym_name, sym_file, sym_line;
 static VALUE sym_samples, sym_total_samples, sym_missed_samples, sym_edges, sym_lines;
 static VALUE sym_version, sym_mode, sym_interval, sym_raw, sym_raw_lines, sym_metadata, sym_frames, sym_ignore_gc, sym_out;
@@ -154,7 +182,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
     int raw = 0, aggregate = 1;
     VALUE metadata_val;
 
-    if (_stackprof.running)
+    if (STACKPROF_RUNNING())
 	return Qfalse;
 
     rb_scan_args(argc, argv, "0:", &opts);
@@ -207,7 +235,7 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
 	sigaction(mode == sym_wall ? SIGALRM : SIGPROF, &sa, NULL);
 
 	timer.it_interval.tv_sec = 0;
-	timer.it_interval.tv_usec = NUM2LONG(interval);
+	timer.it_interval.tv_usec = NUM2UINT(interval);
 	timer.it_value = timer.it_interval;
 	setitimer(mode == sym_wall ? ITIMER_REAL : ITIMER_PROF, &timer, 0);
     } else if (mode == sym_custom) {
@@ -217,7 +245,6 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
 	rb_raise(rb_eArgError, "unknown profiler mode");
     }
 
-    _stackprof.running = 1;
     _stackprof.raw = raw;
     _stackprof.aggregate = aggregate;
     _stackprof.mode = mode;
@@ -226,6 +253,13 @@ stackprof_start(int argc, VALUE *argv, VALUE self)
     _stackprof.metadata = metadata;
     _stackprof.out = out;
     _stackprof.target_thread = pthread_self();
+    /* We need to ensure previous initialization stores are visible across
+     * threads. */
+#if STACKPROF_HAVE_ATOMICS
+    __atomic_store_n(&_stackprof.running, 1, __ATOMIC_SEQ_CST);
+#else
+    _stackprof.running = 1;
+#endif
 
     if (raw) {
 	capture_timestamp(&_stackprof.last_sample_at);
@@ -240,9 +274,15 @@ stackprof_stop(VALUE self)
     struct sigaction sa;
     struct itimerval timer;
 
+#if STACKPROF_HAVE_ATOMICS
+    int was_running = __atomic_exchange_n(&_stackprof.running, 0, __ATOMIC_SEQ_CST);
+    if (!was_running)
+        return Qfalse;
+#else
     if (!_stackprof.running)
 	return Qfalse;
     _stackprof.running = 0;
+#endif
 
     if (_stackprof.mode == sym_object) {
 	rb_tracepoint_disable(objtracer);
@@ -351,7 +391,7 @@ stackprof_results(int argc, VALUE *argv, VALUE self)
 {
     VALUE results, frames;
 
-    if (!_stackprof.frames || _stackprof.running)
+    if (!_stackprof.frames || STACKPROF_RUNNING())
 	return Qnil;
 
     results = rb_hash_new();
@@ -455,7 +495,7 @@ stackprof_run(int argc, VALUE *argv, VALUE self)
 static VALUE
 stackprof_running_p(VALUE self)
 {
-    return _stackprof.running ? Qtrue : Qfalse;
+    return STACKPROF_RUNNING() ? Qtrue : Qfalse;
 }
 
 static inline frame_data_t *
@@ -719,7 +759,7 @@ stackprof_sample_and_record(void)
 static void
 stackprof_job_record_gc(void *data)
 {
-    if (!_stackprof.running) return;
+    if (!STACKPROF_RUNNING()) return;
 
     stackprof_record_gc_samples();
 }
@@ -727,7 +767,7 @@ stackprof_job_record_gc(void *data)
 static void
 stackprof_job_sample_and_record(void *data)
 {
-    if (!_stackprof.running) return;
+    if (!STACKPROF_RUNNING()) return;
 
     stackprof_sample_and_record();
 }
@@ -735,7 +775,7 @@ stackprof_job_sample_and_record(void *data)
 static void
 stackprof_job_record_buffer(void *data)
 {
-    if (!_stackprof.running) return;
+    if (!STACKPROF_RUNNING()) return;
 
     stackprof_record_buffer();
 }
@@ -747,7 +787,7 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
 
     _stackprof.overall_signals++;
 
-    if (!_stackprof.running) return;
+    if (!STACKPROF_RUNNING()) 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
@@ -783,16 +823,16 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
 	    capture_timestamp(&_stackprof.gc_start_timestamp);
 	}
 	_stackprof.unrecorded_gc_samples++;
-	rb_postponed_job_register_one(0, stackprof_job_record_gc, (void*)0);
+	trigger_job(job_record_gc);
     } else {
         if (stackprof_use_postponed_job) {
-            rb_postponed_job_register_one(0, stackprof_job_sample_and_record, (void*)0);
+            trigger_job(job_sample_and_record);
         } else {
             // Buffer a sample immediately, if an existing sample exists this will
             // return immediately
             stackprof_buffer_sample();
             // Enqueue a job to record the sample
-            rb_postponed_job_register_one(0, stackprof_job_record_buffer, (void*)0);
+            trigger_job(job_record_buffer);
         }
     }
     pthread_mutex_unlock(&lock);
@@ -810,7 +850,7 @@ stackprof_newobj_handler(VALUE tpval, void *data)
 static VALUE
 stackprof_sample(VALUE self)
 {
-    if (!_stackprof.running)
+    if (!STACKPROF_RUNNING())
 	return Qfalse;
 
     _stackprof.overall_signals++;
@@ -854,7 +894,7 @@ static void
 stackprof_atfork_prepare(void)
 {
     struct itimerval timer;
-    if (_stackprof.running) {
+    if (STACKPROF_RUNNING()) {
 	if (_stackprof.mode == sym_wall || _stackprof.mode == sym_cpu) {
 	    memset(&timer, 0, sizeof(timer));
 	    setitimer(_stackprof.mode == sym_wall ? ITIMER_REAL : ITIMER_PROF, &timer, 0);
@@ -866,10 +906,10 @@ static void
 stackprof_atfork_parent(void)
 {
     struct itimerval timer;
-    if (_stackprof.running) {
+    if (STACKPROF_RUNNING()) {
 	if (_stackprof.mode == sym_wall || _stackprof.mode == sym_cpu) {
 	    timer.it_interval.tv_sec = 0;
-	    timer.it_interval.tv_usec = NUM2LONG(_stackprof.interval);
+	    timer.it_interval.tv_usec = NUM2UINT(_stackprof.interval);
 	    timer.it_value = timer.it_interval;
 	    setitimer(_stackprof.mode == sym_wall ? ITIMER_REAL : ITIMER_PROF, &timer, 0);
 	}
@@ -980,5 +1020,9 @@ Init_stackprof(void)
     rb_define_singleton_method(rb_mStackProf, "sample", stackprof_sample, 0);
     rb_define_singleton_method(rb_mStackProf, "use_postponed_job!", stackprof_use_postponed_job_l, 0);
 
+    preregister_job(job_record_gc);
+    preregister_job(job_sample_and_record);
+    preregister_job(job_record_buffer);
+
     pthread_atfork(stackprof_atfork_prepare, stackprof_atfork_parent, stackprof_atfork_child);
 }

data/lib/stackprof/report.rb

@@ -10,10 +10,14 @@ module StackProf
 
     class << self
       def from_file(file)
-        if (content = IO.binread(file)).start_with?(MARSHAL_SIGNATURE)
-          new(Marshal.load(content))
-        else
-          from_json(JSON.parse(content))
+        File.open(file, 'rb') do |f|
+          signature_bytes = f.read(2)
+          f.rewind
+          if signature_bytes == MARSHAL_SIGNATURE
+            new(Marshal.load(f))
+          else
+            from_json(JSON.parse(f.read))
+          end
         end
       end
 

data/lib/stackprof.rb

@@ -18,7 +18,7 @@ elsif RUBY_VERSION == "3.2.0"
 end
 
 module StackProf
-  VERSION = '0.2.26'
+  VERSION = '0.2.28'
 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.26'
+  s.version = '0.2.28'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'

data/test/test_stackprof.rb

@@ -51,9 +51,16 @@ class StackProfTest < Minitest::Test
 
     frame = profile[:frames].values.first
     assert_includes frame[:name], "StackProfTest#test_object_allocation"
-    assert_equal 2, frame[:samples]
+    if RUBY_VERSION >= '4'
+      assert_equal 4, frame[:samples]
+    else
+      assert_equal 2, frame[:samples]
+    end
     assert_includes [profile_base_line - 2, profile_base_line], frame[:line]
-    if RUBY_VERSION >= '3'
+    if RUBY_VERSION >= '4'
+      assert_equal [2, 2], frame[:lines][profile_base_line+1]
+      assert_equal [2, 2], frame[:lines][profile_base_line+2]
+    elsif RUBY_VERSION >= '3'
       assert_equal [2, 1], frame[:lines][profile_base_line+1]
       assert_equal [2, 1], frame[:lines][profile_base_line+2]
     else
@@ -151,7 +158,7 @@ class StackProfTest < Minitest::Test
     assert_equal 10, raw_lines[-1] # seen 10 times
 
     offset = RUBY_VERSION >= '3' ? -3 : -2
-    assert_equal 140, raw_lines[offset] # sample caller is on 140
+    assert_equal 147, raw_lines[offset] # sample caller is on 140
     assert_includes profile[:frames][raw[offset]][:name], 'StackProfTest#test_raw'
 
     assert_equal 10, profile[:raw_sample_timestamps].size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.26
+  version: 0.2.28
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2026-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -85,9 +85,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/tmm1/stackprof/issues
-  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.26/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.26
-  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.26
+  changelog_uri: https://github.com/tmm1/stackprof/blob/v0.2.28/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/stackprof/0.2.28
+  source_code_uri: https://github.com/tmm1/stackprof/tree/v0.2.28
 post_install_message: 
 rdoc_options: []
 require_paths: