indis-core 0.1.0 → 0.1.1

data/lib/indis-core/binary_format.rb

@@ -24,7 +24,7 @@ module Indis
     
     # Returns a list of all known binary formats.
     #
-    # @return [Array] all known binary formats.
+    # @return [Array<Class>] all known binary formats.
     def self.known_formats
       fmt = []
       self.constants.each do |c|

data/lib/indis-core/binaryops_string.rb

@@ -0,0 +1,150 @@
+##############################################################################
+#   Indis framework                                                          #
+#   Copyright (C) 2012 Vladimir "Farcaller" Pouzanov <farcaller@gmail.com>   #
+#                                                                            #
+#   This program is free software: you can redistribute it and/or modify     #
+#   it under the terms of the GNU General Public License as published by     #
+#   the Free Software Foundation, either version 3 of the License, or        #
+#   (at your option) any later version.                                      #
+#                                                                            #
+#   This program is distributed in the hope that it will be useful,          #
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of           #
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            #
+#   GNU General Public License for more details.                             #
+#                                                                            #
+#   You should have received a copy of the GNU General Public License        #
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.    #
+##############################################################################
+
+# BinaryopsString manages bitwise operations on a String. This is useful when
+# you expect bitstrings with meaningful leading zeroes.
+class BinaryopsString < String
+  # BinaryopsString can be initialized either from a String or a Fixnum
+  # @param [String, Fixnum] s source value
+  def initialize(s)
+    if s.class == Fixnum
+      super s.to_s(2)
+    else
+      super
+    end
+  end
+  
+  # Outputs an unsigned int value of self
+  def to_i
+    super 2
+  end
+  
+  # Outputs a signed int value of self
+  def to_signed_i
+    return to_i if self[0] == '0'
+    complement = ('1'*(self.length)).to_i(2) - to_i + 1
+    -complement
+  end
+  
+  # @return a new BinaryopsString with a given slice (rightmost bit is 0)
+  # @param [Fixnum] from first bit (inclusive)
+  # @param [Fixnum] to last bit (inclusive)
+  def bits(from, to)
+    BinaryopsString.new(self.to_s[~from..~to])
+  end
+  
+  # @return a new BinaryopsString with a given slice (leftmost bit is 0)
+  # @param [Fixnum] from first bit (inclusive)
+  # @param [Fixnum] to last bit (inclusive)
+  def rbits(from, to)
+    BinaryopsString.new(self.to_s[from..to])
+  end
+  
+  # @return a Fixnum with given bit value (rightmost bit is 0)
+  # @param [Fixnum] i the bit in question
+  def bit(i)
+    self[~i].to_i
+  end
+  
+  # @return a Fixnum with given bit value (leftmost bit is 0)
+  # @param [Fixnum] i the bit in question
+  def rbit(i)
+    self[i].to_i
+  end
+  
+  # Performs an OR operation
+  # @return a new BinaryopsString with result
+  # @raise [ArgumentError] when BinaryopsString lengths don't match
+  def |(other)
+    raise ArgumentError unless self.length == other.length
+    BinaryopsString.new(self.to_i | other.to_i).zero_extend(self.length)
+  end
+  
+  # Concatenates the receiver with another BinaryopsString
+  # @return a new BinaryopsString with result
+  def concat(other)
+    BinaryopsString.new(self.to_s + other.to_s)
+  end
+  
+  # Zero-extends the receiver to given length (left padding)
+  # @return a new BinaryopsString with result
+  def zero_extend(len)
+    return self unless len-self.length > 0
+    zbs = '0'*(len-self.length)
+    BinaryopsString.new(zbs + self.to_s)
+  end
+  
+  # Sign-extends the receiver to given length (left padding)
+  # @return a new BinaryopsString with result
+  def sign_extend(len)
+    return self unless len-self.length > 0
+    zbs = self[0]*(len-self.length)
+    BinaryopsString.new(zbs + self.to_s)
+  end
+  
+  # Performs a LSL operation
+  # @return a new BinaryopsString with result
+  def <<(amount)
+    return self if amount == 0
+    z = BinaryopsString.zeroes(amount)
+    concat(z).bits(self.length-1, 0)
+  end
+  
+  # Performs a LSR operation
+  # @return a new BinaryopsString with result
+  def >>(amount)
+    return self if amount == 0
+    z = BinaryopsString.zeroes(amount)
+    z.concat(self).rbits(0, self.length-1)
+  end
+  
+  # Performs a ROR operation (cyclic LSR)
+  # @return a new BinaryopsString with result
+  def ror(amount)
+    return self if amount == 0
+    s = self.to_s
+    moveover = s[-amount..-1]
+    movable = s[0...-amount]
+    BinaryopsString.new(moveover + movable)
+  end
+  
+  # Returns a new BinaryopsString filled in with zeroes of given length
+  def self.zeroes(n)
+    BinaryopsString.new('0'*n)
+  end
+end
+
+class String
+  # Helper method to convert String to BinaryopsString
+  def to_bo
+    BinaryopsString.new(self)
+  end
+end
+
+class Fixnum
+  # Helper method to convert Fixnum to BinaryopsString
+  def to_bo
+    BinaryopsString.new(self.to_s(2))
+  end
+  
+  # Helper method to convert Fixnum to BinaryopsString with given length
+  # (zero-padded)
+  def to_boz(len)
+    BinaryopsString.new(self.to_s(2)).zero_extend(len)
+  end
+end

