cirron 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff54dda8d0986886acb138298e91096d18acfd9cdb0adb927b13613d6f0eca17
+  data.tar.gz: 7fd5cb27f2834094f1d3941d1c24aca63a4195835f98fc133d064664db4ec662
+SHA512:
+  metadata.gz: 0af236106e911b520dea0dab38194652c1e3ef3f5ccfa33f46f261dd17a8807a15501f136f0a02cc9aa22ab3c09ae7f44088aa41c2451d09fdcda0b288ceab8d
+  data.tar.gz: adfaa9a35e9c2d107c675a9beadfc72c65612d02fcb57d7bc76103b4f050872b06c9e3b73edd43745f5c392a607c182ae08d4075e4ea092bbcc16d02abbaaf7a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matt Stuchlik
+
+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.md

@@ -0,0 +1,42 @@
+==
+# Cirron
+
+Cirron measures a piece of Ruby code and report back several performance counters: CPU instruction count, branch misses, page faults and time spent measuring. It uses the Linux perf events interface or @ibireme's [KPC demo](https://gist.github.com/ibireme/173517c208c7dc333ba962c1f0d67d12) on OSX.
+
+It can also trace syscalls using `strace`, Linux only!
+
+## Prerequisites
+
+- Linux with perf events support / Apple ARM OSX
+- C++
+- Ruby 3.x
+
+## Usage
+
+### Performance Counters
+```
+from cirron import Collector
+
+# Start collecting performance metrics
+with Collector() as collector:
+    # Your code here
+    # ...
+
+# Retrieve the metrics
+print(collector.counters)
+```
+
+### Syscalls
+```
+from cirron import Tracer, to_tef
+
+with Tracer() as tracer:
+    # Your code here
+    # ...
+
+# Stop collecting and retrieve the trace
+print(tracer.trace)
+
+# Save the trace for ingesting to Perfetto
+open("/tmp/trace", "w").write(to_tef(trace))
+```

data/cirron.gemspec

@@ -0,0 +1,42 @@
+
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+Gem::Specification.new do |spec|
+  spec.name = "cirron"
+  spec.version = "0.2.2"
+  spec.authors = ["Matt Stuchlik"]
+  spec.email = ["matej.stuchlik@gmail.com"]
+
+  spec.summary = "Cirron measures how many CPU instructions and system calls a piece of Ruby code executes."
+  spec.description = File.read(File.join(File.dirname(__FILE__), "README.md"))
+  spec.homepage = "https://github.com/s7nfo/Cirron"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/s7nfo/Cirron"
+
+  spec.files = [
+    "lib/apple_arm_events.h",
+    "lib/cirron.rb",
+    "lib/cirronlib.cpp",
+    "lib/collector.rb",
+    "lib/tracer.rb",
+    "README.md",
+    "LICENSE",
+    "cirron.gemspec"
+  ]
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end