pf2 0.11.3 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fd284a999c583522ded7f75ac859162e5f125cf699f5a8eba8a3fac968874b
-  data.tar.gz: ae12d4bf742da3ede82a4e4c3229410ab8a06ef24b020e9d2232f923d64c2c70
+  metadata.gz: 9f219b8aa5b5281a6ed662a085e00f82636ab52365d2b0f7a8d61a3e06bfc9c6
+  data.tar.gz: 162e1eae488afe17e33291f63f807642aa304d7df8069cb165e3a25ce6f10895
 SHA512:
-  metadata.gz: f0d7cc6bf5436ca522e00ec2eabe31a00030df584365b4a3cf5847d7b1d48d287304520e85884635373c025237562951e80e45e121250c72437e27db88687547
-  data.tar.gz: 19cb2e6fcb953134cde12e45dbc861129cd25c325ad3f44492e5808dbb7a10e2acb386e8d8d8041fe4a4a773bd9f8538989b1f9bbfd8bb6b4aedda3b4c4db8ea
+  metadata.gz: 37b6a1aa4f6ab0753d86983d76cbdfae4b3dfbb7464afb0388aa113d728725f09eabcabb2ae7c2ffadc5ab797be75675b5b27b465c20565d5d69f30291d4837f
+  data.tar.gz: 7b69aea55c8873cfd6e28fba3bdddd09325e4c73e1e3e44a5be48fcb9ad776b03e811c707fc049ad8ccc1590e7c011032be7f4053e3d15a5ba5b50c4344db656

data/CHANGELOG.md

@@ -1,52 +1,5 @@
 ## [Unreleased]
 
-## [0.11.3] - 2025-12-28
-
-This version is for testing the new release process through [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/). All code is identical to 0.11.2.
-
-
-## [0.11.2] - 2025-12-28
-
-0.11.1 was yanked since it was accidentally published without libbacktrace vendored. Use 0.11.2.
-
-### Fixed
-
-- Fixed issues preventing builds on macOS.
-
-
-## [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
-
-**This version contains a complete rewrite of the profiler!**
-
-- The default sample collection backend has been switched to the new C-based backend.
-  - The previous Rust-based backed has been removed. Use v0.9.0 if you need it.
-- macOS / non-Linux platform support!
-  - On platforms which lack `timer_create(3)` such as macOS, Pf2 now fall backs to `setitimer(3)` based sampling. This mode does not support per-thread CPU time sampling.
-
-### Changed
-
-- `logger` is now declared as a dependency (Ruby 4.0 compat).
-
-
 ## [0.9.0] - 2025-03-22
 
 ## Added
@@ -58,7 +11,6 @@ This version is for testing the new release process through [Trusted Publishing]
 
 - Set SA_RESTART flag to reduce EINTRs in profiled code
 
-
 ## [0.8.0] - 2025-01-27
 
 ## Added
@@ -67,14 +19,12 @@ This version is for testing the new release process through [Trusted Publishing]
   - This serializer is more efficient and has a smaller memory footprint than the default serializer.
   - Ser2 still lacks some features, such as weaving of native stacks.
 
-
 ## [0.7.1] - 2025-01-02
 
 ### Fixed
 
 - Reverted Cargo.lock version to 3 to support older versions of Rust (<1.78).
 
-
 ## [0.7.0] - 2025-01-03
 
 ### Changed

data/README.md

@@ -3,9 +3,6 @@ Pf2
 
 A experimental sampling-based profiler for Ruby 3.3+.
 
-- GitHub: https://github.com/osyoyu/pf2
-- Documentation: https://osyoyu.github.io/pf2/
-
 Notable Capabilites
 --------
 
@@ -16,25 +13,6 @@ 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,7 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/extensiontask'
 require 'minitest/test_task'
-require 'rdoc/task'
 
 task default: %i[]
 
@@ -16,7 +15,3 @@ 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_mPf2;
+VALUE rb_mPf2c;
 
 RUBY_FUNC_EXPORTED void
 Init_pf2(void)
 {
-    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);
+    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);
 }

data/ext/pf2/sample.c

@@ -9,6 +9,8 @@
 #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);
 
@@ -27,7 +29,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, PF2_SAMPLE_MAX_RUBY_DEPTH, sample->cmes, sample->linenos);
+    sample->depth = rb_profile_frames(0, 200, sample->cmes, sample->linenos);
 
     // Capture C-level backtrace
     sample->native_stack_depth = capture_native_backtrace(sample);

