elftools 1.0.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19ea6d2a816767e47ee17390784085a33e1fe331
-  data.tar.gz: f4af2d0e5552c02ee43d4de74afecd077926532d
+SHA256:
+  metadata.gz: ef6779875e27077da47848a95cef46ee26be52e56e763c0850dbd2e22e7e100b
+  data.tar.gz: a9b422a4fb0a11a08036e222475110f9a9f6f788ce8c775d6e67d0e6f1b5a9c6
 SHA512:
-  metadata.gz: a368bc9ee554c9ca775d8e2d51b121965d242f64d2b2a838d249a3914d0d91ece6a3469c36519fa9fdd5d1347f2ff291917adf43e39f488509f29faac5348eda
-  data.tar.gz: 8d777854fc6d4f931452aa0e738202496dd9dd7ce01b22e25da1cf40e1e4839f944cdd95de99e5a88cea85fab2eb611859379b5dc78180a4d0ff42ea835c1f13
+  metadata.gz: 13f82b3b243a09531408986b1acef31556089bca5927077c9e4d490632229f77cef97f9fdd1eb4343be8dc9bbb9f55e57b3ee51f5da5651009bd4b4ac3724eb5
+  data.tar.gz: 276ad11bcc135f067046694da526da5078cfdc0b24137cadeb7d8c52b0ddb462b23ee7d47c97bc08611160d436240c559ff1b4d18b51ed78a0b607c0973dc913

data/lib/elftools.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/constants'
 require 'elftools/elf_file'
 require 'elftools/version'

data/lib/elftools/constants.rb

@@ -1,54 +1,49 @@
+# frozen_string_literal: true
+
 module ELFTools
   # Define constants from elf.h.
   # Mostly refer from https://github.com/torvalds/linux/blob/master/include/uapi/linux/elf.h
   # and binutils/elfcpp/elfcpp.h.
   module Constants
     # ELF magic header
-    ELFMAG = "\x7FELF".freeze
+    ELFMAG = "\x7FELF"
 
-    # Section header types, records in +sh_type+.
-    module SHT
-      SHT_NULL     = 0 # null section
-      SHT_PROGBITS = 1 # information defined by program itself
-      SHT_SYMTAB   = 2 # symbol table section
-      SHT_STRTAB   = 3 # string table section
-      SHT_RELA     = 4 # relocation with addends
-      SHT_HASH     = 5 # symbol hash table
-      SHT_DYNAMIC  = 6 # information of dynamic linking
-      SHT_NOTE     = 7 # note section
-      SHT_NOBITS   = 8 # section occupies no space
-      SHT_REL      = 9 # relocation
-      SHT_SHLIB    = 10 # reserved
-      SHT_DYNSYM   = 11 # symbols for dynamic
-      # Values between {SHT_LOPROC} and {SHT_HIPROC} are reserved for processor-specific semantics.
-      SHT_LOPROC   = 0x70000000
-      SHT_HIPROC   = 0x7fffffff # see {SHT_LOPROC}
-      # Values between {SHT_LOUSER} and {SHT_HIUSER} are reserved for application programs.
-      SHT_LOUSER   = 0x80000000
-      SHT_HIUSER   = 0xffffffff # see {SHT_LOUSER}
-    end
-    include SHT
+    # Values of `d_un.d_val' in the DT_FLAGS and DT_FLAGS_1 entry.
+    module DF
+      DF_ORIGIN       = 0x00000001 # Object may use DF_ORIGIN
+      DF_SYMBOLIC     = 0x00000002 # Symbol resolutions starts here
+      DF_TEXTREL      = 0x00000004 # Object contains text relocations
+      DF_BIND_NOW     = 0x00000008 # No lazy binding for this object
+      DF_STATIC_TLS   = 0x00000010 # Module uses the static TLS model
 
