perfetto 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3e8e962aeab33cbf932918444eb8273b5488d7c6ef8f06d0093ba7ce61ef26
-  data.tar.gz: 8fc94a35ac54d16ece628dd97d55ee67b50c5b186e5c62ddbf6ec63127ed995b
+  metadata.gz: b753aabc8493140c2019e6eac7673df495b2f3144f161c88eb561210d78171ff
+  data.tar.gz: 300ea0e7a5f70452944921eb44dfe24f51e49760308f5aece59e2d6cd5572f95
 SHA512:
-  metadata.gz: ea31ea7afcd01440e9f1eca3a3ad07c2a1ae085013f2dabf2917448769ffcd783739412e7ed28003131b4efa3aaeb908985d6490e9c0af618beb573126200b27
-  data.tar.gz: 7ebdb79efbfca675bc28d984dda057f2cc2c64e7c4345c099b5acf5bacf9a692ce40eeb689329ad2d416b74ded1b4f207f0f2a51f613d6259c8b6a0df4568617
+  metadata.gz: 8b12129eb219d48f12658c43679d1a2b09663f5dc1cdcbab1ab7a44a92d98b3fbecc2cfe5d0d851e5583d3acbb3683fb2155f03dc64cb744ce692da0b4ff286e
+  data.tar.gz: 2c8ce26e43b3a3f61851595fcd9721136bb9ff7e21c4899e1af56b357b44e2a2af2ab8575ce1d60844281fde920cfd1217cc549fb5770550b6cfdbe29ce5e88f

data/Rakefile

@@ -4,7 +4,7 @@ require "bundler/gem_tasks"
 
 require "rake/extensiontask"
 gemspec = Gem::Specification.load("perfetto.gemspec")
-Rake::ExtensionTask.new("perfetto", gemspec) do |ext|
+Rake::ExtensionTask.new("perfetto_native", gemspec) do |ext|
   ext.ext_dir = "ext/perfetto"
   ext.lib_dir = "lib/perfetto"
 end

data/ext/perfetto/perfetto.c

@@ -4,6 +4,7 @@
 
 /* Modules */
 static VALUE rb_mPerfetto;
+static VALUE rb_mFiber;
 
 /* Methods */
 
@@ -75,9 +76,49 @@ static VALUE rb_perfetto_trace_counter(VALUE self, VALUE category, VALUE name, V
     }
 }
 
