gvl-tracing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 851f587fcb3e81728e4691372cf8433b75179e9b14f88b3516380143692b75c1
+  data.tar.gz: 73af09c5163ef3552c0153ea1fc9fc8fea4e8c8de8d531b1e5fccf812d978d6b
+SHA512:
+  metadata.gz: c624c191a80faf90efdb37fb5745eaea89ab5737c262f26cacf2ac7491d783de8ad3f4ce381ad98e8c12ed7f8bfbb72b6e476765034c8f40e799afe0578f70c3
+  data.tar.gz: 352d912e2fcd6a899c1747ceab4511eea7a6a3b922436be715a49caa445664d3c60d22afefba8d3ad044b97126dd0b6e8548d66a1a1e7fcc8ed7c30aee466471

data/.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.h]
+indent_style = space
+indent_size = 2
+
+[*.c]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2

data/.standard.yml

@@ -0,0 +1,5 @@
+ruby_version: 3.2
+
+ignore:
+  - 'examples/example1.rb':
+    - Style/InfiniteLoop

data/CODE_OF_CONDUCT.adoc

@@ -0,0 +1,134 @@
+
+= Contributor Covenant Code of Conduct
+
+== Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+== Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+== Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+== Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+ivo@ivoanjo.me.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+== Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+=== 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+=== 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+=== 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+=== 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+== Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant,
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+Mozilla's code of conduct enforcement ladder.
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+
+
+
+
+
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ivo Anjo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,87 @@
+= `gvl-tracing`
+:toc:
+:toc-placement: macro
+:toclevels: 4
+:toc-title:
+
+A Ruby gem for getting a timeline view of Global VM Lock usage in your Ruby app that can be analyzed using the https://ui.perfetto.dev/[Perfetto UI].
+
+image::preview.png[]
+
+See my blog post **FIXME** for more details!
+
+NOTE: This gem only works on Ruby 3.2 and above because it depends on the new https://github.com/ruby/ruby/pull/5500[GVL Instrumentation API]. See below for an easy way to run Ruby 3.2 inside docker.
+
+== Quickest start
+
+You can play with the output of running the following example:
+
+[source,ruby]
+----
+require "gvl-tracing"
+
+def fib(n)
+  return n if n <= 1
+  fib(n - 1) + fib(n - 2)
+end
+
+GvlTracing.start("example1.json")
+
+Thread.new { sleep(0.05) while true }
+
+sleep(0.05)
+
+3.times.map { Thread.new { fib(37) } }.map(&:join)
+
+sleep(0.05)
+
+GvlTracing.stop
+----
+
+To do so:
+
+1. Download link:https://github.com/ivoanjo/gvl-tracing/blob/master/examples/example1.json.gz?raw=true[`examples/example1.json.gz`]
+2. Navigate to https://ui.perfetto.dev/ and use the **Open trace file** option to load the file
+
+== Quick start using docker
+
+**FIXME: TODO**
+
+== Installation
+
+Install the gem and add to the application's `Gemfile` or `gems.rb` file by executing:
+
+[source,bash]
+----
+$ bundle add gvl-tracing
+----
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+[source,bash]
+----
+$ gem install gvl-tracing
+----
+
+== Usage
+
+Use `require "gvl-tracing"` to load the gem.
+
+This gem only provides a single module (`GvlTracing`) with methods:
+
+* `start(filename)`: Starts tracing, writing the results to the provided filename
+* `stop`: Stops tracing
+
+The resulting traces can be analyzed by going to https://ui.perfetto.dev/[Perfetto UI].
+
+== Development
+
+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 https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ivoanjo/gvl-tracing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the https://github.com/ivoanjo/gvl-tracing/blob/master/CODE_OF_CONDUCT.adoc[code of conduct].
+
+== Code of Conduct
+
+Everyone interacting in the gvl-tracing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the https://github.com/ivoanjo/gvl-tracing/blob/master/CODE_OF_CONDUCT.adoc[code of conduct].

data/Rakefile

@@ -0,0 +1,34 @@
+# gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+# Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of gvl-tracing.
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("gvl_tracing_native_extension")
+
+task default: [:compile, :"standard:fix"]

data/examples/example1.rb

