Ghidra Decompiler Analysis Engine
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
Scope Class Referenceabstract

A collection of Symbol objects within a single (namespace or functional) scope. More...

#include <database.hh>

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

Public Member Functions

 Scope (uint8 id, const string &nm, Architecture *g, Scope *own)
 Construct an empty scope, given a name and Architecture.
 
virtual ~Scope (void)
 Destructor.
 
virtual MapIterator begin (void) const =0
 Beginning iterator to mapped SymbolEntrys.
 
virtual MapIterator end (void) const =0
 Ending iterator to mapped SymbolEntrys.
 
virtual list< SymbolEntry >::const_iterator beginDynamic (void) const =0
 Beginning iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::const_iterator endDynamic (void) const =0
 Ending iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::iterator beginDynamic (void)=0
 Beginning iterator to dynamic SymbolEntrys.
 
virtual list< SymbolEntry >::iterator endDynamic (void)=0
 Ending iterator to dynamic SymbolEntrys.
 
virtual void clear (void)=0
 Clear all symbols from this scope.
 
virtual void clearCategory (int4 cat)=0
 Clear all symbols of the given category from this scope.
 
virtual void clearUnlocked (void)=0
 Clear all unlocked symbols from this scope.
 
virtual void clearUnlockedCategory (int4 cat)=0
 Clear unlocked symbols of the given category from this scope.
 
virtual void adjustCaches (void)=0
 Let scopes internally adjust any caches. More...
 
virtual bool inScope (const Address &addr, int4 size, const Address &usepoint) const
 Query if the given range is owned by this Scope. More...
 
virtual void removeSymbolMappings (Symbol *symbol)=0
 Remove all SymbolEntrys from the given Symbol.
 
virtual void removeSymbol (Symbol *symbol)=0
 Remove the given Symbol from this Scope.
 
virtual void renameSymbol (Symbol *sym, const string &newname)=0
 Rename a Symbol within this Scope.
 
virtual void retypeSymbol (Symbol *sym, Datatype *ct)=0
 Change the data-type of a Symbol within this Scope. More...
 
virtual void setAttribute (Symbol *sym, uint4 attr)=0
 Set boolean Varnode properties on a Symbol.
 
virtual void clearAttribute (Symbol *sym, uint4 attr)=0
 Clear boolean Varnode properties on a Symbol.
 
virtual void setDisplayFormat (Symbol *sym, uint4 attr)=0
 Set the display format for a Symbol.
 
virtual SymbolEntryfindAddr (const Address &addr, const Address &usepoint) const =0
 Find a Symbol at a given address and usepoint. More...
 
virtual SymbolEntryfindContainer (const Address &addr, int4 size, const Address &usepoint) const =0
 Find the smallest Symbol containing the given memory range. More...
 
virtual SymbolEntryfindClosestFit (const Address &addr, int4 size, const Address &usepoint) const =0
 Find Symbol which is the closest fit to the given memory range. More...
 
virtual FuncdatafindFunction (const Address &addr) const =0
 Find the function starting at the given address. More...
 
virtual ExternRefSymbolfindExternalRef (const Address &addr) const =0
 Find an external reference at the given address. More...
 
virtual LabSymbolfindCodeLabel (const Address &addr) const =0
 Find a label Symbol at the given address. More...
 
virtual SymbolEntryfindOverlap (const Address &addr, int4 size) const =0
 Find first Symbol overlapping the given memory range. More...
 
virtual void findByName (const string &name, vector< Symbol * > &res) const =0
 Find a Symbol by name within this Scope. More...
 
virtual bool isNameUsed (const string &nm, const Scope *op2) const =0
 Check if the given name is occurs within the given scope path. More...
 
virtual FuncdataresolveExternalRefFunction (ExternRefSymbol *sym) const =0
 Convert an external reference to the referenced function. More...
 
virtual string buildVariableName (const Address &addr, const Address &pc, Datatype *ct, int4 &index, uint4 flags) const =0
 Given an address and data-type, build a suitable generic symbol name. More...
 
virtual string buildUndefinedName (void) const =0
 Build a formal undefined name, used internally when a Symbol is not given a name. More...
 
virtual string makeNameUnique (const string &nm) const =0
 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 =0
 Write out this as a <scope> XML tag.
 
virtual void restoreXml (const Element *el)=0
 Restore this Scope from a <scope> XML tag.
 
virtual void printEntries (ostream &s) const =0
 Dump a description of all SymbolEntry objects to a stream.
 