-    # Program header types, records in +p_type+.
-    module PT
-      PT_NULL         = 0          # null segment
-      PT_LOAD         = 1          # segment to be load
-      PT_DYNAMIC      = 2          # dynamic tags
-      PT_INTERP       = 3          # interpreter, same as .interp section
-      PT_NOTE         = 4          # same as .note* section
-      PT_SHLIB        = 5          # reserved
-      PT_PHDR         = 6          # where program header starts
-      PT_TLS          = 7          # thread local storage segment
-      PT_LOOS         = 0x60000000 # OS-specific
-      PT_HIOS         = 0x6fffffff # OS-specific
-      # Values between {PT_LOPROC} and {PT_HIPROC} are reserved for processor-specific semantics.
-      PT_LOPROC       = 0x70000000
-      PT_HIPROC       = 0x7fffffff # see {PT_LOPROC}
-      PT_GNU_EH_FRAME = 0x6474e550 # for exception handler
-      PT_GNU_STACK    = 0x6474e551 # permission of stack
-      PT_GNU_RELRO    = 0x6474e552 # read only after relocation
+      DF_1_NOW        = 0x00000001 # Set RTLD_NOW for this object.
+      DF_1_GLOBAL     = 0x00000002 # Set RTLD_GLOBAL for this object.
+      DF_1_GROUP      = 0x00000004 # Set RTLD_GROUP for this object.
+      DF_1_NODELETE   = 0x00000008 # Set RTLD_NODELETE for this object.
+      DF_1_LOADFLTR   = 0x00000010 # Trigger filtee loading at runtime.
+      DF_1_INITFIRST  = 0x00000020 # Set RTLD_INITFIRST for this object
+      DF_1_NOOPEN     = 0x00000040 # Set RTLD_NOOPEN for this object.
+      DF_1_ORIGIN     = 0x00000080 # $ORIGIN must be handled.
+      DF_1_DIRECT     = 0x00000100 # Direct binding enabled.
+      DF_1_TRANS      = 0x00000200 # :nodoc:
+      DF_1_INTERPOSE  = 0x00000400 # Object is used to interpose.
+      DF_1_NODEFLIB   = 0x00000800 # Ignore default lib search path.
+      DF_1_NODUMP     = 0x00001000 # Object can't be dldump'ed.
+      DF_1_CONFALT    = 0x00002000 # Configuration alternative created.
+      DF_1_ENDFILTEE  = 0x00004000 # Filtee terminates filters search.
+      DF_1_DISPRELDNE = 0x00008000 # Disp reloc applied at build time.
+      DF_1_DISPRELPND = 0x00010000 # Disp reloc applied at run-time.
+      DF_1_NODIRECT   = 0x00020000 # Object has no-direct binding.
+      DF_1_IGNMULDEF  = 0x00040000 # :nodoc:
+      DF_1_NOKSYMS    = 0x00080000 # :nodoc:
+      DF_1_NOHDR      = 0x00100000 # :nodoc:
+      DF_1_EDITED     = 0x00200000 # Object is modified after built.
+      DF_1_NORELOC    = 0x00400000 # :nodoc:
+      DF_1_SYMINTPOSE = 0x00800000 # Object has individual interposers.
+      DF_1_GLOBAUDIT  = 0x01000000 # Global auditing required.
+      DF_1_SINGLETON  = 0x02000000 # Singleton symbols are used.
     end
-    include PT
+    include DF
 
     # Dynamic table types, records in +d_tag+.
     module DT
@@ -100,6 +95,7 @@ module ELFTools
       DT_VERDEF       = 0x6ffffffc # address of version definition table
       DT_VERDEFNUM    = 0x6ffffffd # number of entries in {DT_VERDEF}
       DT_VERNEED      = 0x6ffffffe # address of version dependency table
+      DT_VERSYM       = 0x6ffffff0 # section address of .gnu.version
       DT_VERNEEDNUM   = 0x6fffffff # number of entries in {DT_VERNEED}
       # Values between {DT_LOPROC} and {DT_HIPROC} are reserved for processor-specific semantics.
       DT_LOPROC       = 0x70000000
@@ -107,43 +103,6 @@ module ELFTools
     end
     include DT
 
