pf2 0.3.0 → 0.5.0

data/lib/pf2/session.rb

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

data/lib/pf2/version.rb

@@ -1,3 +1,3 @@
 module Pf2
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/pf2.rb

@@ -1,31 +1,24 @@
 require_relative 'pf2/pf2'
+require_relative 'pf2/session'
 require_relative 'pf2/version'
 
 module Pf2
   class Error < StandardError; end
 
-  def self.default_scheduler_class
-    # SignalScheduler is Linux-only. Use TimerThreadScheduler on other platforms.
-    if defined?(SignalScheduler)
-      SignalScheduler
-    else
-      TimerThreadScheduler
-    end
-  end
-
   def self.start(...)
-    @@default_scheduler = default_scheduler_class.new(...)
-    @@default_scheduler.start
+    @@session = Pf2::Session.new(...)
+    @@session.start
   end
 
-  def self.stop(...)
-    @@default_scheduler.stop(...)
+  def self.stop
+    @@session.stop
   end
 
   def self.profile(&block)
     raise ArgumentError, "block required" unless block_given?
-    start([Thread.current], true)
+    start(threads: Thread.list)
     yield
     stop
+    @@session = nil # let GC clean up the session
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pf2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daisuke Aritomo
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -38,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.63
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - osyoyu@osyoyu.com
 executables:
@@ -156,16 +168,22 @@ files:
 - ext/pf2/src/profile_serializer.rs
 - ext/pf2/src/ringbuffer.rs
 - ext/pf2/src/ruby_init.rs
+- ext/pf2/src/ruby_internal_apis.rs
 - ext/pf2/src/sample.rs
+- ext/pf2/src/scheduler.rs
+- ext/pf2/src/session.rs
+- ext/pf2/src/session/configuration.rs
+- ext/pf2/src/session/new_thread_watcher.rs
+- ext/pf2/src/session/ruby_object.rs
 - ext/pf2/src/siginfo_t.c
 - ext/pf2/src/signal_scheduler.rs
-- ext/pf2/src/signal_scheduler/configuration.rs
-- ext/pf2/src/signal_scheduler/timer_installer.rs
 - ext/pf2/src/timer_thread_scheduler.rs
 - ext/pf2/src/util.rs
 - lib/pf2.rb
 - lib/pf2/cli.rb
 - lib/pf2/reporter.rb
+- lib/pf2/serve.rb
+- lib/pf2/session.rb
 - lib/pf2/version.rb
 homepage: https://github.com/osyoyu/pf2
 licenses:
@@ -175,7 +193,6 @@ metadata:
   homepage_uri: https://github.com/osyoyu/pf2
   source_code_uri: https://github.com/osyoyu/pf2
   changelog_uri: https://github.com/osyoyu/pf2/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,7 +208,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.6.0.dev
-signing_key:
 specification_version: 4
 summary: Yet another Ruby profiler
 test_files: []

data/ext/pf2/src/signal_scheduler/configuration.rs

@@ -1,31 +0,0 @@
-use std::collections::HashSet;
-use std::str::FromStr;
-use std::time::Duration;
-
-use rb_sys::VALUE;
-
-#[derive(Clone, Debug)]
-pub struct Configuration {
-    pub interval: Duration,
-    pub time_mode: TimeMode,
-    pub target_ruby_threads: HashSet<VALUE>,
-    pub track_new_threads: bool,
-}
-
-#[derive(Clone, Debug)]
-pub enum TimeMode {
-    CpuTime,
-    WallTime,
-}
-
-impl FromStr for TimeMode {
-    type Err = ();
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        match s {
-            "cpu" => Ok(Self::CpuTime),
-            "wall" => Ok(Self::WallTime),
-            _ => Err(()),
-        }
-    }
-}

data/ext/pf2/src/signal_scheduler/timer_installer.rs

