heap-profiler 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e263aff57204d350bc5bef799fbd36a3be2b0f97dec58ad5c7ef7876abd74d5a
-  data.tar.gz: d0bdb2c258ddf9a15e04143a4fa5cbbddab74616c2577a131f8057d786c9c53e
+  metadata.gz: d471a3cfa86394c637238b8d27fb487b764862a45ef016e6de9570e9b90811ab
+  data.tar.gz: 05d056160722162d9e6a2866e69baba73a8eb9bc4237e0d1fc597573c15b2380
 SHA512:
-  metadata.gz: 7c79454f33d11d27aee29a26efbb7d5f56ea0540502ef6f8d2a4c35e3aee391f01a6bcd6beab1f8ff9a1ac662f3122f8827595698371d52fc29b6f304038ed10
-  data.tar.gz: 6094bc35c69fa27d42affdf5533c6911614d5f819f06a26a576297fabcc1ecd5cbc83c3cbd1328fa0f4922f1e947294aeac345c8073a78fe26b6a7fb44f765d0
+  metadata.gz: a8d5cea4cc882c00170de66aae01216b52692b60af46a2d5be64804f5565a03016716d17bbe5e413f38dceebc9b7238abaf756b50d519236044dde2f2ae1925b
+  data.tar.gz: 3031b322e69a2235ff388756adf89306e5dfa9cdad639bff79b122339e93b6c8b638cab8ff4f2b4c41592bfb62df05b0c32f8eb3c2a3d6c22f0963b1017cb9d0

data/.github/workflows/tests.yml

@@ -6,25 +6,12 @@ jobs:
     name: Rubocop
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup Ruby
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.5'
-      - name: Ruby gem cache
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-      - name: Install gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
-
+          bundler-cache: true
       - name: Run linters
         run: |
           bin/rubocop -c .rubocop.yml
@@ -33,27 +20,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        ruby: [ '2.5', '2.6', '2.7', '3.0', '3.1' ]
     name: Ruby ${{ matrix.ruby }} Tests
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup Ruby
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Ruby gem cache
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-
-      - name: Install gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
-
+          bundler-cache: true
       - name: Run tests
         run: bundle exec rake

data/.rubocop.yml

@@ -19,5 +19,8 @@ Lint/RescueException:
 Lint/MissingSuper:
   Enabled: false
 
+Lint/AssignmentInCondition:
+  Enabled: false
+
 Metrics/ParameterLists:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heap-profiler (0.5.0)
+    heap-profiler (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,7 +18,7 @@ GEM
     rake-compiler (1.1.1)
       rake
     regexp_parser (2.0.3)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rubocop (1.8.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -37,6 +37,8 @@ GEM
     unicode-display_width (2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-linux

data/README.md

@@ -41,6 +41,20 @@ To then analyse the profile, run the `heap-profiler` command against the directo
 Note that on large applications this can take a while, but if you are profiling a production
 application, you can download the profile directory and do the analysis on another machine.
 
+### Options
+
+```
+Usage: heap-profiler <directory_or_heap_dump> OPTIONS
+
+OPTIONS
+
+    -r, --retained-only              Only compute report for memory retentions.
+    -m, --max=NUM                    Max number of entries to output. (Defaults to 50)
+        --batch-size SIZE            Sets the simdjson parser batch size. It must be larger than the largest JSON document in the heap dump, and defaults to 10MB.
+```
+
+
+
 ```bash
 $ heap-profiler path/to/report/directory
       Total allocated: 3.72 kB (36 objects)
@@ -229,7 +243,7 @@ If you can, you should enable allocation tracing as early as possible during you
 
 ```ruby
 require 'objspace'
-ObjectSpace.trace_object_allocations_start.
+ObjectSpace.trace_object_allocations_start
 ```
 
 Then to dump the heap:

data/bin/generate-report

@@ -6,6 +6,17 @@ require 'fileutils'
 require 'date'
 
 class SomeCustomStuff
+  def initialize
+    @root = 1
+  end
+
+  def foo
+    @foo = 1
+  end
+
+  def bar
+    @bar = 2
+  end
 end
 
 $freed_objects = [+"i am free", +"i am free too"]
@@ -18,6 +29,8 @@ if ARGV[1] == '--empty'
   HeapProfiler.report(dir) {}
 else
   HeapProfiler.report(dir) do
+    SomeCustomStuff.new.tap(&:foo).tap(&:bar)
+    SomeCustomStuff.new.tap(&:bar)
     $retained_objects = [
       +"I am retained",
       +"I am retained",

data/ext/heap_profiler/heap_profiler.cpp

@@ -7,7 +7,7 @@ using namespace simdjson;
 
 static VALUE rb_eHeapProfilerError, rb_eHeapProfilerCapacityError, sym_type, sym_class,
              sym_address, sym_value, sym_memsize, sym_imemo_type, sym_struct, sym_file,
-             sym_line, sym_shared, sym_references, id_uminus;
+             sym_line, sym_shared, sym_references, sym_edge_name, id_uminus;
 
 typedef struct {
     dom::parser *parser;
@@ -190,8 +190,11 @@ static VALUE make_ruby_object(dom::object object)
     }
 
     std::string_view _class;
-    if (!object["class"].get(_class)) {
-        rb_hash_aset(hash, sym_class, INT2FIX(parse_address(_class)));
+    if (type != "IMEMO") {
+        // IMEMO "class" field can sometime be junk
+        if (!object["class"].get(_class)) {
+            rb_hash_aset(hash, sym_class, INT2FIX(parse_address(_class)));
+        }
     }
 
     uint64_t memsize;
@@ -233,6 +236,11 @@ static VALUE make_ruby_object(dom::object object)
                 rb_hash_aset(hash, sym_references, references);
             }
         }
+    } else if (type == "SHAPE") {
+        std::string_view edge_name;
+        if (!object["edge_name"].get(edge_name)) {
+            rb_hash_aset(hash, sym_edge_name, make_string(edge_name));
+        }
     }
 
     std::string_view file;
@@ -299,6 +307,7 @@ extern "C" {
         sym_type = ID2SYM(rb_intern("type"));
         sym_class = ID2SYM(rb_intern("class"));
         sym_address = ID2SYM(rb_intern("address"));
+        sym_edge_name = ID2SYM(rb_intern("edge_name"));
         sym_value = ID2SYM(rb_intern("value"));
         sym_memsize = ID2SYM(rb_intern("memsize"));
         sym_struct = ID2SYM(rb_intern("struct"));