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

An implementation of the Scope interface by querying a Ghidra client for Symbol information. More...

#include <database_ghidra.hh>

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

Public Member Functions

 ScopeGhidra (ArchitectureGhidra *g)
 Constructor. More...
 
void lockDefaultProperties (void)
 Lock in the default state of the boolean property map. More...
 
virtual void clear (void)
 Clear all symbols from this scope.
 
virtual SymbolEntryaddSymbol (const string &name, Datatype *ct, const Address &addr, const Address &usepoint)
 Add a new Symbol to this Scope, given a name, data-type, and a single mapping. More...
 
virtual string buildVariableName (const Address &addr, const Address &pc, Datatype *ct, int4 &index, uint4 flags) const
 Given an address and data-type, build a suitable generic symbol name. More...
 
virtual string buildUndefinedName (void) const
 Build a formal undefined name, used internally when a Symbol is not given a name. More...
 
virtual void setAttribute (Symbol *sym, uint4 attr)
 Set boolean Varnode properties on a Symbol.
 
virtual void clearAttribute (Symbol *sym, uint4 attr)
 Clear boolean Varnode properties on a Symbol.
 
virtual void setDisplayFormat (Symbol *sym, uint4 attr)
 Set the display format for a Symbol.
 
virtual void adjustCaches (void)
 Let scopes internally adjust any caches. More...
 
virtual SymbolEntryfindAddr (const Address &addr, const Address &usepoint) const
 Find a Symbol at a given address and usepoint. More...
 
virtual SymbolEntryfindContainer (const Address &addr, int4 size, const Address &usepoint) const
 Find the smallest Symbol containing the given memory range. More...
 
virtual SymbolEntryfindClosestFit (const Address &addr, int4 size, const Address &usepoint) const
 Find Symbol which is the closest fit to the given memory range. More...
 
virtual FuncdatafindFunction (const Address &addr) const
 Find the function starting at the given address. More...
 
virtual ExternRefSymbolfindExternalRef (const Address &addr) const
 Find an external reference at the given address. More...
 
virtual LabSymbolfindCodeLabel (const Address &addr) const
 Find a label Symbol at the given address. More...
 
virtual FuncdataresolveExternalRefFunction (ExternRefSymbol *sym) const
 Convert an external reference to the referenced function. More...
 
virtual SymbolEntryfindOverlap (const Address &addr, int4 size) const
 Find first Symbol overlapping the given memory range. More...
 
virtual void findByName (const string &name, vector< Symbol * > &res) const
 Find a Symbol by name within this Scope. More...
 
virtual bool isNameUsed (const string &nm, const Scope *op2) const
 Check if the given name is occurs within the given scope path. More...
 
virtual MapIterator begin (void) const
 Beginning iterator to mapped SymbolEntrys.
 
virtual MapIterator end (void) const
 Ending iterator to mapped SymbolEntrys.
 
virtual list< SymbolEntry >::const_iterator beginDynamic (void) const
 Beginning iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::const_iterator endDynamic (void) const
 Ending iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::iterator beginDynamic (void)
 Beginning iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::iterator endDynamic (void)
 Ending iterator to dynamic SymbolEntrys.
 
virtual void clearCategory (int4 cat)
 Clear all symbols of the given category from this scope.
 
virtual void clearUnlockedCategory (int4 cat)
 Clear unlocked symbols of the given category from this scope.
 
virtual void clearUnlocked (void)
 Clear all unlocked symbols from this scope.
 
virtual void restrictScope (Funcdata *f)
 Convert this to a local Scope. More...
 
virtual void removeSymbolMappings (Symbol *symbol)
 Remove all SymbolEntrys from the given Symbol.
 
virtual void removeSymbol (Symbol *symbol)
 Remove the given Symbol from this Scope.
 
virtual void renameSymbol (Symbol *sym, const string &newname)
 Rename a Symbol within this Scope.
 
virtual void retypeSymbol (Symbol *sym, Datatype *ct)
 Change the data-type of a Symbol within this Scope. More...
 
virtual string makeNameUnique (const string &nm) const
 Produce a version of the given symbol name that won't collide with other names in this Scope. More...
 
virtual void saveXml (ostream &s) const
 Write out this as a <scope> XML tag.
 
virtual void restoreXml (const Element *el)
 Restore this Scope from a <scope> XML tag.
 
virtual void printEntries (ostream &s) const
 Dump a description of all SymbolEntry objects to a stream.
 