@@ -1,199 +0,0 @@
-use std::collections::HashMap;
-use std::ffi::c_void;
-use std::mem;
-use std::mem::ManuallyDrop;
-use std::ptr::null_mut;
-use std::sync::{Mutex, RwLock};
-use std::{collections::HashSet, sync::Arc};
-
-use rb_sys::*;
-
-use crate::signal_scheduler::SignalHandlerArgs;
-
-use super::configuration::Configuration;
-use crate::profile::Profile;
-
-// We could avoid deferring the timer creation by combining pthread_getcpuclockid(3) and timer_create(2) here,
-// but we're not doing so since (1) Ruby does not expose the pthread_self() of a Ruby Thread
-// (which is actually stored in th->nt->thread_id), and (2) pthread_getcpuclockid(3) is not portable
-// in the first place (e.g. not available on macOS).
-pub struct TimerInstaller {
-    internal: Box<Mutex<Internal>>,
-}
-
-struct Internal {
-    configuration: Configuration,
-    registered_pthread_ids: HashSet<libc::pthread_t>,
-    kernel_thread_id_to_ruby_thread_map: HashMap<libc::pid_t, VALUE>,
-    profile: Arc<RwLock<Profile>>,
-}
-
-impl TimerInstaller {
-    // Register a callback that gets called when a Ruby Thread is resumed.
-    // The callback should create a timer for the thread.
-    pub fn install_timer_to_ruby_threads(
-        configuration: Configuration,
-        profile: Arc<RwLock<Profile>>,
-    ) {
-        let registrar = Self {
-            internal: Box::new(Mutex::new(Internal {
-                configuration: configuration.clone(),
-                registered_pthread_ids: HashSet::new(),
-                kernel_thread_id_to_ruby_thread_map: HashMap::new(),
-                profile,
-            })),
-        };
-
-        let ptr = Box::into_raw(registrar.internal);
-        unsafe {
-            rb_internal_thread_add_event_hook(
-                Some(Self::on_thread_resume),
-                RUBY_INTERNAL_THREAD_EVENT_RESUMED,
-                ptr as *mut c_void,
-            );
-            // Spawn a no-op Thread to fire the event hook
-            // (at least 2 Ruby Threads must be active for the RESUMED hook to be fired)
-            rb_thread_create(Some(Self::do_nothing), null_mut());
-        };
-
-        if configuration.track_new_threads {
-            unsafe {
-                rb_internal_thread_add_event_hook(
-                    Some(Self::on_thread_start),
-                    RUBY_INTERNAL_THREAD_EVENT_STARTED,
-                    ptr as *mut c_void,
-                );
-            };
-        }
-    }
-
-    unsafe extern "C" fn do_nothing(_: *mut c_void) -> VALUE {
-        Qnil.into()
-    }
-
-    // Thread resume callback
-    unsafe extern "C" fn on_thread_resume(
-        _flag: rb_event_flag_t,
-        data: *const rb_internal_thread_event_data,
-        custom_data: *mut c_void,
-    ) {
-        // The SignalScheduler (as a Ruby obj) should be passed as custom_data
-        let internal =
-            unsafe { ManuallyDrop::new(Box::from_raw(custom_data as *mut Mutex<Internal>)) };
-        let mut internal = internal.lock().unwrap();
-
-        // Check if the current thread is a target Ruby Thread
-        let current_ruby_thread: VALUE = unsafe { (*data).thread };
-        if !internal
-            .configuration
-            .target_ruby_threads
-            .contains(&current_ruby_thread)
-        {
-            return;
-        }
-
-        // Check if the current thread is already registered
-        let current_pthread_id = unsafe { libc::pthread_self() };
-        if internal
-            .registered_pthread_ids
-            .contains(&current_pthread_id)
-        {
-            return;
-        }
-
-        // Record the pthread ID of the current thread
-        internal.registered_pthread_ids.insert(current_pthread_id);
-        // Keep a mapping from kernel thread ID to Ruby Thread
-        internal
-            .kernel_thread_id_to_ruby_thread_map
-            .insert(unsafe { libc::gettid() }, current_ruby_thread);
-
-        Self::register_timer_to_current_thread(
-            &internal.configuration,
-            &internal.profile,
-            &internal.kernel_thread_id_to_ruby_thread_map,
-        );
-
-        // TODO: Remove the hook when all threads have been registered
-    }
-
-    // Thread resume callback
-    unsafe extern "C" fn on_thread_start(
-        _flag: rb_event_flag_t,
-        data: *const rb_internal_thread_event_data,
-        custom_data: *mut c_void,
-    ) {
-        // The SignalScheduler (as a Ruby obj) should be passed as custom_data
-        let internal =
-            unsafe { ManuallyDrop::new(Box::from_raw(custom_data as *mut Mutex<Internal>)) };
-        let mut internal = internal.lock().unwrap();
-
-        let current_ruby_thread: VALUE = unsafe { (*data).thread };
-        internal
-            .configuration
-            .target_ruby_threads
-            .insert(current_ruby_thread);
-    }
-
-    // Creates a new POSIX timer which invocates sampling for the thread that called this function.
-    fn register_timer_to_current_thread(
-        configuration: &Configuration,
-        profile: &Arc<RwLock<Profile>>,
-        kernel_thread_id_to_ruby_thread_map: &HashMap<libc::pid_t, VALUE>,
-    ) {
-        let current_pthread_id = unsafe { libc::pthread_self() };
-        let context_ruby_thread: VALUE = unsafe {
-            *(kernel_thread_id_to_ruby_thread_map
-                .get(&(libc::gettid()))
-                .unwrap())
-        };
-
-        // NOTE: This Box is never dropped
-        let signal_handler_args = Box::new(SignalHandlerArgs {
-            profile: Arc::clone(profile),
-            context_ruby_thread,
-        });
-
-        // Create a signal event
-        let mut sigevent: libc::sigevent = unsafe { mem::zeroed() };
-        // Note: SIGEV_THREAD_ID is Linux-specific. In other platforms, we would need to
-        // "tranpoline" the signal as any pthread can receive the signal.
-        sigevent.sigev_notify = libc::SIGEV_THREAD_ID;
-        sigevent.sigev_notify_thread_id =
-            unsafe { libc::syscall(libc::SYS_gettid).try_into().unwrap() }; // The kernel thread ID
-        sigevent.sigev_signo = libc::SIGALRM;
-        // Pass required args to the signal handler
-        sigevent.sigev_value.sival_ptr = Box::into_raw(signal_handler_args) as *mut c_void;
-
-        // Create and configure timer to fire every _interval_ ms of CPU time
-        let mut timer: libc::timer_t = unsafe { mem::zeroed() };
-        let clockid = match configuration.time_mode {
-            crate::signal_scheduler::TimeMode::CpuTime => libc::CLOCK_THREAD_CPUTIME_ID,
-            crate::signal_scheduler::TimeMode::WallTime => libc::CLOCK_MONOTONIC,
-        };
-        let err = unsafe { libc::timer_create(clockid, &mut sigevent, &mut timer) };
-        if err != 0 {
-            panic!("timer_create failed: {}", err);
-        }
-        let itimerspec = Self::duration_to_itimerspec(&configuration.interval);
-        let err = unsafe { libc::timer_settime(timer, 0, &itimerspec, null_mut()) };
-        if err != 0 {
-            panic!("timer_settime failed: {}", err);
-        }
-
-        log::debug!("timer registered for thread {}", current_pthread_id);
-    }
-
-    fn duration_to_itimerspec(duration: &std::time::Duration) -> libc::itimerspec {
-        let nanos = duration.as_nanos();
-        let seconds_part: i64 = (nanos / 1_000_000_000).try_into().unwrap();
-        let nanos_part: i64 = (nanos % 1_000_000_000).try_into().unwrap();
-
-        let mut its: libc::itimerspec = unsafe { mem::zeroed() };
-        its.it_interval.tv_sec = seconds_part;
-        its.it_interval.tv_nsec = nanos_part;
-        its.it_value.tv_sec = seconds_part;
-        its.it_value.tv_nsec = nanos_part;
-        its
-    }
-}