data/ext/pf2/sample.h

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

data/ext/pf2/serializer.c

@@ -16,8 +16,8 @@ static struct pf2_ser_function extract_function_from_ruby_frame(VALUE frame);
 static struct pf2_ser_function extract_function_from_native_pc(uintptr_t pc);
 // static int backtrace_pcinfo_callback(void *data, uintptr_t pc, const char *filename, int lineno, const char *function);
 static void pf2_backtrace_syminfo_callback(void *data, uintptr_t pc, const char *symname, uintptr_t symval, uintptr_t symsize);
-static size_t function_index_for(struct pf2_ser *serializer, struct pf2_ser_function *function);
-static size_t location_index_for(struct pf2_ser *serializer, size_t function_index, int32_t lineno);
+static int function_index_for(struct pf2_ser *serializer, struct pf2_ser_function *function);
+static int location_index_for(struct pf2_ser *serializer, int function_index, int32_t lineno);
 static void ensure_samples_capacity(struct pf2_ser *serializer);
 static void ensure_locations_capacity(struct pf2_ser *serializer);
 static void ensure_functions_capacity(struct pf2_ser *serializer);
@@ -83,7 +83,7 @@ pf2_ser_prepare(struct pf2_ser *serializer, struct pf2_session *session) {
         ensure_samples_capacity(serializer);
 
         struct pf2_ser_sample *ser_sample = &serializer->samples[serializer->samples_count++];
-        ser_sample->ruby_thread_id = (uintptr_t)sample->context_pthread;
+        ser_sample->ruby_thread_id = sample->context_pthread;
         ser_sample->elapsed_ns = sample->timestamp_ns - serializer->start_timestamp_ns;
 
         // Copy and process Ruby stack frames
@@ -145,7 +145,7 @@ pf2_ser_to_ruby_hash(struct pf2_ser *serializer) {
         VALUE native_stack = rb_ary_new_capa(sample->native_stack_count);
         if (sample->native_stack != NULL) {
             for (size_t j = 0; j < sample->native_stack_count; j++) {
-                rb_ary_push(native_stack, SIZET2NUM(sample->native_stack[j]));
+                rb_ary_push(native_stack, ULL2NUM(sample->native_stack[j]));
             }
         }
         rb_hash_aset(sample_hash, ID2SYM(rb_intern("native_stack")), native_stack);
@@ -154,7 +154,7 @@ pf2_ser_to_ruby_hash(struct pf2_ser *serializer) {
         rb_hash_aset(
             sample_hash,
             ID2SYM(rb_intern("ruby_thread_id")),
-            sample->ruby_thread_id ? ULL2NUM(sample->ruby_thread_id) : Qnil
+            sample->ruby_thread_id ? SIZET2NUM(sample->ruby_thread_id) : Qnil
         );
         rb_hash_aset(sample_hash, ID2SYM(rb_intern("elapsed_ns")), ULL2NUM(sample->elapsed_ns));
 
@@ -304,7 +304,7 @@ pf2_backtrace_syminfo_callback(void *data, uintptr_t pc, const char *symname, ui
 
 // Returns the index of the function in `functions`.
 // Calling this method will modify `serializer->profile` in place.
-static size_t
+static int
 function_index_for(struct pf2_ser *serializer, struct pf2_ser_function *function) {
     for (size_t i = 0; i < serializer->functions_count; i++) {
         struct pf2_ser_function *existing = &serializer->functions[i];
@@ -332,8 +332,8 @@ function_index_for(struct pf2_ser *serializer, struct pf2_ser_function *function
 
 // Returns the index of the location in `locations`.
 // Calling this method will modify `self.profile` in place.
-static size_t
-location_index_for(struct pf2_ser *serializer, size_t function_index, int32_t lineno) {
+static int
+location_index_for(struct pf2_ser *serializer, int function_index, int32_t lineno) {
     for (size_t i = 0; i < serializer->locations_count; i++) {
         struct pf2_ser_location *existing = &serializer->locations[i];
         if (existing->function_index == function_index && existing->lineno == lineno) {

data/ext/pf2/serializer.h

@@ -1,23 +1,21 @@
 #ifndef PF2C_SERIALIZER_H
 #define PF2C_SERIALIZER_H
 
-#include <stdint.h>
-
 #include <ruby.h>
 
 #include "session.h"
 
 struct pf2_ser_sample {
-    size_t *stack; // array of location_indexes
+    int *stack;
     size_t stack_count;
-    size_t *native_stack; // array of location_indexes
+    int *native_stack;
     size_t native_stack_count;
-    uintptr_t ruby_thread_id;
+    size_t ruby_thread_id;
     uint64_t elapsed_ns;
 };
 
 struct pf2_ser_location {
-    size_t function_index;
+    int function_index;
     int32_t lineno;
     size_t address;
 };

data/ext/pf2/session.c

@@ -1,3 +1,4 @@
+#include <bits/time.h>
 #include <pthread.h>
 #include <signal.h>
 #include <stdatomic.h>
@@ -27,7 +28,6 @@ static struct pf2_session *global_current_session = NULL;
 static void *sample_collector_thread(void *arg);
 static void sigprof_handler(int sig, siginfo_t *info, void *ucontext);
 bool ensure_sample_capacity(struct pf2_session *session);
-static void pf2_session_stop(struct pf2_session *session);
 
 VALUE
 rb_pf2_session_initialize(int argc, VALUE *argv, VALUE self)
@@ -251,20 +251,6 @@ rb_pf2_session_stop(VALUE self)
     struct pf2_session *session;
     TypedData_Get_Struct(self, struct pf2_session, &pf2_session_type, session);
 
-    pf2_session_stop(session);
-
-    // Create serializer and serialize
-    struct pf2_ser *serializer = pf2_ser_new();
-    pf2_ser_prepare(serializer, session);
-    VALUE result = pf2_ser_to_ruby_hash(serializer);
-    pf2_ser_free(serializer);
-
-    return result;
-}
-
-static void
-pf2_session_stop(struct pf2_session *session)
-{
     // Calculate duration
     struct timespec end_time;
     clock_gettime(CLOCK_MONOTONIC, &end_time);
@@ -291,6 +277,14 @@ pf2_session_stop(struct pf2_session *session)
     // Terminate the collector thread
     session->is_running = false;
     pthread_join(*session->collector_thread, NULL);
+
+    // Create serializer and serialize
+    struct pf2_ser *serializer = pf2_ser_new();
+    pf2_ser_prepare(serializer, session);
+    VALUE result = pf2_ser_to_ruby_hash(serializer);
+    pf2_ser_free(serializer);
+
+    return result;
 }
 
 VALUE
@@ -317,32 +311,19 @@ 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");
     }
 
-    // samples, samples_index, samples_capacity
+    session->duration_ns = 0;
+
     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);
@@ -350,14 +331,6 @@ 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);
@@ -400,15 +373,8 @@ pf2_session_dmark(void *sess)
 void
 pf2_session_dfree(void *sess)
 {
+    // TODO: Ensure the uninstall process is complete before freeing the session
     struct pf2_session *session = sess;
-
-    assert(session->is_running == false || session->is_running == true);
-
-    // Stop the session if it's still running
-    if (session->is_running) {
-        pf2_session_stop(session);
-    }
-
     pf2_configuration_free(session->configuration);
     pf2_ringbuffer_free(session->rbuf);
     free(session->samples);

data/ext/pf2/session.h

@@ -43,14 +43,14 @@ 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 = "Pf2::Session",
+    .wrap_struct_name = "Pf2c::Session",
     .function = {
         .dmark = pf2_session_dmark,
         .dfree = pf2_session_dfree,
         .dsize = pf2_session_dsize,
     },
     .data = NULL,
-    .flags = 0,
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY,
 };
 
 #endif // PF2_SESSION_H

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]&.match?(/\Avm_exec_core(?:\.lto_priv\.\d+)?\z/)
+        function[:name] == 'vm_exec_core'
       end
     end
   end

data/lib/pf2/session.rb

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

data/lib/pf2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pf2
-  VERSION = '0.11.3'
+  VERSION = '1.0.0.alpha1'
 end

data/lib/pf2.rb

@@ -1,13 +1,14 @@
 # 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 = Session.new(...)
+    @@session = Pf2c::Session.new(...)
     @@session.start
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pf2
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Daisuke Aritomo
@@ -9,20 +9,6 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -93,20 +79,6 @@ 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:
@@ -115,8 +87,6 @@ extensions:
 - ext/pf2/extconf.rb
 extra_rdoc_files: []
 files:
-- ".document"
-- ".rdoc_options"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -148,6 +118,7 @@ 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
@@ -241,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.8.0.dev
 specification_version: 4
 summary: Yet another Ruby profiler
 test_files: []

data/.document

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

data/.rdoc_options

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