-    # Values of `d_un.d_val' in the DT_FLAGS and DT_FLAGS_1 entry.
-    module DF
-      DF_ORIGIN       = 0x00000001 # Object may use DF_ORIGIN
-      DF_SYMBOLIC     = 0x00000002 # Symbol resolutions starts here
-      DF_TEXTREL      = 0x00000004 # Object contains text relocations
-      DF_BIND_NOW     = 0x00000008 # No lazy binding for this object
-      DF_STATIC_TLS   = 0x00000010 # Module uses the static TLS model
-
-      DF_1_NOW        = 0x00000001 # Set RTLD_NOW for this object.
-      DF_1_GLOBAL     = 0x00000002 # Set RTLD_GLOBAL for this object.
-      DF_1_GROUP      = 0x00000004 # Set RTLD_GROUP for this object.
-      DF_1_NODELETE   = 0x00000008 # Set RTLD_NODELETE for this object.
-      DF_1_LOADFLTR   = 0x00000010 # Trigger filtee loading at runtime.
-      DF_1_INITFIRST  = 0x00000020 # Set RTLD_INITFIRST for this object
-      DF_1_NOOPEN     = 0x00000040 # Set RTLD_NOOPEN for this object.
-      DF_1_ORIGIN     = 0x00000080 # $ORIGIN must be handled.
-      DF_1_DIRECT     = 0x00000100 # Direct binding enabled.
-      DF_1_TRANS      = 0x00000200 # :nodoc:
-      DF_1_INTERPOSE  = 0x00000400 # Object is used to interpose.
-      DF_1_NODEFLIB   = 0x00000800 # Ignore default lib search path.
-      DF_1_NODUMP     = 0x00001000 # Object can't be dldump'ed.
-      DF_1_CONFALT    = 0x00002000 # Configuration alternative created.
-      DF_1_ENDFILTEE  = 0x00004000 # Filtee terminates filters search.
-      DF_1_DISPRELDNE = 0x00008000 # Disp reloc applied at build time.
-      DF_1_DISPRELPND = 0x00010000 # Disp reloc applied at run-time.
-      DF_1_NODIRECT   = 0x00020000 # Object has no-direct binding.
-      DF_1_IGNMULDEF  = 0x00040000 # :nodoc:
-      DF_1_NOKSYMS    = 0x00080000 # :nodoc:
-      DF_1_NOHDR      = 0x00100000 # :nodoc:
-      DF_1_EDITED     = 0x00200000 # Object is modified after built.
-      DF_1_NORELOC    = 0x00400000 # :nodoc:
-      DF_1_SYMINTPOSE = 0x00800000 # Object has individual interposers.
-      DF_1_GLOBAUDIT  = 0x01000000 # Global auditing required.
-      DF_1_SINGLETON  = 0x02000000 # Singleton symbols are used.
-    end
-    include DF
-
     # These constants define the various ELF target machines.
     module EM
       EM_NONE           = 0      # none
@@ -253,5 +212,109 @@ module ELFTools
       end
     end
     include ET
