Package ghidra.trace.database.program

Class AbstractDBTraceProgramViewMemoryBlock

java.lang.Object
ghidra.trace.database.program.AbstractDBTraceProgramViewMemoryBlock
All Implemented Interfaces:
MemoryBlock, Serializable, Comparable<MemoryBlock>
Direct Known Subclasses:
DBTraceProgramViewMemoryRegionBlock, DBTraceProgramViewMemorySpaceBlock
public abstract class AbstractDBTraceProgramViewMemoryBlock extends Object implements MemoryBlock
See Also:

  • Field Details

  • Constructor Details

    • AbstractDBTraceProgramViewMemoryBlock

      protected AbstractDBTraceProgramViewMemoryBlock(DBTraceProgramView program)

  • Method Details

    • getInfoDescription

      protected abstract String getInfoDescription()

    • getAddressSpace

      protected AddressSpace getAddressSpace()

    • getMemorySpace

      protected DBTraceMemorySpace getMemorySpace()

    • getAddressRange

      public AddressRange getAddressRange()
      Description copied from interface: MemoryBlock
      Get the address range that corresponds to this block.
      Specified by:
      getAddressRange in interface MemoryBlock
      Returns:
      block address range

    • compareTo

      public int compareTo(MemoryBlock that)
      Specified by:
      compareTo in interface Comparable<MemoryBlock>

    • contains

      public boolean contains(Address addr)
      Description copied from interface: MemoryBlock
      Return whether addr is contained in this block.
      Specified by:
      contains in interface MemoryBlock
      Parameters:
      addr - address

    • getSize

      public long getSize()
      Description copied from interface: MemoryBlock
      Get the number of bytes in this block.
      Specified by:
      getSize in interface MemoryBlock
      Returns:
      number of bytes in the block

    • getSizeAsBigInteger

      public BigInteger getSizeAsBigInteger()
      Description copied from interface: MemoryBlock
      Get the number of bytes in this block.
      Specified by:
      getSizeAsBigInteger in interface MemoryBlock
      Returns:
      the number of bytes in this block as a BigInteger

    • getComment

      public String getComment()
      Description copied from interface: MemoryBlock
      Get the comment associated with this block.
      Specified by:
      getComment in interface MemoryBlock
      Returns:
      block comment string

    • setComment

      public void setComment(String comment)
      Description copied from interface: MemoryBlock
      Set the comment associated with this block.
      Specified by:
      setComment in interface MemoryBlock
      Parameters:
      comment - the comment to associate with this block.

    • getData

      public InputStream getData()
      Description copied from interface: MemoryBlock
      Get memory data in the form of an InputStream. Null is returned for thos memory blocks which have no data.
      Specified by:
      getData in interface MemoryBlock

    • getSourceName

      public String getSourceName()
      Description copied from interface: MemoryBlock
      Get the name of the source of this memory block.
      Specified by:
      getSourceName in interface MemoryBlock
      Returns:
      source name

    • setSourceName

      public void setSourceName(String sourceName)
      Description copied from interface: MemoryBlock
      Sets the name of the source file that provided the data.
      Specified by:
      setSourceName in interface MemoryBlock
      Parameters:
      sourceName - the name of the source file.

    • getByte

      public byte getByte(Address addr) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Returns the byte at the given address in this block.
      Specified by:
      getByte in interface MemoryBlock
      Parameters:
      addr - the address.
      Returns:
      byte value from this block and specified address
      Throws:
      MemoryAccessException - if any of the requested bytes are uninitialized.

    • getBytes

      public int getBytes(Address addr, byte[] b) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Tries to get b.length bytes from this block at the given address. May return fewer bytes if the requested length is beyond the end of the block.
      Specified by:
      getBytes in interface MemoryBlock
      Parameters:
      addr - the address from which to get the bytes.
      b - the byte array to populate.
      Returns:
      the number of bytes actually populated.
      Throws:
      MemoryAccessException - if any of the requested bytes are uninitialized.

    • getBytes

      public int getBytes(Address addr, byte[] b, int off, int len) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Tries to get len bytes from this block at the given address and put them into the given byte array at the specified offet. May return fewer bytes if the requested length is beyond the end of the block.
      Specified by:
      getBytes in interface MemoryBlock
      Parameters:
      addr - the address from which to get the bytes.
      b - the byte array to populate.
      off - the offset into the byte array.
      len - the number of bytes to get.
      Returns:
      the number of bytes actually populated.
      Throws:
      MemoryAccessException - if any of the requested bytes are uninitialized.

    • putByte

      public void putByte(Address addr, byte b) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Puts the given byte at the given address in this block.
      Specified by:
      putByte in interface MemoryBlock
      Parameters:
      addr - the address.
      b - byte value
      Throws:
      MemoryAccessException - if the block is uninitialized

    • putBytes

      public int putBytes(Address addr, byte[] b) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Tries to put b.length bytes from the specified byte array to this block. All the bytes may not be put if the requested length is beyond the end of the block.
      Specified by:
      putBytes in interface MemoryBlock
      Parameters:
      addr - the address of where to put the bytes.
      b - the byte array containing the bytes to write.
      Returns:
      the number of bytes actually written.
      Throws:
      MemoryAccessException - if the block is uninitialized

    • putBytes

      public int putBytes(Address addr, byte[] b, int off, int len) throws MemoryAccessException
      Description copied from interface: MemoryBlock
      Tries to put len bytes from the specified byte array to this block. All the bytes may not be written if the requested length is beyond the end of the block.
      Specified by:
      putBytes in interface MemoryBlock
      Parameters:
      addr - the address of where to put the bytes.
      b - the byte array containing the bytes to write.
      off - the offset into the byte array.
      len - the number of bytes to write.
      Returns:
      the number of bytes actually written.
      Throws:
      MemoryAccessException - if the block is uninitialized

    • getType

      public MemoryBlockType getType()
      Description copied from interface: MemoryBlock
      Get the type for this block: DEFAULT, BIT_MAPPED, or BYTE_MAPPED (see MemoryBlockType).
      Specified by:
      getType in interface MemoryBlock
      Returns:
      memory block type

    • isInitialized

      public boolean isInitialized()
      Description copied from interface: MemoryBlock
      Return whether this block has been initialized.

      WARNING: A mapped memory block may have a mix of intialized, uninitialized, and undefined regions. The value returned by this method for a mapped memory block is always false even if some regions are initialized.

      Specified by:
      isInitialized in interface MemoryBlock
      Returns:
      true if block is fully initialized and not a memory-mapped-block, else false

    • isMapped

      public boolean isMapped()
      Description copied from interface: MemoryBlock
      Returns true if this is either a bit-mapped or byte-mapped block
      Specified by:
      isMapped in interface MemoryBlock
      Returns:
      true if this is either a bit-mapped or byte-mapped block

    • isOverlay

      public boolean isOverlay()
      Description copied from interface: MemoryBlock
      Returns true if this is an overlay block (i.e., contained within overlay space).
      Specified by:
      isOverlay in interface MemoryBlock
      Returns:
      true if this is an overlay block

    • isLoaded

      public boolean isLoaded()
      Description copied from interface: MemoryBlock
      Returns true if this memory block is a real loaded block (i.e. RAM) and not a special block containing file header data such as debug sections.
      Specified by:
      isLoaded in interface MemoryBlock
      Returns:
      true if this is a loaded block and not a "special" block such as a file header.

    • getSourceInfos

      public List<MemoryBlockSourceInfo> getSourceInfos()
      Description copied from interface: MemoryBlock
      Returns a list of MemoryBlockSourceInfo objects for this block. A block may consist of multiple sequences of bytes from different sources. Each such source of bytes is described by its respective SourceInfo object. Blocks may have multiple sources after two or more memory blocks have been joined together and the underlying byte sources can't be joined.
      Specified by:
      getSourceInfos in interface MemoryBlock
      Returns:
      a list of SourceInfo objects, one for each different source of bytes in this block.