Ghidra Decompiler Analysis Engine
Public Member Functions | List of all members
IopSpace Class Reference

Space for storing internal PcodeOp pointers as addresses. More...

#include <op.hh>

Inheritance diagram for IopSpace:
Inheritance graph
[legend]
Collaboration diagram for IopSpace:
Collaboration graph
[legend]

Public Member Functions

 IopSpace (AddrSpaceManager *m, const Translate *t, const string &nm, int4 ind)
 
virtual void saveXmlAttributes (ostream &s, uintb offset) const
 Save an address as XML. More...
 
virtual void saveXmlAttributes (ostream &s, uintb offset, int4 size) const
 Save an address and size as XML. More...
 
virtual void printRaw (ostream &s, uintb offset) const
 Write an address in this space to a stream. More...
 
virtual void saveXml (ostream &s) const
 Write the details of this space as XML. More...
 
virtual void restoreXml (const Element *el)
 Recover the details of this space from XML. More...
 
- Public Member Functions inherited from AddrSpace
 AddrSpace (AddrSpaceManager *m, const Translate *t, spacetype tp, const string &nm, uint4 size, uint4 ws, int4 ind, uint4 fl, int4 dl)
 
 AddrSpace (AddrSpaceManager *m, const Translate *t, spacetype tp)
 For use with restoreXml. More...
 
const string & getName (void) const
 Get the name. More...
 
AddrSpaceManagergetManager (void) const
 Get the space manager. More...
 
const TranslategetTrans (void) const
 Get the processor translator. More...
 
spacetype getType (void) const
 Get the type of space. More...
 
int4 getDelay (void) const
 Get number of heritage passes being delayed. More...
 
int4 getDeadcodeDelay (void) const
 Get number of passes before deadcode removal is allowed. More...
 
int4 getIndex (void) const
 Get the integer identifier. More...
 
uint4 getWordSize (void) const
 Get the addressable unit size. More...
 
uint4 getAddrSize (void) const
 Get the size of the space. More...
 
uintb getHighest (void) const
 Get the highest byte-scaled address. More...
 
uintb getPointerLowerBound (void) const
 Get lower bound for assuming an offset is a pointer. More...
 
uintb getPointerUpperBound (void) const
 Get upper bound for assuming an offset is a pointer. More...
 
int4 getMinimumPtrSize (void) const
 Get the minimum pointer size for this space. More...
 
uintb wrapOffset (uintb off) const
 Wrap -off- to the offset that fits into this space. More...
 
char getShortcut (void) const
 Get the shortcut character. More...
 
bool isHeritaged (void) const
 Return true if dataflow has been traced. More...
 
bool doesDeadcode (void) const
 Return true if dead code analysis should be done on this space. More...
 
bool hasPhysical (void) const
 Return true if data is physically stored in this. More...
 
bool isBigEndian (void) const
 Return true if values in this space are big endian. More...
 
bool isReverseJustified (void) const
 Return true if alignment justification does not match endianness. More...
 
bool isOverlay (void) const
 Return true if this is an overlay space.
 
bool isOverlayBase (void) const
 Return true if other spaces overlay this space.
 
bool isOtherSpace (void) const
 Return true if this is the other address space.
 
bool isTruncated (void) const
 Return true if this space is truncated from its original size. More...
 
bool hasNearPointers (void) const
 Return true if near (truncated) pointers into this space are possible.
 
void printOffset (ostream &s, uintb offset) const
 Write an address offset to a stream. More...
 
virtual int4 numSpacebase (void) const
 Number of base registers associated with this space. More...
 
virtual const VarnodeDatagetSpacebase (int4 i) const
 Get a base register that creates this virtual space. More...
 
virtual const VarnodeDatagetSpacebaseFull (int4 i) const
 Return original spacebase register before truncation. More...
 
virtual bool stackGrowsNegative (void) const
 Return true if a stack in this space grows negative. More...
 
virtual AddrSpacegetContain (void) const
 Return this space's containing space (if any) More...
 
virtual uintb restoreXmlAttributes (const Element *el, uint4 &size) const
 Recover an offset and size. More...
 
virtual uintb read (const string &s, int4 &size) const
 Read in an address (and possible size) from a string. More...
 

Additional Inherited Members

- Public Types inherited from AddrSpace
enum  {
  big_endian = 1, heritaged = 2, does_deadcode = 4, programspecific = 8,
  reverse_justification = 16, overlay = 32, overlaybase = 64, truncated = 128,
  hasphysical = 256, is_otherspace = 512, has_nearpointers = 0x400
}
 
