calleree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbb6acebd17bc68a5547ccd29c14e41a359aec189a08dbdeca7ab19088a00a8e
+  data.tar.gz: 7e364534c22b4d4d6184fba2dc472939bb578b379fe508d1292e538f27391383
+SHA512:
+  metadata.gz: 0a1be7bce4337c46c1bb6e45c1dc62d8801379a07167b0784dfa5c36e0595e5fd2bbcf939b27ca7e6ba41f006f6a6b3a31807f52a5d67861fb9ad314903ec209
+  data.tar.gz: c5c6695fe51447599341bb541a903964380e1b6f1579856101739d14a6e6443fb04f4accd7859ef7d12ca2b8146989507475984ae7bd428cc27d05427b65a4fb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in calleree.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rake-compiler"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Koichi Sasada
+
+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,70 @@
+# Calleree
+
+Calleree helps to analyze Ruby's caller-callee relationships.
+Note that this tool consumes memory and introduces additional overhead because of dynamic analysis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'calleree'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install calleree
+
+## Usage
+
+```ruby
+     1
+     2  require 'calleree'
+     3
+     4  def foo
+     5    :foo
+     6  end
+     7
+     8  def bar
+     9    foo
+    10  end
+    11
+    12  Calleree.start
+    13
+    14  foo
+    15
+    16  pp Calleree.result
+```
+
+And this program shows:
+
+```
+[[["test.rb", 14], ["test.rb", 5], 1],
+ [["test.rb", 16], ["/mnt/c/ko1/src/rb/calleree/lib/calleree.rb", 24], 1]]
+...
+
+The `Calleree.result` method returns an array of arrays which contains `[[caller_path, caller_line], [callee_path, callee_line], called_caount]`.
+
+In this case, `foo` at `["test.rb", 5]` is called at `["test.rb", 14]` only once.
+
+* You can stop the analisys with `Calleree.stop`. `Calleree.start` will continue the analysis.
+* You can use block with `Calleree.start do ... end`.
+* You can clear the result if `Calleree.result(clear: true)` is passed.
+
+## 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/ko1/calleree.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,27 @@
+require_relative 'lib/calleree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "calleree"
+  spec.version       = Calleree::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+
+  spec.summary       = %q{Calleree helps to analyze Ruby's caller-callee relationships.}
+  spec.description   = %q{Calleree helps to analyze Ruby's caller-callee relationships.}
+  spec.homepage      = "https://github.com/ko1/calleree"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ko1/calleree"
+
+  # 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/calleree/extconf.rb"]
+end

data/ext/calleree/calleree.c

@@ -0,0 +1,112 @@
+#include "ruby/ruby.h"
+#include "ruby/debug.h"
+#include "ruby/st.h"
+
+VALUE rb_mCalleree;
+
+struct eree_data {
+    VALUE tp; // TracePoint.new(:call)
+    VALUE files; // name -> [ {[fname, 1], ... } ]
+    struct st_table* caller_callee;  // [posnum | posnum] -> cnt
+    int last_posnum;
+} eree_data;
+
+static int
+posnum(struct eree_data *data, VALUE path, int line)
+{
+    VALUE lines, posnumv;
+
+    if (NIL_P(lines = rb_hash_aref(data->files, path))) {
+        rb_hash_aset(data->files, path, lines = rb_ary_new());
+    }
+    if (NIL_P(posnumv = rb_ary_entry(lines, line))) {
+        rb_ary_store(lines, line, posnumv = INT2FIX(data->last_posnum++));
+    }
+    return FIX2INT(posnumv);
+}
+
+static int
+increment_i(st_data_t *key, st_data_t *value, st_data_t arg, int existing)
+{
+    *value = (existing ? *value : 0) + 1;
+    return ST_CONTINUE;
+}
+
+static void
+erree_called(VALUE tpval, void *ptr)
+{
+    struct eree_data *data = ptr;
+    VALUE frames[2];
+    int lines[2];
+    // int start, int limit, VALUE *buff, int *lines);
+    rb_profile_frames(1, 2, frames, lines);
+    int callee_posnum = posnum(data, rb_profile_frame_path(frames[0]), lines[0]);
+    int caller_posnum = posnum(data, rb_profile_frame_path(frames[1]), lines[1]);
+    // rb_p(rb_profile_frame_path(frames[1]));
+    st_data_t eree_pair = (((VALUE)caller_posnum << 32) | ((VALUE)callee_posnum));
+
+    st_update(data->caller_callee, eree_pair, increment_i, 0);
+}
+
+static VALUE
+eree_start(VALUE self)
+{
+    if (!eree_data.tp) {
+        eree_data.tp = rb_tracepoint_new(0, RUBY_EVENT_CALL, erree_called, &eree_data);
+        eree_data.caller_callee = st_init_numtable();
+    }
+    rb_tracepoint_enable(eree_data.tp);
+    return self;
+}
+
+static VALUE
+eree_stop(VALUE self)
+{
+    if (eree_data.tp) {
+        rb_tracepoint_disable(eree_data.tp);
+    }
+    return self;
+}
+
+static int
+raw_result_i(st_data_t key, st_data_t val, st_data_t data)
+{
+    VALUE ary = (VALUE)data;
+    int callee_posnum = (int)(key & 0xffffffff);
+    int caller_posnum = (int)(key >> 32);
+    rb_ary_push(ary, rb_ary_new_from_args(3, INT2FIX(caller_posnum), INT2FIX(callee_posnum), INT2FIX((int)val)));
+    return ST_CONTINUE;
+}
+
+static VALUE
+eree_raw_result(VALUE self, VALUE clear_p)
+{
+    VALUE ary = rb_ary_new();
+    if (eree_data.tp) {
+        st_foreach(eree_data.caller_callee, raw_result_i, (st_data_t)ary);
+
+        if (RTEST(clear_p)) {
+            st_clear(eree_data.caller_callee);
+        }
+    }
+    return ary;
+}
+
+static VALUE
+eree_raw_posmap(VALUE self)
+{
+    return eree_data.files;
+}
+
+void
+Init_calleree(void)
+{
+    eree_data.files = rb_hash_new();
+    rb_gc_register_mark_object(eree_data.files);
+
+    rb_mCalleree = rb_define_module("Calleree");
+    rb_define_singleton_method(rb_mCalleree, "_start", eree_start, 0);
+    rb_define_singleton_method(rb_mCalleree, "_stop", eree_stop, 0);
+    rb_define_singleton_method(rb_mCalleree, "raw_result", eree_raw_result, 1);
+    rb_define_singleton_method(rb_mCalleree, "raw_posmap", eree_raw_posmap, 0);
+}

data/ext/calleree/calleree.h

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

data/ext/calleree/extconf.rb

@@ -0,0 +1,8 @@
+require "mkmf"
+require 'rbconfig/sizeof'
+
+unless RbConfig::LIMITS['SIZE_MAX'] == 2**64 - 1
+  raise "This library is only work on 64bit CPU."
+end
+
+create_makefile("calleree/calleree")

data/lib/calleree.rb

@@ -0,0 +1,38 @@
+require "calleree/version"
+require "calleree/calleree"
+
+module Calleree
+  def self.start
+    if block_given?
+      begin
+        Calleree._start
+        yield
+      ensure
+        Calleree._stop
+      end
+    else
+      Calleree._start
+    end
+  end
+
+  def self.stop
+    Calleree._stop
+  end
+
+  def self.result clear: false
+    posnum_set = []
+    Calleree.raw_posmap.each{|file, lines|
+      lines.each_with_index{|posnum, line|
+        posnum_set[posnum] = [file, line] if posnum
+      }
+    }
+    # pp posnum_set
+    rs = []
+    Calleree.raw_result(clear).each{|i, j, cnt|
+      er = posnum_set[i]
+      ee = posnum_set[j]
+      rs << [er, ee, cnt] if er && ee
+    }
+    rs
+  end
+end

data/lib/calleree/version.rb

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: calleree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-17 00:00:00.000000000 Z
+dependencies: []
+description: Calleree helps to analyze Ruby's caller-callee relationships.
+email:
+- ko1@atdot.net
+executables: []
+extensions:
+- ext/calleree/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- calleree.gemspec
+- ext/calleree/calleree.c
+- ext/calleree/calleree.h
+- ext/calleree/extconf.rb
+- lib/calleree.rb
+- lib/calleree/version.rb
+homepage: https://github.com/ko1/calleree
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ko1/calleree
+  source_code_uri: https://github.com/ko1/calleree
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Calleree helps to analyze Ruby's caller-callee relationships.
+test_files: []