+
+    # Program header permission flags, records bitwise OR value in +p_flags+.
+    module PF
+      PF_X = 1
+      PF_W = 2
+      PF_R = 4
+    end
+    include PF
+
+    # Program header types, records in +p_type+.
+    module PT
+      PT_NULL         = 0          # null segment
+      PT_LOAD         = 1          # segment to be load
+      PT_DYNAMIC      = 2          # dynamic tags
+      PT_INTERP       = 3          # interpreter, same as .interp section
+      PT_NOTE         = 4          # same as .note* section
+      PT_SHLIB        = 5          # reserved
+      PT_PHDR         = 6          # where program header starts
+      PT_TLS          = 7          # thread local storage segment
+      PT_LOOS         = 0x60000000 # OS-specific
+      PT_HIOS         = 0x6fffffff # OS-specific
+      # Values between {PT_LOPROC} and {PT_HIPROC} are reserved for processor-specific semantics.
+      PT_LOPROC       = 0x70000000
+      PT_HIPROC       = 0x7fffffff # see {PT_LOPROC}
+      PT_GNU_EH_FRAME = 0x6474e550 # for exception handler
+      PT_GNU_STACK    = 0x6474e551 # permission of stack
+      PT_GNU_RELRO    = 0x6474e552 # read only after relocation
+    end
+    include PT
+
+    # Special indices to section. These are used when there is no valid index to section header.
+    # The meaning of these values is left upto the embedding header.
+    module SHN
+      SHN_UNDEF     = 0      # undefined section
+      SHN_LORESERVE = 0xff00 # start of reserved indices
+    end
+    include SHN
+
+    # Section header types, records in +sh_type+.
+    module SHT
+      SHT_NULL     = 0 # null section
+      SHT_PROGBITS = 1 # information defined by program itself
+      SHT_SYMTAB   = 2 # symbol table section
+      SHT_STRTAB   = 3 # string table section
+      SHT_RELA     = 4 # relocation with addends
+      SHT_HASH     = 5 # symbol hash table
+      SHT_DYNAMIC  = 6 # information of dynamic linking
+      SHT_NOTE     = 7 # note section
+      SHT_NOBITS   = 8 # section occupies no space
+      SHT_REL      = 9 # relocation
+      SHT_SHLIB    = 10 # reserved
+      SHT_DYNSYM   = 11 # symbols for dynamic
+      # Values between {SHT_LOPROC} and {SHT_HIPROC} are reserved for processor-specific semantics.
+      SHT_LOPROC   = 0x70000000
+      SHT_HIPROC   = 0x7fffffff # see {SHT_LOPROC}
+      # Values between {SHT_LOUSER} and {SHT_HIUSER} are reserved for application programs.
+      SHT_LOUSER   = 0x80000000
+      SHT_HIUSER   = 0xffffffff # see {SHT_LOUSER}
+    end
+    include SHT
+
+    # Symbol binding from Sym st_info field.
+    module STB
+      STB_LOCAL      = 0 # Local symbol
+      STB_GLOBAL     = 1 # Global symbol
+      STB_WEAK       = 2 # Weak symbol
+      STB_NUM        = 3 # Number of defined types.
+      STB_LOOS       = 10 # Start of OS-specific
+      STB_GNU_UNIQUE = 10 # Unique symbol.
+      STB_HIOS       = 12 # End of OS-specific
+      STB_LOPROC     = 13 # Start of processor-specific
+      STB_HIPROC     = 15 # End of processor-specific
+    end
+    include STB
+
+    # Symbol types from Sym st_info field.
+    module STT
+      STT_NOTYPE         = 0 # Symbol type is unspecified
+      STT_OBJECT         = 1 # Symbol is a data object
+      STT_FUNC           = 2 # Symbol is a code object
+      STT_SECTION        = 3 # Symbol associated with a section
+      STT_FILE           = 4 # Symbol's name is file name
+      STT_COMMON         = 5 # Symbol is a common data object
+      STT_TLS            = 6 # Symbol is thread-local data object
+      STT_NUM            = 7 # Number of defined types.
+
+      # GNU extension: symbol value points to a function which is called
+      # at runtime to determine the final value of the symbol.
+      STT_GNU_IFUNC      = 10
+
+      STT_LOOS           = 10 # Start of OS-specific
+      STT_HIOS           = 12 # End of OS-specific
+      STT_LOPROC         = 13 # Start of processor-specific
+      STT_HIPROC         = 15 # End of processor-specific
+
+      # The section type that must be used for register symbols on
+      # Sparc. These symbols initialize a global register.
+      STT_SPARC_REGISTER = 13
+
+      # ARM: a THUMB function. This is not defined in ARM ELF Specification but
+      # used by the GNU tool-chain.
+      STT_ARM_TFUNC      = 13
+    end
+    include STT
   end
 end

data/lib/elftools/dynamic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ELFTools
   # Define common methods for dynamic sections and dynamic segments.
   #
@@ -18,6 +20,7 @@ module ELFTools
     #   Otherwise, return array of tags.
     def each_tags(&block)
       return enum_for(:each_tags) unless block_given?
+
       arr = []
       0.step do |i|
         tag = tag_at(i).tap(&block)
@@ -31,7 +34,7 @@ module ELFTools
     # @return [Array<ELFTools::Dynamic::Tag>]
     #   Array of tags.
     def tags
-      each_tags.to_a
+      @tags ||= each_tags.to_a
     end
 
     # Get a tag of specific type.
@@ -63,6 +66,18 @@ module ELFTools
       each_tags.find { |tag| tag.header.d_tag == type }
     end
 
+    # Get tags of specific type.
+    # @param [Integer, Symbol, String] type
+    #   Constant value, symbol, or string of type
+    #   is acceptable. See examples for more information.
+    # @return [Array<ELFTools::Dynamic::Tag>] The desired tags.
+    #
+    # @see #tag_by_type
+    def tags_by_type(type)
+      type = Util.to_constant(Constants::DT, type)
+      each_tags.select { |tag| tag.header.d_tag == type }
+    end
+
     # Get the +n+-th tag.
     #
     # Tags are lazy loaded.
@@ -76,9 +91,11 @@ module ELFTools
     # @param [Integer] n The index.
     # @return [ELFTools::Dynamic::Tag] The desired tag.
     def tag_at(n)
-      return if n < 0
+      return if n.negative?
+
       @tag_at_map ||= {}
       return @tag_at_map[n] if @tag_at_map[n]