virtual int4 getCategorySize (int4 cat) const =0
 Get the number of Symbols in the given category. More...
 
virtual SymbolgetCategorySymbol (int4 cat, int4 ind) const =0
 Retrieve a Symbol by index within a specific category. More...
 
virtual void setCategory (Symbol *sym, int4 cat, int4 ind)=0
 Set the category and index for the given Symbol. More...
 
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...
 
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...
 

Protected Member Functions

virtual ScopebuildSubScope (uint8 id, const string &nm)=0
 Build an unattached Scope to be associated as a sub-scope of this. More...
 
virtual void restrictScope (Funcdata *f)
 Convert this to a local Scope. More...
 
virtual void addRange (AddrSpace *spc, uintb first, uintb last)
 Add a memory range to the ownership of this Scope. More...
 
virtual void removeRange (AddrSpace *spc, uintb first, uintb last)
 Remove a memory range from the ownership of this Scope. More...
 
virtual void addSymbolInternal (Symbol *sym)=0
 Put a Symbol into the name map. More...
 
virtual SymbolEntryaddMapInternal (Symbol *sym, uint4 exfl, const Address &addr, int4 off, int4 sz, const RangeList &uselim)=0
 Create a new SymbolEntry for a Symbol given a memory range. More...
 
virtual SymbolEntryaddDynamicMapInternal (Symbol *sym, uint4 exfl, uint8 hash, int4 off, int4 sz, const RangeList &uselim)=0
 Create a new SymbolEntry for a Symbol given a dynamic hash. More...
 
SymbolEntryaddMap (SymbolEntry &entry)
 Integrate a SymbolEntry into the range maps. More...
 

Static Protected Member Functions

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

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.
 

Friends

class Database
 
class ScopeCompare
 

Detailed Description

A collection of Symbol objects within a single (namespace or functional) scope.

This acts as a traditional Symbol container, allowing them to be accessed by name, but it also keeps track of how a Symbol is mapped into memory. It allows a Symbol to be looked up by its location in memory, which is sensitive to the address of the code accessing the Symbol.

Capabilities include:

A scope also supports the idea of ownership of memory. In theory, for a Symbol in the scope, at the code locations where the Symbol storage is valid, the scope owns the storage memory. In practice, a Scope object knows about memory ranges where a Symbol might be discovered. For instance, the global Scope usually owns all memory in the ram address space.

Member Function Documentation

◆ addCodeLabel()

LabSymbol * Scope::addCodeLabel ( const Address addr,
const string &  nm 
)

Create a code label at the given address in this Scope.

A LabSymbol is created and mapped to the given address.

Parameters
addris the given address to map to
nmis the name of the symbol/label
Returns
the new LabSymbol

◆ addDynamicMapInternal()

virtual SymbolEntry* Scope::addDynamicMapInternal ( Symbol sym,
uint4  exfl,
uint8  hash,
int4  off,
int4  sz,
const RangeList uselim 
)
protectedpure virtual

Create a new SymbolEntry for a Symbol given a dynamic hash.

The SymbolEntry is specified in terms of a hash and usepoint, which describe how to find the temporary Varnode holding the symbol value.

Parameters
symis the given Symbol being mapped
exflare any boolean Varnode properties
hashis the given dynamic hash
offis the byte offset of the new SymbolEntry (relative to the whole Symbol)
szis the number of bytes occupied by the Varnode
uselimis the given usepoint
Returns
the newly created SymbolEntry

Implemented in ScopeInternal.

◆ addDynamicSymbol()

Symbol * Scope::addDynamicSymbol ( const string &  nm,
Datatype ct,
const Address caddr,
uint8  hash 
)

Create a dynamically mapped Symbol attached to a specific data-flow.

The Symbol is created and mapped to a dynamic hash and a code address where the Symbol is being used.

Parameters
nmis the name of the Symbol
ctis the data-type of the Symbol
caddris the code address where the Symbol is being used
hashis the dynamic hash
Returns
the new Symbol

◆ addExternalRef()

ExternRefSymbol * Scope::addExternalRef ( const Address addr,
const Address refaddr,
const string &  nm 
)

Create an external reference at the given address in this Scope

An ExternRefSymbol is created and mapped to the given address and stores a reference address to the actual function.

Parameters
addris the given address to map the Symbol to
refaddris the reference address
nmis the name of the symbol/function
Returns
the new ExternRefSymbol

◆ addFunction()

FunctionSymbol * Scope::addFunction ( const Address addr,
const string &  nm 
)

