heapinfo 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22b8757e3a48390494b019943a52754a154051c3
-  data.tar.gz: 4b4af3bf4d67e0ca35b9f5f8feb537499565f56e
+  metadata.gz: d934f5ad5614d320a103119b23a48312b5034598
+  data.tar.gz: 188ca4fe298b9859cbd546397d1176836a92e967
 SHA512:
-  metadata.gz: 3872db0f32aaa2fbbedcca004163cb0b5181495cc81605a6587ef5c6dfcebf60f43209146aeda541c716cbdb6bca2bd2770927643cf3bfe50ade2cf7b709a282
-  data.tar.gz: 82a57d0254a650ba531b5f00db676acc3ef4635cd0dbcdc34877f5a09ea8b369667377d96456e466e0a20ad2a6fb3dcb3737cb05966c95cd2483315bb24b7a8c
+  metadata.gz: 3051a5f8568e6a57d48ea2604193710a635c1fbd0c880b7a3e971b3608869e4c3d34e34a4c69886f422c0fe96e941c6be2c8d1f8d7a113759d244a6c739d1266
+  data.tar.gz: 8a441e5ed3acebf552a047123d897fcaafd7b31117b26e07a5d2499d4e298da1baabd271517b84a065225e3fd47a1547da26da6796fb85763a1a2417adcf5f71

data/lib/heapinfo.rb

@@ -16,7 +16,7 @@ module HeapInfo
 
   # Entry point for using {HeapInfo}.
   # Show segments info of the process after loaded.
-  # @param [String, Fixnum] prog
+  # @param [String, Integer] prog
   #   The program name of victim. If a number is given, seem as pid (useful when multi-processes exist).
   # @param [Hash] options Give library's file name.
   # @option options [String, Regexp] :libc file name of glibc, default is +/bc[^a-z]*\.so/+.

data/lib/heapinfo/arena.rb

@@ -114,7 +114,7 @@ module HeapInfo
       end.join
     end
 
-    # @return [Array<Integer, Symbol, NilClass>] single link list of +fd+ chain.
+    # @return [Array<Integer, Symbol, nil>] single link list of +fd+ chain.
     #   Last element will be:
     #   - +:loop+ if loop detectded
     #   - +:invalid+ invalid address detected
@@ -168,8 +168,8 @@ module HeapInfo
     end
 
     # @param [Integer] size
-    #   At most expand size. For +size = 2+, the expand list would be +bk, bk, bin, fd, fd+.
-    # @return [String] unsorted bin layouts wrapper with color codes.
+    #   At most expand size. For +size = 2+, 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 && Helper.class_name(self) != 'UnsortedBin' # bad..
@@ -177,7 +177,7 @@ module HeapInfo
     end
 
     # Wrapper the double-linked list with color codes.
-    # @param [Array<Integer>] list The list from +#link_list+.
+    # @param [Array<Integer>] list The list from {#link_list}.
     # @return [String] Wrapper with color codes.
     def pretty_list(list)
       center = nil
@@ -199,7 +199,7 @@ module HeapInfo
     #
     # The list will like +[..., bk of bk, bk of bin, bin, fd of bin, fd of fd, ...]+.
     # @param [Integer] expand_size
-    #   At most expand size. For +size = 2+, the expand list would be +bk, bk, bin, fd, fd+.
+    #   At most expand size. For +size = 2+, 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]

data/lib/heapinfo/cache.rb

@@ -33,7 +33,7 @@ module HeapInfo
       # Read cache from file.
       #
       # @param [String] key In file path format, only accept +[\w\/]+ to prevent horrible things.
-      # @return [Object, NilClass] Value that recorded, return +nil+ when cache miss.
+      # @return [Object, nil] Value that recorded, return +nil+ when cache miss.
       def read(key)
         filepath = realpath(key)
         return unless File.file?(filepath)

data/lib/heapinfo/chunks.rb

@@ -1,8 +1,8 @@
 module HeapInfo
-  # Self-defined array for collecting chunk(s)
+  # Self-defined array for collecting chunk(s).
   class Chunks
     include Enumerable
-    # Instantiate a <tt>HeapInfo::Chunks</tt> object.
+    # Instantiate a {HeapInfo::Chunks} object.
     def initialize
       @chunks = []
     end

data/lib/heapinfo/dumper.rb

@@ -6,17 +6,19 @@ module HeapInfo
 
     # Instantiate a {HeapInfo::Dumper} object
     #
-    # @param [HeapInfo::ProcessInfo] info process info object.
     # @param [String] mem_filename The filename that can be access for dump. Should be +/proc/[pid]/mem+.