+
       dyn = Structs::ELF_Dyn.new(endian: endian)
       dyn.elf_class = header.elf_class
       stream.pos = tag_start + n * dyn.num_bytes
@@ -153,6 +170,7 @@ module ELFTools
       # @return [String, nil] The name.
       def name
         return nil unless name?
+
         Util.cstring(stream, @str_offset.call + header.d_val.to_i)
       end
     end

data/lib/elftools/elf_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/constants'
 require 'elftools/exceptions'
 require 'elftools/lazy_array'
@@ -32,6 +34,7 @@ module ELFTools
     # @return [ELFTools::Structs::ELF_Ehdr] The header.
     def header
       return @header if defined?(@header)
+
       stream.pos = 0
       @header = Structs::ELF_Ehdr.new(endian: endian, offset: stream.pos)
       @header.elf_class = elf_class
@@ -49,9 +52,11 @@ module ELFTools
     def build_id
       section = section_by_name('.note.gnu.build-id')
       return nil if section.nil?
+
       note = section.notes.first
       return nil if note.nil?
-      note.desc.unpack('H*').first
+
+      note.desc.unpack1('H*')
     end
 
     # Get machine architecture.
@@ -116,6 +121,7 @@ module ELFTools
     #   otherwise, the whole sections will be returned.
     def each_sections(&block)
       return enum_for(:each_sections) unless block_given?
+
       Array.new(num_sections) do |i|
         section_at(i).tap(&block)
       end
@@ -188,6 +194,7 @@ module ELFTools
     #   Whole segments will be returned.
     def each_segments(&block)
       return enum_for(:each_segments) unless block_given?
+
       Array.new(num_segments) do |i|
         segment_at(i).tap(&block)
       end
@@ -277,18 +284,15 @@ module ELFTools
     #
     # This method should work no matter ELF is a PIE or not.
     # This method refers from (actually equals to) binutils/readelf.c#offset_from_vma.
-    # @param [Integer] vma The address need query.
-    # @return [Integer] Offset related to file.
+    # @param [Integer] vma The virtual address to be queried.
+    # @return [Integer] Related file offset.
     # @example
     #   elf = ELFTools::ELFFile.new(File.open('/bin/cat'))
     #   elf.offset_from_vma(0x401337)
     #   #=> 4919 # 0x1337
     def offset_from_vma(vma, size = 0)
       segments_by_type(:load) do |seg|
-        if vma >= (seg.header.p_vaddr & -seg.header.p_align) &&
-           vma + size <= seg.header.p_vaddr + seg.header.p_filesz
-          return vma - seg.header.p_vaddr + seg.header.p_offset
-        end
+        return seg.vma_to_offset(vma) if seg.vma_in?(vma, size)
       end
     end
 
@@ -324,6 +328,7 @@ module ELFTools
       explore = lambda do |obj|
         return obj if obj.is_a?(::ELFTools::Structs::ELFStruct)
         return obj.map(&explore) if obj.is_a?(Array)
+
         obj.instance_variables.map do |s|
           explore.call(obj.instance_variable_get(s))
         end
@@ -334,19 +339,21 @@ module ELFTools
     def identify
       stream.pos = 0
       magic = stream.read(4)
-      raise ELFError, "Invalid magic number #{magic.inspect}" unless magic == Constants::ELFMAG
+      raise ELFMagicError, "Invalid magic number #{magic.inspect}" unless magic == Constants::ELFMAG
+
       ei_class = stream.read(1).ord
       @elf_class = {
         1 => 32,
         2 => 64
       }[ei_class]
-      raise ELFError, format('Invalid EI_CLASS "\x%02x"', ei_class) if elf_class.nil?
+      raise ELFClassError, format('Invalid EI_CLASS "\x%02x"', ei_class) if elf_class.nil?
+
       ei_data = stream.read(1).ord
       @endian = {
         1 => :little,
         2 => :big
       }[ei_data]
-      raise ELFError, format('Invalid EI_DATA "\x%02x"', ei_data) if endian.nil?
+      raise ELFDataError, format('Invalid EI_DATA "\x%02x"', ei_data) if endian.nil?
     end
 
     def create_section(n)

data/lib/elftools/exceptions.rb

@@ -1,4 +1,15 @@
+# frozen_string_literal: true
+
 module ELFTools
   # Being raised when parsing error.
   class ELFError < StandardError; end
