cirron 0.2.8 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '031948c5f88eb541e318a992ec6c99d534f703a2e372082c6b07ed2b4e7783f2'
-  data.tar.gz: 79ad0542a7e65819008b65e053250d073b5c87a8f4923c1ae8a64fdd2f15cf10
+  metadata.gz: a77b46874cc80bc5596a3855ed42263ede1fca9a37c1577ea4f3345bb1790e93
+  data.tar.gz: 7448021b56a6fb278c3ed7a098e6a30c09d5347b6d926810c129247b31efdb7c
 SHA512:
-  metadata.gz: d0a263836ee39db7e6723aeb78a71da0d4bdc6536d9a79463a2dd312c3fa0ff3737f233d7c4e8b9a2c26957678565e4eebc400e827f206088c5c87d28e7ba1f4
-  data.tar.gz: d081b2b307ed89ddf06735be9c547383ea42de2129a365d910f72b19b298373a4cb94ad011cee20e7d5db793436067d0a9e1cdc42947c00e380455f598444e69
+  metadata.gz: 4f1a875af0e1d1f29087a8066ed78ac645c33087a3d8ff4cd30bc4c3b9f5edbb20b00f0a7cb0605d2a76fb54851c58dbacc6287ca9b5fa9e1c6c1250937ed5f8
+  data.tar.gz: 1c0ad6fd55b08dec530b4ffc4d8e807ebe2499eec5138110a9e0b117efa6db3c209eb106318669e4e9d9abfd3f63ba951963bc2fc0cd44c2a8031ed5ce0e35a6

data/README.md

@@ -8,28 +8,27 @@ It can also trace syscalls using +strace+, Linux only!
 
 == Prerequisites
 
-- Linux with perf events support / Apple ARM OSX
-- C++
-- Ruby 3.x
+  - Linux with perf events support / Apple ARM OSX
+  - C++
+  - Ruby 3.x
 
 == Usage
 
 === Performance Counters
   $ sudo irb
-  irb> require 'cirron'
-
-  # Start collecting performance metrics
-  irb> counters = Cirron::collector do
-  irb>  # Your code here
-  irb>  puts "Hello"
-  irb> end
-  => Counter(time_enabled_ns: 0, instruction_count: 39066, branch_misses: 546, page_faults: 0)
+  irb(main):001> require 'cirron'
+  => true
+  irb(main):002* c = Cirron::collector do
+  irb(main):003*   puts "Hello"
+  irb(main):004> end
+  Hello
+  => Counter(time_enabled_ns: 110260, instruction_count: 15406, branch_misses: 525, page_faults: 0)
 
 === Syscalls
 
   $ sudo irb
   irb> require 'cirron'
-
+  => true
   irb> trace = Cirron::tracer do
   irb>  # Your code here
   irb>  puts "Hello"

data/cirron.gemspec

@@ -6,7 +6,7 @@ require 'pathname'
 
 Gem::Specification.new do |spec|
   spec.name = "cirron"
-  spec.version = "0.2.8"
+  spec.version = "0.3"
   spec.authors = ["Matt Stuchlik"]
   spec.email = ["matej.stuchlik@gmail.com"]
 
@@ -33,10 +33,4 @@ Gem::Specification.new do |spec|
   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

data/lib/collector.rb

@@ -46,6 +46,19 @@ class Counter < FFI::Struct
 end
 
 module Cirron
+  @overhead = {}
+
+  def self.calculate_overhead
+    puts "Measuring overhead..."
+    10.times do
+      counter = collector(measure_overhead: false) {}
+      Counter.members.each do |field|
+        @overhead[field] = [@overhead[field], counter[field]].compact.min
+      end
+    end
+    puts @overhead
+  end
+
   def self.start
     ret_val = CirronInterOp.start
     if ret_val == -1
@@ -58,13 +71,22 @@ module Cirron
     CirronInterOp.end(fd, counter)
   end
 
