Package ghidra.program.model.address

Class OverlayAddressSpace

  • All Implemented Interfaces:
    AddressSpace, java.lang.Comparable<AddressSpace>
    public class OverlayAddressSpace
extends java.lang.Object

    • Field Detail

      • name

        protected java.lang.String name

      • size

        protected int size

      • unitSize

        protected int unitSize

      • type

        protected int type

      • spaceSize

        protected long spaceSize

      • signed

        protected boolean signed

      • minOffset

        protected long minOffset

      • maxOffset

        protected long maxOffset

      • minAddress

        protected Address minAddress

      • maxAddress

        protected Address maxAddress

      • spaceID

        protected int spaceID

    • Constructor Detail

      • OverlayAddressSpace

        public OverlayAddressSpace​(java.lang.String name,
                           AddressSpace originalSpace,
                           int unique,
                           long minOffset,
                           long maxOffset)

    • Method Detail

      • getOverlayedSpace

        public AddressSpace getOverlayedSpace()

      • getPhysicalSpace

        public AddressSpace getPhysicalSpace()
        Description copied from interface: AddressSpace
        Returns the physical space associated with an address space. There is always exactly one physical space associated with an address space (it may be its own physical space).
        Specified by:
        getPhysicalSpace in interface AddressSpace
        Returns:
        the associated physical space.
        See Also:
        AddressSpace.getPhysicalSpace()

      • hasMappedRegisters

        public boolean hasMappedRegisters()
        Description copied from interface: AddressSpace
        Returns true if this space has registers that are mapped into it. This means that registers could actually have pointers to them.
        Specified by:
        hasMappedRegisters in interface AddressSpace
        Returns:
        true if this space has any registers mapped in it.
        See Also:
        AddressSpace.hasMappedRegisters()

      • getMinOffset

        public long getMinOffset()

      • getMaxOffset

        public long getMaxOffset()

      • contains

        public boolean contains​(long offset)

      • getAddressInThisSpaceOnly

        public Address getAddressInThisSpaceOnly​(long offset)
        Description copied from interface: AddressSpace
        Get a byte address from this address space. Don't allow overlay spaces to remap the address into a base space when the address is not contained in the bounds of the overlay region.
        Parameters:
        offset - the byte offset for the new address.
        Returns:
        an address if the offset is valid.

      • getAddress

        public Address getAddress​(long offset)
        Description copied from interface: AddressSpace
        Returns a new address in this space with the given byte offset. NOTE: This method is the same as invoking getAddress(long byteOffset, false).
        Parameters:
        offset - the byte offset for the new address.
        Returns:
        address with given byte offset
        See Also:
        AddressSpace.getAddress(long)

      • getUncheckedAddress

        protected Address getUncheckedAddress​(long offset)
        Instantiates an address within this space. No offset validation should be performed.
        See Also:
        ghidra.program.model.address.AbstractAddressSpace#getUncheckedAddress(long, long)

      • translateAddress

        public Address translateAddress​(Address addr)
        If the given address is outside the overlay block, then the address is tranlated to an address in the base space with the same offset, otherwise (if the address exists in the overlay block), it is returned
        Parameters:
        addr - the address to translate to the base space if it is outside the overlay block
        Returns:
        either the given address if it is contained in the overlay memory block or an address in the base space with the same offset as the given address.

      • translateAddress

        public Address translateAddress​(Address addr,
                                boolean forceTranslation)
        Tranlated an overlay-space address (addr, which may exceed the bounds of the overlay space) to an address in the base space with the same offset. If forceTranslation is false and addr is contained within the overlay-space the original addr is returned.
        Parameters:
        addr - the address to translate to the base space
        forceTranslation - if true addr will be translated even if addr falls within the bounds of this overlay-space.
        Returns:
        either the given address if it is contained in the overlay memory block or an address in the base space with the same offset as the given address.

      • toString

        public java.lang.String toString()
        See Also:
        Object.toString()

      • setName

        public void setName​(java.lang.String newName)

      • setDatabaseKey

        public void setDatabaseKey​(long key)

      • getDatabaseKey

        public long getDatabaseKey()

      • equals

        public boolean equals​(java.lang.Object obj)
        See Also:
        Object.equals(java.lang.Object)

      • getSize

        public int getSize()
        Description copied from interface: AddressSpace
        Returns the number of bits that are used to form the address. Thus the maximum offset for this address space will be 2^size-1.
        Specified by:
        getSize in interface AddressSpace
        See Also:
        AddressSpace.getSize()

      • getAddressableUnitSize

        public int getAddressableUnitSize()
        Description copied from interface: AddressSpace
        Returns the number of data bytes which correspond to each addressable location within this space (i.e., word-size in bytes). NOTE: When transforming a byte-offset to an addressable word offset the method AddressSpace.getAddressableWordOffset(long) should be used instead of simple division. When transforming an addressable word-offset to a byte-offset simple multiplication may be used. Neither of these transformations perform address space bounds checking. 
           byteOffset = wordOffset * addressUnitSize
   wordOffset = getAddressableWordOffset(byteOffset)
        Specified by:
        getAddressableUnitSize in interface AddressSpace
        See Also:
        AddressSpace.getAddressableUnitSize()

      • getAddressableWordOffset

        public long getAddressableWordOffset​(long byteOffset)
        Description copied from interface: AddressSpace
        Get the addressable memory word offset which corresponds to the specified memory byte offset. This method handles some of the issues of unsigned math when stuck using Java's signed long primitives. No space bounds checking is performed.
        Specified by:
        getAddressableWordOffset in interface AddressSpace
        Parameters:
        byteOffset - memory byte offset
        Returns:
        addressable memory word offset

      • getUnique

        public int getUnique()
        Returns the unique id value for this space.
        Specified by:
        getUnique in interface AddressSpace

      • getAddress

        public Address getAddress​(java.lang.String addrString,
                          boolean caseSensitive)
                   throws AddressFormatException
        Description copied from interface: AddressSpace
        Parses the String into an address.
        Specified by:
        getAddress in interface AddressSpace
        Parameters:
        addrString - the string to parse as an address.
        caseSensitive - specifies if addressSpace names must match case.
        Returns:
        an address if the string parsed successfully or null if the AddressSpace specified in the addrString is not this space.
        Throws:
        AddressFormatException - if the string cannot be parsed or the parsed offset is larger than the size for this space.

      • getAddress

        public Address getAddress​(long offset,
                          boolean isAddressableWordOffset)
                   throws AddressOutOfBoundsException
        Description copied from interface: AddressSpace
        Returns a new address in this space with the given offset. NOTE: for those spaces with an addressable unit size other than 1, the address returned may not correspond to an addressable unit/word boundary if a byte-offset is specified.
        Specified by:
        getAddress in interface AddressSpace
        Parameters:
        offset - the offset for the new address.
        isAddressableWordOffset - if true the specified offset is an addressable unit/word offset, otherwise offset is a byte offset. See AddressSpace.getAddressableUnitSize() to understand the distinction (i.e., wordOffset = byteOffset * addressableUnitSize).
        Returns:
        address with given offset
        Throws:
        AddressOutOfBoundsException - if the offset is less than 0 or greater than the max offset allowed for this space.

      • getTruncatedAddress

        public Address getTruncatedAddress​(long offset,
                                   boolean isAddressableWordOffset)
        Description copied from interface: AddressSpace
        Returns a new address in this space with the given offset. The specified offset will be truncated within the space and will not throw an exception. NOTE: for those spaces with an addressable unit size other than 1, the address returned may not correspond to a word boundary (addressable unit) if a byte-offset is specified.
        Specified by:
        getTruncatedAddress in interface AddressSpace
        Parameters:
        offset - the offset for the new address.
        isAddressableWordOffset - if true the specified offset is an addressable unit/word offset, otherwise offset is a byte offset. See AddressSpace.getAddressableUnitSize() to understand the distinction (i.e., wordOffset = byteOffset * addressableUnitSize).
        Returns:
        address with given byte offset truncated to the physical space size

      • subtractWrap

        public Address subtractWrap​(Address addr,
                            long displacement)
        Description copied from interface: AddressSpace
        Creates a new address by subtracting displacement from addr's offset.
        Specified by:
        subtractWrap in interface AddressSpace
        Parameters:
        addr - the original address. The new address will wrap in a manner that depends on the address space. For a generic address space this will wrap at the extents of the address space. For a segmented address space it will wrap at the extents of the segment.
        displacement - the displacement to subtract.
        Returns:
        a new address created by subtracting the displacement from addr.offset.
        See Also:
        AddressSpace.subtractWrap(ghidra.program.model.address.Address, long)

      • subtractWrapSpace

        public Address subtractWrapSpace​(Address addr,
                                 long displacement)
        Description copied from interface: AddressSpace
        Creates a new address by subtracting the displacement from the given address. If the offset is greater than the max offset of the address space, the high order bits are masked off, making the address wrap. For non-segmented addresses this will be the same as subtractWrap(). For segmented addresses, the address will wrap when the 20 bit (oxfffff) offset is exceeded, as opposed to when the segment offset is exceeded.
        Specified by:
        subtractWrapSpace in interface AddressSpace
        Parameters:
        addr - the address to subtract the displacement from.
        displacement - the displacement to subtract.
        Returns:
        The new Address formed by subtracting the displacement from the specified address.
        See Also:
        AddressSpace.subtractWrapSpace(ghidra.program.model.address.Address, long)

      • addWrap

        public Address addWrap​(Address addr,
                       long displacement)
        Description copied from interface: AddressSpace
        Creates a new address by adding displacement to the given address. The resulting address may wrap. The new address will wrap in a manner that depends on the address space. For a generic address space this will wrap at the extents of the address space. For a segmented address space it will wrap at the extents of the segment.
        Specified by:
        addWrap in interface AddressSpace
        Parameters:
        addr - the original address.
        displacement - the displacement to add.
        Returns:
        the new address created by adding displacement to addr.offset.
        See Also:
        AddressSpace.addWrap(ghidra.program.model.address.Address, long)

      • addWrapSpace

        public Address addWrapSpace​(Address addr,
                            long displacement)
        Description copied from interface: AddressSpace
        Creates a new address by adding the displacement to the given address. If the offset is greater than the max offset of the address space, the high order bits are masked off, making the address wrap. For non-segmented addresses this will be the same as addWrap(). For segmented addresses, the address will wrap when the 20 bit (oxfffff) offset is exceeded, as opposed to when the segment offset is exceeded.
        Specified by:
        addWrapSpace in interface AddressSpace
        Parameters:
        addr - the address to add the displacement to.
        displacement - the displacement to add.
        Returns:
        The new Address formed by adding the displacement to the specified addresst.
        See Also:
        AddressSpace.addWrapSpace(ghidra.program.model.address.Address, long)

      • addNoWrap

        public Address addNoWrap​(GenericAddress addr,
                         java.math.BigInteger displacement)
                  throws AddressOverflowException
        Description copied from interface: AddressSpace
        Creates a new address by adding displacement to the given address. The new address will NOT wrap!
        Specified by:
        addNoWrap in interface AddressSpace
        Parameters:
        addr - the original address.
        displacement - the displacement to add.
        Returns:
        The new address created by adding displacement to addr.offset.
        Throws:
        AddressOverflowException - if the addition would cause a wrap,

      • isValidRange

        public boolean isValidRange​(long byteOffset,
                            long length)
        Description copied from interface: AddressSpace
        Check the specified address range for validity within this space. Segmented spaces will restrict a range to a single segment.
        Specified by:
        isValidRange in interface AddressSpace
        Returns:
        true if range is valid for this space

      • compareTo

        public int compareTo​(AddressSpace space)
        Specified by:
        compareTo in interface java.lang.Comparable<AddressSpace>
        See Also:
        Comparable.compareTo(java.lang.Object)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()

      • testAddressSpace

        protected void testAddressSpace​(Address addr)

      • truncateOffset

        public long truncateOffset​(long offset)
        Description copied from interface: AddressSpace
        Truncate the specified byte offset within this space to produce a valid offset.
        Specified by:
        truncateOffset in interface AddressSpace
        Parameters:
        offset - any byte offset
        Returns:
        truncated byte offset
        See Also:
        AddressSpace.truncateOffset(long)

      • truncateAddressableWordOffset

        public long truncateAddressableWordOffset​(long wordOffset)
        Description copied from interface: AddressSpace
        Truncate the specified addressable unit/word offset within this space to produce a valid offset.
        Specified by:
        truncateAddressableWordOffset in interface AddressSpace
        Parameters:
        wordOffset - any addressable unit/word offset
        Returns:
        truncated word offset
        See Also:
        AddressSpace.truncateOffset(long)

      • isMemorySpace

        public boolean isMemorySpace()
        Description copied from interface: AddressSpace
        Returns true if this space represents a memory address. NOTE: It is important to make the distinction between Loaded and Non-Loaded memory addresses. Program importers may create memory blocks associated with Non-Loaded file content which are not associated with processor defined memory regions. While Loaded file content is placed into memory blocks which are associated with specific memory address spaces defined by the processor language specification.
        Specified by:
        isMemorySpace in interface AddressSpace
        See Also:
        AddressSpace.isMemorySpace()

      • isLoadedMemorySpace

        public boolean isLoadedMemorySpace()
        Description copied from interface: AddressSpace
        Returns true if this space represents represents a Loaded Memory region (e.g., processor RAM).
        Specified by:
        isLoadedMemorySpace in interface AddressSpace

      • isNonLoadedMemorySpace

        public boolean isNonLoadedMemorySpace()
        Description copied from interface: AddressSpace
        Returns true if this space represents represents a Non-Loaded storage region for retaining non-loaded file data (e.g., OTHER)
        Specified by:
        isNonLoadedMemorySpace in interface AddressSpace

      • setShowSpaceName

        public void setShowSpaceName​(boolean b)

      • setHasMappedRegisters

        public void setHasMappedRegisters​(boolean hasRegisters)
        Tag this memory space as having memory mapped registers
        Parameters:
        hasRegisters - true if it has registers, false otherwise