stackprof 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88f62f89ebff2c249b7eaabcb330f12997f09120
-  data.tar.gz: 629071b6584701d830b827e5d4b9b0951eaa0282
+  metadata.gz: 25c29d953e534a2d31065493cbffa762c5f92ee1
+  data.tar.gz: f9533f32cd7d5d648f3b9e16fd9d43469181521a
 SHA512:
-  metadata.gz: d02684e9bd77e2b561f626a69a897e1ec2c89b870b30ef54709165cc1debb966a56127f3053d7a27e81cc7c3c62fef50865ebd5bcbfd6d2b28630add6280e479
-  data.tar.gz: 2d5d70aaa53080112d8f794d1d5412cd8225f451f43431f30209e42854b5de8246ff77347ef39496c2b55b447d6cf114116b81dc2eb458adea16a5d9ce03606e
+  metadata.gz: 69d486b03120ed37b76b16e65825b98e00fa6fbfb3aa3c484870ebead42cdbfed204e1e4e4362e3d5bdadee9c81ccf4169bcdaf109191c8b0fa580f97a8dfc62
+  data.tar.gz: b735b0457b8ee0bbf217d0a891abd81c88ecbfd63a435001d1aaaec9707ac01607e14bea0b82a6c0c6ba827b64b3885d0cbffffdabe0742a3cc51bb402a59fc2

data/.gitignore

@@ -2,3 +2,5 @@
 /lib/stackprof/stackprof.bundle
 /lib/stackprof/stackprof.so
 *.sw?