+/* Ruby Fiber */
+static int current_fiber_object_id(void)
+{
+    VALUE fiber = rb_funcall(rb_mFiber, rb_intern("current"), 0);
+    VALUE object_id = rb_funcall(fiber, rb_intern("object_id"), 0);
+    return NUM2LL(object_id);
+}
+
+static VALUE rb_perfetto_fiber_trace_event_begin(VALUE self, VALUE category, VALUE name)
+{
+    perfetto_fiber_trace_event_begin(StringValuePtr(category), StringValuePtr(name), current_fiber_object_id());
+    return Qnil;
+}
+
+static VALUE rb_perfetto_fiber_trace_event_end(VALUE self, VALUE category)
+{
+    perfetto_fiber_trace_event_end(StringValuePtr(category), current_fiber_object_id());
+    return Qnil;
+}
+
+static VALUE rb_perfetto_fiber_trace_event_instant(VALUE self, VALUE category, VALUE name)
+{
+    perfetto_fiber_trace_event_instant(StringValuePtr(category), StringValuePtr(name), current_fiber_object_id());
+    return Qnil;
+}
+
+static VALUE rb_perfetto_fiber_trace_event_instant_with_debug_info(VALUE self, VALUE category, VALUE name, VALUE debug_info_key, VALUE debug_info_value)
+{
+    perfetto_fiber_trace_event_instant_with_debug_info(StringValuePtr(category), StringValuePtr(name), StringValuePtr(debug_info_key), StringValuePtr(debug_info_value), current_fiber_object_id());
+    return Qnil;
+}
+
+static VALUE rb_perfetto_fiber_trace_event_begin_with_debug_info(VALUE self, VALUE category, VALUE name, VALUE debug_info_key, VALUE debug_info_value)
+{
+    perfetto_fiber_trace_event_begin_with_debug_info(StringValuePtr(category), StringValuePtr(name), StringValuePtr(debug_info_key), StringValuePtr(debug_info_value), current_fiber_object_id());
+    return Qnil;
+}
+
+
 void Init_perfetto_native(void)
 {
     rb_mPerfetto = rb_define_module("Perfetto");
+    rb_mFiber = rb_define_class("Fiber", rb_cObject);
 
     rb_define_module_function(rb_mPerfetto, "start_tracing", rb_perfetto_start_tracing, 1);
     rb_define_module_function(rb_mPerfetto, "stop_tracing", rb_perfetto_stop_tracing, 1);
@@ -89,4 +130,10 @@ void Init_perfetto_native(void)
     rb_define_module_function(rb_mPerfetto, "trace_event_instant", rb_perfetto_trace_event_instant, 2);
     rb_define_module_function(rb_mPerfetto, "trace_event_instant_with_debug_info", rb_perfetto_trace_event_instant_with_debug_info, 4);
     rb_define_module_function(rb_mPerfetto, "trace_event_begin_with_debug_info", rb_perfetto_trace_event_begin_with_debug_info, 4);
+
+    rb_define_module_function(rb_mPerfetto, "fiber_trace_event_begin", rb_perfetto_fiber_trace_event_begin, 2);
+    rb_define_module_function(rb_mPerfetto, "fiber_trace_event_end", rb_perfetto_fiber_trace_event_end, 1);
+    rb_define_module_function(rb_mPerfetto, "fiber_trace_event_instant", rb_perfetto_fiber_trace_event_instant, 2);
+    rb_define_module_function(rb_mPerfetto, "fiber_trace_event_instant_with_debug_info", rb_perfetto_fiber_trace_event_instant_with_debug_info, 4);
+    rb_define_module_function(rb_mPerfetto, "fiber_trace_event_begin_with_debug_info", rb_perfetto_fiber_trace_event_begin_with_debug_info, 4);
 }

data/ext/perfetto/perfetto_internal.cc

@@ -4,8 +4,10 @@
 #include <atomic>
 #include <mutex>
 #include <fstream>
+#include <sstream>
 #include <vector>
 #include <string>
+#include <thread>
 
 #include "perfetto_internal.h"
 
@@ -146,4 +148,53 @@ extern "C"
                           debug_info_key, debug_info_value);
     }
 
+    /* Ruby Fiber */
+    static inline perfetto::Track fiber_track(const int64_t fiber_object_id)
+    {
+        auto tid = std::this_thread::get_id();
+        std::stringstream ss;
+        ss << "T(" << tid << ")F(" << fiber_object_id << ")"; // T(thread_id)F(fiber_id)
+        perfetto::Track fiber_track(fiber_object_id);
+        auto track_desc = fiber_track.Serialize();
+        track_desc.set_name(ss.str());
+        perfetto::TrackEvent::SetTrackDescriptor(fiber_track, track_desc);
+        return fiber_track;
+    }
+
+    void perfetto_fiber_trace_event_begin(const char *const category, const char *const name, const int64_t fiber_object_id)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_BEGIN(dynamic_category, dynamic_name, fiber_track(fiber_object_id));
+    }
+
+    void perfetto_fiber_trace_event_end(const char *const category, const int64_t fiber_object_id)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        TRACE_EVENT_END(dynamic_category, fiber_track(fiber_object_id));
+    }
+
+    void perfetto_fiber_trace_event_instant(const char *const category, const char *const name, const int64_t fiber_object_id)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_INSTANT(dynamic_category, dynamic_name, fiber_track(fiber_object_id));
+    }
+
+    void perfetto_fiber_trace_event_instant_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value, const int64_t fiber_object_id)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_INSTANT(dynamic_category, dynamic_name, fiber_track(fiber_object_id),
+                            debug_info_key, debug_info_value);
+    }
+
+    void perfetto_fiber_trace_event_begin_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value, const int64_t fiber_object_id)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_BEGIN(dynamic_category, dynamic_name, fiber_track(fiber_object_id),
+                          debug_info_key, debug_info_value);
+    }
+
 } // extern "C"

data/ext/perfetto/perfetto_internal.h

@@ -29,6 +29,18 @@ extern "C"
     void perfetto_trace_event_instant_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value);
 
     void perfetto_trace_event_begin_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value);
