perfetto 0.1.15-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5ae34b8295e0d919e3044cb77884fb583441bc3b5f218920d11d5ded9506849
+  data.tar.gz: 1e89f789a7e043718dc9fbf1068416a9b779b92b6c2b71729990dc8854d6d33b
+SHA512:
+  metadata.gz: 0c0d832b5acbbdd6a5857e216b9853bc48b43f213e6687a33db40e9480d02b8fefcb4c444fbb59d0390e0021ef163a24ad51bc3b60f5a39de9ed3425d0488b87
+  data.tar.gz: 45cc831c7eb2234c3546cd3f8cf2a7ca3e1f90eb04b21258eaeb9e405d106230c71115693587c9677928b3c959c8b13d82b06d7fa2a7ac2baca9d822da04f68f

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+require:
+  - rubocop-rake
+  - rubocop-minitest

data/README.md

@@ -0,0 +1,109 @@
+# Perfetto
+
+## Visualization
+
+https://ui.perfetto.dev/
+
+## Usage
+
+### Basic
+
+```ruby
+require "perfetto"
+
+Perfetto.setup enable_tracing: true
+
+Perfetto.start_tracing
+
+# Slice
+# Stack frame is inferred from the begin event with the same category 'cpu_work'
+Perfetto.trace_event_begin "cpu_work", "example_task"
+sleep 0.1
+Perfetto.trace_event_end "cpu_work"
+
+# Slice with debug info
+# Same as above, but "key"=>"value" is added to the event details
+Perfetto.trace_event_begin_with_debug_info "cpu_work", "example_task2", "key", "value"
+sleep 0.1
+Perfetto.trace_event_end "cpu_work"
+
+# Counter
+10.times do |n|
+  Perfetto.trace_counter "rendering", "frame_rate", n.even? ? 60 : 30
+  sleep 0.1
+end
+Perfetto.trace_counter "rendering", "frame_rate", 0
+
+# Instant
+Perfetto.trace_event_instant "cpu_work", "example_instant"
+
+sleep 0.1
+
+# Instant with debug info
+Perfetto.trace_event_instant_with_debug_info "cpu_work", "example_instant2", "key", "value"
+
+sleep 0.1
+
+class Foo
+  # Intercept instance methods
+  include Perfetto::Interceptor
+  perfetto_trace_all
+
+  def bar(a, b = 1, c: 2)
+    yield(a + b + c)
+  end
+
+  def baz(x)
+    puts x
+    sleep 0.1
+  end
+
+  def self.buf
+    puts "buf"
+    sleep 0.1
+  end
+end
+
+class Bar < Foo
+  def say
+    puts "hello"
+    sleep 0.1
+  end
+end
+
+f = Foo.new
+b = Bar.new
+f.bar(1, 2, c: 3) do |n|
+  n.times do |x|
+    f.baz x + n
+    Foo.buf
+    b.say
+  end
+end
+
+Perfetto.stop_tracing "example.pftrace"
+```
+
+![example](./example/example.png)
+
+### Rack Middleware
+
+```ruby
+# frozen_string_literal: true
+
+require "sinatra/base"
+require "perfetto"
+
+class Server < Sinatra::Base
+  use Perfetto::Middleware, env_proc: ->(env) { env.to_json }
+
+  get "/" do
+    "Hello World"
+  end
+end
+
+Perfetto.setup enable_tracing: true
+Perfetto.start_tracing
+Server.run!
+Perfetto.stop_tracing "middleware.pftrace"
+```

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rake/extensiontask"
+gemspec = Gem::Specification.load("perfetto.gemspec")
+Rake::ExtensionTask.new("perfetto_native", gemspec) do |ext|
+  ext.ext_dir = "ext/perfetto"
+  ext.lib_dir = "lib/perfetto"
+end
+
+require "minitest/test_task"
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/example/example.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# rubocop:disable Naming/MethodParameterName
+# rubocop:disable Style/Documentation
+
+require_relative "../lib/perfetto"
+
+Perfetto.setup enable_tracing: true
+
+Perfetto.start_tracing
+
+# Slice
+# Stack frame is inferred from the begin event with the same category 'cpu_work'
+Perfetto.trace_event_begin "cpu_work", "example_task"
+sleep 0.1
+Perfetto.trace_event_end "cpu_work"
+
+# Slice with debug info
+# Same as above, but "key"=>"value" is added to the event details
+Perfetto.trace_event_begin_with_debug_info "cpu_work", "example_task2", "key", "value"
+sleep 0.1
+Perfetto.trace_event_end "cpu_work"
+
+# Counter
+10.times do |n|
+  Perfetto.trace_counter "rendering", "frame_rate", n.even? ? 60 : 30
+  sleep 0.1
+end
+Perfetto.trace_counter "rendering", "frame_rate", 0
+
+# Instant
+Perfetto.trace_event_instant "cpu_work", "example_instant"
+
+sleep 0.1
+
+# Instant with debug info
+Perfetto.trace_event_instant_with_debug_info "cpu_work", "example_instant2", "key", "value"
+
+sleep 0.1
+
+class Foo
+  # Intercept instance methods
+  include Perfetto::Interceptor
+  perfetto_trace_all
+
+  def bar(a, b = 1, c: 2)
+    yield(a + b + c)
+  end
+
+  def baz(x)
+    puts x
+    sleep 0.1
+  end
+
+  def self.buf
+    puts "buf"
+    sleep 0.1
+  end
+end
+
+class Bar < Foo
+  def self.buf2
+    puts "buf2"
+    sleep 0.1
+  end
+
+  def say
+    puts "hello"
+    sleep 0.1
+    Bar.buf2
+    Foo.buf
+  end
+end
+
+f = Foo.new
+b = Bar.new
+f.bar(1, 2, c: 3) do |n|
+  n.times do |x|
+    f.baz x + n
+    Foo.buf
+    b.say
+  end
+end
+
+Perfetto.stop_tracing "example.pftrace"
+
+# rubocop:enable Naming/MethodParameterName
+# rubocop:enable Style/Documentation