+
+  # Raised on invalid ELF magic.
+  class ELFMagicError < ELFError; end
+
+  # Raised on invalid ELF class (EI_CLASS).
+  class ELFClassError < ELFError; end
+
+  # Raised on invalid ELF data encoding (EI_DATA).
+  class ELFDataError < ELFError; end
 end

data/lib/elftools/lazy_array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ELFTools
   # A helper class for {ELFTools} easy to implement
   # 'lazy loading' objects.
@@ -37,7 +39,8 @@ module ELFTools
     #   return type of block given in {#initialize}.
     def [](i)
       # XXX: support negative index?
-      return nil if i < 0 || i >= @internal.size
+      return nil unless i.between?(0, @internal.size - 1)
+
       @internal[i] ||= @block.call(i)
     end
   end

data/lib/elftools/note.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/structs'
 require 'elftools/util'
 
@@ -41,6 +43,7 @@ module ELFTools
     #   Otherwise, return the array of notes.
     def each_notes
       return enum_for(:each_notes) unless block_given?
+
       @notes_offset_map ||= {}
       cur = note_start
       notes = []
@@ -100,7 +103,8 @@ module ELFTools
       # Name of this note.
       # @return [String] The name.
       def name
-        return @name if @name
+        return @name if defined?(@name)
+
         stream.pos = @offset + SIZE_OF_NHDR
         @name = stream.read(header.n_namesz)[0..-2]
       end
@@ -108,7 +112,8 @@ module ELFTools
       # Description of this note.
       # @return [String] The description.
       def desc
-        return @desc if @desc
+        return @desc if instance_variable_defined?(:@desc)
+
         stream.pos = @offset + SIZE_OF_NHDR + Util.align(header.n_namesz, 2)
         @desc = stream.read(header.n_descsz)
       end

data/lib/elftools/sections/dynamic_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/dynamic'
 require 'elftools/sections/section'
 

data/lib/elftools/sections/note_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/note'
 require 'elftools/sections/section'
 

data/lib/elftools/sections/null_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/sections/section'
 
 module ELFTools

data/lib/elftools/sections/relocation_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/constants'
 require 'elftools/sections/section'
 require 'elftools/structs'
@@ -42,6 +44,7 @@ module ELFTools
       #   Otherwise, the whole relocations will be returned.
       def each_relocations(&block)
         return enum_for(:each_relocations) unless block_given?
+
         Array.new(num_relocations) do |i|
           relocation_at(i).tap(&block)
         end

data/lib/elftools/sections/section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/constants'
 module ELFTools
   module Sections

data/lib/elftools/sections/sections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Require this file to load all sections classes.
 
 require 'elftools/sections/section'
@@ -19,7 +21,7 @@ module ELFTools
       # @param [#pos=, #read] stream Streaming object.
       # @return [ELFTools::Sections::Section]
       #   Return object dependes on +header.sh_type+.
-      def create(header, stream, *args)
+      def create(header, stream, *args, **kwargs)
         klass = case header.sh_type
                 when Constants::SHT_DYNAMIC then DynamicSection
                 when Constants::SHT_NULL then NullSection
@@ -29,7 +31,7 @@ module ELFTools
                 when Constants::SHT_SYMTAB, Constants::SHT_DYNSYM then SymTabSection
                 else Section
                 end
-        klass.new(header, stream, *args)
+        klass.new(header, stream, *args, **kwargs)
       end
     end
   end

data/lib/elftools/sections/str_tab_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/sections/section'
 require 'elftools/util'
 

data/lib/elftools/sections/sym_tab_section.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/sections/section'
 
 module ELFTools
@@ -56,6 +58,7 @@ module ELFTools
       #   Otherwise return array of symbols.
       def each_symbols(&block)
         return enum_for(:each_symbols) unless block_given?
+
         Array.new(num_symbols) do |i|
           symbol_at(i).tap(&block)
         end

data/lib/elftools/segments/dynamic_segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/segments/segment'
 require 'elftools/dynamic'
 

data/lib/elftools/segments/interp_segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/segments/segment'
 
 module ELFTools