Create a function Symbol at the given address in this Scope.

The FunctionSymbol is created and mapped to the given address. A Funcdata object is only created once FunctionSymbol::getFunction() is called.

Parameters
addris the entry address of the function
nmis the name of the function, within this Scope
Returns
the new FunctionSymbol object

◆ addMap()

SymbolEntry * Scope::addMap ( SymbolEntry entry)
protected

Integrate a SymbolEntry into the range maps.

The mapping is given as an unintegrated SymbolEntry object. Memory may be specified in terms of join addresses, which this method must unravel. The offset, size, and extraflags fields of the SymbolEntry are not used. In particular, the SymbolEntry is assumed to map the entire Symbol.

Parameters
entryis the given SymbolEntry
Returns
a SymbolEntry which has been fully integrated

◆ addMapInternal()

virtual SymbolEntry* Scope::addMapInternal ( Symbol sym,
uint4  exfl,
const Address addr,
int4  off,
int4  sz,
const RangeList uselim 
)
protectedpure virtual

Create a new SymbolEntry for a Symbol given a memory range.

The SymbolEntry is specified in terms of a memory range and usepoint

Parameters
symis the given Symbol being mapped
exflare any boolean Varnode properties specific to the memory range
addris the starting address of the given memory range
offis the byte offset of the new SymbolEntry (relative to the whole Symbol)
szis the number of bytes in the range
uselimis the given usepoint (which may be invalid)
Returns
the newly created SymbolEntry

Implemented in ScopeInternal, and ScopeGhidraNamespace.

◆ addMapPoint()

SymbolEntry * Scope::addMapPoint ( Symbol sym,
const Address addr,
const Address usepoint 
)

Map a Symbol to a specific address.

Create a new SymbolEntry that maps the whole Symbol to the given address

Parameters
symis the Symbol
addris the given address to map to
usepointis a point at which the Symbol is accessed at that address
Returns
the SymbolEntry representing the new mapping

◆ addMapSym()

Symbol * Scope::addMapSym ( const Element el)

Add a mapped Symbol from a <mapsym> XML tag.

A tag describing the Symbol is parsed first, followed by sequences of <addr> or <hash> and <rangelist> which define 1 or more mappings of the Symbol The new Symbol and SymbolEntry mappings are integrated into this Scope

Parameters
elis the <mapsym> XML element
Returns
the new Symbol

◆ addRange()

void Scope::addRange ( AddrSpace spc,
uintb  first,
uintb  last 
)
protectedvirtual

Add a memory range to the ownership of this Scope.

Parameters
spcis the address space of the range
firstis the offset of the first byte in the range
lastis the offset of the last byte in the range

◆ addSymbol() [1/2]

Symbol * Scope::addSymbol ( const string &  name,
Datatype ct 
)

Add a new Symbol without mapping it to an address.

The Symbol is created and added to any name map, but no SymbolEntry objects are created for it.

Parameters
nameis the name of the new Symbol
ctis a data-type to assign to the new Symbol
Returns
the new Symbol object

◆ addSymbol() [2/2]

SymbolEntry * Scope::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 in ScopeGhidra.

◆ addSymbolInternal()

virtual void Scope::addSymbolInternal ( Symbol sym)
protectedpure virtual

Put a Symbol into the name map.

Parameters
symis the preconstructed Symbol

Implemented in ScopeInternal.

◆ adjustCaches()

virtual void Scope::adjustCaches ( void  )
pure virtual

Let scopes internally adjust any caches.

This is called once after Architecture configuration is complete.

Implemented in ScopeInternal, and ScopeGhidra.

◆ buildDefaultName()

string Scope::buildDefaultName ( Symbol sym,
int4 &  base,
Varnode vn 
) const

Create a default name for the given Symbol.

Create default name given information in the Symbol and possibly a representative Varnode. This method extracts the crucial properties and then uses the buildVariableName method to construct the actual name.

Parameters
symis the given Symbol to name
baseis an index (which may get updated) used to uniquify the name
vnis an optional (may be null) Varnode representative of the Symbol
Returns
the default name

◆ buildSubScope()

virtual Scope* Scope::buildSubScope ( uint8  id,
const string &  nm 
)
protectedpure virtual

Build an unattached Scope to be associated as a sub-scope of this.

This is a Scope object factory, intended to be called off of the global scope for building global namespace scopes. Function scopes are handled differently.

Parameters
idis the globally unique id associated with the scope
nmis the name of the new scope
Returns
the new Scope object

Implemented in ScopeInternal.