-    def initialize(info, mem_filename)
-      @info = info
+    # @param [Proc] block
+    #   Use for get segment info.
+    #   See {Dumper#base_len_of} for more information.
+    def initialize(mem_filename, &block)
       @filename = mem_filename
+      @info = block || ->(*) { HeapInfo::Nil.new }
       need_permission unless dumpable?
     end
 
     # A helper for {HeapInfo::Process} to dump memory.
     # @param [Mixed] args The use input commands, see examples of {HeapInfo::Process#dump}.
-    # @return [String, NilClass] Dump results. If error happend, +nil+ is returned.
+    # @return [String, nil] Dump results. If error happend, +nil+ is returned.
     # @example
     #   p dump(:elf, 4)
     #   # => "\x7fELF"
@@ -41,12 +43,12 @@ module HeapInfo
     # @param [Mixed] args Same as arguments of {#dump}.
     def dump_chunks(*args)
       base = base_of(*args)
-      dump(*args).to_chunks(bits: @info.bits, base: base)
+      dump(*args).to_chunks(bits: @info[:bits], base: base)
     end
 
     # Show dump results like in gdb's command +x+.
     #
-    # Details are in {HeapInfo:Process#x}.
+    # Details are in {HeapInfo::Process#x}.
     # @param [Integer] count The number of result need to dump.
     # @param [Symbol, String, Integer] address The base address to be dumped.
     # @return [void]
@@ -73,7 +75,7 @@ module HeapInfo
     #   Start address for searching, can be segment(+Symbol+)
     #   or segments with offset. See examples for more information.
     # @param [Integer] length The length limit for searching.
-    # @return [Integer, NilClass] The first matched address, +nil+ is returned when no such pattern found.
+    # @return [Integer, nil] The first matched address, +nil+ is returned when no such pattern found.
     # @example
     #   find(/E.F/, :elf)
     #   # => 4194305
@@ -119,6 +121,8 @@ module HeapInfo
 
     # Get the base address and length.
     #
+    # +@info+ will be used for getting the segment base,
+    # so we can support use symbol as base address.
     # @param [Integer, Symbol, String] arg The base address, see examples.
     # @param [Integer] len An integer.
     # @example
@@ -128,14 +132,14 @@ module HeapInfo
     #   base_len_of('heap+0x30', 10) #=> [0x603030, 10]
     #   base_len_of('elf+0x3*2-1') #=> [0x400005, DUMP_BYTES]
     def base_len_of(arg, len = DUMP_BYTES)
-      values = HeapInfo::ProcessInfo::EXPORT.map do |seg|
-        segment = @info.respond_to?(seg) && @info.send(seg)
-        [seg, segment.base] if segment.is_a?(Segment)
-      end.compact.to_h
+      segments = @info.call(:segments) || {}
+      segments = segments.each_with_object({}) do |(k, seg), memo|
+        memo[k] = seg.base
+      end
       base = case arg
              when Integer then arg
-             when Symbol then values[arg]
-             when String then Helper.evaluate(arg, store: values)
+             when Symbol then segments[arg]
+             when String then Helper.evaluate(arg, store: segments)
              end
       raise ArgumentError, "Invalid base: #{arg.inspect}" unless base.is_a?(Integer) # invalid usage
       [base, len]
@@ -173,7 +177,7 @@ module HeapInfo
     end
 
     def size_t
-      @info.bits / 8
+      @info[:bits] / 8
     end
   end
 end

data/lib/heapinfo/ext/string.rb

@@ -1,11 +1,13 @@
 module HeapInfo
+  # Define extensions of naive objects.
   module Ext
+    # Extension of +String+ class.
     module String
       # Methods to be mixed into String
       module InstanceMethods
-        # Convert string to a <tt>HeapInfo::Chunk</tt>.
+        # Convert string to a {HeapInfo::Chunk}.
         # @option [Integer] bits 32 or 64 bit of this chunk.
-        # @option [Integer] base Base address will show when print the <tt>Chunk</tt> object.
+        # @option [Integer] base Base address will show when print the {Chunk} object.
         # @return [HeapInfo::Chunk]
         def to_chunk(bits: 64, base: 0)
           size_t = bits / 8
@@ -13,9 +15,9 @@ module HeapInfo
           Chunk.new(size_t, base, dumper)
         end
 
-        # Convert string to array of <tt>HeapInfo::Chunk</tt>.
+        # Convert string to array of {HeapInfo::Chunk}.
         # @option [Integer] bits 32 or 64 bit of this chunk.
-        # @option [Integer] base Base address will show when print the <tt>Chunk</tt> object.
+        # @option [Integer] base Base address will show when print the {Chunk} object.
         # @return [HeapInfo::Chunks]
         def to_chunks(bits: 64, base: 0)
           size_t = bits / 8