data/lib/indis-core/segment.rb

@@ -25,7 +25,7 @@ module Indis
   # @note this class is heavily based on Mach-O
   class Segment
     # Contains a list of current segment sections
-    # @return [Array]
+    # @return [Array<Indis::Section>]
     attr_reader :sections
     
     attr_reader :target   # @return [Indis::Target] owning target

data/lib/indis-core/target.rb

@@ -30,9 +30,9 @@ module Indis
     
     attr_reader :vmmap  # @return [Indis::VMMap] virtual memory map
 
-    attr_accessor :segments # @return [Array] list of all processed {Indis::Segment segments}
+    attr_accessor :segments # @return [Array<Indis::Segment>] list of all processed {Indis::Segment segments}
     
-    attr_accessor :symbols  # @return [Array] list of all processed {Indis::Symbol symbols}
+    attr_accessor :symbols  # @return [Array<Indis::Symbol>] list of all processed {Indis::Symbol symbols}
     
     # @param [String] filename target binary file name
     # @raise [AttributeError] if the file does not exist

data/lib/indis-core/version.rb

@@ -17,5 +17,5 @@
 ##############################################################################
 
 module Indis
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/indis-core/vmmap.rb

@@ -54,7 +54,7 @@ module Indis
       s.bytes[ofs-s.vmaddr].ord
     end
     
-    # @return [Array] a list of bytes at given virtual address span
+    # @return [Array<Fixnum>] a list of bytes at given virtual address span
     def bytes_at(ofs, size)
       seg = segment_at(ofs)
       return nil unless seg
@@ -110,7 +110,7 @@ module Indis
     #   nil's. For each unmapped byte it is returned as a Fixnum
     #
     #   @param [Range] range range
-    #   @return [Array] mapped entities
+    #   @return [Array<Indis::Entity,nil,Fixnum>] mapped entities
     #   @raise [ArgumentError] if there is no segment at given range or the range spans several segments
     def [](range)
       return entity_at(range) if range.is_a?(Fixnum)

data/spec/indis-core/binaryops_string_spec.rb

@@ -0,0 +1,55 @@
+require 'indis-core/binaryops_string'
+
+describe BinaryopsString do
+  it "should initialize from String" do
+    BinaryopsString.new('0110').should == '0110'
+    BinaryopsString.new('0110').to_i.should == 0b0110
+  end
+  
+  it "should initialize from Fixnum" do
+    BinaryopsString.new(0b0110).should == '110'
+    BinaryopsString.new(0b0110).to_i.should == 0b110    
+  end
+  
+  it "should initialize from given zeroes count" do
+    BinaryopsString.zeroes(5).should == '00000'
+    BinaryopsString.zeroes(5).to_i.should == 0
+  end
+  
+  it "should perform concatenation" do
+    BinaryopsString.new('0110').concat(BinaryopsString.new('0001')).to_s.should == '01100001'
+  end
+  
+  it "should perform zero extension" do
+    BinaryopsString.new('0110').zero_extend(8).should == '00000110'
+    BinaryopsString.new('0110').zero_extend(4).should == '0110'
+    BinaryopsString.new('0110').zero_extend(0).should == '0110'
+  end
+  
+  it "should perform sign extension" do
+    BinaryopsString.new('1010').sign_extend(8).should == '11111010'
+    BinaryopsString.new('0010').sign_extend(8).should == '00000010'
+  end
+  
+  it "should output correct sign on to_signed_i" do
+    BinaryopsString.new('11111010').to_signed_i.should == -6
+    BinaryopsString.new('00001010').to_signed_i.should == 10
+  end
+  
+  it "should output correct sign on to_i" do
+    BinaryopsString.new('11111010').to_i.should == 250
+    BinaryopsString.new('00001010').to_i.should == 10
+  end
+  
+  it "should perform lsl / lsr" do
+    (BinaryopsString.new('0110') << 1).should == '1100'
+    (BinaryopsString.new('0110') >> 1).should == '0011'
+    (BinaryopsString.new('0110') << 2).should == '1000'
+    (BinaryopsString.new('0110') >> 2).should == '0001'
+  end
+  
+  it "should perform ror" do
+    (BinaryopsString.new('0110').ror(1)).should == '0011'
+    (BinaryopsString.new('0110').ror(2)).should == '1001'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indis-core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -45,6 +45,7 @@ files:
 - indis-core.gemspec
 - lib/indis-core.rb
 - lib/indis-core/binary_format.rb
+- lib/indis-core/binaryops_string.rb
 - lib/indis-core/data_entity.rb
 - lib/indis-core/entity.rb
 - lib/indis-core/section.rb
@@ -55,6 +56,7 @@ files:
 - lib/indis-core/vmmap.rb
 - spec/fixtures/single-object.o
 - spec/indis-core/binary_format_spec.rb
+- spec/indis-core/binaryops_string_spec.rb
 - spec/indis-core/data_entity_spec.rb
 - spec/indis-core/section_spec.rb
 - spec/indis-core/segment_spec.rb
@@ -90,6 +92,7 @@ summary: Core indis components
 test_files:
 - spec/fixtures/single-object.o
 - spec/indis-core/binary_format_spec.rb
+- spec/indis-core/binaryops_string_spec.rb
 - spec/indis-core/data_entity_spec.rb
 - spec/indis-core/section_spec.rb
 - spec/indis-core/segment_spec.rb