tacho 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 649ae475b526cb6a76fec040c7ba1f1519a1035a980eecc51b3b57fb593ca950
+  data.tar.gz: d16cce60864b220c7b376dd4248f35cce5584f56332cd716d3db9ad0943b76e4
+SHA512:
+  metadata.gz: 6eaea8985e1dcbdb92156fe6ef0655978a94a960a3ebb119c91ddd769e9ecb0f042d39b48956c17dd64ca1d38c94dbbb569174a1758160b9ab93d377a24d0316
+  data.tar.gz: 7587dd2b0b9a843981cf083ba38abb54529e2c890906cb2d5b3114a4155a98046b24d875c9c5573919bb7c6febc01904cf788161519db8764466d6d19f596cfa

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

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 tacho.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    tacho (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    rake-compiler (1.0.7)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rake-compiler
+  tacho!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,49 @@
+# Tacho
+
+Profiles ruby code and generates profiles that can be read by the tacho viewer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tacho'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tacho
+
+## Usage
+
+Surround the code to be profiled like so:
+
+```ruby
+profile = Tacho.start 'some_Name'
+some_code()
+profile.stop
+```
+
+This will generate a file in `./tachometer/<timestamp>.tch` which can be read by the viewer
+
+## 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 tags, 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/divanburger/tacho. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tacho project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/divanburger/tacho/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+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("tacho") do |ext|
+  ext.lib_dir = "lib/tacho"
+end
+
+task :default => [:clobber, :compile, :test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tacho"
+
+# 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/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/tacho/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("tacho/tacho")

data/ext/tacho/tacho.c

@@ -0,0 +1,176 @@
+#include "tacho.h"
+
+#include <ruby/ruby.h>
+#include <ruby/debug.h>
+
+static inline void write_header(tch_profile* profile, char type, uint64_t time) {
+    uint64_t c = ((time - profile->start_time) << 8) | type;
+    fwrite(&c, sizeof(uint64_t), 1, profile->output);
+}
+
+static void tacho_event(VALUE tpval, void *data) {
+    tch_profile* profile = (tch_profile*)data;
+
+    struct timespec time;
+    uint64_t itime;
+
+    VALUE path;
+    VALUE method_id;
+    const char* method_name;
+    int method_length;
+
+    int   file_len;
+    char* file_str;
+    int   cur_len;
+    char* cur_str;
+    int i;
+
+    tch_call_body call_body;
+
+    rb_trace_arg_t* trace_arg;
+    rb_event_flag_t event_flag;
+
+    trace_arg = rb_tracearg_from_tracepoint(tpval);
+    event_flag = rb_tracearg_event_flag(trace_arg);
+
+    clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &time);
+    itime = (long)time.tv_sec * 1000000000 + (long)time.tv_nsec;
+
+    if (event_flag == RUBY_EVENT_CALL) {
+        write_header(profile, 'C', itime);
+        call_body.line_no = FIX2INT(rb_tracearg_lineno(trace_arg));
+
+        path = rb_tracearg_path(trace_arg);
+
+        method_id = SYM2ID(rb_tracearg_method_id(trace_arg));
+
+        method_name = rb_id2name(method_id);
+        method_length = strlen(method_name);
+
+        cur_len = file_len = (int)RSTRING_LEN(path);
+        cur_str = file_str = RSTRING_PTR(path);
+
+        for (i = 0; i < file_len && i < profile->buffer_count; i++) {
+            if (*cur_str != profile->buffer[i]) break;
+            cur_len--;
+            cur_str++;
+        }
+
+        profile->buffer_count = file_len;
+        memcpy(profile->buffer, file_str, file_len);
+
+        call_body.method_name_length = method_length;
+        call_body.filename_offset = file_len - cur_len;
+        call_body.filename_length = cur_len;
+        fwrite(&call_body, CALL_BODY_BYTES, 1, profile->output);
+        fwrite(method_name, call_body.method_name_length, 1, profile->output);
+        fwrite(cur_str, call_body.filename_length, 1, profile->output);
+    } else if (event_flag == RUBY_EVENT_RETURN) {
+        write_header(profile, 'R', itime);
+    }
+}
+
+VALUE rb_mTacho;
+VALUE rb_cTachoProfile;
+
+static tch_profile* tch_profile_get_profile(VALUE self) {
+    return (tch_profile*)RDATA(self)->data;
+}
+
+static size_t tch_profile_size(const void* data) {
+	return sizeof(tch_profile);
+}
+
+static void tch_profile_mark(void* data)
+{
+	rb_gc_mark(((tch_profile*)data)->tracepoint);
+}
+
+static const rb_data_type_t tch_profile_type = {
+	.wrap_struct_name = "tacho_profile",
+	.function = {
+		.dfree = RUBY_DEFAULT_FREE,
+		.dsize = tch_profile_size,
+		.dmark = tch_profile_mark,
+	},
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+static VALUE tch_profile_allocate(VALUE self) {
+    tch_profile* profile;
+    return TypedData_Make_Struct(self, tch_profile, &tch_profile_type, profile);
+}
+
+static VALUE tch_profile_initialize(VALUE self) {
+    tch_profile* profile = tch_profile_get_profile(self);
+    profile->recording = 0;
+    return self;
+}
+
+static VALUE tch_profile_start(VALUE self, VALUE filename, VALUE name) {
+    tch_profile* profile = tch_profile_get_profile(self);
+
+    struct timespec time;
+    uint32_t name_length;
+
+    profile->output = fopen(StringValueCStr(filename), "wb");
+    profile->buffer_count = 0;
+
+    if (!profile->output) {
+        rb_raise(rb_eRuntimeError, "Could not open file %s", StringValueCStr(filename));
+        RB_GC_GUARD(filename);
+        return Qnil;
+    }
+    RB_GC_GUARD(filename);
+
+    profile->recording = 1;
+
+    clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &time);
+    profile->start_time = (long)time.tv_sec * 1000000000 + (long)time.tv_nsec;
+    write_header(profile, 'S', profile->start_time);
+
+    name_length = (uint32_t)RSTRING_LEN(name);
+    fwrite(&name_length, sizeof(uint32_t), 1, profile->output);
+    fwrite(RSTRING_PTR(name), name_length, 1, profile->output);
+    RB_GC_GUARD(name);
+
+    profile->tracepoint = rb_tracepoint_new(Qnil, RUBY_EVENT_CALL | RUBY_EVENT_RETURN, tacho_event, profile);
+    rb_tracepoint_enable(profile->tracepoint);
+
+    return Qnil;
+}
+
+static VALUE tch_profile_stop(VALUE self) {
+    tch_profile* profile = tch_profile_get_profile(self);
+
+    struct timespec time;
+    uint64_t itime;
+
+    if (profile->recording) {
+        clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &time);
+        itime = (long)time.tv_sec * 1000000000 + (long)time.tv_nsec;
+        write_header(profile, 'F', itime);
+
+        fflush(profile->output);
+        fclose(profile->output);
+
+        rb_tracepoint_disable(profile->tracepoint);
+
+        profile->recording = 0;
+    } else {
+        rb_raise(rb_eRuntimeError, "Not currently recording");
+    }
+
+    return Qnil;
+}
+
+void
+Init_tacho(void) {
+    rb_mTacho = rb_define_module("Tacho");
+
+    rb_cTachoProfile = rb_define_class_under(rb_mTacho, "Profile", rb_cObject);
+	rb_define_alloc_func(rb_cTachoProfile, tch_profile_allocate);
+	rb_define_method(rb_cTachoProfile, "initialize", tch_profile_initialize, 0);
+    rb_define_method(rb_cTachoProfile, "start", tch_profile_start, 2);
+    rb_define_method(rb_cTachoProfile, "stop", tch_profile_stop, 0);
+}