data/lib/elftools/segments/load_segment.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'elftools/segments/segment'
+
+module ELFTools
+  module Segments
+    # For DT_LOAD segment.
+    # Able to query between file offset and virtual memory address.
+    class LoadSegment < Segment
+      # Returns the start of this segment.
+      # @return [Integer]
+      #   The file offset.
+      def file_head
+        header.p_offset.to_i
+      end
+
+      # Returns size in file.
+      # @return [Integer]
+      #   The size.
+      def size
+        header.p_filesz.to_i
+      end
+
+      # Returns the end of this segment.
+      # @return [Integer]
+      #   The file offset.
+      def file_tail
+        file_head + size
+      end
+
+      # Returns the start virtual address of this segment.
+      # @return [Integer]
+      #   The vma.
+      def mem_head
+        header.p_vaddr.to_i
+      end
+
+      # Returns size in memory.
+      # @return [Integer]
+      #   The size.
+      def mem_size
+        header.p_memsz.to_i
+      end
+
+      # Returns the end virtual address of this segment.
+      # @return [Integer]
+      #   The vma.
+      def mem_tail
+        mem_head + mem_size
+      end
+
+      # Query if the given file offset located in this segment.
+      # @param [Integer] offset
+      #   File offset.
+      # @param [Integer] size
+      #   Size.
+      # @return [Boolean]
+      def offset_in?(offset, size = 0)
+        file_head <= offset && offset + size < file_tail
+      end
+
+      # Convert file offset into virtual memory address.
+      # @param [Integer] offset
+      #   File offset.
+      # @return [Integer]
+      def offset_to_vma(offset)
+        # XXX: What if file_head is not aligned with p_vaddr (which is invalid according to ELF spec)?
+        offset - file_head + header.p_vaddr
+      end
+
+      # Query if the given virtual memory address located in this segment.
+      # @param [Integer] vma
+      #   Virtual memory address.
+      # @param [Integer] size
+      #   Size.
+      # @return [Boolean]
+      def vma_in?(vma, size = 0)
+        vma >= (header.p_vaddr & -header.p_align) &&
+          vma + size <= mem_tail
+      end
+
+      # Convert virtual memory address into file offset.
+      # @param [Integer] vma
+      #   Virtual memory address.
+      # @return [Integer]
+      def vma_to_offset(vma)
+        vma - header.p_vaddr + header.p_offset
+      end
+    end
+  end
+end

data/lib/elftools/segments/note_segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'elftools/note'
 require 'elftools/segments/segment'
 

data/lib/elftools/segments/segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ELFTools
   module Segments
     # Base class of segments.

data/lib/elftools/segments/segments.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 # Require this file to load all segment classes.
 
 require 'elftools/segments/segment'
 
 require 'elftools/segments/dynamic_segment'
 require 'elftools/segments/interp_segment'
+require 'elftools/segments/load_segment'
 require 'elftools/segments/note_segment'
 
 module ELFTools
@@ -16,14 +19,15 @@ module ELFTools
       # @param [#pos=, #read] stream Streaming object.
       # @return [ELFTools::Segments::Segment]
       #   Return object dependes on +header.p_type+.
-      def create(header, stream, *args)
+      def create(header, stream, *args, **kwargs)
         klass = case header.p_type
                 when Constants::PT_DYNAMIC then DynamicSegment
                 when Constants::PT_INTERP then InterpSegment
+                when Constants::PT_LOAD then LoadSegment
                 when Constants::PT_NOTE then NoteSegment
                 else Segment
                 end
-        klass.new(header, stream, *args)
+        klass.new(header, stream, *args, **kwargs)
       end
     end
   end

data/lib/elftools/structs.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bindata'
+
 module ELFTools
   # Define ELF related structures in this module.
   #
   # Structures are fetched from https://github.com/torvalds/linux/blob/master/include/uapi/linux/elf.h.
-  # Using the bindata gem to make these structures support 32/64 bits and
-  # little/big endian simultaneously.
+  # Use gem +bindata+ to have these structures support 32/64 bits and little/big endian simultaneously.
   module Structs
     # The base structure to define common methods.
     class ELFStruct < BinData::Record
@@ -23,9 +25,13 @@ module ELFTools
       end
 
       class << self
-        # Hook constructor, while +BinData::Record+ doesn't allow us to override +#initialize+,
-        # so we hack +new+ here.
-        def new(**kwargs)
+        # Hooks the constructor.
+        #
+        # +BinData::Record+ doesn't allow us to override +#initialize+, so we hack +new+ here.
+        def new(*args)
+          # XXX: The better implementation is +new(*args, **kwargs)+, but we can't do this unless bindata changed
+          # lib/bindata/dsl.rb#override_new_in_class to invoke +new+ with both +args+ and +kwargs+.
+          kwargs = args.last.is_a?(Hash) ? args.last : {}
           offset = kwargs.delete(:offset)
           super.tap do |obj|
             obj.offset = offset
@@ -42,18 +48,19 @@ module ELFTools
           end
         end
 
-        # Hacking to get endian of current class
-        # @return [Symbol, nil] +:little+ or +:big+.
+        # Gets the endianness of current class.
+        # @return [:little, :big] The endianness.
         def self_endian
           bindata_name[-2..-1] == 'be' ? :big : :little
         end
 
-        # Pack integer into string.
+        # Packs an integer to string.
         # @param [Integer] val
         # @param [Integer] bytes
         # @return [String]
         def pack(val, bytes)
           raise ArgumentError, "Not supported assign type #{val.class}" unless val.is_a?(Integer)
+
           number = val & ((1 << (8 * bytes)) - 1)
           out = []
           bytes.times do
@@ -109,7 +116,7 @@ module ELFTools
       choice :sh_entsize, **CHOICE_SIZE_T
     end
 
-    # Program header structure for 32bit.
+    # Program header structure for 32-bit.
     class ELF32_Phdr < ELFStruct
       endian :big_and_little
       uint32 :p_type
@@ -122,7 +129,7 @@ module ELFTools
       uint32 :p_align
     end
 
-    # Program header structure for 64bit.
+    # Program header structure for 64-bit.
     class ELF64_Phdr < ELFStruct
       endian :big_and_little
       uint32 :p_type
@@ -134,13 +141,14 @@ module ELFTools
       uint64 :p_memsz
       uint64 :p_align
     end
-    # Get program header class according to bits.
+
+    # Gets the class of program header according to bits.
     ELF_Phdr = {
       32 => ELF32_Phdr,
       64 => ELF64_Phdr
     }.freeze
 
-    # Symbol structure for 32bit.
+    # Symbol structure for 32-bit.
     class ELF32_sym < ELFStruct
       endian :big_and_little
       uint32 :st_name
@@ -151,7 +159,7 @@ module ELFTools
       uint16 :st_shndx
     end
 
-    # Symbol structure for 64bit.
+    # Symbol structure for 64-bit.
     class ELF64_sym < ELFStruct
       endian :big_and_little
       uint32 :st_name  # Symbol name, index in string tbl
@@ -161,6 +169,7 @@ module ELFTools
       uint64 :st_value # Value of the symbol
       uint64 :st_size  # Associated symbol size
     end
+
     # Get symbol header class according to bits.
     ELF_sym = {
       32 => ELF32_sym,

data/lib/elftools/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ELFTools
   # Define some util methods.
   module Util
@@ -17,6 +19,7 @@ module ELFTools
       def align(num, bit)
         n = 2**bit
         return num if (num % n).zero?
+
         (num + n) & ~(n - 1)
       end
 
@@ -36,6 +39,7 @@ module ELFTools
         # if val is an integer, check if exists in mod
         if val.is_a?(Integer)
           return val if mod.constants.any? { |c| mod.const_get(c) == val }
+
           raise ArgumentError, "No constants in #{module_name} is #{val}"
         end
         val = val.to_s.upcase
@@ -43,6 +47,7 @@ module ELFTools
         val = prefix + '_' + val unless val.start_with?(prefix)
         val = val.to_sym
         raise ArgumentError, "No constants in #{module_name} named \"#{val}\"" unless mod.const_defined?(val)
+
         mod.const_get(val)
       end
 
@@ -61,6 +66,7 @@ module ELFTools
           c = stream.read(1)
           return nil if c.nil? # reach EOF
           break if c == "\x00"
+
           ret += c
         end
         ret

data/lib/elftools/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module ELFTools
   # Current gem version
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elftools
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.3
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2020-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -58,56 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.59'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +135,7 @@ files:
 - lib/elftools/sections/sym_tab_section.rb
 - lib/elftools/segments/dynamic_segment.rb
 - lib/elftools/segments/interp_segment.rb
+- lib/elftools/segments/load_segment.rb
 - lib/elftools/segments/note_segment.rb
 - lib/elftools/segments/segment.rb
 - lib/elftools/segments/segments.rb
@@ -167,15 +154,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ELFTools - Pure ruby library for parsing and patching ELF files