◆ buildUndefinedName()

virtual string Scope::buildUndefinedName ( void  ) const
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ buildVariableName()

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

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

Implemented in ScopeInternal, ScopeLocal, and ScopeGhidra.

◆ discoverScope()

Scope * Scope::discoverScope ( const Address addr,
int4  sz,
const Address usepoint 
)

Find the owning Scope of a given memory range.

Discover a sub-scope or containing Scope of this, that owns the given memory range at a specific usepoint. Note that ownership does not necessarily mean there is a known symbol there.

Parameters
addris the starting address of the memory range
szis the number of bytes in the range
usepointis a point at which the memory is getting accesses

◆ findAddr()

virtual SymbolEntry* Scope::findAddr ( const Address addr,
const Address usepoint 
) const
pure 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

Implemented in ScopeInternal, and ScopeGhidra.

◆ findByName()

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

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ findClosestFit()

virtual SymbolEntry* Scope::findClosestFit ( const Address addr,
int4  size,
const Address usepoint 
) const
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ findCodeLabel()

virtual LabSymbol* Scope::findCodeLabel ( const Address addr) const
pure virtual

Find a label Symbol at the given address.

Parameters
addris the given address
Returns
the matching LabSymbol or NULL

Implemented in ScopeInternal, and ScopeGhidra.

◆ findContainer()

virtual SymbolEntry* Scope::findContainer ( const Address addr,
int4  size,
const Address usepoint 
) const
pure 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

Implemented in ScopeInternal, and ScopeGhidra.

◆ findDistinguishingScope()

const Scope * Scope::findDistinguishingScope ( const Scope op2) const

Find first ancestor of this not shared by given scope.

Any two scopes share at least the global scope as a common ancestor. We find the first scope that is not in common. The scope returned will always be an ancestor of this. If this is an ancestor of the other given scope, then null is returned.

Parameters
op2is the other given Scope
Returns
the first ancestor Scope that is not in common or null

◆ findExternalRef()

virtual ExternRefSymbol* Scope::findExternalRef ( const Address addr) const
pure virtual

Find an external reference at the given address.

Parameters
addris the given address
Returns
the matching ExternRefSymbol or NULL

Implemented in ScopeInternal, and ScopeGhidra.

◆ findFunction()

virtual Funcdata* Scope::findFunction ( const Address addr) const
pure virtual

Find the function starting at the given address.

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ findOverlap()

virtual SymbolEntry* Scope::findOverlap ( const Address addr,
int4  size 
) const
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ getCategorySize()

virtual int4 Scope::getCategorySize ( int4  cat) const
pure virtual

Get the number of Symbols in the given category.

Parameters
catis the Symbol category
Returns
the number in that category

Implemented in ScopeInternal, and ScopeGhidra.

◆ getCategorySymbol()

virtual Symbol* Scope::getCategorySymbol ( int4  cat,
int4  ind 
) const
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ getScopePath()

void Scope::getScopePath ( vector< const Scope * > &  vec) const

Get the ordered list of scopes up to this.

Put the parent scopes of this into an array in order, starting with the global scope.

Parameters
vecis storage for the array of scopes

◆ inScope()

virtual bool Scope::inScope ( const Address addr,
int4  size,
const Address usepoint 
) const
inlinevirtual

Query if the given range is owned by this Scope.

All bytes in the range must be owned, and ownership can be informed by particular code that is accessing the range.

Parameters
addris the starting address of the range
sizeis the number of bytes in the range
usepointis the code address at which the given range is being accessed (may be invalid)
Returns
true if this Scope owns the memory range

◆ isNameUsed()

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

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)

Implemented in ScopeInternal, ScopeGhidraNamespace, and ScopeGhidra.

◆ isReadOnly()

bool Scope::isReadOnly ( const Address addr,
int4  size,
const Address usepoint 
) const

Is the given memory range marked as read-only.

Check for Symbols relative to this Scope that are marked as read-only, and look-up properties of the memory in general.

Parameters
addris the starting address of the given memory range
sizeis the number of bytes in the range
usepointis a point where the range is getting accessed
Returns
true if the memory is marked as read-only

◆ isSubScope()

bool Scope::isSubScope ( const Scope scp) const

Is this a sub-scope of the given Scope.

Does the given Scope contain this as a sub-scope.

Parameters
scpis the given Scope
Returns
true if this is a sub-scope

◆ makeNameUnique()

virtual string Scope::makeNameUnique ( const string &  nm) const
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ overrideSizeLockType()