data/ext/tacho/tacho.h

@@ -0,0 +1,26 @@
+#ifndef TACHOMETER_H
+#define TACHOMETER_H 1
+
+#include "ruby.h"
+#include <time.h>
+#include <stdint.h>
+
+typedef struct {
+    uint32_t line_no;
+    uint16_t method_name_length;
+    uint16_t filename_offset;
+    uint16_t filename_length;
+} tch_call_body;
+#define CALL_BODY_BYTES 10
+
+typedef struct {
+    VALUE    tracepoint;
+
+    int      recording;
+    FILE*    output;
+    uint64_t start_time;
+    int64_t  buffer_count;
+    char     buffer[4096];
+} tch_profile;
+
+#endif /* TACHOMETER_H */

data/lib/tacho.rb

@@ -0,0 +1,14 @@
+require "tacho/version"
+require "tacho/tacho"
+require "tacho/middleware"
+
+module Tacho
+  class Error < StandardError;
+  end
+
+  def self.start(name = '')
+    profile = Profile.new()
+    profile.start("tacho/#{Time.now.strftime("%Y%m%d_%H%M%S_%N")}.tch", name)
+    return profile
+  end
+end

data/lib/tacho/middleware.rb

@@ -0,0 +1,14 @@
+module Tacho
+  class Middleware
+    def initialize app
+      @app = app
+    end
+
+    def call(env)
+      Tacho.enable
+      response = @app.call(env)
+      Tacho.disable
+      response
+    end
+  end
+end

data/lib/tacho/version.rb

@@ -0,0 +1,3 @@
+module Tacho
+  VERSION = "0.1.0"
+end

data/tacho.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tacho/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tacho"
+  spec.version       = Tacho::VERSION
+  spec.authors       = ["Divan Burger"]
+  spec.email         = ["divan@labs.epiuse.com"]
+
+  spec.summary       = %q{Records performance data and displays it.}
+  spec.homepage      = "https://github.com/divanburger/tacho"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/divanburger/tacho"
+    spec.metadata["changelog_uri"] = "https://github.com/divanburger/tacho/blob/master/README.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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/tacho/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: tacho
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Divan Burger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !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'
+description: 
+email:
+- divan@labs.epiuse.com
+executables: []
+extensions:
+- ext/tacho/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/tacho/extconf.rb
+- ext/tacho/tacho.c
+- ext/tacho/tacho.h
+- lib/tacho.rb
+- lib/tacho/middleware.rb
+- lib/tacho/version.rb
+- tacho.gemspec
+homepage: https://github.com/divanburger/tacho
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/divanburger/tacho
+  source_code_uri: https://github.com/divanburger/tacho
+  changelog_uri: https://github.com/divanburger/tacho/blob/master/README.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Records performance data and displays it.
+test_files: []