pf2 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22269113784c160efa2ef33412444646afdb33d58215f0a7f0ec2e4e05ad2708
-  data.tar.gz: cc1b783cab40fc4469b5bc09fc3a3a5dec4a76357d14accb7f6a4458ea7cc7bd
+  metadata.gz: 74e3ac2900007b7750e3c3274833e1f713b6e85570db0aa738761ea99b517fe8
+  data.tar.gz: 68ffc8d681328e4d5542e4bd4b3a98edfd08d69fa1b54342fdccbe8f9495bcf0
 SHA512:
-  metadata.gz: 551b033c17201f6f21d741e53bf5b5c43cce3adb3f5daa0e1f17679176c23b87d727cbd162b67f855a39b9fd344ed499ec7d283598f95de30c25d2b3ac7d179e
-  data.tar.gz: ffa342dcfd1c467737485c0aba8497ff98c144a53ae5c0e50566ef1ba58e6fc9e0cfbe0ad870e64788b2a93f31eb8011c0fa1194e674f092dfb9b662d7b9db71
+  metadata.gz: 4f1e67870eac32734a7532f46f29b74589ec6d71c59c925fc02456f473a516218fbbf46fed730558f0b9525c585dbb2fbc088fcf9cbfb47e7f4b89adda7f4974
+  data.tar.gz: 8f5ec74f112eb65a512dbcd7002b0db9a4da0d3a2124d3bd2e7106412c71009b36f92ff442efc87910a5a8829094c06e1ee93169c829ab893dd8e1bd86a81a4f

data/.document

@@ -0,0 +1,3 @@
+ext/
+lib/
+*.md

data/.rdoc_options

@@ -0,0 +1,6 @@
+title: Pf2
+main_page: README.md
+encoding: UTF-8
+
+autolink_excluded_words:
+  - Pf2

data/CHANGELOG.md

@@ -1,6 +1,25 @@
+## [Unreleased]
+
+## [0.11.0] - 2025-12-27
+
+### Added
+
+- RDoc documentation is now online - https://osyoyu.github.io/pf2/
+- Native stack consolidation now supports LTO-ed binaries (@hanazuki)
+
+### Changed
+
+- `Pf2c` module is now completely removed. `Pf2c::Session` has been merged as `Pf2::Session`.
+
+### Fixed
+
+- Fixed an bug where the program crashes when a `Pf2::Session` is GC'd before profiling starts.
+- Fixed an bug where the program crashes when the native stack was more than 200 frames deep.
+
+
 ## [0.10.0] - 2025-12-26
 
-## Added
+### Added
 
 **This version contains a complete rewrite of the profiler!**
 

data/README.md

@@ -3,6 +3,9 @@ Pf2
 
 A experimental sampling-based profiler for Ruby 3.3+.
 
+- GitHub: https://github.com/osyoyu/pf2
+- Documentation: https://osyoyu.github.io/pf2/
+
 Notable Capabilites
 --------
 
@@ -13,6 +16,25 @@ Notable Capabilites
 Usage
 --------
 
