|
Ghidra Decompiler Analysis Engine
|
A storage location for a particular Symbol. More...
#include <database.hh>
Classes | |
| class | EntryInitData |
| Initialization data for a SymbolEntry to facilitate a rangemap. More... | |
| class | EntrySubsort |
| Class for sub-sorting different SymbolEntry objects at the same address. More... | |
Public Types | |
| typedef uintb | linetype |
| The linear element for a rangemap of SymbolEntry. | |
| typedef EntrySubsort | subsorttype |
| The sub-sort object for a rangemap. | |
| typedef EntryInitData | inittype |
| Initialization data for a SymbolEntry in a rangemap. | |
Public Member Functions | |
| SymbolEntry (const EntryInitData &data, uintb a, uintb b) | |
| Fully initialize this. More... | |
| SymbolEntry (Symbol *sym, uint4 exfl, uint8 h, int4 off, int4 sz, const RangeList &rnglist) | |
| Construct a dynamic SymbolEntry. More... | |
| uint4 | getAllFlags (void) const |
| Get all Varnode flags for this storage. More... | |
| subsorttype | getSubsort (void) const |
| Get the sub-sort object. More... | |
| bool | inUse (const Address &usepoint) const |
| Is this storage valid for the given code address. More... | |
| Address | getFirstUseAddress (void) const |
| Get the first code address where this storage is valid. | |
| bool | isAddrTied (void) const |
| Is this storage address tied. | |
| bool | updateType (Varnode *vn) const |
| Update a Varnode data-type from this. More... | |
| Datatype * | getSizedType (const Address &addr, int4 sz) const |
| Get the data-type associated with (a piece of) this. More... | |
| void | printEntry (ostream &s) const |
| Dump a description of this to a stream. More... | |
| void | saveXml (ostream &s) const |
| Save this to an XML stream. More... | |
| List::const_iterator | restoreXml (List::const_iterator iter, const AddrSpaceManager *manage) |
| Restore this from an XML stream. More... | |
Friends | |
| class | Scope |
A storage location for a particular Symbol.
Where a Symbol is stored, as a byte address and a size, is of particular importance to the decompiler. This class encapsulates this storage meta-data. A single Symbol split across multiple storage locations is supported by the offset and size fields. The hash field supports dynamic storage, where a Symbol is represented by a constant or a temporary register. In this case, storage must be tied to the particular p-code operators using the value.
A particular memory address does not have to represent the symbol across all code. Storage may get recycled for different Symbols at different points in the code. The uselimit object defines the range of instruction addresses over which a particular memory address does represent a Symbol, with the convention that an empty uselimit indicates the storage holds the Symbol across all code.
| SymbolEntry::SymbolEntry | ( | const EntryInitData & | data, |
| uintb | a, | ||
| uintb | b | ||
| ) |
Fully initialize this.
Establish the boundary offsets and fill in additional data
| data | contains the raw initialization data |
| a | is the starting offset of the entry |
| b | is the ending offset of the entry |
| SymbolEntry::SymbolEntry | ( | Symbol * | sym, |
| uint4 | exfl, | ||
| uint8 | h, | ||
| int4 | off, | ||
| int4 | sz, | ||
| const RangeList & | rnglist | ||
| ) |
Construct a dynamic SymbolEntry.
This is used specifically for dynamic Symbol objects, where the storage location is attached to a temporary register or a constant. The main address field (addr) is set to invalid, and the hash becomes the primary location information.
| sym | is the underlying Symbol |
| exfl | are the Varnode flags associated with the storage location |
| h | is the the hash |
| off | if the offset into the Symbol for this (piece of) storage |
| sz | is the size in bytes of this (piece of) storage |
| rnglist | is the set of code addresses where this SymbolEntry represents the Symbol |
|
inline |
Get the data-type associated with (a piece of) this.
Return the data-type that matches the given size and address within this storage. NULL is returned if there is no valid sub-type matching the size.
| inaddr | is the given address |
| sz | is the given size (in bytes) |
| SymbolEntry::subsorttype SymbolEntry::getSubsort | ( | void | ) | const |
Get the sub-sort object.
Get data used to sub-sort entries (in a rangemap) at the same address
| bool SymbolEntry::inUse | ( | const Address & | usepoint | ) | const |
Is this storage valid for the given code address.
This storage location may only hold the Symbol value for a limited portion of the code.
| usepoint | is the given code address to test |
| void SymbolEntry::printEntry | ( | ostream & | s | ) | const |
Dump a description of this to a stream.
Give a contained one-line description of this storage, suitable for a debug console
| s | is the output stream |
| List::const_iterator SymbolEntry::restoreXml | ( | List::const_iterator | iter, |
| const AddrSpaceManager * | manage | ||
| ) |
Restore this from an XML stream.
Given an iterator to children of a <mapsym> tag, restore the storage address (or the hash if the symbol is dynamic) and the uselimit describing the valid range of code addresses, then advance the iterator to the next tag.
| iter | is the iterator pointing to the address or hash tag |
| manage | is an address space manager for constructing Address objects |
| void SymbolEntry::saveXml | ( | ostream & | s | ) | const |
Save this to an XML stream.
This writes tags internal to the <mapsym> tag associated with the Symbol. It outputs the address tag (or the <hash> tag for dynamic symbols) and a <rangelist> tag associated with the uselimit.
| s | is the output stream |
| bool SymbolEntry::updateType | ( | Varnode * | vn | ) | const |
1.8.17