rbkit 0.0.1

data/ext/rbkit_tracer.h

@@ -0,0 +1,35 @@
+#ifndef RBKIT_TRACER_H
+#define RBKIT_TRACER_H
+
+#include "ruby/ruby.h"
+#include "ruby/debug.h"
+#include <stdio.h>
+#include <assert.h>
+#include "zmq.h"
+#include "msgpack.h"
+
+// Structure is used to store profiling data
+struct gc_hooks {
+  VALUE hooks[3];
+  VALUE enabled;
+  void (*funcs[3])(void *data, int event_index);
+  void *args[3];
+  void *data;
+  st_table *object_table;
+  st_table *str_table;
+  VALUE newobj_trace;
+  VALUE freeobj_trace;
+  int keep_remains;
+  msgpack_sbuffer *sbuf;
+  msgpack_packer *msgpacker;
+};
+
+char * tracer_string_recv(void *socket);
+int tracer_string_send(void *socket, const char *message);
+void pack_value_object(msgpack_packer *packer, VALUE value);
+void pack_string(msgpack_packer *packer, char *string);
+void pack_timestamp(msgpack_packer *packer);
+void pack_event_header(msgpack_packer *packer, const char *event_type, int map_size);
+void pack_pointer(msgpack_packer *packer, VALUE object_id);
+
+#endif

data/lib/rbkit.rb

@@ -0,0 +1,101 @@
+require "rbkit_tracer"
+require "rbkit/timer"
+require "objspace"
+
+# Class implements user friendly interface in pure Ruby for profiler.
+module Rbkit
+  class Profiler
+    attr_accessor :pub_port, :request_port
+
+    def initialize(pub_port, request_port)
+      @pub_port = pub_port
+      @request_port = request_port
+      @profiler_thread = nil
+      @stop_thread = false
+      @server_running = false
+      @gc_stats_timer = Rbkit::Timer.new(5) do
+        data = GC.stat
+        no_of_allocated_pages = data[:heap_length]
+        max_objects_per_page = GC::INTERNAL_CONSTANTS[:HEAP_OBJ_LIMIT]
+        size_of_one_obj = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+        data[:total_heap_size] = no_of_allocated_pages * max_objects_per_page *
+          size_of_one_obj
+        data[:total_memsize] = ObjectSpace.memsize_of_all
+        Rbkit.send_hash_as_event(data, "gc_stats")
+      end
+      @message_dispatch_timer = Rbkit::Timer.new(1) do
+        Rbkit.send_messages
+      end
+    end
+
+    def start_server(enable_profiling: false)
+      return if @server_running
+      @profiler_thread = Thread.new do
+        Rbkit.start_stat_server(pub_port, request_port)
+        Rbkit.start_stat_tracing if enable_profiling
+        loop do
+          break if @stop_thread
+          incoming_request = Rbkit.poll_for_request
+          process_incoming_request(incoming_request)
+          @gc_stats_timer.run
+          @message_dispatch_timer.run
+          # Let us sleep this thread for a bit, so as other things can run.
+          sleep(0.05)
+        end
+      end
+      @server_running = true
+    end
+
+    def process_incoming_request(incoming_request)
+      case incoming_request
+      when "start_memory_profile"
+        Rbkit.start_stat_tracing
+      when "stop_memory_profile"
+        Rbkit.stop_stat_tracing
+      when "trigger_gc"
+        GC.start
+      when "objectspace_snapshot"
+        Rbkit.send_objectspace_dump
+      end
+    end
+
+    def stop_server
+      return if !@server_running
+      Rbkit.stop_stat_server
+      @server_running = false
+    end
+
+    def make_clean_exit
+      @stop_thread = true
+      stop_server
+    end
+  end
+
+  ########### Rbkit API ###########
+
+  # Starts the server and enables memory profiling tracepoints
+  def self.start_profiling(pub_port = nil, request_port = nil)
+    @profiler = Rbkit::Profiler.new(pub_port, request_port)
+    @profiler.start_server(enable_profiling: true)
+    at_exit do
+      self.stop_server
+    end
+  end
+
+  # Just starts the server and waits for instructions.
+  # The client needs to connect to the request_port and send
+  # commands over the wire. The client also needs to connect
+  # to the pub_port and subscribe to the responses from the server.
+  def self.start_server(pub_port = nil, request_port = nil)
+    @profiler = Rbkit::Profiler.new(pub_port, request_port)
+    @profiler.start_server
+    at_exit do
+      self.stop_server
+    end
+  end
+
+  # Stops profiling and brings down the rbkit server if it's running
+  def self.stop_server
+    @profiler.make_clean_exit
+  end
+end

data/lib/rbkit/timer.rb

@@ -0,0 +1,18 @@
+module Rbkit
+  class Timer
+    attr_accessor :last_fired_at, :interval
+
+    def initialize(interval, &timer_block)
+      @interval = interval
+      @timer_block = timer_block
+      @last_fired_at = Time.now
+    end
+
+    def run
+      if Time.now - last_fired_at > interval
+        @timer_block.call
+        @last_fired_at = Time.now
+      end
+    end
+  end
+end

data/lib/rbkit/version.rb

@@ -0,0 +1,3 @@
+module Rbkit
+  VERSION = "0.0.1"
+end

data/rbkit.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+GEM_NAME = "rbkit"
+
+lib = File.expand_path("../lib", __FILE__)
+$: << lib unless $:.include?(lib)
+
+require "rbkit/version"
+
+Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = Rbkit::VERSION
+
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new(">= 0")
+  end
+  s.authors = ["Hemant Kumar", "Emil Soman", "Kashyap"]
+  s.description = %q{Something small for process management}
+  s.email = %q{hemant@codemancers.com emil@codemancers.com kashyap@codemancers.com}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.extensions = 'ext/extconf.rb'
+  s.require_paths = ["lib"]
+
+  s.homepage = %q{http://rbkit.codemancers.com}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.summary = %q{Ruby profiler for rest of us}
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("simplecov")
+end

data/schema/tracing_info.md

@@ -0,0 +1,8 @@
+## How we send tracing information ##
+
+1. For now Tracing information is sent via simple strings like:
+
+        obj_created <klass_name> <object_id_in_hex>
+        obj_destroyed <klass_name> <object_id_in_hex>
+        gc_start
+        gc_end_s

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "pry"
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rbkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hemant Kumar
+- Emil Soman
+- Kashyap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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: simplecov
+  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: Something small for process management
+email: hemant@codemancers.com emil@codemancers.com kashyap@codemancers.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- docs/debugging.md
+- docs/design.md
+- experiments/benchmark.rb
+- experiments/mspack_to_file.rb
+- experiments/no_growth.rb
+- experiments/object_dump.rb
+- experiments/rbkit_client.rb
+- experiments/rbkit_command_test.rb
+- experiments/using_new_client.rb
+- experiments/using_object_tracer.rb
+- experiments/using_rbkit.rb
+- experiments/zmq_client.rb
+- experiments/zmq_server.rb
+- ext/extconf.rb
+- ext/rbkit_message_aggregator.c
+- ext/rbkit_message_aggregator.h
+- ext/rbkit_object_graph.c
+- ext/rbkit_object_graph.h
+- ext/rbkit_tracer.c
+- ext/rbkit_tracer.h
+- lib/rbkit.rb
+- lib/rbkit/timer.rb
+- lib/rbkit/version.rb
+- rbkit.gemspec
+- schema/tracing_info.md
+- spec/spec_helper.rb
+homepage: http://rbkit.codemancers.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby profiler for rest of us
+test_files:
+- spec/spec_helper.rb