+### Installation
+
+You will need a C compiler to build the native extension.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pf2'
+
+# When using the main branch, specify submodules: true
+gem 'pf2', git: 'https://github.com/osyoyu/pf2.git', submodules: true
+```
+
+Pf2 can be installed as a standalone CLI tool as well.
+
+```console
+gem install pf2
+```
+
 ### Quickstart
 
 Run your Ruby program through `pf2 serve`.

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rake/extensiontask'
 require 'minitest/test_task'
+require 'rdoc/task'
 
 task default: %i[]
 
@@ -15,3 +16,7 @@ Minitest::TestTask.create(:test) do |t|
   t.warning = false
   t.test_globs = ["test/**/*_test.rb"]
 end
+
+RDoc::Task.new do |doc|
+  doc.rdoc_dir = "_site" # for GitHub pages
+end

data/ext/pf2/pf2.c

@@ -2,16 +2,16 @@
 
 #include "session.h"
 
-VALUE rb_mPf2c;
+VALUE rb_mPf2;
 
 RUBY_FUNC_EXPORTED void
 Init_pf2(void)
 {
-    rb_mPf2c = rb_define_module("Pf2c");
-    VALUE rb_mPf2c_cSession = rb_define_class_under(rb_mPf2c, "Session", rb_cObject);
-    rb_define_alloc_func(rb_mPf2c_cSession, pf2_session_alloc);
-    rb_define_method(rb_mPf2c_cSession, "initialize", rb_pf2_session_initialize, -1);
-    rb_define_method(rb_mPf2c_cSession, "start", rb_pf2_session_start, 0);
-    rb_define_method(rb_mPf2c_cSession, "stop", rb_pf2_session_stop, 0);
-    rb_define_method(rb_mPf2c_cSession, "configuration", rb_pf2_session_configuration, 0);
+    rb_mPf2 = rb_define_module("Pf2");
+    VALUE rb_mPf2_cSession = rb_define_class_under(rb_mPf2, "Session", rb_cObject);
+    rb_define_alloc_func(rb_mPf2_cSession, pf2_session_alloc);
+    rb_define_method(rb_mPf2_cSession, "initialize", rb_pf2_session_initialize, -1);
+    rb_define_method(rb_mPf2_cSession, "start", rb_pf2_session_start, 0);
+    rb_define_method(rb_mPf2_cSession, "stop", rb_pf2_session_stop, 0);
+    rb_define_method(rb_mPf2_cSession, "configuration", rb_pf2_session_configuration, 0);
 }

data/ext/pf2/sample.c

@@ -9,8 +9,6 @@
 #include "backtrace_state.h"
 #include "sample.h"
 
-const int PF2_SAMPLE_MAX_NATIVE_DEPTH = 300;
-
 static int capture_native_backtrace(struct pf2_sample *sample);
 static int backtrace_on_ok(void *data, uintptr_t pc);
 
@@ -29,7 +27,7 @@ pf2_sample_capture(struct pf2_sample *sample)
     sample->context_pthread = pthread_self();
 
     // Obtain the current stack from Ruby
-    sample->depth = rb_profile_frames(0, 200, sample->cmes, sample->linenos);
+    sample->depth = rb_profile_frames(0, PF2_SAMPLE_MAX_RUBY_DEPTH, sample->cmes, sample->linenos);
 
     // Capture C-level backtrace
     sample->native_stack_depth = capture_native_backtrace(sample);

data/ext/pf2/sample.h

@@ -5,17 +5,18 @@
 
 #include <ruby.h>
 
-extern const int PF2_SAMPLE_MAX_NATIVE_DEPTH;
+#define PF2_SAMPLE_MAX_RUBY_DEPTH 200
+#define PF2_SAMPLE_MAX_NATIVE_DEPTH 300
 
 struct pf2_sample {
     pthread_t context_pthread;
 
     int depth;
-    VALUE cmes[200];
-    int linenos[200];
+    VALUE cmes[PF2_SAMPLE_MAX_RUBY_DEPTH];
+    int linenos[PF2_SAMPLE_MAX_RUBY_DEPTH];
 
     size_t native_stack_depth;
-    uintptr_t native_stack[200];
+    uintptr_t native_stack[PF2_SAMPLE_MAX_NATIVE_DEPTH];
 
     uint64_t consumed_time_ns;
     uint64_t timestamp_ns;

data/ext/pf2/session.c

@@ -318,19 +318,32 @@ pf2_session_alloc(VALUE self)
         rb_raise(rb_eNoMemError, "Failed to allocate memory");
     }
 
+    // is_running
+    session->is_running = false;
+
+    // timer
+#ifdef HAVE_TIMER_CREATE
+    session->timer = (timer_t)0;
+#else
+    session->timer = (struct itimerval){0};
+#endif
+
+    // rbuf
     session->rbuf = pf2_ringbuffer_new(1000);
     if (session->rbuf == NULL) {
         rb_raise(rb_eNoMemError, "Failed to allocate memory");
     }
 
+    // is_marking
     atomic_store_explicit(&session->is_marking, false, memory_order_relaxed);
+
+    // collector_thread
     session->collector_thread = malloc(sizeof(pthread_t));
     if (session->collector_thread == NULL) {
         rb_raise(rb_eNoMemError, "Failed to allocate memory");
     }
 
-    session->duration_ns = 0;
-
+    // samples, samples_index, samples_capacity
     session->samples_index = 0;
     session->samples_capacity = 500; // 10 seconds worth of samples at 50 Hz
     session->samples = malloc(sizeof(struct pf2_sample) * session->samples_capacity);
@@ -338,6 +351,14 @@ pf2_session_alloc(VALUE self)
         rb_raise(rb_eNoMemError, "Failed to allocate memory");
     }
 
+    // start_time_realtime, start_time
+    session->start_time_realtime = (struct timespec){0};
+    session->start_time = (struct timespec){0};
+
+    // duration_ns
+    session->duration_ns = 0;
+
+    // configuration
     session->configuration = NULL;
 
     return TypedData_Wrap_Struct(self, &pf2_session_type, session);

data/ext/pf2/session.h

@@ -43,7 +43,7 @@ void pf2_session_dfree(void *sess);
 size_t pf2_session_dsize(const void *sess);
 
 static const rb_data_type_t pf2_session_type = {
-    .wrap_struct_name = "Pf2c::Session",
+    .wrap_struct_name = "Pf2::Session",
     .function = {
         .dmark = pf2_session_dmark,
         .dfree = pf2_session_dfree,

data/lib/pf2/reporter/stack_weaver.rb

@@ -82,7 +82,7 @@ module Pf2
 
         # If the next function is a vm_exec_core() (= VM_EXEC in vm_exec.h),
         # we switch to the Ruby stack.
-        function[:name] == 'vm_exec_core'
+        function[:name]&.match?(/\Avm_exec_core(?:\.lto_priv\.\d+)?\z/)
       end
     end
   end

data/lib/pf2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pf2
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/lib/pf2.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'pf2/pf2'
-require_relative 'pf2/session'
 require_relative 'pf2/version'
 
 module Pf2
   class Error < StandardError; end
 
   def self.start(...)
-    @@session = Pf2c::Session.new(...)
+    @@session = Session.new(...)
     @@session.start
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pf2
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Daisuke Aritomo
@@ -93,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - osyoyu@osyoyu.com
 executables:
@@ -101,6 +115,8 @@ extensions:
 - ext/pf2/extconf.rb
 extra_rdoc_files: []
 files:
+- ".document"
+- ".rdoc_options"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -132,7 +148,6 @@ files:
 - lib/pf2/reporter/firefox_profiler_ser2.rb
 - lib/pf2/reporter/stack_weaver.rb
 - lib/pf2/serve.rb
-- lib/pf2/session.rb
 - lib/pf2/version.rb
 - vendor/libbacktrace/.gitignore
 - vendor/libbacktrace/Isaac.Newton-Opticks.txt

data/lib/pf2/session.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Pf2
-  class Session
-    attr_reader :configuration
-
-    # Implementation is in Rust code.
-  end
-end