heapinfo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 546784a7f3d841d2505b517a355afc2e1e914e5d
-  data.tar.gz: 166efbf709763a0a5a5a68d3e0f13515839bc125
+  metadata.gz: fd09327165de603d3fa3350e9022d8bf642a1f7c
+  data.tar.gz: 5c1dd70e46c5fad709e187c25a8347be8262586e
 SHA512:
-  metadata.gz: fb5882bc6a55e02abcfc7f11e646952ee50c1622cb8020103c6f1753163b49984d2be00e320eb0d61d601d3d30eb1a90d5dbd2b8053c83d80c9324159dc80f1e
-  data.tar.gz: 8789e7be0d5336870fc75100df74c5ea9151c0d4a9f6f7f9553756623915a4eef70b802f4a8511443f8a90322f50dfbfc0b60c697ebaab9400d1491705142901
+  metadata.gz: 6827c2c7129162b716046200e71cdba7475de9edad4a1880b0aec374c3e9a5649c6a2ae934566097794671bc1c30d255e4fed9142e6a1de4b95a914f3c8c5ee1
+  data.tar.gz: 82bfd1db1bca104fa62d54e7c14a63ad91d2a208dfa346d8a23464141d9767e1f9d18dda21dfd106a840d2799c92c3d4dad2a78893b4bcbc224aa9c415f38692

data/lib/heapinfo/arena.rb

@@ -1,9 +1,17 @@
 module HeapInfo
+  # Records status of an arena, including bin(s) and top chunk.
   class Arena
-    attr_reader :fastbin, :unsorted_bin, :smallbin, :top_chunk
+    # @return [Array<HeapInfo::Fastbin>] Fastbins in an array.
+    attr_reader :fastbin
+    # @return [Array<HeapInfo::UnsortedBin>] The unsorted bin (only one).
+    attr_reader :unsorted_bin
+    # @return [Array<HeapInfo::Smallbin>] Smallbins in an array.
+    attr_reader :smallbin
+    # @return [HeapInfo::Chunk] Current top chunk.
+    attr_reader :top_chunk
     # attr_reader :largebin, :last_remainder
 
-    # Instantiate a <tt>HeapInfo::Arena</tt> object
+    # Instantiate a <tt>HeapInfo::Arena</tt> object.
     #
     # @param [Integer] base Base address of arena.
     # @param [Integer] bits Either 64 or 32
@@ -14,7 +22,7 @@ module HeapInfo
       reload!
     end
 
-    # Refresh all attributes
+    # Refresh all attributes.
     # Retrive data using <tt>@dumper</tt>, load bins, top chunk etc.
     # @return [HeapInfo::Arena] self
     def reload!
@@ -54,11 +62,14 @@ module HeapInfo
     attr_reader :size_t
   end
 
+  # Class for record fastbin type chunk.
   class Fastbin < Chunk
+    # @return [Integer]
     attr_reader :fd
+    # @return [Integer]
     attr_accessor :index
     
-    # Instantiate a <tt>HeapInfo::Fastbin</tt> object
+    # Instantiate a <tt>HeapInfo::Fastbin</tt> object.
     #
     # @param [Mixed] args See <tt>HeapInfo::Chunk</tt> for more information.
     def initialize(*args)
@@ -66,18 +77,20 @@ module HeapInfo
       @fd = Helper.unpack(size_t, @data[0, @size_t])
     end
 
-    # Mapping index of fastbin to chunk size
+    # Mapping index of fastbin to chunk size.
     # @return [Integer] size
     def idx_to_size
       index * size_t * 2 + size_t * 4
     end
 