data/ext/perfetto/LICENSE

@@ -0,0 +1,189 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2017, The Android Open Source Project
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/ext/perfetto/README.md

@@ -0,0 +1,11 @@
+# Google Perfetto Tracing SDK
+
+`sdk.h` and `sdk.cc` are copied from the Google Perfetto Tracing SDK.
+
+## Version
+
+v40.0
+
+## Reference
+
+https://perfetto.dev/docs/instrumentation/tracing-sdk

data/ext/perfetto/extconf.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# Rubocop
+# rubocop:disable Style/GlobalVars
+$CXXFLAGS += " -std=c++17 -O3 -pthread"
+$CFLAGS += " -std=c11 -O3 -pthread"
+# rubocop:enable Style/GlobalVars
+
+create_makefile "perfetto/perfetto_native"

data/ext/perfetto/perfetto.c

@@ -0,0 +1,139 @@
+#include <ruby.h>
+
+#include "perfetto_internal.h"
+
+/* Modules */
+static VALUE rb_mPerfetto;
+static VALUE rb_mFiber;
+
+/* Methods */
+
+static VALUE rb_perfetto_start_tracing(VALUE self, VALUE buffer_size_kb)
+{
+    return perfetto_start_tracing(NUM2UINT(buffer_size_kb)) ? Qtrue : Qfalse;
+}
+
+static VALUE rb_perfetto_stop_tracing(VALUE self, VALUE output_file)
+{
+    return perfetto_stop_tracing(StringValuePtr(output_file)) ? Qtrue : Qfalse;
+}
+
+static VALUE rb_perfetto_trace_event_begin(VALUE self, VALUE category, VALUE name)
+{
+    perfetto_trace_event_begin(StringValuePtr(category), StringValuePtr(name));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_event_end(VALUE self, VALUE category)
+{
+    perfetto_trace_event_end(StringValuePtr(category));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_counter_i64(VALUE self, VALUE category, VALUE name, VALUE value)
+{
+    perfetto_trace_counter_i64(StringValuePtr(category), StringValuePtr(name), NUM2LL(value));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_counter_double(VALUE self, VALUE category, VALUE name, VALUE value)
+{
+    perfetto_trace_counter_double(StringValuePtr(category), StringValuePtr(name), NUM2DBL(value));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_event_instant(VALUE self, VALUE category, VALUE name)
+{
+    perfetto_trace_event_instant(StringValuePtr(category), StringValuePtr(name));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_event_instant_with_debug_info(VALUE self, VALUE category, VALUE name, VALUE debug_info_key, VALUE debug_info_value)
+{
+    perfetto_trace_event_instant_with_debug_info(StringValuePtr(category), StringValuePtr(name), StringValuePtr(debug_info_key), StringValuePtr(debug_info_value));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_event_begin_with_debug_info(VALUE self, VALUE category, VALUE name, VALUE debug_info_key, VALUE debug_info_value)
+{
+    perfetto_trace_event_begin_with_debug_info(StringValuePtr(category), StringValuePtr(name), StringValuePtr(debug_info_key), StringValuePtr(debug_info_value));
+    return Qnil;
+}
+
+static VALUE rb_perfetto_trace_counter(VALUE self, VALUE category, VALUE name, VALUE value)
+{
+    if (TYPE(value) == T_FIXNUM)
+    {
+        return rb_perfetto_trace_counter_i64(self, category, name, value);
+    }
+    else if (TYPE(value) == T_FLOAT)
+    {
+        return rb_perfetto_trace_counter_double(self, category, name, value);
+    }
+    else
+    {
+        rb_raise(rb_eTypeError, "Value must be a Fixnum or Float");
+    }
+}
+
+/* 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);
+    rb_define_module_function(rb_mPerfetto, "trace_event_begin", rb_perfetto_trace_event_begin, 2);
+    rb_define_module_function(rb_mPerfetto, "trace_event_end", rb_perfetto_trace_event_end, 1);
+    rb_define_module_function(rb_mPerfetto, "trace_counter_i64", rb_perfetto_trace_counter_i64, 3);
+    rb_define_module_function(rb_mPerfetto, "trace_counter_double", rb_perfetto_trace_counter_double, 3);
+    rb_define_module_function(rb_mPerfetto, "trace_counter", rb_perfetto_trace_counter, 3);
+    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);
+}