virtual int4 getCategorySize (int4 cat) const
 Get the number of Symbols in the given category. More...
 
virtual SymbolgetCategorySymbol (int4 cat, int4 ind) const
 Retrieve a Symbol by index within a specific category. More...
 
virtual void setCategory (Symbol *sym, int4 cat, int4 ind)
 Set the category and index for the given Symbol. More...
 
- Public Member Functions inherited from Scope
 Scope (uint8 id, const string &nm, Architecture *g, Scope *own)
 Construct an empty scope, given a name and Architecture.
 
virtual ~Scope (void)
 Destructor.
 
virtual bool inScope (const Address &addr, int4 size, const Address &usepoint) const
 Query if the given range is owned by this Scope. More...
 
void queryByName (const string &name, vector< Symbol * > &res) const
 Look-up symbols by name. More...
 
FuncdataqueryFunction (const string &name) const
 Look-up a function by name. More...
 
SymbolEntryqueryByAddr (const Address &addr, const Address &usepoint) const
 Get Symbol with matching address. More...
 
SymbolEntryqueryContainer (const Address &addr, int4 size, const Address &usepoint) const
 Find the smallest containing Symbol. More...
 
SymbolEntryqueryProperties (const Address &addr, int4 size, const Address &usepoint, uint4 &flags) const
 Find a Symbol or properties at the given address. More...
 
FuncdataqueryFunction (const Address &addr) const
 Look-up a function by address. More...
 
FuncdataqueryExternalRefFunction (const Address &addr) const
 Look-up a function thru an external reference. More...
 
LabSymbolqueryCodeLabel (const Address &addr) const
 Look-up a code label by address. More...
 
ScoperesolveScope (const string &name, bool strategy) const
 Find a child Scope of this. More...
 
ScopediscoverScope (const Address &addr, int4 sz, const Address &usepoint)
 Find the owning Scope of a given memory range. More...
 
void saveXmlRecursive (ostream &s, bool onlyGlobal) const
 Save all contained scopes as an XML stream. More...
 
void overrideSizeLockType (Symbol *sym, Datatype *ct)
 Change the data-type of a Symbol that is sizelocked. More...
 
void resetSizeLockType (Symbol *sym)
 Clear a Symbol's size-locked data-type. More...
 
bool isSubScope (const Scope *scp) const
 Is this a sub-scope of the given Scope. More...
 
string getFullName (void) const
 Get the full name of this Scope.
 
void getScopePath (vector< const Scope * > &vec) const
 Get the ordered list of scopes up to this. More...
 
const ScopefindDistinguishingScope (const Scope *op2) const
 Find first ancestor of this not shared by given scope. More...
 
SymboladdSymbol (const string &name, Datatype *ct)
 Add a new Symbol without mapping it to an address. More...
 
SymbolEntryaddMapPoint (Symbol *sym, const Address &addr, const Address &usepoint)
 Map a Symbol to a specific address. More...
 
SymboladdMapSym (const Element *el)
 Add a mapped Symbol from a <mapsym> XML tag. More...
 
FunctionSymboladdFunction (const Address &addr, const string &nm)
 Create a function Symbol at the given address in this Scope. More...
 
ExternRefSymboladdExternalRef (const Address &addr, const Address &refaddr, const string &nm)
 
LabSymboladdCodeLabel (const Address &addr, const string &nm)
 Create a code label at the given address in this Scope. More...
 
SymboladdDynamicSymbol (const string &nm, Datatype *ct, const Address &caddr, uint8 hash)
 Create a dynamically mapped Symbol attached to a specific data-flow. More...
 
string buildDefaultName (Symbol *sym, int4 &base, Varnode *vn) const
 Create a default name for the given Symbol. More...
 
bool isReadOnly (const Address &addr, int4 size, const Address &usepoint) const
 Is the given memory range marked as read-only. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Scope
SymbolEntryaddMap (SymbolEntry &entry)
 Integrate a SymbolEntry into the range maps. More...
 
- Static Protected Member Functions inherited from Scope
static const ScopestackAddr (const Scope *scope1, const Scope *scope2, const Address &addr, const Address &usepoint, SymbolEntry **addrmatch)
 Query for Symbols starting at a given address, which match a given usepoint. More...
 
static const ScopestackContainer (const Scope *scope1, const Scope *scope2, const Address &addr, int4 size, const Address &usepoint, SymbolEntry **addrmatch)
 
