perf_counters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cced98e93f41c89e87acaa723bd631056953ff7
+  data.tar.gz: 5448721efebcf1d565d97fbcb98337cd5bb66c78
+SHA512:
+  metadata.gz: 5d72ff056f7b7340c57ed55304edafaaf4dfdabf2e54a31c53cb95286a9cfaf8f4d42fb66e06b42a28bbfe9316b4c1356f2258d541b334d9d0c33cd3ddc2fcbb
+  data.tar.gz: 2143340b8ac4737835c26fc08fded05e36cf6a8e1f78d9d703b0c530982809187f1df4b013d3605513b2ec4a879b0ab968241c7e5c42feca38347e8e91847d3a

data/.gitignore

@@ -0,0 +1,14 @@
+*.sw[po]
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in perf_counters.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    perf_counters (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.7.2)
+    kalibera (0.1)
+      memoist (~> 0.11.0)
+      rbzip2 (~> 0.2.0)
+    memoist (0.11.0)
+    minitest (5.10.3)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+    rbzip2 (0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips (~> 2.7.2)
+  bundler (~> 1.16)
+  kalibera
+  minitest (~> 5.0)
+  perf_counters!
+  rake (~> 10.0)
+  rake-compiler
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,45 @@
+# PerfCounters
+
+Experimental, do not use in production, could blow up your Rubies.
+
+### What
+Read the CPU's performance counters from Ruby using `perf_event_open(2)`.
+
+### Usage
+```ruby
+require 'perf_counters'
+events = [
+  Event::INSTRUCTIONS,
+  Event::CPU_CYCLES,
+  Event::CACHE_MISSES,
+]
+perf = PerfCounters::Measurement.new(
+  exclude_kernel: true,
+  events: events,
+)
+perf.start
+# do something here
+perf.stop
+=> {:instructions=>3276, :cpu_cycles=>18651, :cache_misses=>24}
+```
+
+### Contributing
+
+#### Requirements
+A modern Linux machine (unfortunately, most VMs don't virtualize perf counters)
+with `perf` installed.
+
+#### Install
+```shell
+$ bin/setup
+```
+
+#### Compile
+```shell
+$ rake compile
+```
+
+#### Run tests
+```shell
+$ rake [test]
+```

data/Rakefile

@@ -0,0 +1,61 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rake/extensiontask'
+
+task build: :compile
+
+Rake::ExtensionTask.new('perf_counters') do |ext|
+  ext.lib_dir = 'lib/perf_counters'
+end
+
+task default: %i[clobber compile test]
+
+task benchmark: %i[clobber compile] do
+  require 'benchmark/ips'
+  require 'perf_counters'
+
+  # TODO:
+  # - `x.stats = :bootstrap` seems to get frozen
+  # - investigate why results are not very consistent
+  Benchmark.ips do |x|
+    x.iterations = 3
+
+    x.report('no perf_counters') do |times|
+      (0..times).inject(:+)
+    end
+
+    x.report('using yield') do |times|
+      PerfCounters.measure(events: [Event::INSTRUCTIONS]) do
+        (0..times).inject(:+)
+      end
+    end
+
+    x.report('using yield (frozen array)') do |times|
+      PerfCounters.measure(events: [Event::INSTRUCTIONS].freeze) do
+        (0..times).inject(:+)
+      end
+    end
+
+    x.report('not using yield') do |times|
+      pc = PerfCounters::Measurement.new(events: [Event::INSTRUCTIONS])
+      pc.start
+      (0..times).inject(:+)
+      pc.stop
+    end
+
+    x.report('not using yield (frozen array)') do |times|
+      pc = PerfCounters::Measurement.new(events: [Event::INSTRUCTIONS].freeze)
+      pc.start
+      (0..times).inject(:+)
+      pc.stop
+    end
+    x.compare!
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'perf_counters'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/format_c

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+clang-format -i ext/perf_counters/*.[ch]

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/perf_counters/extconf.rb

@@ -0,0 +1,12 @@
+require 'mkmf'
+
+$CFLAGS << ' -Wall -Werror -Wextra -Wshadow -Wpedantic'
+
+$CFLAGS << if ENV['OPTIMIZE']
+             ' -O3'
+           else
+             ' -O0 -ggdb'
+end
+
+# RbConfig::MAKEFILE_CONFIG['CC'] = 'clang' if ENV['USE_CLANG']
+create_makefile('perf_counters/perf_counters')

data/ext/perf_counters/perf_counters.c

@@ -0,0 +1,161 @@
+#include "perf_counters.h"
+#include <asm/unistd.h>
+#include <errno.h>
+#include <linux/perf_event.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <string.h>
+#include <sys/ioctl.h>
+#include <unistd.h>
+
+#define LEADER(array) (array[0])
+#define RAISE_ON_ERROR(function_call)                                          \
+  do {                                                                         \
+    if (function_call == -1) {                                                 \
+      state->started = 0;                                                      \
+      xfree(state->fds);                                                       \
+      xfree(state->ids);                                                       \
+      rb_raise(rb_eArgError, "ioctl call failed in line %d with '%s'",         \
+               __LINE__, strerror(errno));                                     \
+    }                                                                          \
+  } while (0);
+
+struct read_format {
+  uint64_t nr;
+  struct {
+    uint64_t value;
+    uint64_t id;
+  } values[];
+};
+struct perf_event_attr pe;
+struct perf_state {
+  int started;
+  int *fds;
+  uint64_t *ids;
+};
+
+static long perf_event_open(struct perf_event_attr *hw_event, pid_t pid,
+                            int cpu, int group_fd, unsigned long flags) {
+  return syscall(__NR_perf_event_open, hw_event, pid, cpu, group_fd, flags);
+}
+
+void dealloc_state(struct perf_state *state) { xfree(state); }
+
+VALUE
+alloc_state(VALUE klass) {
+  struct perf_state *state = xmalloc(sizeof(struct perf_state));
+  state->started = 0;
+  return Data_Wrap_Struct(klass, NULL, dealloc_state, state);
+}
+
+VALUE
+measurement_start(VALUE self) {
+  VALUE rb_events = rb_iv_get(self, "@events");
+  size_t rb_events_len = RARRAY_LEN(rb_events);
+
+  struct perf_state *state;
+  Data_Get_Struct(self, struct perf_state, state);
+  state->started = 1;
+  state->fds = xmalloc(sizeof(int) * rb_events_len);
+  state->ids = xmalloc(sizeof(uint64_t) * rb_events_len);
+
+  for (unsigned int i = 0; i < rb_events_len; i++) {
+    VALUE rb__events = rb_iv_get(self, "@__events");
+    // extract type, value
+    VALUE type = rb_ary_entry(rb__events, (i * 3) + 1);
+    VALUE config = rb_ary_entry(rb__events, (i * 3) + 2);
+
+    memset(&pe, 0, sizeof(struct perf_event_attr));
+    pe.type = NUM2INT(type);
+    pe.config = NUM2INT(config);
+    pe.size = sizeof(struct perf_event_attr);
+    pe.disabled = rb_iv_get(self, "@disabled") == Qtrue ? 1 : 0;
+    pe.exclude_kernel = rb_iv_get(self, "@exclude_kernel") == Qtrue ? 1 : 0;
+    pe.exclude_hv = rb_iv_get(self, "@exclude_hv") == Qtrue ? 1 : 0;
+    pe.read_format = PERF_FORMAT_GROUP | PERF_FORMAT_ID;
+
+    int current_fd;
+    if (i == 0) {
+      current_fd = perf_event_open(&pe, 0, -1, -1, 0);
+    } else {
+      current_fd = perf_event_open(&pe, 0, -1, LEADER(state->fds), 0);
+    }
+
+    if (current_fd == -1) {
+      state->started = 0;
+      xfree(state->fds);
+      xfree(state->ids);
+
+      rb_raise(rb_eArgError, "perf_event_open failed type=%d, config=%d. Check "
+                             "your Linux kernel's version source code to see "
+                             "if this event exists in "
+                             "'include/uapi/linux/perf_event.h'",
+               NUM2INT(type), NUM2INT(config));
+    }
+
+    state->fds[i] = current_fd;
+    RAISE_ON_ERROR(ioctl(current_fd, PERF_EVENT_IOC_ID, &state->ids[i]));
+  }
+
+  RAISE_ON_ERROR(
+      ioctl(LEADER(state->fds), PERF_EVENT_IOC_RESET, PERF_IOC_FLAG_GROUP));
+  RAISE_ON_ERROR(
+      ioctl(LEADER(state->fds), PERF_EVENT_IOC_ENABLE, PERF_IOC_FLAG_GROUP));
+
+  return Qtrue;
+}
+
+VALUE
+measurement_stop(VALUE self) {
+  struct perf_state *state;
+  Data_Get_Struct(self, struct perf_state, state);
+
+  if (!state->started) {
+    return Qnil;
+  }
+
+  VALUE rb_events = rb_iv_get(self, "@events");
+  size_t rb_events_len = RARRAY_LEN(rb_events);
+  // TODO: check the buffer size is ok
+  size_t buffer_size =
+      (sizeof(uint64_t) + (sizeof(uint64_t) * 2 * rb_events_len));
+  char buffer[buffer_size];
+  memset(buffer, 0, buffer_size);
+  struct read_format *rf = (struct read_format *)buffer;
+
+  RAISE_ON_ERROR(
+      ioctl(LEADER(state->fds), PERF_EVENT_IOC_DISABLE, PERF_IOC_FLAG_GROUP));
+  ssize_t read_bytes = read(LEADER(state->fds), buffer, sizeof(buffer));
+
+  for (unsigned int i = 0; i < rb_events_len; i++) {
+    close(state->fds[i]);
+  }
+  xfree(state->fds);
+  xfree(state->ids);
+
+  if (read_bytes == -1) {
+    rb_raise(rb_eArgError, "read of the performance counters failed");
+    return Qnil;
+  }
+
+  VALUE rb_array_result = rb_ary_new();
+
+  // Assuming here that the events are in the same order they are requested
+  for (unsigned int i = 0; i < rb_events_len; i++) {
+    rb_ary_push(rb_array_result, INT2NUM(rf->values[i].value));
+  }
+
+  state->started = 0;
+  return rb_array_result;
+}
+
+void Init_perf_counters(void) {
+  VALUE rb_mPerfCounters = rb_define_module("PerfCounters");
+
+  VALUE rb_Measurement =
+      rb_define_class_under(rb_mPerfCounters, "Measurement", rb_cObject);
+  rb_define_alloc_func(rb_Measurement, alloc_state);
+  rb_define_method(rb_Measurement, "__start", measurement_start, 0);
+  rb_define_method(rb_Measurement, "__stop", measurement_stop, 0);
+}

data/ext/perf_counters/perf_counters.h

@@ -0,0 +1,6 @@
+#ifndef PERF_COUNTERS_H
+#define PERF_COUNTERS_H 1
+
+#include "ruby.h"
+
+#endif /* PERF_COUNTERS_H */

data/lib/perf_counters.rb

@@ -0,0 +1,84 @@
+require 'perf_counters/version'
+require 'perf_counters/perf_counters'
+
+Counter = Struct.new(:name, :type, :value)
+
+module Event
+  # from linux's include/uapi/linux/perf_event.h
+
+  # `perf_type_id`
+  module Type
+    HARDWARE = 0
+    SOFTWARE = 1
+  end
+
+  # TODO: does this make more sense?
+  #
+  # class HWCounter < Counter
+  #   def initialize(name, value)
+  #     super(name, Type::HARDWARE, value)
+  #   end
+  # end
+
+  # `perf_hw_id`
+  CPU_CYCLES              = Counter.new(:cpu_cycles, Type::HARDWARE, 0)
+  INSTRUCTIONS            = Counter.new(:instructions, Type::HARDWARE, 1)
+  CACHE_REFERENCES        = Counter.new(:cache_references, Type::HARDWARE, 2)
+  CACHE_MISSES            = Counter.new(:cache_misses, Type::HARDWARE, 3)
+  BRANCH_INSTRUCTIONS     = Counter.new(:branch_instructions, Type::HARDWARE, 4)
+  BRANCH_MISSES           = Counter.new(:branch_misses, Type::HARDWARE, 5)
+  BUS_CYCLES              = Counter.new(:bus_cycles, Type::HARDWARE, 6)
+  STALLED_CYCLES_FRONTEND = Counter.new(:stalled_cycles_frontend, Type::HARDWARE, 7)
+  STALLED_CYCLES_BACKEND  = Counter.new(:stalled_cycles_backend, Type::HARDWARE, 8)
+  REF_CPU_CYCLES          = Counter.new(:ref_cpu_cycles, Type::HARDWARE, 9)
+
+  # `perf_sw_ids`
+  CPU_CLOCK         = Counter.new(:cpu_clock, Type::SOFTWARE, 0)
+  TASK_CLOCK        = Counter.new(:task_clock, Type::SOFTWARE, 1)
+  PAGE_FAULTS       = Counter.new(:page_faults, Type::SOFTWARE, 2)
+  CONTEXT_SWITCHES  = Counter.new(:context_switches, Type::SOFTWARE, 3)
+  CPU_MIGRATIONS    = Counter.new(:cpu_migrations, Type::SOFTWARE, 4)
+  PAGE_FAULTS_MIN   = Counter.new(:page_faults_min, Type::SOFTWARE, 5)
+  PAGE_FAULTS_MAJ   = Counter.new(:page_faults_maj, Type::SOFTWARE, 6)
+  ALIGNMENT_FAULTS  = Counter.new(:alignment_faults, Type::SOFTWARE, 7)
+  EMULATION_FAULTS  = Counter.new(:emulation_faults, Type::SOFTWARE, 8)
+  DUMMY             = Counter.new(:dummy, Type::SOFTWARE, 9)
+  BPF_OUTPUT        = Counter.new(:bpf_output, Type::SOFTWARE, 10)
+end
+
+module PerfCounters
+  class Measurement
+    attr_accessor :events, :exclude_kernel, :disabled, :exclude_hv
+
+    def initialize(events: [], exclude_kernel: true, disabled: true, exclude_hv: true)
+      @events = events
+
+      @exclude_kernel = exclude_kernel
+      @disabled = disabled
+      @exclude_hv = exclude_hv
+
+      @__events = @events.flat_map do |event|
+        [event.name, event.type, event.value]
+      end
+    end
+
+    def start
+      __start
+    end
+
+    def stop
+      return nil unless result_array = __stop
+
+      result_array.each_with_object({}).with_index do |(result, final), i|
+        final[events[i].name] = result
+      end
+    end
+  end
+
+  def self.measure(*args)
+    perf = PerfCounters::Measurement.new(*args)
+    perf.start
+    yield
+    perf.stop
+  end
+end

data/lib/perf_counters/available_perf_counters.rb

@@ -0,0 +1,19 @@
+module PerfCounters
+  module AvailableCounters
+    module Hardware
+      EVENTS_SYS_PATH = '/sys/bus/event_source/devices/cpu/events/'
+
+      class << self
+        def all
+          Dir
+            .entries(EVENTS_SYS_PATH)
+            .reject { |el| ['.', '..'].include?(el) }
+        end
+
+        def event(event_name)
+          File.read("#{EVENTS_SYS_PATH}#{event_name}")
+        end
+      end
+    end
+  end
+end

data/lib/perf_counters/version.rb

@@ -0,0 +1,3 @@
+module PerfCounters
+  VERSION = '0.1.0'.freeze
+end

data/perf_counters.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perf_counters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'perf_counters'
+  spec.version       = PerfCounters::VERSION
+  spec.authors       = ['Javier Honduvilla Coto']
+  spec.email         = ['javierhonduco@gmail.com']
+
+  spec.summary       = "Read the CPU's performance counters perf_event_open(2)"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/javierhonduco/ruby_perf_counters'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/perf_counters/extconf.rb']
+
+  spec.add_development_dependency 'benchmark-ips', '~> 2.7.2'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'kalibera'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: perf_counters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javier Honduvilla Coto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: kalibera
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Read the CPU's performance counters perf_event_open(2)
+email:
+- javierhonduco@gmail.com
+executables: []
+extensions:
+- ext/perf_counters/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/format_c
+- bin/setup
+- ext/perf_counters/extconf.rb
+- ext/perf_counters/perf_counters.c
+- ext/perf_counters/perf_counters.h
+- lib/perf_counters.rb
+- lib/perf_counters/available_perf_counters.rb
+- lib/perf_counters/version.rb
+- perf_counters.gemspec
+homepage: https://github.com/javierhonduco/ruby_perf_counters
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Read the CPU's performance counters perf_event_open(2)
+test_files: []