data/lib/heapinfo/helper.rb

@@ -1,9 +1,10 @@
 require 'dentaku'
+require 'shellwords'
 
 module HeapInfo
-  # Some helper functions
+  # Some helper functions.
   module Helper
-    # Create read +/proc/[pid]/*+ methods
+    # Create read +/proc/[pid]/*+ methods.
     %w(exe maps).each do |method|
       define_singleton_method("#{method}_of".to_sym) do |pid|
         begin
@@ -16,21 +17,23 @@ module HeapInfo
 
     # Define class methods here.
     module ClassMethods
-      # Get the process id of a process
-      # @param [String] prog The request process name
-      # @return [Fixnum] process id
+      # Get the process id from program name.
+      #
+      # When multiple processes exist, the one with lastest start time would be returned.
+      # @param [String] prog The request process name.
+      # @return [Integer] Process id.
       def pidof(prog)
-        # plz, don't cmd injection your self :p
-        pid = `pidof #{prog}`.strip.to_i
-        return nil if pid.zero? # process not exists yet
-        throw "pidof #{prog} fail" unless pid.between?(2, 65_535)
-        pid
-        # TODO: handle when multi processes exists
+        info = %x(ps -o pid=,lstart= --pid `pidof #{Shellwords.escape(prog)}` 2>/dev/null).lines.map do |l|
+          pid, time = l.split(' ', 2)
+          [Time.parse(time), pid.to_i]
+        end
+        return nil if info.empty? # process not exists yet
+        info.max_by(&:first).last
       end
 
       # Parse the contents of <tt>/proc/[pid]/maps</tt>.
       #
-      # @param [String] content The file content of <tt>/proc/[pid]/maps</tt>
+      # @param [String] content The file content of <tt>/proc/[pid]/maps</tt>.
       # @return [Array] In form of <tt>[[start, end, permission, name], ...]</tt>. See examples.
       # @example
       #   HeapInfo::Helper.parse_maps(<<EOS
@@ -59,20 +62,21 @@ module HeapInfo
         @disable_color = !on
       end
 
-      # Color codes for pretty print
+      # Color codes for pretty print.
       COLOR_CODE = {
         esc_m: "\e[0m",
-        normal_s: "\e[38;5;1m", # red
-        integer: "\e[38;5;12m", # light blue
+        normal_s: "\e[31m", # red
+        integer: "\e[1m\e[34m", # light blue
         fatal: "\e[38;5;197m", # dark red
         bin: "\e[38;5;120m", # light green
         klass: "\e[38;5;155m", # pry like
-        sym: "\e[38;5;229m", # pry like
+        sym: "\e[33m", # pry like
       }.freeze
       # Wrapper color codes for pretty inspect.
-      # @param [String] s Contents for wrapper
-      # @param [Symbol?] sev Specific which kind of color want to use, valid symbols are defined in +#COLOR_CODE+.
-      # If this argument is not present, will detect according to the content of +s+.
+      # @param [String] s Contents for wrapper.
+      # @param [Symbol?] sev
+      #   Specific which kind of color want to use, valid symbols are defined in +#COLOR_CODE+.
+      #   If this argument is not present, will detect according to the content of +s+.
       # @return [String] wrapper with color codes.
       def color(s, sev: nil)
         s = s.to_s
@@ -101,7 +105,7 @@ module HeapInfo
         data.unpack(size_t == 4 ? 'L*' : 'Q*')[0]
       end
 
-      # Convert number in hex format
+      # Convert number in hex format.
       #
       # @param [Integer] num Non-negative integer.
       # @return [String] number in hex format.
@@ -112,9 +116,9 @@ module HeapInfo
         format('-0x%x', -num)
       end
 
-      # Retrieve pure class name(without module) of an object
-      # @param [Object] obj Any instance
-      # @return [String] Class name of <tt>obj</tt>
+      # Retrieve pure class name(without module) of an object.
+      # @param [Object] obj Any instance.
+      # @return [String] Class name of +obj+.
       # @example
       #   # suppose obj is an instance of HeapInfo::Chunk
       #   Helper.class_name(obj)

data/lib/heapinfo/process.rb

@@ -8,12 +8,12 @@ module HeapInfo
       libc: /bc[^a-z]*\.so/,
       ld:   %r{/ld-.+\.so}
     }.freeze
-    # @return [Fixnum, NilClass] return the pid of process, +nil+ if no such process found
+    # @return [Integer, nil] return the pid of process, +nil+ if no such process found
     attr_reader :pid
 
     # Instantiate a {HeapInfo::Process} object.