static const ScopestackClosestFit (const Scope *scope1, const Scope *scope2, const Address &addr, int4 size, const Address &usepoint, SymbolEntry **addrmatch)
 
static const ScopestackFunction (const Scope *scope1, const Scope *scope2, const Address &addr, Funcdata **addrmatch)
 
static const ScopestackExternalRef (const Scope *scope1, const Scope *scope2, const Address &addr, ExternRefSymbol **addrmatch)
 
static const ScopestackCodeLabel (const Scope *scope1, const Scope *scope2, const Address &addr, LabSymbol **addrmatch)
 
- Protected Attributes inherited from Scope
Architectureglb
 Architecture of this scope.
 
string name
 Name of this scope.
 
Funcdatafd
 (If non-null) the function which this is the local Scope for
 
uint8 uniqueId
 Unique id for the scope, for deduping scope names, assigning symbol ids.
 

Detailed Description

An implementation of the Scope interface by querying a Ghidra client for Symbol information.

This object is generally instantiated once for an executable and acts as the global scope for the decompiler. Queries for symbol information are forwarded to the Ghidra client and the response is cached. This object fields queries for all scopes above functions. Responses may be for Symbol objects that are not global but belong to sub-scopes, like namespace and function Scopes. This object will build any new Scope or Funcdata, object as necessary and stick the Symbol in, returning as if the new Scope had caught the query in the first place.

Constructor & Destructor Documentation

◆ ScopeGhidra()

ScopeGhidra::ScopeGhidra ( ArchitectureGhidra g)

Constructor.

Parameters
gis the Architecture and connection to the Ghidra client

Member Function Documentation

◆ addSymbol()

SymbolEntry * ScopeGhidra::addSymbol ( const string &  name,
Datatype ct,
const Address addr,
const Address usepoint 
)
virtual

Add a new Symbol to this Scope, given a name, data-type, and a single mapping.

The Symbol object will be created with the given name and data-type. A single mapping (SymbolEntry) will be created for the Symbol based on a given storage address for the symbol and an address for code that accesses the Symbol at that storage location.

Parameters
nameis the new name of the Symbol
ctis the data-type of the new Symbol
addris the starting address of the Symbol storage
usepointis the point accessing that storage (may be invalid)
Returns
the SymbolEntry matching the new mapping

Reimplemented from Scope.

◆ adjustCaches()

virtual void ScopeGhidra::adjustCaches ( void  )
inlinevirtual

Let scopes internally adjust any caches.

This is called once after Architecture configuration is complete.

Implements Scope.

◆ buildUndefinedName()

virtual string ScopeGhidra::buildUndefinedName ( void  ) const
inlinevirtual

Build a formal undefined name, used internally when a Symbol is not given a name.

Returns
a special internal name that won't collide with other names in this Scope

Implements Scope.

◆ buildVariableName()

virtual string ScopeGhidra::buildVariableName ( const Address addr,
const Address pc,
Datatype ct,
int4 &  index,
uint4  flags 
) const
inlinevirtual

Given an address and data-type, build a suitable generic symbol name.

Parameters
addris the given address
pcis the address at which the name is getting used
ctis a data-type used to inform the name
indexis a reference to an index used to make the name unique, which will be updated
flagsare boolean properties of the variable we need the name for
Returns
the new variable name

Implements Scope.

◆ findAddr()

SymbolEntry * ScopeGhidra::findAddr ( const Address addr,
const Address usepoint 
) const
virtual

Find a Symbol at a given address and usepoint.

Parameters
addris the given address
usepointis the point at which the Symbol is accessed (may be invalid)
Returns
the matching SymbolEntry or NULL

Implements Scope.

◆ findByName()

virtual void ScopeGhidra::findByName ( const string &  name,
vector< Symbol * > &  res 
) const
inlinevirtual

Find a Symbol by name within this Scope.

If there are multiple Symbols with the same name, all are passed back.

Parameters
nameis the name to search for
reswill contain any matching Symbols

Implements Scope.

◆ findClosestFit()

virtual SymbolEntry* ScopeGhidra::findClosestFit ( const Address addr,
int4  size,
const Address usepoint 
) const
inlinevirtual

Find Symbol which is the closest fit to the given memory range.

Parameters
addris the starting address of the given memory range
sizeis the number of bytes in the range
usepointis the point at which the Symbol is accessed (may be invalid)
Returns
the matching SymbolEntry or NULL

Implements Scope.

◆ findCodeLabel()