void Scope::overrideSizeLockType ( Symbol sym,
Datatype ct 
)

Change the data-type of a Symbol that is sizelocked.

Change (override) the data-type of a sizelocked Symbol, while preserving the lock. An exception is thrown if the new data-type doesn't fit the size.

Parameters
symis the locked Symbol
ctis the data-type to change the Symbol to

◆ queryByAddr()

SymbolEntry * Scope::queryByAddr ( const Address addr,
const Address usepoint 
) const

Get Symbol with matching address.

Within a sub-scope or containing Scope of this, find a Symbol that is mapped to the given address, where the mapping is valid at a specific usepoint.

Parameters
addris the given address
usepointis the point at which code accesses that address (may be invalid)
Returns
the matching SymbolEntry

◆ queryByName()

void Scope::queryByName ( const string &  name,
vector< Symbol * > &  res 
) const

Look-up symbols by name.

Starting from this Scope, look for a Symbol with the given name. If there are no Symbols in this Scope, recurse into the parent Scope. If there are 1 (or more) Symbols matching in this Scope, add them to the result list

Parameters
nameis the name to search for
resis the result list

◆ queryCodeLabel()

LabSymbol * Scope::queryCodeLabel ( const Address addr) const

Look-up a code label by address.

Within a sub-scope or containing Scope of this, find a label Symbol at the given address.

Parameters
addris the given address
Returns
the LabSymbol object, or NULL if it doesn't exist

◆ queryContainer()

SymbolEntry * Scope::queryContainer ( const Address addr,
int4  size,
const Address usepoint 
) const

Find the smallest containing Symbol.

Within a sub-scope or containing Scope of this, find the smallest Symbol that contains a given memory range and can be accessed at a given usepoint.

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

◆ queryExternalRefFunction()

Funcdata * Scope::queryExternalRefFunction ( const Address addr) const

Look-up a function thru an external reference.

Given an address, search for an external reference. If no Symbol is found and this Scope does not own the address, recurse searching in the parent Scope. If an external reference is found, try to resolve the function it refers to and return it.

Parameters
addris the given address where an external reference might be
Returns
the referred to Funcdata object or NULL if not found

◆ queryFunction() [1/2]

Funcdata * Scope::queryFunction ( const Address addr) const

Look-up a function by address.

Within a sub-scope or containing Scope of this, find a function starting at the given address.

Parameters
addris the starting address of the function
Returns
the Funcdata object of the matching function, or NULL if it doesn't exist

◆ queryFunction() [2/2]

Funcdata * Scope::queryFunction ( const string &  name) const

Look-up a function by name.

Starting with this Scope, find a function with the given name. If there are no Symbols with that name in this Scope at all, recurse into the parent Scope.

Parameters
nameif the name to search for
Returns
the Funcdata object of the matching function, or NULL if it doesn't exist

◆ queryProperties()

SymbolEntry * Scope::queryProperties ( const Address addr,
int4  size,
const Address usepoint,
uint4 &  flags 
) const

Find a Symbol or properties at the given address.

Similarly to queryContainer(), this searches for the smallest containing Symbol, but whether a known Symbol is found or not, boolean properties associated with the memory range are also search for and passed back.

Parameters
addris the starting address of the range
sizeis the number of bytes in the range
usepointis a point at which the memory range is accessed (may be invalid)
flagsis a reference used to pass back the boolean properties of the memory range
Returns
the smallest SymbolEntry containing the range, or NULL

◆ removeRange()

void Scope::removeRange ( AddrSpace spc,
uintb  first,
uintb  last 
)
protectedvirtual

Remove a memory range from the ownership of this Scope.

Parameters
spcis the address space of the range
firstis the offset of the first byte in the range
lastis the offset of the last byte in the range

◆ resetSizeLockType()

void Scope::resetSizeLockType ( Symbol sym)

Clear a Symbol's size-locked data-type.

Replace any overriding data-type type with the locked UNKNOWN type of the correct size. The data-type is cleared, but the lock is preserved.

Parameters
symis the Symbol to clear

◆ resolveExternalRefFunction()

virtual Funcdata* Scope::resolveExternalRefFunction ( ExternRefSymbol sym) const
pure 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

Implemented in ScopeInternal, and ScopeGhidra.

◆ resolveScope()

Scope * Scope::resolveScope ( const string &  name,
bool  strategy 
) const

Find a child Scope of this.

Look for the immediate child of this with a given name