@@ -0,0 +1,18 @@
+require "gvl-tracing"
+
+def fib(n)
+  return n if n <= 1
+  fib(n - 1) + fib(n - 2)
+end
+
+GvlTracing.start("example1.json")
+
+Thread.new { sleep(0.05) while true }
+
+sleep(0.05)
+
+3.times.map { Thread.new { fib(37) } }.map(&:join)
+
+sleep(0.05)
+
+GvlTracing.stop

data/ext/gvl_tracing_native_extension/extconf.rb

@@ -0,0 +1,35 @@
+# gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+# Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of gvl-tracing.
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+if ["jruby", "truffleruby"].include?(RUBY_ENGINE)
+  raise \
+    "\n#{"-" * 80}\nSorry! This gem is unsupported on #{RUBY_ENGINE}. Since it relies on a lot of guts of MRI Ruby, " \
+    "it's impossible to make a direct port.\n" \
+    "Perhaps a #{RUBY_ENGINE} equivalent could be created -- help is welcome! :)\n#{"-" * 80}"
+end
+
+require "mkmf"
+
+create_makefile "gvl_tracing_native_extension"

data/ext/gvl_tracing_native_extension/gvl_tracing.c

@@ -0,0 +1,134 @@
+// gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+// Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+//
+// This file is part of gvl-tracing.
+//
+// MIT License
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+#include <ruby/ruby.h>
+#include <ruby/thread.h>
+#include <errno.h>
+#include <stdbool.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+static VALUE tracing_start(VALUE _self, VALUE output_path);
+static VALUE tracing_stop(VALUE _self);
+static double timestamp_microseconds(void);
+static void render_event(const char *event_name);
+static void on_event(rb_event_flag_t event, const rb_internal_thread_event_data_t *_unused1, void *_unused2);
+
+// Global mutable state
+static FILE *output_file = NULL;
+static rb_internal_thread_event_hook_t *current_hook = NULL;
+static double started_tracing_at_microseconds = 0;
+static pid_t process_id = 0;
+
+void Init_gvl_tracing_native_extension(void) {
+  VALUE gvl_tracing_module = rb_define_module("GvlTracing");
+
+  rb_define_singleton_method(gvl_tracing_module, "start", tracing_start, 1);
+  rb_define_singleton_method(gvl_tracing_module, "stop", tracing_stop, 0);
+}
+
+static VALUE tracing_start(VALUE _self, VALUE output_path) {
+  Check_Type(output_path, T_STRING);
+
+  if (output_file != NULL) rb_raise(rb_eRuntimeError, "Already started");
+  output_file = fopen(StringValuePtr(output_path), "w");
+  if (output_file == NULL) rb_syserr_fail(errno, "Failed to open GvlTracing output file");
+
+  started_tracing_at_microseconds = timestamp_microseconds();
+  process_id = getpid();
+
+  fprintf(output_file, "[\n");
+  render_event("started_tracing");
+
+  current_hook = rb_internal_thread_add_event_hook(
+    on_event,
+    (
+      RUBY_INTERNAL_THREAD_EVENT_READY |
+      RUBY_INTERNAL_THREAD_EVENT_RESUMED |
+      RUBY_INTERNAL_THREAD_EVENT_SUSPENDED |
+      RUBY_INTERNAL_THREAD_EVENT_STARTED |
+      RUBY_INTERNAL_THREAD_EVENT_EXITED
+    ),
+    NULL
+  );
+
+  return Qtrue;
+}
+
+static VALUE tracing_stop(VALUE _self) {
+  if (output_file == NULL) rb_raise(rb_eRuntimeError, "Tracing not running");
+
+  rb_internal_thread_remove_event_hook(current_hook);
+
+  render_event("stopped_tracing");
+  fprintf(output_file, "]\n");
+
+  if (fclose(output_file) != 0) rb_syserr_fail(errno, "Failed to close GvlTracing output file");
+
+  output_file == NULL;
+
+  return Qtrue;
+}
+
+static double timestamp_microseconds(void) {
+  struct timespec current_monotonic;
+  if (clock_gettime(CLOCK_MONOTONIC, &current_monotonic) != 0) rb_syserr_fail(errno, "Failed to read CLOCK_MONOTONIC");
+  return (current_monotonic.tv_nsec / 1000.0) + (current_monotonic.tv_sec * 1000.0 * 1000.0);
+}
+
+// Render output using trace event format for perfetto:
+// https://chromium.googlesource.com/catapult/+/refs/heads/main/docs/trace-event-format.md
+static void render_event(const char *event_name) {
+  // Event data
+  double now_microseconds = timestamp_microseconds() - started_tracing_at_microseconds;
+  pid_t thread_id = gettid();
+
+  // Each event is converted into two events in the output: one that signals the end of the previous event
+  // (whatever it was), and one that signals the start of the actual event we're processing.
+  // Yes this is seems to be bending a bit the intention of the output format, but it seemed easier to do this way.
+
+  fprintf(output_file,
+    // Finish previous duration
+    "  {\"ph\": \"E\", \"pid\": %u, \"tid\": %u, \"ts\": %f},\n" \
+    // Current event
+    "  {\"ph\": \"B\", \"pid\": %u, \"tid\": %u, \"ts\": %f, \"name\": \"%s\"},\n",
+    // Args for first line
+    process_id, thread_id, now_microseconds,
+    // Args for second line
+    process_id, thread_id, now_microseconds, event_name
+  );
+}
+
+static void on_event(rb_event_flag_t event_id, const rb_internal_thread_event_data_t *_unused1, void *_unused2) {
+  const char* event_name = "bug_unknown_event";
+  switch (event_id) {
+    case RUBY_INTERNAL_THREAD_EVENT_READY:     event_name = "ready";     break;
+    case RUBY_INTERNAL_THREAD_EVENT_RESUMED:   event_name = "resumed";   break;
+    case RUBY_INTERNAL_THREAD_EVENT_SUSPENDED: event_name = "suspended"; break;
+    case RUBY_INTERNAL_THREAD_EVENT_STARTED:   event_name = "started";   break;
+    case RUBY_INTERNAL_THREAD_EVENT_EXITED:    event_name = "exited";    break;
+  };
+  render_event(event_name);
+}