-  def self.collector(&blk)
+  def self.collector(measure_overhead: true, &blk)
+    calculate_overhead if measure_overhead && @overhead.empty?
+
     counter = Counter.new
     ret_val = self.start
 
     yield
 
     self.end(ret_val, counter)
+
+    if measure_overhead && !@overhead.empty?
+      Counter.members.each do |field|
+        counter[field] = [counter[field] - @overhead[field], 0].max
+      end
+    end
+
     counter
   end
 end

data/lib/tracer.rb

@@ -73,8 +73,8 @@ def parse_strace(file)
 end
 
 def filter_trace(trace, marker_path)
-  start_index = trace.index { |event| event.args.include?(marker_path) }
-  end_index = trace.rindex { |event| event.args.include?(marker_path) }
+  start_index = trace.index { |event| event.is_a?(Syscall) && event.args.include?(marker_path) }
+  end_index = trace.rindex { |event| event.is_a?(Syscall) && event.args.include?(marker_path) }
 
   if start_index && end_index
     trace[start_index + 1...end_index]

metadata

@@ -1,26 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: cirron
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: '0.3'
 platform: ruby
 authors:
 - Matt Stuchlik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-06 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies: []
 description: "= Cirron\n\nCirron measures a piece of Ruby code and reports back several
   performance counters: \nCPU instruction count, branch misses, page faults and time
   spent measuring. \nIt uses the Linux perf events interface or @ibireme's KPC demo[https://gist.github.com/ibireme/173517c208c7dc333ba962c1f0d67d12]
-  on OSX.\n\nIt can also trace syscalls using +strace+, Linux only!\n\n== Prerequisites\n\n-
-  Linux with perf events support / Apple ARM OSX\n- C++\n- Ruby 3.x\n\n== Usage\n\n===
-  Performance Counters\n  $ sudo irb\n  irb> require 'cirron'\n\n  # Start collecting
-  performance metrics\n  irb> counters = Cirron::collector do\n  irb>  # Your code
-  here\n  irb>  puts \"Hello\"\n  irb> end\n  => Counter(time_enabled_ns: 0, instruction_count:
-  39066, branch_misses: 546, page_faults: 0)\n\n=== Syscalls\n\n  $ sudo irb\n  irb>
-  require 'cirron'\n\n  irb> trace = Cirron::tracer do\n  irb>  # Your code here\n
-  \ irb>  puts \"Hello\"\n  irb> end\n  => [#<Syscall:0x00007c6c1a4b3608 @args=\"1,
+  on OSX.\n\nIt can also trace syscalls using +strace+, Linux only!\n\n== Prerequisites\n\n
+  \ - Linux with perf events support / Apple ARM OSX\n  - C++\n  - Ruby 3.x\n\n==
+  Usage\n\n=== Performance Counters\n  $ sudo irb\n  irb(main):001> require 'cirron'\n
+  \ => true\n  irb(main):002* c = Cirron::collector do\n  irb(main):003*   puts \"Hello\"\n
+  \ irb(main):004> end\n  Hello\n  => Counter(time_enabled_ns: 110260, instruction_count:
+  15406, branch_misses: 525, page_faults: 0)\n\n=== Syscalls\n\n  $ sudo irb\n  irb>
+  require 'cirron'\n  => true\n  irb> trace = Cirron::tracer do\n  irb>  # Your code
+  here\n  irb>  puts \"Hello\"\n  irb> end\n  => [#<Syscall:0x00007c6c1a4b3608 @args=\"1,
   [{iov_base=\\\"Hello\\\", iov_len=5}, {iov_base=\\\"\\\\n\\\", iov_len=1}], 2\",
   @duration=\"0.000201\", @name=\"writev\", @pid=\"2261962\", @retval=\"6\", @timestamp=\"1720285300.334976\">]\n
   \ # Save the trace for ingesting to Perfetto\n  irb> File.write(\"/tmp/trace\",