fast_stack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25593572df6635a6ab1e50009f6e20617dcf345d
-  data.tar.gz: e1c7839628489bc0cc1dceb044b82c7a46493bf9
+  metadata.gz: 5379c5d5a7c8876efd6c43433644a7d88454afce
+  data.tar.gz: 5446ba4ccea259eae6264339aab38f0e72b54f74
 SHA512:
-  metadata.gz: 82b33efbffe61e59052b109eb848697dfada7cac792f871a138c6ff83f3ca1461b4b2f47b59a4d342743e5b32a380d5db8fd524ad5ba35e2bcde4c4870310c0b
-  data.tar.gz: 910abe7607c9e1c96ee7444e3a2e9f83c4d88b693385416bed5088a71b84e2d423bfd2faaf19065e173b9a6fc445a0d76d07070be483b00867747e0704742425
+  metadata.gz: a92d6aefd51e5effae3d804934218e6c3f74a71d3f8268792f44a2a2722d3b6f1639a873111ff31c532b8ae03b4e7aac94650decea798fe060e5070e4b6c2d41
+  data.tar.gz: d350f9fd8154e9d78f6934b687fbefd975706788b723266bff4bffa4469c01ab3e32fb615bc101bd4ec41bd4a03ebda9a10b68737760a6e2079e51d36b059bf4

data/MIT-LICENSE

@@ -1,21 +1,21 @@
-Copyright (c) 2006-2009 Steve Sloan
-
-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.
-
+Copyright (c) 2006-2009 Steve Sloan
+
+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