+/ext
+/pkg

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.2.12
+
+* Eliminate one loop over the stack by using `overall_samples` [#98]

data/README.md

@@ -1,13 +1,17 @@
-## stackprof
+# Stackprof
 
-a sampling call-stack profiler for ruby 2.1+
+A sampling call-stack profiler for Ruby.
 
-inspired heavily by [gperftools](https://code.google.com/p/gperftools/),
-and written as a replacement for [perftools.rb](https://github.com/tmm1/perftools.rb)
+Inspired heavily by [gperftools](https://code.google.com/p/gperftools/), and written as a replacement for [perftools.rb](https://github.com/tmm1/perftools.rb).
 
-### getting started
+## Requirements
 
-#### Install
+* Ruby 2.1+
+* Linux-based OS
+
+## Getting Started
+
+### Install
 
 In your Gemfile add:
 
@@ -18,7 +22,7 @@ gem 'stackprof'
 Then run `$ bundle install`. Alternatively you can run `$ gem install stackprof`.
 
 
-#### Run
+### Run
 
 in ruby:
 
@@ -93,7 +97,7 @@ The `--flamegraph-viewer` command will output the exact shell command you need t
 
 ![](http://i.imgur.com/EwndrgD.png)
 
-### sampling
+## Sampling
 
 four sampling modes are supported:
 
@@ -142,7 +146,7 @@ samples are taken using a combination of three new C-APIs in ruby 2.1:
   - in allocation mode, samples are taken via `rb_tracepoint_new(RUBY_INTERNAL_EVENT_NEWOBJ)`,
     which provides a notification every time the VM allocates a new object.
 
-### Aggregation
+## Aggregation
 
 each sample consists of N stack frames, where a frame looks something like `MyClass#method` or `block in MySingleton.method`.
 for each of these frames in the sample, the profiler collects a few pieces of metadata:
@@ -175,14 +179,14 @@ this technique builds up an incremental callgraph from the samples. on any given
 the sum of the outbound edge weights is equal to total samples collected on that frame
 (`frame.total_samples == frame.edges.values.sum`).
 
-### reporting
+## Reporting
 
 multiple reporting modes are supported:
   - text
   - dotgraph
   - source annotation
 
-#### `StackProf::Report.new(data).print_text`
+### `StackProf::Report.new(data).print_text`
 
 ```
      TOTAL    (pct)     SAMPLES    (pct)     FRAME
@@ -197,7 +201,7 @@ multiple reporting modes are supported:
        188 (100.0%)           0   (0.0%)     <main>
 ```
 
-#### `StackProf::Report.new(data).print_graphviz`
+### `StackProf::Report.new(data).print_graphviz`
 
 ![](http://cl.ly/image/2t3l2q0l0B0A/content)
 
@@ -223,7 +227,7 @@ digraph profile {
 }
 ```
 
-#### `StackProf::Report.new(data).print_method(/pow|newobj|math/)`
+### `StackProf::Report.new(data).print_method(/pow|newobj|math/)`
 
 ```
 A#pow (/Users/tmm1/code/stackprof/sample.rb:11)
@@ -245,7 +249,7 @@ block in A#math (/Users/tmm1/code/stackprof/sample.rb:21)
                          |    23  |     end
 ```
 
-### usage
+## Usage
 
 the profiler is compiled as a C-extension and exposes a simple api: `StackProf.run(mode: [:cpu|:wall|:object])`.
 the `run` method takes a block of code and returns a profile as a simple hash.
@@ -295,7 +299,7 @@ above, `A#pow` was involved in 91 samples, and in all cases it was at the top of
 divided up between its callee edges. all 91 calls to `A#pow` came from `A#initialize`, as seen by the edge numbered
 `70346498324780`.
 
-### advanced usage
+## Advanced usage
 
 the profiler can be started and stopped manually. results are accumulated until retrieval, across
 multiple start/stop invocations.
@@ -307,7 +311,7 @@ StackProf.stop
 StackProf.results('/tmp/some.file')
 ```
 
-### all options
+## All options
 
 `StackProf.run` accepts an options hash. Currently, the following options are recognized:
 
@@ -320,7 +324,7 @@ Option      | Meaning
 `raw`       | defaults `false` - if `true` collects the extra data required by the `--flamegraph` and `--stackcollapse` report types
 `save_every`| (rack middleware only) write the target file after this many requests
 
-### todo
+## Todo
 
 * file/iseq blacklist
 * restore signal handlers on stop

data/ext/stackprof/stackprof.c

@@ -20,7 +20,7 @@
 typedef struct {
     size_t total_samples;
     size_t caller_samples;
-    int already_accounted_in_total;
+    size_t seen_at_sample_number;
     st_table *edges;
     st_table *lines;
 } frame_data_t;
@@ -268,6 +268,7 @@ stackprof_results(int argc, VALUE *argv, VALUE self)
 
     if (_stackprof.raw && _stackprof.raw_samples_len) {
 	size_t len, n, o;
+	VALUE raw_timestamp_deltas;
 	VALUE raw_samples = rb_ary_new_capa(_stackprof.raw_samples_len);
 
 	for (n = 0; n < _stackprof.raw_samples_len; n++) {
@@ -287,7 +288,7 @@ stackprof_results(int argc, VALUE *argv, VALUE self)
 
 	rb_hash_aset(results, sym_raw, raw_samples);
 
-	VALUE raw_timestamp_deltas = rb_ary_new_capa(_stackprof.raw_timestamp_deltas_len);
+	raw_timestamp_deltas = rb_ary_new_capa(_stackprof.raw_timestamp_deltas_len);
 
 	for (n = 0; n < _stackprof.raw_timestamp_deltas_len; n++) {
 	    rb_ary_push(raw_timestamp_deltas, INT2FIX(_stackprof.raw_timestamp_deltas[n]));
@@ -432,19 +433,15 @@ stackprof_record_sample_for_stack(int num, int timestamp_delta)
 	_stackprof.raw_timestamp_deltas[_stackprof.raw_timestamp_deltas_len++] = timestamp_delta;
     }
 
-    for (i = 0; i < num; i++) {
-	VALUE frame = _stackprof.frames_buffer[i];
-	sample_for(frame)->already_accounted_in_total = 0;
-    }
-
     for (i = 0; i < num; i++) {
 	int line = _stackprof.lines_buffer[i];
 	VALUE frame = _stackprof.frames_buffer[i];
 	frame_data_t *frame_data = sample_for(frame);
 
-	if (!frame_data->already_accounted_in_total)
+	if (frame_data->seen_at_sample_number != _stackprof.overall_samples) {
 	    frame_data->total_samples++;
-	frame_data->already_accounted_in_total = 1;
+	}
+	frame_data->seen_at_sample_number = _stackprof.overall_samples;
 
 	if (i == 0) {
 	    frame_data->caller_samples++;
@@ -455,10 +452,10 @@ stackprof_record_sample_for_stack(int num, int timestamp_delta)
 	}
 
 	if (_stackprof.aggregate && line > 0) {
-	    if (!frame_data->lines)
-		frame_data->lines = st_init_numtable();
 	    size_t half = (size_t)1<<(8*SIZEOF_SIZE_T/2);
 	    size_t increment = i == 0 ? half + 1 : half;
+	    if (!frame_data->lines)
+		frame_data->lines = st_init_numtable();
 	    st_numtable_increment(frame_data->lines, (st_data_t)line, increment);
 	}
 
@@ -474,14 +471,15 @@ void
 stackprof_record_sample()
 {
     int timestamp_delta = 0;
+    int num;
     if (_stackprof.raw) {
 	struct timeval t;
-	gettimeofday(&t, NULL);
 	struct timeval diff;
+	gettimeofday(&t, NULL);
 	timersub(&t, &_stackprof.last_sample_at, &diff);
 	timestamp_delta = (1000 * diff.tv_sec) + diff.tv_usec;
     }
-    int num = rb_profile_frames(0, sizeof(_stackprof.frames_buffer) / sizeof(VALUE), _stackprof.frames_buffer, _stackprof.lines_buffer);
+    num = rb_profile_frames(0, sizeof(_stackprof.frames_buffer) / sizeof(VALUE), _stackprof.frames_buffer, _stackprof.lines_buffer);
     stackprof_record_sample_for_stack(num, timestamp_delta);
 }
 
@@ -489,10 +487,11 @@ void
 stackprof_record_gc_samples()
 {
     int delta_to_first_unrecorded_gc_sample = 0;
+    int i;
     if (_stackprof.raw) {
 	struct timeval t;
-	gettimeofday(&t, NULL);
 	struct timeval diff;
+	gettimeofday(&t, NULL);
 	timersub(&t, &_stackprof.last_sample_at, &diff);
 
 	// We don't know when the GC samples were actually marked, so let's
@@ -503,8 +502,6 @@ stackprof_record_gc_samples()
 	}
     }
 
-    int i;
-
     _stackprof.frames_buffer[0] = _stackprof.fake_gc_frame;
     _stackprof.lines_buffer[0] = 0;
 

data/lib/stackprof/middleware.rb

@@ -11,7 +11,8 @@ module StackProf
       Middleware.interval = options[:interval] || 1000
       Middleware.raw      = options[:raw] || false
       Middleware.enabled  = options[:enabled]
-      Middleware.path     = options[:path] || 'tmp'
+      options[:path]      = 'tmp/' if options[:path].to_s.empty?
+      Middleware.path     = options[:path]
       at_exit{ Middleware.save } if options[:save_at_exit]
     end
 
@@ -40,11 +41,20 @@ module StackProf
         end
       end
 
-      def save(filename = nil)
+      def save
         if results = StackProf.results
-          FileUtils.mkdir_p(Middleware.path)
-          filename ||= "stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump"
-          File.open(File.join(Middleware.path, filename), 'wb') do |f|
+          path = Middleware.path
+          is_directory = path != path.chomp('/')
+
+          if is_directory
+            filename = "stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump"
+          else
+            filename = File.basename(path)
+            path = File.dirname(path)
+          end
+
+          FileUtils.mkdir_p(path)
+          File.open(File.join(path, filename), 'wb') do |f|
             f.write Marshal.dump(results)
           end
           filename

data/lib/stackprof/report.rb

@@ -55,8 +55,8 @@ module StackProf
 
     def add_lines(a, b)
       return b if a.nil?
-      return a+b if a.is_a? Fixnum
-      return [ a[0], a[1]+b ] if b.is_a? Fixnum
+      return a+b if a.is_a? Integer
+      return [ a[0], a[1]+b ] if b.is_a? Integer
       [ a[0]+b[0], a[1]+b[1] ]
     end
 

data/stackprof.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.11'
+  s.version = '0.2.12'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'

data/test/test_middleware.rb

@@ -9,31 +9,31 @@ class StackProf::MiddlewareTest < MiniTest::Test
   def test_path_default
     StackProf::Middleware.new(Object.new)
 
-    assert_equal 'tmp', StackProf::Middleware.path
+    assert_equal 'tmp/', StackProf::Middleware.path
   end
 
   def test_path_custom
-    StackProf::Middleware.new(Object.new, { path: '/foo' })
+    StackProf::Middleware.new(Object.new, { path: 'foo/' })
 
-    assert_equal '/foo', StackProf::Middleware.path
+    assert_equal 'foo/', StackProf::Middleware.path
   end
 
   def test_save_default
     StackProf::Middleware.new(Object.new)
 
     StackProf.stubs(:results).returns({ mode: 'foo' })
-    FileUtils.expects(:mkdir_p).with('tmp')
+    FileUtils.expects(:mkdir_p).with('tmp/')
     File.expects(:open).with(regexp_matches(/^tmp\/stackprof-foo/), 'wb')
 
     StackProf::Middleware.save
   end
 
   def test_save_custom
-    StackProf::Middleware.new(Object.new, { path: '/foo' })
+    StackProf::Middleware.new(Object.new, { path: 'foo/' })
 
     StackProf.stubs(:results).returns({ mode: 'foo' })
-    FileUtils.expects(:mkdir_p).with('/foo')
-    File.expects(:open).with(regexp_matches(/^\/foo\/stackprof-foo/), 'wb')
+    FileUtils.expects(:mkdir_p).with('foo/')
+    File.expects(:open).with(regexp_matches(/^foo\/stackprof-foo/), 'wb')
 
     StackProf::Middleware.save
   end

data/test/test_stackprof.rb

@@ -119,6 +119,27 @@ class StackProfTest < MiniTest::Test
     end
   end
 
+  def foo(n = 10)
+    if n == 0
+      StackProf.sample
+      return
+    end
+    foo(n - 1)
+  end
+
+  def test_recursive_total_samples
+    profile = StackProf.run(mode: :cpu, raw: true) do
+      10.times do
+        foo
+      end
+    end
+
+    frame = profile[:frames].values.find do |frame|
+      frame[:name] == "StackProfTest#foo"
+    end
+    assert_equal 10, frame[:total_samples]
+  end
+
   def test_gc
     profile = StackProf.run(interval: 100, raw: true) do
       5.times do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -65,6 +65,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: sampling callstack-profiler for ruby 2.1+