-    # @param [String, Fixnum] prog Process name or pid, see {HeapInfo::heapinfo} for more information
-    # @param [Hash{Symbol => RegExp, String}] options libraries' filename, see {HeapInfo::heapinfo} for more information
+    # @param [String, Integer] prog Process name or pid, see {HeapInfo::heapinfo} for more information
+    # @param [Hash{Symbol => Regexp, String}] options libraries' filename, see {HeapInfo::heapinfo} for more information
     def initialize(prog, options = {})
       @prog = prog
       @options = DEFAULT_LIB.merge options
@@ -126,7 +126,7 @@ module HeapInfo
     # The dump results wrapper with color codes and nice typesetting will output to +stdout+.
     # @param [Integer] count The number of result need to dump, see examples for more information.
     # @param [String, Symbol, Integer] address The base address to be dumped.
-    #   Same format as {#dump(*args)}, see {#dump} for more information.
+    #   Same format as {#dump}, see {#dump} for more information.
     # @return [void]
     # @example
     #   h.x 8, :heap
@@ -154,7 +154,7 @@ module HeapInfo
     # @param [Integer] length
     #   The search length limit, default is unlimited,
     #   which will search until pattern found or reach unreadable memory.
-    # @return [Integer, NilClass] The first matched address, +nil+ is returned when no such pattern found.
+    # @return [Integer, nil] The first matched address, +nil+ is returned when no such pattern found.
     # @example
     #   h.find(0xdeadbeef, 'heap+0x10', 0x1000)
     #   # => 6299664 # 0x602010
@@ -238,7 +238,9 @@ module HeapInfo
       ProcessInfo::EXPORT.each do |m|
         self.class.send(:define_method, m) { @info.send(m) }
       end
-      @dumper = Dumper.new(@info, mem_filename)
+      @dumper = Dumper.new(mem_filename) do |sym|
+        @info.send(sym) if @info.respond_to?(sym)
+      end
     end
 
     def mem_filename

data/lib/heapinfo/process_info.rb

@@ -26,9 +26,9 @@ module HeapInfo
     def initialize(process)
       @pid = process.pid
       options = process.instance_variable_get(:@options)
-      maps!
+      maps = load_maps
       @bits = bits_of(Helper.exe_of(@pid))
-      @elf = @program = Segment.find(maps, File.readlink("/proc/#{@pid}/exe"))
+      @program = Segment.find(maps, File.readlink("/proc/#{@pid}/exe"))
       @stack = Segment.find(maps, '[stack]')
       # well.. stack is a strange case because it will grow in runtime..
       # should i detect stack base growing..?
@@ -41,7 +41,7 @@ module HeapInfo
     #
     # @return [HeapInfo::Segment] The {Segment} of heap.
     def heap # special handle because heap might not be initialized in the beginning
-      @heap ||= Segment.find(maps!, '[heap]')
+      @heap ||= Segment.find(load_maps, '[heap]')
     end
 
     # Return segemnts load currently.
@@ -55,11 +55,8 @@ module HeapInfo
 
     private
 
-    attr_reader :maps
-
-    # force reload maps
-    def maps!
-      @maps = Helper.parse_maps(Helper.maps_of(@pid))
+    def load_maps
+      Helper.parse_maps(Helper.maps_of(@pid))
     end
 
     def bits_of(elf)

data/lib/heapinfo/segment.rb

@@ -5,7 +5,7 @@ module HeapInfo
     attr_reader :base
     # Name of segment
     attr_reader :name
-    # Instantiate a <tt>HeapInfo::Segment</tt> object
+    # Instantiate a {HeapInfo::Segment} object
     # @param [Integer] base Base address
     # @param [String] name Name of segment
     def initialize(base, name)
@@ -23,10 +23,10 @@ module HeapInfo
     #
     # Search the specific <tt>pattern</tt> in <tt>maps</tt> and return a {HeapInfo::Segment} object.
     #
-    # @param [Array] maps <tt>maps</tt> is in the form of the return value of <tt>HeapInfo::Helper.parse_maps</tt>.
+    # @param [Array] maps <tt>maps</tt> is in form of the return value of {Helper::ClassMethods#parse_maps}.
     # @param [Regexp, String] pattern
     #   The segment name want to match in maps. If +String+ is given, the pattern is matched as a substring.
-    # @return [HeapInfo::Segment, NilClass]
+    # @return [HeapInfo::Segment, nil]
     #   The request {HeapInfo::Segment} object. If the pattern is not matched, <tt>nil</tt> will be returned.
     def self.find(maps, pattern)
       return Nil.new if pattern.nil?

data/lib/heapinfo/version.rb

@@ -1,3 +1,4 @@
 module HeapInfo
-  VERSION = '1.0.0'.freeze
+  # Current gem version.
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heapinfo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dentaku