+
+    /* Ruby Fiber */
+    void perfetto_fiber_trace_event_begin(const char *const category, const char *const name, const int64_t fiber_object_id);
+
+    void perfetto_fiber_trace_event_end(const char *const category, const int64_t fiber_object_id);
+
+    void perfetto_fiber_trace_event_instant(const char *const category, const char *const name, const int64_t fiber_object_id);
+
+    void perfetto_fiber_trace_event_instant_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value, const int64_t fiber_object_id);
+
+    void perfetto_fiber_trace_event_begin_with_debug_info(const char *const category, const char *const name, const char *const debug_info_key, const char *const debug_info_value, const int64_t fiber_object_id);
+
 #ifdef __cplusplus
 }
 #endif

data/lib/perfetto/configure.rb

@@ -6,6 +6,7 @@ module Perfetto
     extend Configurable
 
     set :enable_tracing, false
+    set :enable_fiber, false
     set :buffer_size_kb, 1024
   end
 end

data/lib/perfetto/perfetto.rb

@@ -8,6 +8,23 @@ module Perfetto
   end
 
   if Perfetto::Configure.enable_tracing?
+    if Perfetto::Configure.enable_fiber?
+      class << self
+        # Replace thread based methods with fiber based methods
+        alias thread_trace_event_begin trace_event_begin
+        alias thread_trace_event_end trace_event_end
+        alias thread_trace_event_instant trace_event_instant
+        alias thread_trace_event_begin_with_debug_info trace_event_begin_with_debug_info
+        alias thread_trace_event_instant_with_debug_info trace_event_instant_with_debug_info
+
+        alias trace_event_begin fiber_trace_event_begin
+        alias trace_event_end fiber_trace_event_end
+        alias trace_event_instant fiber_trace_event_instant
+        alias trace_event_begin_with_debug_info fiber_trace_event_begin_with_debug_info
+        alias trace_event_instant_with_debug_info fiber_trace_event_instant_with_debug_info
+      end
+    end
+
     # Default arguments implemented in this wrapper
     def self.start_tracing
       start_tracing_native Configure.buffer_size_kb
@@ -16,19 +33,6 @@ module Perfetto
     def self.stop_tracing(trace_file_name = "#{Time.now.strftime("%Y%m%d-%H-%M-%S")}.pftrace")
       stop_tracing_native trace_file_name
     end
-
-    # Methods implemented in native extension
-    # We don't want to proxy these methods because they are called very frequently on hot paths
-    #   def self.start_tracing; end
-    #   def self.stop_tracing(_trace_file_name); end
-    #   def self.trace_event_begin(_class_name, _method_name); end
-    #   def self.trace_event_end(_class_name); end
-    #   def self.trace_counter(_class_name, _counter_name, _counter_value); end
-    #   def self.trace_counter_i64(_class_name, _counter_name, _counter_value); end
-    #   def self.trace_counter_double(_class_name, _counter_name, _counter_value); end
-    #   def self.trace_event_instant(_class_name, _method_name); end
-    #   def self.trace_event_begin_with_debug_info(_class_name, _method_name, _debug_key, _debug_value); end
-    #   def self.trace_event_instant_with_debug_info(_class_name, _method_name, _debug_key, _debug_value); end
   else
     # Stub methods
     def self.start_tracing; end

data/lib/perfetto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Perfetto
-  VERSION = "0.1.14"
+  VERSION = "0.1.15"
 end

data/lib/perfetto.rb

@@ -15,8 +15,9 @@ require_relative "perfetto/middleware"
 # at the first call to 'setup' method instead of
 # every call to bussiness logics being traced.
 module Perfetto
-  def self.setup(enable_tracing: nil, buffer_size_kb: nil)
+  def self.setup(enable_tracing: nil, enable_fiber: nil, buffer_size_kb: nil)
     Configure.enable_tracing = enable_tracing unless enable_tracing.nil?
+    Configure.enable_fiber = enable_fiber unless enable_fiber.nil?
     Configure.buffer_size_kb = buffer_size_kb unless buffer_size_kb.nil?
 
     # Native extension

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perfetto
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Kowalski Dark
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies: []
 description: Yet another event tracing library for Ruby.
 email: