decompiler
1.0.0
|
A manager for different address spaces. More...
#include <translate.hh>
Public Member Functions | |
AddrSpaceManager (void) | |
Construct an empty address space manager. More... | |
virtual | ~AddrSpaceManager (void) |
Destroy the manager. More... | |
int4 | getDefaultSize (void) const |
Get size of addresses for the default space. More... | |
AddrSpace * | getSpaceByName (const string &nm) const |
Get address space by name. More... | |
AddrSpace * | getSpaceByShortcut (char sc) const |
Get address space from its shortcut. More... | |
AddrSpace * | getIopSpace (void) const |
Get the internal pcode op space. More... | |
AddrSpace * | getFspecSpace (void) const |
Get the internal callspec space. More... | |
AddrSpace * | getJoinSpace (void) const |
Get the joining space. More... | |
AddrSpace * | getStackSpace (void) const |
Get the stack space for this processor. More... | |
AddrSpace * | getUniqueSpace (void) const |
Get the temporary register space for this processor. More... | |
AddrSpace * | getDefaultCodeSpace (void) const |
Get the default address space of this processor. More... | |
AddrSpace * | getDefaultDataSpace (void) const |
Get the default address space where data is stored. More... | |
AddrSpace * | getConstantSpace (void) const |
Get the constant space. More... | |
Address | getConstant (uintb val) const |
Get a constant encoded as an Address. More... | |
Address | createConstFromSpace (AddrSpace *spc) const |
Create a constant address encoding an address space. More... | |
Address | resolveConstant (AddrSpace *spc, uintb val, int4 sz, const Address &point, uintb &fullEncoding) const |
Resolve a native constant into an Address. More... | |
int4 | numSpaces (void) const |
Get the number of address spaces for this processor. More... | |
AddrSpace * | getSpace (int4 i) const |
Get an address space via its index. More... | |
AddrSpace * | getNextSpaceInOrder (AddrSpace *spc) const |
Get the next contiguous address space. More... | |
JoinRecord * | findAddJoin (const vector< VarnodeData > &pieces, uint4 logicalsize) |
Get (or create) JoinRecord for pieces. More... | |
JoinRecord * | findJoin (uintb offset) const |
Find JoinRecord for offset in the join space. More... | |
void | setDeadcodeDelay (AddrSpace *spc, int4 delaydelta) |
Set the deadcodedelay for a specific space. More... | |
void | truncateSpace (const TruncationTag &tag) |
Mark a space as truncated from its original size. More... | |
Address | constructFloatExtensionAddress (const Address &realaddr, int4 realsize, int4 logicalsize) |
Build a logically lower precision storage location for a bigger floating point register. More... | |
Address | constructJoinAddress (const Translate *translate, const Address &hiaddr, int4 hisz, const Address &loaddr, int4 losz) |
Build a logical whole from register pairs. More... | |
void | renormalizeJoinAddress (Address &addr, int4 size) |
Make sure a possibly offset join address has a proper JoinRecord. More... | |
Protected Member Functions | |
AddrSpace * | restoreXmlSpace (const Element *el, const Translate *trans) |
Add a space to the model based an on XML tag. More... | |
void | restoreXmlSpaces (const Element *el, const Translate *trans) |
Restore address spaces in the model from an XML tag. More... | |
void | setDefaultCodeSpace (int4 index) |
Set the default address space (for code) More... | |
void | setDefaultDataSpace (int4 index) |
Set the default address space for data. More... | |
void | setReverseJustified (AddrSpace *spc) |
Set reverse justified property on this space. More... | |
void | assignShortcut (AddrSpace *spc) |
Select a shortcut character for a new space. More... | |
void | markNearPointers (AddrSpace *spc, int4 size) |
Mark that given space can be accessed with near pointers. More... | |
void | insertSpace (AddrSpace *spc) |
Add a new address space to the model. More... | |
void | copySpaces (const AddrSpaceManager *op2) |
Copy spaces from another manager. More... | |
void | addSpacebasePointer (SpacebaseSpace *basespace, const VarnodeData &ptrdata, int4 truncSize, bool stackGrowth) |
Set the base register of a spacebase space. More... | |
void | insertResolver (AddrSpace *spc, AddressResolver *rsolv) |
Override the base resolver for a space. More... | |
void | setInferPtrBounds (const Range &range) |
Set the range of addresses that can be inferred as pointers. More... | |
JoinRecord * | findJoinInternal (uintb offset) const |
Find JoinRecord for offset in the join space. More... | |
Private Attributes | |
vector< AddrSpace * > | baselist |
Every space we know about for this architecture. | |
vector< AddressResolver * > | resolvelist |
Special constant resolvers. | |
map< string, AddrSpace * > | name2Space |
Map from name -> space. | |
map< int4, AddrSpace * > | shortcut2Space |
Map from shortcut -> space. | |
AddrSpace * | constantspace |
Quick reference to constant space. | |
AddrSpace * | defaultcodespace |
Default space where code lives, generally main RAM. | |
AddrSpace * | defaultdataspace |
Default space where data lives. | |
AddrSpace * | iopspace |
Space for internal pcode op pointers. | |
AddrSpace * | fspecspace |
Space for internal callspec pointers. | |
AddrSpace * | joinspace |
Space for unifying split variables. | |
AddrSpace * | stackspace |
Stack space associated with processor. | |
AddrSpace * | uniqspace |
Temporary space associated with processor. | |
uintb | joinallocate |
Next offset to be allocated in join space. | |
set< JoinRecord *, JoinRecordCompare > | splitset |
Different splits that have been defined in join space. | |
vector< JoinRecord * > | splitlist |
JoinRecords indexed by join address. | |
A manager for different address spaces.
Allow creation, lookup by name, lookup by shortcut, lookup by name, and iteration over address spaces
AddrSpaceManager::AddrSpaceManager | ( | void | ) |
Construct an empty address space manager.
Initialize manager containing no address spaces. All the cached space slots are set to null.
|
virtual |
Destroy the manager.
Base destructor class, cleans up AddrSpace pointers which must be explicited created via new
References AddrSpace::refcount.
|
protected |
Set the base register of a spacebase space.
Perform the privileged act of associating a base register with an existing virtual space
basespace | is the virtual space |
ptrdata | is the location data for the base register |
truncSize | is the size of the space covered by the base register |
stackGrowth | is true if the stack grows "normally" towards address 0 |
References SpacebaseSpace::setBaseRegister().
|
protected |
Select a shortcut character for a new space.
Assign a shortcut character to the given address space. This routine makes use of the desired type of the new space and info about shortcuts for spaces that already exist to pick a unique and consistent character. This method also builds up a map from short to AddrSpace object.
spc | is the given AddrSpace |
References AddrSpace::getName(), AddrSpace::getType(), IPTR_CONSTANT, IPTR_FSPEC, IPTR_INTERNAL, IPTR_IOP, IPTR_JOIN, IPTR_PROCESSOR, IPTR_SPACEBASE, and AddrSpace::shortcut.
Address AddrSpaceManager::constructFloatExtensionAddress | ( | const Address & | realaddr, |
int4 | realsize, | ||
int4 | logicalsize | ||
) |
Build a logically lower precision storage location for a bigger floating point register.
This handles the situation where we need to find a logical address to hold the lower precision floating-point value that is stored in a bigger register If the logicalsize (precision) requested matches the -realsize- of the register just return the real address. Otherwise construct a join address to hold the logical value
realaddr | is the address of the real floating-point register |
realsize | is the size of the real floating-point register |
logicalsize | is the size (lower precision) size of the logical value |
References VarnodeData::getAddr(), Address::getOffset(), Address::getSpace(), and JoinRecord::getUnified().
Referenced by ParamEntry::getAddrBySlot().
Address AddrSpaceManager::constructJoinAddress | ( | const Translate * | translate, |
const Address & | hiaddr, | ||
int4 | hisz, | ||
const Address & | loaddr, | ||
int4 | losz | ||
) |
Build a logical whole from register pairs.
This handles the common case, of trying to find a join address given a high location and a low location. This may not return an address in the join address space. It checks for the case where the two pieces are contiguous locations in a mappable space, in which case it just returns the containing address
translate | is the Translate object used to find registers |
hiaddr | is the address of the most significant piece to be joined |
hisz | is the size of the most significant piece |
loaddr | is the address of the least significant piece |
losz | is the size of the least significant piece |
References VarnodeData::getAddr(), Address::getOffset(), Translate::getRegisterName(), Address::getSpace(), AddrSpace::getType(), JoinRecord::getUnified(), IPTR_PROCESSOR, IPTR_SPACEBASE, Address::isBigEndian(), and Address::isContiguous().
Referenced by FuncCallSpecs::buildOutputFromTrials(), and ActionReturnRecovery::buildReturnOutput().
|
protected |
Copy spaces from another manager.
Different managers may need to share the same spaces. I.e. if different programs being analyzed share the same processor. This routine pulls in a reference of every space in -op2- in order to manage it from within -this-
op2 | is a pointer to space manager being copied |
References baselist, getDefaultCodeSpace(), getDefaultDataSpace(), and AddrSpace::getIndex().
Create a constant address encoding an address space.
This routine is used to encode a pointer to an address space as a constant Address, for use in LOAD and STORE operations. This is used internally and is slightly more efficient than storing the formal index of the space param spc is the space pointer to be encoded
Referenced by Funcdata::newVarnodeSpace().
JoinRecord * AddrSpaceManager::findAddJoin | ( | const vector< VarnodeData > & | pieces, |
uint4 | logicalsize | ||
) |
Get (or create) JoinRecord for pieces.
Given a list of memory locations, the pieces, either find a pre-existing JoinRecord or create a JoinRecord that represents the logical joining of the pieces.
pieces | if the list memory locations to be joined |
logicalsize | of a single piece join, or zero |
References VarnodeData::offset, JoinRecord::pieces, VarnodeData::size, VarnodeData::space, and JoinRecord::unified.
Referenced by JoinSpace::read(), and JoinSpace::restoreXmlAttributes().
JoinRecord * AddrSpaceManager::findJoin | ( | uintb | offset | ) | const |
Find JoinRecord for offset in the join space.
Given a specific offset into the join address space, recover the JoinRecord that lists the pieces corresponding to that offset. The offset must originally have come from a JoinRecord returned by findAddJoin, otherwise this method throws an exception.
offset | is an offset into the join space |
References VarnodeData::offset, and JoinRecord::unified.
Referenced by RulePullsubMulti::buildSubpiece(), JoinSpace::printRaw(), ParamEntry::resolveJoin(), and JoinSpace::saveXmlAttributes().
|
protected |
Find JoinRecord for offset in the join space.
Given a specific offset into the join address space, recover the JoinRecord that contains the offset, as a range in the join address space. If there is no existing record, null is returned.
offset | is an offset into the join space |
References VarnodeData::offset, VarnodeData::size, and JoinRecord::unified.
|
inline |
Get a constant encoded as an Address.
This routine encodes a specific value as a constant address. I.e. the address space of the resulting Address will be the constant space, and the offset will be the value.
val | is the constant value to encode |
Referenced by RuleCollapseConstants::applyOp(), and Funcdata::newConstant().
|
inline |
Get the constant space.
Pcode represents constant values within an operation as offsets within a special constant address space. (See ConstantSpace)
Referenced by ActionConstantPtr::apply(), ActionNameVars::linkSymbols(), PcodeEmit::restoreXmlOp(), and PcodeEmit::unpackVarnodeData().
|
inline |
Get the default address space of this processor.
Most processors have a main address bus, on which the bulk of the processor's RAM is mapped. This matches SLEIGH's notion of the default space. For Harvard architectures, this is the space where code exists (as opposed to data).
Referenced by ActionPrototypeTypes::apply(), RulePtrFlow::applyOp(), ExecutablePcode::build(), copySpaces(), PrintC::pushPtrCodeConstant(), VarnodeData::restoreXml(), Range::restoreXml(), and SleighBase::saveXml().
|
inline |
Get the default address space where data is stored.
Return the default address space for holding data. For most processors, this is just the main RAM space and is the same as the default code space. For Harvard architectures, this is the space where data is stored (as opposed to code).
Referenced by ParamListStandard::assignMap(), ParamListStandardOut::assignMap(), copySpaces(), ActionInferTypes::propagateTypeEdge(), PrintC::pushPtrCharConstant(), and RulePtrFlow::RulePtrFlow().
|
inline |
Get size of addresses for the default space.
Return the size of addresses for the processor's official default space. This space is usually the main RAM databus.
Referenced by ActionParamDouble::apply(), Varnode::printRawNoMarkup(), and AddrSpace::read().
|
inline |
Get the internal callspec space.
There is a special address space reserved for encoding pointers to the FuncCallSpecs object as addresses. This allows direct pointers to be hidden within an operation, when manipulating pcode internally. (See FspecSpace)
Referenced by Funcdata::newVarnodeCallSpecs().
|
inline |
Get the internal pcode op space.
There is a special address space reserved for encoding pointers to pcode operations as addresses. This allows a direct pointer to be hidden within an operation, when manipulating pcode internally. (See IopSpace)
Referenced by TransformVar::createReplacement(), and Funcdata::newVarnodeIop().
|
inline |
Get the joining space.
There is a special address space reserved for providing a logical contiguous memory location for variables that are really split between two physical locations. This allows the the decompiler to work with the logical value. (See JoinSpace)
Get the next contiguous address space.
Get the next space in the absolute order of addresses. This ordering is determined by the AddrSpace index.
spc | is the pointer to the space being queried |
References AddrSpace::getIndex(), and AddrSpace::index.
Referenced by VarnodeBank::endLoc(), and Range::getLastAddrOpen().
|
inline |
Get an address space via its index.
This retrieves a specific address space via its formal index. All spaces have an index, and in conjunction with the numSpaces method, this method can be used to iterate over all spaces.
i | is the index of the address space |
Referenced by ActionDeadCode::apply(), Override::applyDeadCodeDelay(), ConditionalExecution::buildHeritageArray(), Heritage::buildInfoList(), Override::generateDeadcodeDelayMessage(), ActionNameVars::linkSymbols(), GhidraTranslate::oneInstruction(), Override::printRaw(), SleighBase::saveXml(), Override::saveXml(), Funcdata::saveXmlTree(), Funcdata::spacebase(), and PcodeEmit::unpackVarnodeData().
AddrSpace * AddrSpaceManager::getSpaceByName | ( | const string & | nm | ) | const |
Get address space by name.
All address spaces have a unique name associated with them. This routine retrieves the AddrSpace object based on the desired name.
nm | is the name of the address space |
Referenced by LoadImageXml::open(), VarnodeData::restoreXml(), Override::restoreXml(), SpacebaseSpace::restoreXml(), Range::restoreXml(), SegmentOp::restoreXml(), ScopeLocal::restoreXml(), OverlaySpace::restoreXml(), JoinSpace::restoreXmlAttributes(), and PcodeEmit::restoreXmlOp().
AddrSpace * AddrSpaceManager::getSpaceByShortcut | ( | char | sc | ) | const |
Get address space from its shortcut.
All address spaces have a unique shortcut (ASCII) character assigned to them. This routine retrieves an AddrSpace object given a specific shortcut.
sc | is the shortcut character |
Referenced by JoinSpace::read().
|
inline |
Get the stack space for this processor.
Most processors have registers and instructions that are reserved for implementing a stack. In the pcode translation, these are translated into locations and operations on a dedicated stack address space. (See SpacebaseSpace)
Referenced by ActionPrototypeTypes::apply(), ActionActiveParam::apply(), Funcdata::Funcdata(), Funcdata::restoreXml(), and ActionDatabase::universalAction().
|
inline |
Get the temporary register space for this processor.
Both the pcode translation process and the simplification process need access to a pool of temporary registers that can be used for moving data around without affecting the address spaces used to formally model the processor's RAM and registers. These temporary locations are all allocated from a dedicated address space, referred to as the unique space. (See UniqueSpace)
Referenced by ExecutablePcode::build().
|
protected |
Override the base resolver for a space.
Provide a new specialized resolver for a specific AddrSpace. The manager takes ownership of resolver.
spc | is the space to which the resolver is associated |
rsolv | is the new resolver object |
References AddrSpace::getIndex().
|
protected |
Add a new address space to the model.
This adds a previously instantiated address space (AddrSpace) to the model for this processor. It checks a set of indexing and naming conventions for the space and throws an exception if the conventions are violated. Should only be called during initialization.
spc | the address space to insert |
References AddrSpace::constant_space_index, OverlaySpace::getBaseSpace(), AddrSpace::getName(), AddrSpace::getType(), AddrSpace::index, IPTR_CONSTANT, IPTR_FSPEC, IPTR_INTERNAL, IPTR_IOP, IPTR_JOIN, IPTR_PROCESSOR, IPTR_SPACEBASE, AddrSpace::isOtherSpace(), AddrSpace::isOverlay(), AddrSpace::other_space_index, AddrSpace::overlaybase, AddrSpace::refcount, and AddrSpace::setFlags().
|
protected |
Mark that given space can be accessed with near pointers.
spc | is the AddrSpace to mark |
size | is the (minimum) size of a near pointer in bytes |
References AddrSpace::addressSize, AddrSpace::has_nearpointers, AddrSpace::minimumPointerSize, and AddrSpace::setFlags().
|
inline |
Get the number of address spaces for this processor.
This returns the total number of address spaces used by the processor, including all special spaces, like the constant space and the iop space.
Referenced by ScopeInternal::adjustCaches(), ActionDeadCode::apply(), ConditionalExecution::buildHeritageArray(), Heritage::buildInfoList(), ActionNameVars::linkSymbols(), SleighBase::saveXml(), Funcdata::saveXmlTree(), ScopeInternal::ScopeInternal(), and Funcdata::spacebase().
void AddrSpaceManager::renormalizeJoinAddress | ( | Address & | addr, |
int4 | size | ||
) |
Make sure a possibly offset join address has a proper JoinRecord.
If an Address in the join AddressSpace is shifted from its original offset, it may no longer have a valid JoinRecord. The shift or size change may even make the address of one of the pieces a more natural representation. Given a new Address and size, this method decides if there is a matching JoinRecord. If not it either constructs a new JoinRecord or computes the address within the containing piece. The given Address is changed if necessary either to the offset corresponding to the new JoinRecord or to a normal non-join Address.
addr | is the given Address |
size | is the size of the range in bytes |
References JoinRecord::getEquivalentAddress(), Address::getOffset(), Address::isInvalid(), VarnodeData::offset, JoinRecord::pieces, VarnodeData::size, VarnodeData::space, and JoinRecord::unified.
Address AddrSpaceManager::resolveConstant | ( | AddrSpace * | spc, |
uintb | val, | ||
int4 | sz, | ||
const Address & | point, | ||
uintb & | fullEncoding | ||
) | const |
Resolve a native constant into an Address.
If there is a special resolver for the AddrSpace, this is invoked, otherwise basic wordsize conversion and wrapping is performed. If the address encoding is partial (as in a near pointer) and the full encoding can be recovered, it is passed back. The sz parameter indicates the number of bytes in constant and is used to determine if the constant is a partial or full pointer encoding. A value of -1 indicates the value is known to be a full encoding.
spc | is the space to generate the address from |
val | is the constant encoding of the address |
sz | is the size of the constant encoding (or -1) |
point | is the context address (for recovering full encoding info if necessary) |
fullEncoding | is used to pass back the recovered full encoding of the pointer |
References AddrSpace::addressToByte(), AddrSpace::getIndex(), AddrSpace::getWordSize(), AddressResolver::resolve(), and AddrSpace::wrapOffset().
Referenced by ActionConstantPtr::isPointer(), and PrintC::pushPtrCharConstant().
|
protected |
Add a space to the model based an on XML tag.
The initialization of address spaces is the same across all variants of the Translate object. This routine initializes a single address space from a parsed XML tag. It knows which class derived from AddrSpace to instantiate based on the tag name.
el | is the parsed XML tag |
trans | is the translator object to be associated with the new space |
References AddrSpace::AddrSpace(), Element::getName(), IPTR_PROCESSOR, AddrSpace::restoreXml(), and SpacebaseSpace::SpacebaseSpace().
Restore address spaces in the model from an XML tag.
This routine initializes (almost) all the address spaces used for a particular processor by using a <spaces> tag, which contains subtags for the specific address spaces. This also instantiates the builtin constant space. It should probably also instantiate the iop, fspec, and join spaces, but this is currently done by the Architecture class.
el | is the parsed <spaces> tag |
trans | is the processor translator to be associated with the spaces |
References AddrSpace::constant_space_index, Element::getAttributeValue(), Element::getChildren(), and AddrSpace::getIndex().
Referenced by GhidraTranslate::restoreXml(), and SleighBase::restoreXml().
void AddrSpaceManager::setDeadcodeDelay | ( | AddrSpace * | spc, |
int4 | delaydelta | ||
) |
Set the deadcodedelay for a specific space.
Set the number of passes for a specific AddrSpace before deadcode removal is allowed for that space.
spc | is the AddrSpace to change |
delaydelta | is the number of rounds to the delay should be set to |
References AddrSpace::deadcodedelay.
|
protected |
Set the default address space (for code)
Once all the address spaces have been initialized, this routine should be called once to establish the official default space for the processor, via its index. Should only be called during initialization.
index | is the index of the desired default space |
References AddrSpace::index.
|
protected |
Set the default address space for data.
If the architecture has different code and data spaces, this routine can be called to set the data space after the code space has been set.
index | is the index of the desired default space |
References AddrSpace::index.
|
protected |
Set the range of addresses that can be inferred as pointers.
This method establishes for a single address space, what range of constants are checked as possible symbol starts, when it is not known apriori that a constant is a pointer.
range | is the range of values for a single address space |
References Range::getFirst(), Range::getLast(), Range::getSpace(), AddrSpace::pointerLowerBound, and AddrSpace::pointerUpperBound.
|
protected |
Set reverse justified property on this space.
For spaces with alignment restrictions, the address of a small variable must be justified within a larger aligned memory word, usually either to the left boundary for little endian encoding or to the right boundary for big endian encoding. Some compilers justify small variables to the opposite side of the one indicated by the endianness. Setting this property on a space causes the decompiler to use this justification
References AddrSpace::reverse_justification, and AddrSpace::setFlags().
void AddrSpaceManager::truncateSpace | ( | const TruncationTag & | tag | ) |
Mark a space as truncated from its original size.
Mark the named space as truncated from its original size
tag | is a description of the space and how it should be truncated |
References TruncationTag::getName(), TruncationTag::getSize(), and AddrSpace::truncateSpace().
Referenced by SleighArchitecture::modifySpaces(), and GhidraTranslate::restoreXml().