perfetto 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409c5c5efda9fd49e9865e14b9dcfdd2fda8115af2c88ad551ff2606aee165ec
-  data.tar.gz: a5d109278ebd31f707a57a0391d41c3ff803268ac9f4171ea229fd11d98f5f0f
+  metadata.gz: 6642fce9318093a63a3d77565697ae113b3482aebd5408ec017eaedc6329c359
+  data.tar.gz: d92d38f6e5c3a177bc160677bc1c6a7a5334cf899a68724a7ff686266aaef71f
 SHA512:
-  metadata.gz: fe779514261dfed2ff2ac54b5ab1e4d5b40985bc508d53e1a5ecb34a6995399fd21ecc26647c87a905fe7177735d098f5fb4aa8184e95be74151bc3a2f4542aa
-  data.tar.gz: 303f4428d6fa8e78a292e0890caf3d0f9d365767f1bfe790e8166e04cae3f4cd91ab7e858f69914f6c6372adef78c46ba327feb6559761c126ffa56c70a2eeff
+  metadata.gz: 12d78ef7a12958fe60be11128014f0327a6aae91543acefdf9c1d473438ad858d79830638699afa80684fedafda2b294f5b6ab486f6ffc9b6166b84c33f91cdf
+  data.tar.gz: 471b51999fd8a7b93aa7dc5d2ed3722193f7d4beb02a74db265db437ab220ef99fb62a23ce437afb734c7385757feacf2b7a27a6112ea1fdec73450750a07e1f

data/.rubocop.yml

@@ -12,3 +12,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+require:
+  - rubocop-rake
+  - rubocop-minitest

data/README.md

@@ -1,31 +1,5 @@
 # Perfetto
 
-TODO: Delete this and the text below, and describe your gem
+## Visualization
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/perfetto`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/perfetto.
+https://ui.perfetto.dev/

data/Rakefile

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "minitest/test_task"
 
+require "rake/extensiontask"
+gemspec = Gem::Specification.load("perfetto.gemspec")
+Rake::ExtensionTask.new("perfetto", 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/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,92 @@
+#include <ruby.h>
+
+#include "perfetto_internal.h"
+
+/* Modules */
+static VALUE rb_mPerfetto;
+
+/* 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");
+    }
+}
+
+void Init_perfetto_native(void)
+{
+    rb_mPerfetto = rb_define_module("Perfetto");
+
+    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);
+}

data/ext/perfetto/perfetto_internal.cc

@@ -0,0 +1,149 @@
+#include "sdk.h"
+
+#include <memory>
+#include <atomic>
+#include <mutex>
+#include <fstream>
+#include <vector>
+#include <string>
+
+#include "perfetto_internal.h"
+
+PERFETTO_DEFINE_CATEGORIES();
+PERFETTO_TRACK_EVENT_STATIC_STORAGE();
+
+static struct GlobalState
+{
+    std::unique_ptr<perfetto::TracingSession> tracing_session;
+    bool is_initialized;
+    bool is_tracing;
+    std::mutex mutex;
+
+    GlobalState() : tracing_session(nullptr), is_initialized(false), mutex()
+    {
+    }
+} global_state;
+
+extern "C"
+{
+
+    static inline void perfetto_initialize()
+    {
+        perfetto::TracingInitArgs args;
+        args.backends = perfetto::kInProcessBackend;
+        perfetto::Tracing::Initialize(args);
+        perfetto::TrackEvent::Register();
+        global_state.is_initialized = true;
+    }
+
+    bool perfetto_start_tracing(const uint32_t buffer_size_kb)
+    {
+        std::lock_guard<std::mutex> lock(global_state.mutex);
+
+        if (global_state.is_tracing)
+        {
+            return false;
+        }
+
+        if (!global_state.is_initialized)
+        {
+            perfetto_initialize();
+        }
+
+        if (buffer_size_kb == 0)
+        {
+            return false;
+        }
+
+        perfetto::TraceConfig trace_config;
+        trace_config.add_buffers()->set_size_kb(buffer_size_kb);
+        auto *ds_config = trace_config.add_data_sources()->mutable_config();
+        ds_config->set_name("track_event");
+
+        auto tracing_session = perfetto::Tracing::NewTrace();
+        tracing_session->Setup(trace_config);
+        tracing_session->StartBlocking();
+
+        global_state.tracing_session = std::move(tracing_session);
+        global_state.is_tracing = true;
+        return true;
+    }
+
+    bool perfetto_stop_tracing(const char *const output_file)
+    {
+        std::lock_guard<std::mutex> lock(global_state.mutex);
+        if (!global_state.is_initialized || !global_state.is_tracing)
+        {
+            return false;
+        }
+
+        perfetto::TrackEvent::Flush();
+        global_state.tracing_session->StopBlocking();
+        std::vector<char> trace_data(global_state.tracing_session->ReadTraceBlocking());
+        global_state.tracing_session.reset();
+        global_state.is_tracing = false;
+
+        try
+        {
+            std::ofstream output(output_file, std::ios::out | std::ios::binary);
+            output.write(trace_data.data(), trace_data.size());
+            output.close();
+        }
+        catch (std::exception &e)
+        {
+            return false;
+        }
+
+        return true;
+    }
+
+    void perfetto_trace_event_begin(const char *const category, const char *const name)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_BEGIN(dynamic_category, dynamic_name);
+    }
+
+    void perfetto_trace_event_end(const char *const category)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        TRACE_EVENT_END(dynamic_category);
+    }
+
+    void perfetto_trace_counter_i64(const char *const category, const char *const name, const int64_t value)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_COUNTER(dynamic_category, perfetto::CounterTrack(name), value);
+    }
+
+    void perfetto_trace_counter_double(const char *const category, const char *const name, const double value)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        TRACE_COUNTER(dynamic_category, perfetto::CounterTrack(name), value);
+    }
+
+    void perfetto_trace_event_instant(const char *const category, const char *const name)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_INSTANT(dynamic_category, dynamic_name);
+    }
+
+    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)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_INSTANT(dynamic_category, dynamic_name,
+                            debug_info_key, 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)
+    {
+        perfetto::DynamicCategory dynamic_category(category);
+        perfetto::DynamicString dynamic_name(name);
+        TRACE_EVENT_BEGIN(dynamic_category, dynamic_name,
+                          debug_info_key, debug_info_value);
+    }
+
+} // extern "C"

data/ext/perfetto/perfetto_internal.h

@@ -0,0 +1,36 @@
+#ifndef _RUBY_PERFETTO_INTERNAL_H_
+#define _RUBY_PERFETTO_INTERNAL_H_
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#include <stdint.h>
+#include <string.h>
+#include <stdlib.h>
+
+    /* C Interface */
+
+    bool perfetto_start_tracing(const uint32_t buffer_size_kb);
+
+    bool perfetto_stop_tracing(const char *const output_file);
+
+    void perfetto_trace_event_begin(const char *const category, const char *const name);
+
+    void perfetto_trace_event_end(const char *const category);
+
+    void perfetto_trace_counter_i64(const char *const category, const char *const name, const int64_t value);
+
+    void perfetto_trace_counter_double(const char *const category, const char *const name, const double value);
+
+    void perfetto_trace_event_instant(const char *const category, const char *const name);
+
+    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);
+#ifdef __cplusplus
+}
+#endif
+
+#endif // _RUBY_PERFETTO_INTERNAL_H_