Parameters
nameis the child's name
strategyis true if hash of the name determines id
Returns
the child Scope or NULL if there is no child with that name

◆ restrictScope()

void Scope::restrictScope ( Funcdata f)
protectedvirtual

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 in ScopeGhidra.

◆ retypeSymbol()

virtual void Scope::retypeSymbol ( Symbol sym,
Datatype ct 
)
pure virtual

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

Implemented in ScopeInternal, and ScopeGhidra.

◆ saveXmlRecursive()

void Scope::saveXmlRecursive ( ostream &  s,
bool  onlyGlobal 
) const

Save all contained scopes as an XML stream.

This Scope and all of its sub-scopes are saved as a sequence of <scope> tags in post order. For each Scope, the saveXml() method is invoked.

Parameters
sis the output stream
onlyGlobalis true if only non-local Scopes should be saved

◆ setCategory()

virtual void Scope::setCategory ( Symbol sym,
int4  cat,
int4  ind 
)
pure virtual

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)

Implemented in ScopeInternal, and ScopeGhidra.

◆ stackAddr()

const Scope * Scope::stackAddr ( const Scope scope1,
const Scope scope2,
const Address addr,
const Address usepoint,
SymbolEntry **  addrmatch 
)
staticprotected

Query for Symbols starting at a given address, which match a given usepoint.

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory at that address, the Scope object is returned. Additionally, if a symbol matching the criterion is found, the matching SymbolEntry is passed back.

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the given address to search for
usepointis the given point at which the memory is being accessed (can be an invalid address)
addrmatchis used to pass-back any matching SymbolEntry
Returns
the Scope owning the address or NULL if none found

◆ stackClosestFit()

const Scope * Scope::stackClosestFit ( const Scope scope1,
const Scope scope2,
const Address addr,
int4  size,
const Address usepoint,
SymbolEntry **  addrmatch 
)
staticprotected

Query for a Symbol which most closely matches a given range and usepoint

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory in the given range, the Scope object is returned. Among symbols that overlap the given range, the SymbolEntry which most closely matches the starting address and size is passed back.

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the starting address of the given range
sizeis the number of bytes in the given range
usepointis the point at which the memory is being accessed (can be an invalid address)
addrmatchis used to pass-back any matching SymbolEntry
Returns
the Scope owning the address or NULL if none found

◆ stackCodeLabel()

const Scope * Scope::stackCodeLabel ( const Scope scope1,
const Scope scope2,
const Address addr,
LabSymbol **  addrmatch 
)
staticprotected

Query for a label Symbol for a given address.

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory in the given range, the Scope object is returned. If there is a label at that address, pass back the corresponding LabSymbol object

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the given address
addrmatchis used to pass-back any matching Symbol
Returns
the Scope owning the address or NULL if none found

◆ stackContainer()

const Scope * Scope::stackContainer ( const Scope scope1,
const Scope scope2,
const Address addr,
int4  size,
const Address usepoint,
SymbolEntry **  addrmatch 
)
staticprotected

Query for a Symbol containing a given range which is accessed at a given usepoint

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory in the given range, the Scope object is returned. If a known Symbol contains the range, the matching SymbolEntry is passed back.

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the starting address of the given range
sizeis the number of bytes in the given range
usepointis the point at which the memory is being accessed (can be an invalid address)
addrmatchis used to pass-back any matching SymbolEntry
Returns
the Scope owning the address or NULL if none found

◆ stackExternalRef()

const Scope * Scope::stackExternalRef ( const Scope scope1,
const Scope scope2,
const Address addr,
ExternRefSymbol **  addrmatch 
)
staticprotected

Query for an external reference Symbol starting at the given address

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory in the given range, the Scope object is returned. If an external reference is found at the address, pass back the matching ExternRefSymbol

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the given address
addrmatchis used to pass-back any matching Symbol
Returns
the Scope owning the address or NULL if none found

◆ stackFunction()

const Scope * Scope::stackFunction ( const Scope scope1,
const Scope scope2,
const Address addr,
Funcdata **  addrmatch 
)
staticprotected

Query for a function Symbol starting at the given address

Searching starts at a first scope, continuing thru parents up to a second scope, which is not queried. If a Scope controls the memory in the given range, the Scope object is returned. If a FunctionSymbol is found at the given address, the corresponding Funcdata object is passed back.

Parameters
scope1is the first Scope where searching starts
scope2is the second Scope where searching ends
addris the given address where the function should start
addrmatchis used to pass-back any matching function
Returns
the Scope owning the address or NULL if none found

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