LabSymbol * ScopeGhidra::findCodeLabel ( const Address addr) const
virtual

Find a label Symbol at the given address.

Parameters
addris the given address
Returns
the matching LabSymbol or NULL

Implements Scope.

◆ findContainer()

SymbolEntry * ScopeGhidra::findContainer ( const Address addr,
int4  size,
const Address usepoint 
) const
virtual

Find the smallest Symbol containing the given memory range.

Parameters
addris the starting address of the given memory range
sizeis the number of bytes in the range
usepointis the point at which the Symbol is accessed (may be invalid)
Returns
the matching SymbolEntry or NULL

Implements Scope.

◆ findExternalRef()

ExternRefSymbol * ScopeGhidra::findExternalRef ( const Address addr) const
virtual

Find an external reference at the given address.

Parameters
addris the given address
Returns
the matching ExternRefSymbol or NULL

Implements Scope.

◆ findFunction()

Funcdata * ScopeGhidra::findFunction ( const Address addr) const
virtual

Find the function starting at the given address.

Parameters
addris the given starting address
Returns
the matching Funcdata object or NULL

Implements Scope.

◆ findOverlap()

virtual SymbolEntry* ScopeGhidra::findOverlap ( const Address addr,
int4  size 
) const
inlinevirtual

Find first Symbol overlapping the given memory range.

Parameters
addris the starting address of the given range
sizeis the number of bytes in the range
Returns
an overlapping SymbolEntry or NULL if none exists

Implements Scope.

◆ getCategorySize()

virtual int4 ScopeGhidra::getCategorySize ( int4  cat) const
inlinevirtual

Get the number of Symbols in the given category.

Parameters
catis the Symbol category
Returns
the number in that category

Implements Scope.

◆ getCategorySymbol()

virtual Symbol* ScopeGhidra::getCategorySymbol ( int4  cat,
int4  ind 
) const
inlinevirtual

Retrieve a Symbol by index within a specific category.

Parameters
catis the Symbol category
indis the index (within the category) of the Symbol
Returns
the indicated Symbol or NULL if no Symbol with that index exists

Implements Scope.

◆ isNameUsed()

virtual bool ScopeGhidra::isNameUsed ( const string &  nm,
const Scope op2 
) const
inlinevirtual

Check if the given name is occurs within the given scope path.

Test for the presence of a symbol with the given name in either this scope or an ancestor scope up to but not including the given terminating scope. If the name is used true is returned.

Parameters
nmis the given name to test
op2is the terminating ancestor scope (or null)

Implements Scope.

◆ lockDefaultProperties()

void ScopeGhidra::lockDefaultProperties ( void  )
inline

Lock in the default state of the boolean property map.

When this Scope gets created, parsing of .pspec and .cspec files may lay down property information about memory before any the load-image is consulted. This method locks creates a copy of this state of memory, so the decompiler can reset to it before decompiling a new function.

◆ makeNameUnique()

virtual string ScopeGhidra::makeNameUnique ( const string &  nm) const
inlinevirtual

Produce a version of the given symbol name that won't collide with other names in this Scope.

Parameters
nmis the given name
Returns
return a unique version of the name

Implements Scope.

◆ resolveExternalRefFunction()

Funcdata * ScopeGhidra::resolveExternalRefFunction ( ExternRefSymbol sym) const
virtual

Convert an external reference to the referenced function.

Parameters
symis the Symbol marking the external reference
Returns
the underlying Funcdata object or NULL if none exists

Implements Scope.

◆ restrictScope()

virtual void ScopeGhidra::restrictScope ( Funcdata f)
inlinevirtual

Convert this to a local Scope.

Attach this to the given function, which makes this the local scope for the function

Parameters
fis the given function to attach to

Reimplemented from Scope.

◆ retypeSymbol()

virtual void ScopeGhidra::retypeSymbol ( Symbol sym,
Datatype ct 
)
inlinevirtual

Change the data-type of a Symbol within this Scope.

If the size of the Symbol changes, any mapping (SymbolEntry) is adjusted

Parameters
symis the given Symbol
ctis the new data-type

Implements Scope.

◆ setCategory()

virtual void ScopeGhidra::setCategory ( Symbol sym,
int4  cat,
int4  ind 
)
inlinevirtual

Set the category and index for the given Symbol.

Parameters
symis the given Symbol
catis the category to set for the Symbol
indis the index position to set (within the category)

Implements Scope.


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