-    # For pretty inspect
-    # @return [String] Title with color codes
+    # For pretty inspect.
+    # @return [String] Title with color codes.
     def title
       "%s%s: " % [Helper.color(Helper.class_name(self), sev: :bin),  index.nil? ? nil : "[#{Helper.color("%#x" % idx_to_size)}]"]
     end
 
+    # Pretty inspect.
+    # @return [String] fastbin layouts wrapper with color codes.
     def inspect
       title + list.map do |ptr|
         next "(#{ptr})\n" if ptr.is_a? Symbol
@@ -105,10 +118,14 @@ module HeapInfo
       ret << nil
     end
 
+    # @param [Integer] ptr Get the <tt>fd</tt> value of chunk at <tt>ptr</tt>.
+    # @return [Integer] The <tt>fd</tt>.
     def fd_of(ptr)
       addr_of(ptr, 2)
     end
 
+    # @param [Integer] ptr Get the <tt>bk</tt> value of chunk at <tt>ptr</tt>.
+    # @return [Integer] The <tt>bk</tt>.
     def bk_of(ptr)
       addr_of(ptr, 3)
     end
@@ -121,21 +138,30 @@ module HeapInfo
     end
   end
 
+  # Class for record unsorted bin type chunk.
   class UnsortedBin < Fastbin
+    # @return [Integer]
     attr_reader :bk
+
+    # Instantiate a <tt>HeapInfo::UnsortedBin</tt> object.
+    #
+    # @param [Mixed] args See <tt>HeapInfo::Chunk</tt> for more information.
     def initialize(*args)
       super
       @bk = Helper.unpack(size_t, @data[@size_t, @size_t])
     end
 
-    # size: at most extend size
-    # size=2: bk, bk, bin, fd, fd
+    # @option [Integer] size At most expand size. For <tt>size = 2</tt>, the expand list would be <tt>bk, bk, bin, fd, fd</tt>.
+    # @return [String] unsorted bin layouts wrapper with color codes.
     def inspect(size: 2)
       list = link_list(size)
       return '' if list.size <= 1 and Helper.class_name(self) != 'UnsortedBin' # bad..
       title + pretty_list(list) + "\n"
     end
 
+    # Wrapper the double-linked list with color codes.
+    # @param [Array<Integer>] list The list from <tt>#link_list</tt>.
+    # @return [String] Wrapper with color codes.
     def pretty_list(list)
       center = nil
       list.map.with_index do |c, idx|
@@ -157,6 +183,11 @@ module HeapInfo
       end.join(" === ")
     end
 
+    # Return the double link list with bin in the center.
+    #
+    # The list will like <tt>[..., bk of bk, bk of bin, bin, fd of bin, fd of fd, ...]</tt>.
+    # @param [Integer] expand_size At most expand size. For <tt>size = 2</tt>, the expand list would be <tt>bk, bk, bin, fd, fd</tt>.
+    # @return [Array<Integer>] The linked list.
     def link_list(expand_size)
       list = [@base]
       # fd
@@ -178,9 +209,10 @@ module HeapInfo
     end
   end
 
+  # Class for record smallbin type chunk.
   class Smallbin < UnsortedBin
 
-    # Mapping index of smallbin to chunk size
+    # Mapping index of smallbin to chunk size.
     # @return [Integer] size
     def idx_to_size
       index * size_t * 2 + size_t * 18

data/lib/heapinfo/chunks.rb

@@ -6,6 +6,7 @@ module HeapInfo
       @chunks = []
     end
 
+    # Redirect methods to private records.
     def method_missing(method_sym, *arguments, &block)
       return super unless @chunks.respond_to? method_sym
       @chunks.send(method_sym, *arguments, &block)

data/lib/heapinfo/ext/string.rb

@@ -3,12 +3,20 @@ module HeapInfo
     module String
       # Methods to be mixed into String
       module InstanceMethods
+        # Convert string to a <tt>HeapInfo::Chunk</tt>.
+        # @option [Integer] bits 32 or 64 bit of this chunk.
+        # @option [Integer] base Base address will show when print the <tt>Chunk</tt> object.
+        # @return [HeapInfo::Chunk]
         def to_chunk(bits: 64, base: 0)
           size_t = bits / 8
           dumper = ->(addr, len) { self[addr-base, len] }
           Chunk.new(size_t, base, dumper)
         end
 
+        # Convert string to array of <tt>HeapInfo::Chunk</tt>.
+        # @option [Integer] bits 32 or 64 bit of this chunk.
+        # @option [Integer] base Base address will show when print the <tt>Chunk</tt> object.
+        # @return [HeapInfo::Chunks]
         def to_chunks(bits: 64, base: 0)
           size_t = bits / 8
           chunks = Chunks.new

data/lib/heapinfo/libc.rb

@@ -1,30 +1,42 @@
 module HeapInfo
+  # Record libc's base, name, and offsets.
   class Libc < Segment
+
+    # Instantiate a <tt>HeapInfo::Libc</tt> object.
+    #
+    # @param [Mixed] args See <tt>#HeapInfo::Segment.initialize</tt> for more information.
     def initialize(*args)
       super
       @offset = {}
     end
 
+    # Get the offset of <tt>main_arena</tt> in libc.
+    # @return [Integer]
     def main_arena_offset
       return @offset[:main_arena] if @offset[:main_arena]
       return nil unless exhaust_search :main_arena
       @offset[:main_arena]
     end
 
+    # Get the <tt>main_arena</tt> of libc.
+    # @return [HeapInfo::Arena]
     def main_arena
       return @main_arena.reload! if @main_arena
       off = main_arena_offset
       return if off.nil?
-      @main_arena = Arena.new(off + self.base, process.bits, ->(*args) { process.dump(*args) })
+      @main_arena = Arena.new(off + self.base, process.bits, process.method(:dump))
     end
 
+    # @param [Array] maps See <tt>#HeapInfo::Segment.find</tt> for more information.
+    # @param [String] name See <tt>#HeapInfo::Segment.find</tt> for more information.
+    # @param [HeapInfo::Process] process The process.
+    # @return [HeapInfo::Libc] libc segment found in maps.
     def self.find(maps, name, process)
       obj = super(maps, name)
       obj.send(:process=, process)
       obj
     end
 
-
   private
     attr_accessor :process
     # only for searching offset of main_arena now

data/lib/heapinfo/process.rb

@@ -162,7 +162,7 @@ module HeapInfo
     end
 
     def load! # try to load
-      return if @pid
+      return true if @pid
       @pid = fetch_pid
       return false if @pid.nil? # still can't load
       load_info!
@@ -186,6 +186,7 @@ module HeapInfo
       end
       @dumper = Dumper.new(@info, mem_filename)
     end
+
     def mem_filename
       "/proc/#{pid}/mem"
     end

data/lib/heapinfo/process_info.rb

@@ -8,7 +8,16 @@ module HeapInfo
     # e.g. <tt>process.libc alias to process.info.libc</tt>
     EXPORT = %i(libc ld heap elf program stack bits)
    
-    attr_reader :bits, :program, :stack, :libc, :ld
+    # @return [Integer] 32 or 64.
+    attr_reader :bits
+    # @return [HeapInfo::Segment]
+    attr_reader :program
+    # @return [HeapInfo::Segment]
+    attr_reader :stack
+    # @return [HeapInfo::Libc]
+    attr_reader :libc
+    # @return [HeapInfo::Segment]
+    attr_reader :ld
     alias :elf :program
 
     # Instantiate a <tt>ProcessInfo</tt> object

data/lib/heapinfo/segment.rb

@@ -1,4 +1,5 @@
 module HeapInfo
+  # Record the base address and name in maps
   class Segment
 
     # Base address of segment

data/lib/heapinfo/version.rb

@@ -1,3 +1,3 @@
 module HeapInfo
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heapinfo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - david942j