enum  { constant_space_index = 0, other_space_index = 1 }
 
- Static Public Member Functions inherited from AddrSpace
static uintb addressToByte (uintb val, uint4 ws)
 Scale from addressable units to byte units. More...
 
static uintb byteToAddress (uintb val, uint4 ws)
 Scale from byte units to addressable units. More...
 
static int4 addressToByteInt (int4 val, uint4 ws)
 Scale int4 from addressable units to byte units. More...
 
static int4 byteToAddressInt (int4 val, uint4 ws)
 Scale int4 from byte units to addressable units. More...
 
static bool compareByIndex (const AddrSpace *a, const AddrSpace *b)
 Compare two spaces by their index. More...
 
- Protected Member Functions inherited from AddrSpace
void calcScaleMask (void)
 Calculate scale and mask. More...
 
void setFlags (uint4 fl)
 Set a cached attribute. More...
 
void clearFlags (uint4 fl)
 Clear a cached attribute. More...
 
void saveBasicAttributes (ostream &s) const
 Write the XML attributes of this space. More...
 
void truncateSpace (uint4 newsize)
 
- Protected Attributes inherited from AddrSpace
string name
 Name of this space.
 
uint4 addressSize
 Size of an address into this space in bytes.
 
uint4 wordsize
 Size of unit being addressed (1=byte)
 
int4 minimumPointerSize
 Smallest size of a pointer into this space (in bytes)
 
int4 index
 An integer identifier for the space.
 
int4 delay
 Delay in heritaging this space.
 
int4 deadcodedelay
 Delay before deadcode removal is allowed on this space.
 

Detailed Description

Space for storing internal PcodeOp pointers as addresses.

It is convenient and efficient to replace the formally encoded branch target addresses with a pointer to the actual PcodeOp being branched to. This special iop space allows a PcodeOp pointer to be encoded as an address so it can be stored as part of an input varnode, in place of the target address, in a branching operation. The pointer is encoded as an offset within the fspec space.

Constructor & Destructor Documentation

◆ IopSpace()

IopSpace::IopSpace ( AddrSpaceManager m,
const Translate t,
const string &  nm,
int4  ind 
)

Constructor for the iop space. There is only one such space, and it is considered internal to the model, i.e. the Translate engine should never generate addresses in this space.

Parameters
mis the associated address space manager
tis the associated processor translator
nmis the name of the space (always iop)
indis the associated index

Member Function Documentation

◆ printRaw()

void IopSpace::printRaw ( ostream &  s,
uintb  offset 
) const
virtual

Write an address in this space to a stream.

This is a printing method for the debugging routines. It prints taking into account the wordsize, adding a "+n" if the offset is not on-cut with wordsize. It also returns the expected/typical size of values from this space.

Parameters
sis the stream being written
offsetis the offset to be printed

Reimplemented from AddrSpace.

◆ restoreXml()

void IopSpace::restoreXml ( const Element el)
virtual

Recover the details of this space from XML.

Walk a parsed XML tag and recover all the properties defining this space. The processor translator, trans, and the type must already be filled in.

Parameters
elis the parsed XML tag

Reimplemented from AddrSpace.

◆ saveXml()

void IopSpace::saveXml ( ostream &  s) const
virtual

Write the details of this space as XML.

Write a tag fully describing the details of this space suitable for later recovery via restoreXml.

Parameters
sis the stream being written

Reimplemented from AddrSpace.

◆ saveXmlAttributes() [1/2]

virtual void IopSpace::saveXmlAttributes ( ostream &  s,
uintb  offset 
) const
inlinevirtual

Save an address as XML.

Write the main XML attributes for an address within this space The caller provides only the offset, and this routine fills in other details pertaining to this particular space.

Parameters
sis the stream to write to
offsetis the offset of the address

Reimplemented from AddrSpace.

◆ saveXmlAttributes() [2/2]

virtual void IopSpace::saveXmlAttributes ( ostream &  s,
uintb  offset,
int4  size 
) const
inlinevirtual

Save an address and size as XML.

Write the main XML attributes of an address with this space and a size. The caller provides the offset and size, and other details about this particular space are filled in.

Parameters
sis the stream to write to
offsetis the offset of the address
sizeis the size of the memory location

Reimplemented from AddrSpace.


The documentation for this class was generated from the following files: