sheap 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63584faef266eb7722518ee68bbb9cb757786a6aec38779889466b3d215eb542
-  data.tar.gz: f4979afbb9ce9f1f7ae8aabb58a8b69e7fc86b676c35a451774311a8d6d212d1
+  metadata.gz: 84cd499accc73ed5e94564c3703fd2ed19dfb380b1c62cbccb35a207ab670e1e
+  data.tar.gz: b44e356f1d76c36b1cd4bb335594765aafafcdf3e21af96b7cecda3bb3617fdb
 SHA512:
-  metadata.gz: 5388e77ef86d256762f7388836f6aa2f34837e0a87da9e9fa842156fca972c475b87c506c7310cbde3739343d250bcc11714c875785627fd557da7bd0a7606e7
-  data.tar.gz: b3696454a64657a42c07c331d659938933417fb611ef5494127d76c9aa4b83ee2ef057c0c0e2d220d8cf27a1b822c9e5300b0a1fee9c1706ab07283335e21175
+  metadata.gz: 69fdf739e7088d998f3968024f2fe2b086ba79d2a4707f3dc924a87a079f40c2b89958647ef92fafa8f7a9f513377bae229c715178071a2c19c30384c81374ec
+  data.tar.gz: 6b29e443a217dab6b283c9026b85c1ac358fca2c8653926774cb7356eff8693e61652c1d4bad1032539c9cb0e37fba56b2dc3267d334a38c6105d2bcb8bde69f

data/README.md

@@ -1,6 +1,6 @@
 # Sheap
 
-Sheap is a library for interactively exploring Ruby Heap dumps. Sheap contains contains a command-line tool and a library for use in IRB. 
+Sheap is a library for interactively exploring Ruby Heap dumps. Sheap contains a command-line tool and a library for use in IRB. 
 
 Some examples of things you can do with Sheap:
 - Find all retained objects between two heap dumps, and analyze them by their properties
@@ -38,43 +38,55 @@ $diff = Sheap::Diff.new('tmp/heap_before.dump', 'tmp/heap_after.dump')
 $diff.retained.map(&:type_str).tally.sort_by(&:last)
 # => [["DATA", 1], ["FILE", 1], ["IMEMO", 4], ["STRING", 4], ["ARRAY", 10000]]
 
-# Find the largest array in the 'after' heap dump
-$diff.after.of_type("ARRAY").sort_by { |o| o.data["length"] }.last
-# => <ARRAY 0x1023effc8 (10000 refs)>
+# Find the 4 largest arrays in the 'after' heap dump
+>> $diff.after.arrays.sort_by(&:length).last(5)
+# =>
+# [#<ARRAY 0x100ec0440  (512 refs)>,
+#  #<ARRAY 0x100ec9270  (512 refs)>,
+#  #<ARRAY 0x100f4b450  (512 refs)>,
+#  #<ARRAY 0x11bc6d5b0  (512 refs)>,
+#  #<ARRAY 0x11c137960  (10000 refs)>]
+
+# Grab and examine just the largest array
+large_arr = $diff.after.arrays.max_by(&:length)
+# =>
+# #<ARRAY 0x1023effc8
+#  type="ARRAY",
+#  shape_id=0,
+#  slot_size=40,
+#  class=#<CLASS 0x100e43350 Array (252 refs)>,
+#  length=10000,
+#  references=(10000 refs),
+#  memsize=89712,
+#  flags=wb_protected>
 
 # Is it old?
-$diff.after.of_type("ARRAY").sort_by { |o| o.data["length"] }.last.old?
+large_arr.old?
 # => false
 
-# What else can be learned about it
-$diff.after.of_type("ARRAY").sort_by { |o| o.data["length"] }.last.data
-# => 
-# { "address"=>"0x1023effc8",
-#   "type"=>"ARRAY",
-#   "shape_id"=>0,
-#   "slot_size"=>40,
-#   "class"=>"0x1024c33f0",
-#   "length"=>10000,
-#   "memsize"=>89712,
-#   "flags"=>{"wb_protected"=>true}
-#   "references" => [
-#      <ARRAY 0x1023efc80>, 
-#      <ARRAY 0x1023efc58>,
-#      <ARRAY 0x1023efc30>,
-#      <ARRAY 0x1023efc08>,
-#      <ARRAY 0x1023efbe0>,
-#      <ARRAY 0x1023efbb8>,
-#      # ...
-#   ]
-# }
-
-# Find the first of its references by address
-$diff.after.at("0x1023efc80")
-=> <ARRAY 0x1023efc80>
-
-# Show that object's path back to the root of the heap 
-$diff.after.find_path($diff.after.at("0x1023efc80"))
-# => [<ROOT global_tbl (13 refs)>, <ARRAY 0x1023effc8 (10000 refs)>, <ARRAY 0x1023efc80>]
+# Find the first of its references
+large_arr.references.first
+# =>
+# #<ARRAY 0x11c13fdb8
+#  type="ARRAY",
+#  shape_id=0,
+#  slot_size=40,
+#  class=#<CLASS 0x100e43350 Array (252 refs)>,
+#  length=0,
+#  embedded=true,
+#  memsize=40,
+#  flags=wb_protected>
+
+# Reference that same object by address
+$diff.after.at("0x11c13fdb8")
+# =>
+# #<ARRAY 0x11c13fdb8
+#  type="ARRAY",
+#  ...
+
+# Show that object's path back to the root of the heap
+$diff.after.find_path($diff.after.at("0x11c13fdb8"))
+# => [#<ROOT global_tbl (13 refs)>, #<ARRAY 0x1023effc8 (10000 refs)>, #<ARRAY 0x11c13fdb8>]
 ```
 
 ### Generating heap dumps

data/lib/sheap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sheap
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/sheap.rb

@@ -37,6 +37,11 @@ class Sheap
       filter { |o| o.json.include?(type) && o.type_str == type }
     end
 
+    def of_imemo_type(type)
+      type = type.to_s.downcase
+      filter { |o| o.json.include?(type) && o.imemo_type == type }
+    end
+
     def classes; of_type("CLASS"); end
     def icasses; of_type("ICLASS"); end
     def modules; of_type("MODULE"); end
@@ -59,6 +64,14 @@ class Sheap
     def floats; of_type("FLOAT"); end
     def rationals; of_type("RATIONAL"); end
     def complexes; of_type("COMPLEX"); end
+
+    # imemo types
+    def iseqs; of_imemo_type("iseq"); end
+    def callcaches; of_imemo_type("callcache"); end
+    def constcaches; of_imemo_type("constcache"); end
+    def callinfos; of_imemo_type("callinfo"); end
+    def crefs; of_imemo_type("cref"); end
+    def ments; of_imemo_type("ment"); end
   end
 
   class Diff
@@ -142,6 +155,10 @@ class Sheap
       end
     end
 
+    def [](*args)
+      @objects[*args]
+    end
+
     def last(n = nil)
       if n
         HeapObjectCollection.new(@objects.last(n))
@@ -158,7 +175,9 @@ class Sheap
       @objects.length
     end
     alias size length
-    alias count length
+    def count(&block)
+      @objects.count(&block)
+    end
 
     def pretty_print(q)
       q.group(1, '[', ']') {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sheap
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies: []
 description: A set of helpers for analyzing the output of ObjectSpace.dump_all
 email: