Package com.pnfsoftware.jeb.core.units.codeobject

Class AbstractCodeObjectUnit

java.lang.Object
com.pnfsoftware.jeb.core.events.JebEventSource
com.pnfsoftware.jeb.core.units.AbstractUnit
com.pnfsoftware.jeb.core.units.AbstractBinaryUnit
com.pnfsoftware.jeb.core.units.codeobject.AbstractCodeObjectUnit
All Implemented Interfaces:
IUnitCreator, IUserDataSupport, ICodeObjectUnit, IBinaryUnit, IUnit, IEventSource
@Ser public abstract class AbstractCodeObjectUnit extends AbstractBinaryUnit implements ICodeObjectUnit
Convenient base class for code objects.

  • Constructor Details

    • AbstractCodeObjectUnit

      protected AbstractCodeObjectUnit(IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)
      Create a code object unit.
      Parameters:
      input - input object
      formatType - format type
      name - unit name
      unitProcessor - unit processor
      parent - parent unit creator
      pdm - property definition manager

  • Method Details

    • getLoaderInformation

      public ILoaderInformation getLoaderInformation()
      Description copied from interface: ICodeObjectUnit
      Retrieve basic information about the object file.
      Specified by:
      getLoaderInformation in interface ICodeObjectUnit
      Returns:
      the object file information, never null

    • setLoaderInformation

      protected void setLoaderInformation(ILoaderInformation ldInfo)
      Set loader information.
      Parameters:
      ldInfo - loader information

    • getSegments

      public List<? extends ISegmentInformation> getSegments()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of segments defined in the object file. Typically, segments are mapped to memory by a code object loader. Segments and sections may overlap.
      Specified by:
      getSegments in interface ICodeObjectUnit
      Returns:
      the list of segments, or null if unsupported

    • getValidSegments

      public List<? extends ISegmentInformation> getValidSegments()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of segments that are not marked INVALID.
      Specified by:
      getValidSegments in interface ICodeObjectUnit
      Returns:
      the valid segments, or null if unsupported

    • getSegments

      public List<? extends ISegmentInformation> getSegments(int wflags, int bflags)
      Description copied from interface: ICodeObjectUnit
      Retrieve a list of segments.
      Specified by:
      getSegments in interface ICodeObjectUnit
      Parameters:
      wflags - must-have flags
      bflags - must-not-have flags
      Returns:
      the matching segments, or null if unsupported

    • getSegment

      public ISegmentInformation getSegment(int i)
      Description copied from interface: ICodeObjectUnit
      Retrieve a segment by index.
      Specified by:
      getSegment in interface ICodeObjectUnit
      Parameters:
      i - segment index
      Returns:
      the segment

    • getSegmentCount

      public int getSegmentCount()
      Description copied from interface: ICodeObjectUnit
      Retrieve the number of segments.
      Specified by:
      getSegmentCount in interface ICodeObjectUnit
      Returns:
      segment count

    • addSegment

      protected void addSegment(ISegmentInformation segment)
      Add segment information.
      Parameters:
      segment - segment information

    • insertSegment

      protected void insertSegment(int index, ISegmentInformation segment)
      Insert segment information.
      Parameters:
      index - insertion index
      segment - segment information

    • addAllSegments

      protected void addAllSegments(Collection<? extends ISegmentInformation> segments)
      Add segment information entries.
      Parameters:
      segments - segment information entries

    • removeSegment

      protected void removeSegment(int index)
      Remove segment information by index.
      Parameters:
      index - segment index

    • getSections

      public List<? extends ISegmentInformation> getSections()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of sections defined in the object file. Typically, sections are used to point to areas of interest. Sections and segments may overlap.
      Specified by:
      getSections in interface ICodeObjectUnit
      Returns:
      the list of sections, or null if unsupported

    • getValidSections

      public List<? extends ISegmentInformation> getValidSections()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of sections that are not marked INVALID.
      Specified by:
      getValidSections in interface ICodeObjectUnit
      Returns:
      the valid sections, or null if unsupported

    • getSections

      public List<? extends ISegmentInformation> getSections(int wflags, int bflags)
      Description copied from interface: ICodeObjectUnit
      Retrieve a list of sections.
      Specified by:
      getSections in interface ICodeObjectUnit
      Parameters:
      wflags - must-have flags
      bflags - must-not-have flags
      Returns:
      the matching sections, or null if unsupported

    • getSection

      public ISegmentInformation getSection(int i)
      Description copied from interface: ICodeObjectUnit
      Retrieve a section by index.
      Specified by:
      getSection in interface ICodeObjectUnit
      Parameters:
      i - section index
      Returns:
      the section

    • getSectionCount

      public int getSectionCount()
      Description copied from interface: ICodeObjectUnit
      Retrieve the number of sections.
      Specified by:
      getSectionCount in interface ICodeObjectUnit
      Returns:
      section count

    • addSection

      protected void addSection(ISegmentInformation section)
      Add section information.
      Parameters:
      section - section information

    • insertSection

      protected void insertSection(int index, ISegmentInformation section)
      Insert section information.
      Parameters:
      index - insertion index
      section - section information

    • addAllSections

      protected void addAllSections(Collection<? extends ISegmentInformation> sections)
      Add section information entries.
      Parameters:
      sections - section information entries

    • removeSection

      protected void removeSection(int index)
      Remove section information by index.
      Parameters:
      index - section index

    • getSymbols

      public Collection<? extends ISymbolInformation> getSymbols()
      Description copied from interface: ICodeObjectUnit
      Retrieve the symbols defined in the object file.
      Specified by:
      getSymbols in interface ICodeObjectUnit
      Returns:
      the symbols, or null if unsupported

    • getSymbolCount

      public int getSymbolCount()
      Get the number of symbols.
      Returns:
      symbol count

    • addSymbol

      protected boolean addSymbol(ISymbolInformation symbol)
      Add symbol information.
      Parameters:
      symbol - symbol information
      Returns:
      true if the symbol was added

    • addAllSymbols

      protected void addAllSymbols(Collection<? extends ISymbolInformation> symbols)
      Add symbol information entries.
      Parameters:
      symbols - symbol information entries

    • getImportedSymbols

      public List<? extends ISymbolInformation> getImportedSymbols()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of imported symbols.
      Specified by:
      getImportedSymbols in interface ICodeObjectUnit
      Returns:
      the list (possibly empty) of imported symbols, or null if unsupported

    • getExportedSymbols

      public List<? extends ISymbolInformation> getExportedSymbols()
      Description copied from interface: ICodeObjectUnit
      Retrieve the list of exported symbols.
      Specified by:
      getExportedSymbols in interface ICodeObjectUnit
      Returns:
      the list (possibly empty) of exported symbols, or null if unsupported

    • getSymbols

      public List<? extends ISymbolInformation> getSymbols(int mustHaveFlags, int mustNotHaveFlags)
      Description copied from interface: ICodeObjectUnit
      Retrieve symbols filtered by flags.
      Specified by:
      getSymbols in interface ICodeObjectUnit
      Parameters:
      mustHaveFlags - mask of flags that must be present
      mustNotHaveFlags - mask of flags that must be absent
      Returns:
      the matching symbols, or null if unsupported

    • convertFileOffsetToRelativeAddress

      public long convertFileOffsetToRelativeAddress(long offset)
      Description copied from interface: ICodeObjectUnit
      Convert a file offset to a memory address, relative to the base.
      Specified by:
      convertFileOffsetToRelativeAddress in interface ICodeObjectUnit
      Parameters:
      offset - a file offset
      Returns:
      a base-relative memory address, or -1 if unsupported or if the offset does not map to anywhere in memory

    • convertRelativeAddressToFileOffset

      public long convertRelativeAddressToFileOffset(long rel)
      Description copied from interface: ICodeObjectUnit
      Convert a memory address (relative to the base) to a file offset.
      Specified by:
      convertRelativeAddressToFileOffset in interface ICodeObjectUnit
      Parameters:
      rel - the base-relative memory address
      Returns:
      a file offset, or -1 if unsupported or if the address does not map to anywhere in the file

    • getRawMemoryMappedImage

      public IVirtualMemory getRawMemoryMappedImage()
      Description copied from interface: ICodeObjectUnit
      Retrieve a raw mapping of the code object. No relocations are applied. Do not attempt to modify the returned VM object; it should be considered read-only.
      Specified by:
      getRawMemoryMappedImage in interface ICodeObjectUnit
      Returns:
      the virtual memory containing the mapped, unresolved code object; null on error or if the code object unit decided to not map the object file

    • map

      public boolean map(IVirtualMemory mem, long wantedBase, boolean applyRelocations, ILinkInfoProvider linkInfoPrv)
      Description copied from interface: ICodeObjectUnit
      Map this object file onto virtual memory.
      Specified by:
      map in interface ICodeObjectUnit
      Parameters:
      mem - memory image onto which the mapping should be done
      wantedBase - wanted base; set to -1L to request mapping at the normal base
      applyRelocations - true to apply relocations after mapping
      linkInfoPrv - optional link information provider
      Returns:
      success indicator

    • createSuitableMemory

      protected IVirtualMemory createSuitableMemory()
      Create a virtual memory suitable to map this code object.
      Returns:
      virtual memory object

    • mapRawNoReloc

      protected boolean mapRawNoReloc(IVirtualMemory mem, long base)
      Map the object's segments at the provided base without applying relocations.
      Parameters:
      mem - virtual memory object
      base - mapping base address, or -1 to use the preferred image base
      Returns:
      the VM, null on error

    • getMappableInput

      protected IInput getMappableInput()
      Retrieve the input that is truly mappable. The default implementation simply returns AbstractBinaryUnit.getInput(), as is expected in most cases (eg, ELF, PE). For formats requiring pre-processing of the input data, such as IHEX or other ascii-encoded code objects, this method should be overridden.
      Returns:
      mappable input

    • shouldAllocateFullImage

      protected abstract boolean shouldAllocateFullImage()
      Indicate whether the loader should allocate the full image range when preparing to load and map a code object file to memory.

      Typically, the answer is yes for PE-like files, no for ELF-like files.

      Returns:
      true if the full image range should be allocated

    • applyRelocations

      protected abstract boolean applyRelocations(IVirtualMemory mem, long base, ILinkInfoProvider linkInfoPrv)
      Relocate a mapped code object.
      Parameters:
      mem - virtual memory
      base - mapping base address
      linkInfoPrv - optional link information provider
      Returns:
      true if relocations were applied