data/gems.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rake-compiler", "~> 1.2"
+gem "pry"
+gem "standard", "~> 1.12"

data/gvl-tracing.gemspec

@@ -0,0 +1,50 @@
+# gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+# Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of gvl-tracing.
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require_relative "lib/gvl_tracing/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gvl-tracing"
+  spec.version = GvlTracing::VERSION
+  spec.authors = ["Ivo Anjo"]
+  spec.email = ["ivo@ivoanjo.me"]
+
+  spec.summary = "Get a timeline view of Global VM Lock usage in your Ruby app"
+  spec.homepage = "https://github.com/ivoanjo/gvl-tracing"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib", "ext"]
+  spec.extensions = ["ext/gvl_tracing_native_extension/extconf.rb"]
+end

data/lib/gvl-tracing.rb

@@ -0,0 +1,33 @@
+# gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+# Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of gvl-tracing.
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require_relative "gvl_tracing/version"
+
+require "gvl_tracing_native_extension"
+
+module GvlTracing
+end

data/lib/gvl_tracing/version.rb

@@ -0,0 +1,30 @@
+# gvl-tracing: Ruby gem for getting a timelinew view of GVL usage
+# Copyright (c) 2022 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of gvl-tracing.
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+module GvlTracing
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: gvl-tracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivo Anjo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-10 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- ivo@ivoanjo.me
+executables: []
+extensions:
+- ext/gvl_tracing_native_extension/extconf.rb
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".standard.yml"
+- CODE_OF_CONDUCT.adoc
+- LICENSE
+- README.adoc
+- Rakefile
+- examples/example1.json.gz
+- examples/example1.rb
+- ext/gvl_tracing_native_extension/extconf.rb
+- ext/gvl_tracing_native_extension/gvl_tracing.c
+- gems.rb
+- gvl-tracing.gemspec
+- lib/gvl-tracing.rb
+- lib/gvl_tracing/version.rb
+- preview.png
+homepage: https://github.com/ivoanjo/gvl-tracing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.0.dev
+signing_key: 
+specification_version: 4
+summary: Get a timeline view of Global VM Lock usage in your Ruby app
+test_files: []