@@ -1,37 +1,32 @@
-### Fast stack
-
-Very efficient collection of ruby backtraces, even under heavy CPU load
-
-### How do you use it?
-
-    require 'fast_stack'
-
-### Usage
-
-
-```
-  def fib( n )
-    return  n  if ( 0..1 ).include? n
-    ( fib( n - 1 ) + fib( n - 2 ) )
-  end
-
-  stacks = FastStack.profile do
-    fib(30)
-  end
-
-  puts stacks.count
-  # 30
-
-```
-
-### Changelog
-
-0.1.0 - 17-Sep - Bugfix - deep callstacks could lead to an infinite loop
-
-### Notes
-
-This technique was conceived by https://github.com/tmm1 , big thank you.
-
-Ruby 2.0 uses #backtrace_locations, 1.9.3 uses #backtrace
-
-(gem template based on https://github.com/CodeMonkeySteve/fast_xor )
+# Fast stack [![Build Status](https://travis-ci.org/SamSaffron/fast_stack.svg?branch=master)](https://travis-ci.org/SamSaffron/fast_stack)
+
+Very efficient collection of ruby backtraces, even under heavy CPU load
+
+### How do you use it?
+
+```ruby
+require 'fast_stack'
+```
+
+### Usage
+
+```ruby
+def fib( n )
+  return  n  if ( 0..1 ).include? n
+  ( fib( n - 1 ) + fib( n - 2 ) )
+end
+
+stacks = FastStack.profile do
+  fib(30)
+end
+
+puts stacks.count # => 30
+```
+
+### Notes
+
+This technique was conceived by https://github.com/tmm1 , big thank you.
+
+Ruby 2.0 uses #backtrace_locations, 1.9.3 uses #backtrace
+
+(gem template based on https://github.com/CodeMonkeySteve/fast_xor )

data/ext/fast_stack/extconf.rb

@@ -1,8 +1,13 @@
-require 'mkmf'
-require 'rbconfig'
-require 'fileutils'
-
-# work around ruby 2.0 p0 bug
-FileUtils.mkdir_p(File.expand_path('../../../lib/fast_stack',__FILE__))
-
-create_makefile('fast_stack/fast_stack')
+require 'mkmf'
+require 'rbconfig'
+require 'fileutils'
+
+# work around ruby 2.0 p0 bug
+FileUtils.mkdir_p(File.expand_path('../../../lib/fast_stack',__FILE__))
+
+have_func('backtrace_symbols_fd')
+have_func('CreateTimerQueueTimer')
+have_library('winmm', 'timeBeginPeriod')
+
+
+create_makefile('fast_stack/fast_stack')

data/ext/fast_stack/fast_stack.c

@@ -1,46 +1,12 @@
-#include <stdio.h>
-#include <sys/time.h>
-#include <ruby.h>
-#include <ruby/encoding.h>
-
-static VALUE
-rb_profile_start(VALUE module, VALUE usec)
-{
-    struct itimerval timer;
-    timer.it_interval.tv_sec = 0;
-    timer.it_interval.tv_usec = (suseconds_t)NUM2LONG(usec);
-    timer.it_value = timer.it_interval;
-    setitimer(ITIMER_REAL, &timer, 0);
-
-    return Qnil;
-}
-
-static VALUE
-rb_profile_stop(VALUE module)
-{
-    struct itimerval timer;
-    memset(&timer, 0, sizeof(timer));
-    setitimer(ITIMER_REAL, &timer, 0);
-
-    return Qnil;
-}
-
-static VALUE
-rb_profile_block(VALUE module, VALUE usec)
-{
-    rb_need_block();
-
-    rb_profile_start(module, usec);
-    rb_yield(Qundef);
-    rb_profile_stop(module);
-
-    return Qnil;
-}
-
-void Init_fast_stack( void )
-{
-  VALUE rb_mFastStack = rb_define_module("FastStack");
-  rb_define_module_function(rb_mFastStack, "profile_block", rb_profile_block, 1);
-  rb_define_module_function(rb_mFastStack, "stop", rb_profile_stop, 0);
-  rb_define_module_function(rb_mFastStack, "start", rb_profile_start, 1);
-}
+#include "fast_stack.h"
+
+void Init_fast_stack( void )
+{
+  VALUE rb_mFastStack = rb_define_module("FastStack");
+  rb_define_module_function(rb_mFastStack, "start", rb_profile_start, 1);
+  rb_define_module_function(rb_mFastStack, "stop", rb_profile_stop, 0);
+  rb_define_module_function(rb_mFastStack, "signal", rb_profile_signal, 0);
+
+  rb_define_module_function(rb_mFastStack, "start_native", rb_profile_start_native, 2);
+  rb_define_module_function(rb_mFastStack, "stop_native", rb_profile_stop_native, 0);
+}

data/ext/fast_stack/fast_stack.h

@@ -0,0 +1,13 @@
+#ifndef FAST_STACK_H__
+#define FAST_STACK_H__
+
+#include <ruby.h>
+#include <ruby/encoding.h>
+
+VALUE rb_profile_start_native(VALUE module, VALUE usec, VALUE fd);
+VALUE rb_profile_stop_native(VALUE module);
+VALUE rb_profile_start(VALUE module, VALUE usec);
+VALUE rb_profile_stop(VALUE module);
+VALUE rb_profile_signal(VALUE module);
+
+#endif

data/ext/fast_stack/fast_stack_linux.c

@@ -0,0 +1,87 @@
+#ifdef HAVE_BACKTRACE_SYMBOLS_FD
+
+#include <stdio.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <sys/time.h>
+#include <sys/types.h>
+#include <signal.h>
+#include <execinfo.h>
+
+#include "fast_stack.h"
+
+struct sigaction old_alrm;
+int backtrace_fd;
+
+static void alrm_handler(int signum)
+{
+   static void *trace[2048];
+   int n = backtrace(trace, 2048);
+
+   if(n>2){
+       backtrace_symbols_fd(trace + sizeof(void*)*2 , n-2, backtrace_fd);
+       write(backtrace_fd, "__SEP__\n", 8);
+   }
+}
+
+VALUE rb_profile_start_native(VALUE module, VALUE usec, VALUE fd)
+{
+    struct itimerval timer;
+    struct sigaction sa;
+
+    backtrace_fd = NUM2INT(fd);
+    sigaction(SIGALRM, NULL, &old_alrm);
+
+    memset(&sa, 0, sizeof(sa));
+    sa.sa_handler = alrm_handler;
+    sigemptyset(&sa.sa_mask);
+    sigaction(SIGALRM, &sa, NULL);
+
+    timer.it_interval.tv_sec = 0;
+    timer.it_interval.tv_usec = (suseconds_t)NUM2LONG(usec);
+    timer.it_value = timer.it_interval;
+    setitimer(ITIMER_REAL, &timer, 0);
+
+    return Qnil;
+}
+
+
+VALUE rb_profile_stop_native(VALUE module)
+{
+    struct itimerval timer;
+
+    sigaction(SIGALRM, &old_alrm, NULL);
+
+    memset(&timer, 0, sizeof(timer));
+    setitimer(ITIMER_REAL, &timer, 0);
+
+    return Qnil;
+}
+
+VALUE rb_profile_start(VALUE module, VALUE usec)
+{
+    struct itimerval timer;
+
+    timer.it_interval.tv_sec = 0;
+    timer.it_interval.tv_usec = (suseconds_t)NUM2LONG(usec);
+    timer.it_value = timer.it_interval;
+    setitimer(ITIMER_REAL, &timer, 0);
+
+    return Qnil;
+}
+
+VALUE rb_profile_stop(VALUE module)
+{
+    struct itimerval timer;
+    memset(&timer, 0, sizeof(timer));
+    setitimer(ITIMER_REAL, &timer, 0);
+
+    return Qnil;
+}
+
+VALUE rb_profile_signal(VALUE module)
+{
+    return rb_str_new_cstr("ALRM");
+}
+
+#endif // HAVE_BACKTRACE_SYMBOLS_FD

data/ext/fast_stack/fast_stack_windows.c

@@ -0,0 +1,58 @@
+#ifdef HAVE_CREATETIMERQUEUETIMER
+
+#include "fast_stack.h"
+
+static VALUE handler_proc;
+static HANDLE timer = NULL;
+
+VALUE rb_profile_start_native(VALUE module, VALUE usec, VALUE fd)
+{
+    rb_raise(rb_eNotImpError, "Not implemented on Windows");
+    return Qnil;
+}
+
+VALUE rb_profile_stop_native(VALUE module)
+{
+    rb_raise(rb_eNotImpError, "Not implemented on Windows");
+    return Qnil;
+}
+
+static void CALLBACK timer_handler(void* handler, BOOLEAN from_timer)
+{
+    raise(SIGINT);
+}
+
+VALUE rb_profile_start(VALUE module, VALUE usec)
+{
+    DWORD interval;
+
+    interval = NUM2LONG(usec) / 1000; /* Windows resolution is in milliseconds */
+
+    timeBeginPeriod(1);
+    if (!CreateTimerQueueTimer(&timer, NULL, &timer_handler, (void*)handler_proc,
+        interval, interval, WT_EXECUTEDEFAULT))
+    {
+        rb_raise(rb_eRuntimeError, "Cannot start timer: %d", GetLastError());
+    }
+
+    return Qnil;
+}
+
+VALUE rb_profile_stop(VALUE module)
+{
+    if (timer)
+    {
+        DeleteTimerQueueTimer(NULL, timer, NULL);
+        timer = NULL;
+    }
+    timeEndPeriod(1);
+
+    return Qnil;
+}
+
+VALUE rb_profile_signal(VALUE module)
+{
+    return rb_str_new_cstr("INT");
+}
+
+#endif // HAVE_CREATETIMERQUEUETIMER

data/lib/fast_stack.rb

@@ -1,26 +1,142 @@
-require 'fast_stack/fast_stack'
-module FastStack
-  def self.profile(millisecs=1, &blk)
-    stacks = []
-    thread = Thread.current
-    last_time = Time.new
-
-    new_api = thread.respond_to?(:backtrace_locations)
-
-    trap('ALRM') do
-      FastStack.stop
-      stack = (new_api ? thread.backtrace_locations : thread.backtrace)
-      # I am not sure if this is ensured to run in the thread
-      # though in my samples it always does
-      if thread == Thread.current
-        stack = stack[2..-1]
-      end
-      stacks << stack
-      FastStack.start(millisecs * 1000)
-    end
-
-    profile_block(millisecs * 1000, &blk)
-
-    stacks
-  end
-end
+require 'fast_stack/fast_stack'
+require 'tempfile'
+module FastStack
+
+  def self.profile(millisecs=1, mode=:ruby, &blk)
+
+    return profile_native(millisecs, &blk) if mode == :c
+
+    stacks = []
+    thread = Thread.current
+
+    new_api = thread.respond_to?(:backtrace_locations)
+
+    handler do
+      FastStack.stop
+      stack = (new_api ? thread.backtrace_locations : thread.backtrace)
+      # I am not sure if this is ensured to run in the thread
+      # though in my samples it always does
+      if thread == Thread.current
+        stack = stack[2..-1]
+      end
+      stacks << stack
+      FastStack.start(millisecs*1000)
+    end
+
+    begin
+      FastStack.start(millisecs*1000)
+      blk.call
+    ensure
+      FastStack.stop
+    end
+
+    stacks
+  end
+
+
+  private
+
+  def self.handler(&block)
+    trap(signal, &block)
+  end
+
+  def self.profile_native(millisecs)
+    temp = Tempfile.new('stacks')
+    stacks = nil
+
+    begin
+      FastStack.start_native(millisecs*1000, temp.fileno)
+      yield
+    ensure
+      FastStack.stop_native
+    end
+
+    temp.flush
+    temp.close
+    temp.open
+    stacks = []
+    stack = []
+    temp.each_line do |line|
+      if line.strip == "__SEP__"
+        stacks << stack
+        stack = []
+      else
+        stack << line.strip
+      end
+    end
+    temp.close
+    temp.unlink
+
+    resolve_frames!(stacks)
+    stacks
+  end
+
+  def self.resolve_frames!(stacks)
+    frames = {}
+    resolved = {}
+    stacks.each do |stack|
+      stack.map! do |frame|
+        frames[frame] ||= resolve_frame(frame,resolved)
+      end
+    end
+  end
+
+  def self.process_name
+    @name ||= File.readlink("/proc/#{Process.pid}/exe")
+  end
+
+  def self.pmap
+    @pmap ||= begin
+
+      result = []
+
+      unparsed  = `pmap #{Process.pid} | awk '{ printf $1; for(i=4;i<=10;i++) printf " %s ",$i; print "" }'`.split("\n")
+      unparsed[1..-1].each do |line|
+        split = line.split(" ")
+        if split[0] != "total"
+          result << [split[0].hex, split[1..-1].join(" ").strip]
+        end
+      end
+
+      result
+    end
+  end
+
+  def self.parse_frame(frame)
+    matches = frame.match(/(.*)\((.*)\)\[(.*)\]/)
+    {exe: matches[1], local: matches[2], global: matches[3]}
+  rescue
+    {exe: "unknown", local: "0", global: "0"}
+  end
+
+  def self.global_to_local(global)
+    prev = 0
+    pmap.each do |location, e|
+      if location > global
+        return global - prev
+      end
+      prev = location
+    end
+
+    0
+  end
+
+  def self.resolve_frame(frame,resolved)
+    resolved[frame] ||= begin
+
+      parsed = parse_frame(frame)
+
+      resolved_location = global_to_local(parsed[:global].hex)
+
+       info = `addr2line -f -C -e #{process_name} 0x#{resolved_location.to_s(16)}`.split("\n")
+       parsed[:fn] = info[0].strip
+       parsed[:file], parsed[:line] = info[1].strip.split(":")
+
+       file = parsed[:file] == "??" ? parsed[:exe] : parsed[:file]
+       fn = parsed[:fn] == "??" ? parsed[:local] : parsed[:fn]
+
+       "#{file}:#{parsed[:line]}:in `#{fn}'"
+    end
+  end
+
+end

data/spec/fast_stack_spec.rb

@@ -1,28 +1,40 @@
-require 'fast_stack'
-
-
-describe String do
-  it "works" do
-    s = FastStack.profile do
-      t = Time.new
-      while (Time.new - t) < 0.1 do
-        "nothing"
-      end
-    end
-
-    expect(s.count).to be > 2
-  end
-
-  def fib( n )
-    return  n  if ( 0..1 ).include? n
-    ( fib( n - 1 ) + fib( n - 2 ) )
-  end
-
-  it "fibos" do
-    s = FastStack.profile do
-      fib(30)
-    end
-
-    expect(s.count).to be > 10
-  end
-end
+require 'fast_stack'
+
+
+RSpec.describe String do
+
+  it "works for c mode" do
+    s = FastStack.profile(1, :c) do
+      t = Time.new
+      while (Time.new - t) < 0.01 do
+        "nothing"
+      end
+    end
+
+    expect(s.count).to be > 2
+  end
+
+  it "works" do
+    s = FastStack.profile do
+      t = Time.new
+      while (Time.new - t) < 0.1 do
+        "nothing"
+      end
+    end
+
+    expect(s.count).to be > 2
+  end
+
+  def fib( n )
+    return  n  if ( 0..1 ).include? n
+    ( fib( n - 1 ) + fib( n - 2 ) )
+  end
+
+  it "fibos" do
+    s = FastStack.profile do
+      fib(30)
+    end
+
+    expect(s.count).to be > 10
+  end
+end

metadata

@@ -1,58 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: fast_stack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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'
-description: Fast method for collecting stack traces in Ruby 2.1
+description: Fast method for collecting stack traces in Ruby 2.1+
 email: sam.saffron@gmail.com
 executables: []
 extensions:
@@ -61,9 +61,12 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- lib/fast_stack.rb
-- ext/fast_stack/fast_stack.c
 - ext/fast_stack/extconf.rb
+- ext/fast_stack/fast_stack.c
+- ext/fast_stack/fast_stack.h
+- ext/fast_stack/fast_stack_linux.c
+- ext/fast_stack/fast_stack_windows.c
+- lib/fast_stack.rb
 - spec/fast_stack_spec.rb
 homepage: https://github.com/SamSaffron/fast_stack
 licenses:
@@ -75,19 +78,19 @@ 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.0.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Fast method for collecting stack traces in Ruby 2.1
+summary: Fast method for collecting stack traces in Ruby 2.1+
 test_files:
 - spec/fast_stack_spec.rb