Package ghidra.features.bsim.query.description

Class FunctionDescription

java.lang.Object

ghidra.features.bsim.query.description.FunctionDescription

All Implemented Interfaces:

Comparable<FunctionDescription>

public class FunctionDescription
extends Object
implements Comparable<FunctionDescription>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionDescription.Update

Constructor Summary

Constructors

Constructor	Description
FunctionDescription(ExecutableRecord ex, String name, long addr)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FunctionDescription o)
static Map<Long,FunctionDescription>	createAddressToFunctionMap(Iterator<FunctionDescription> iter)	Create a map from addresses to functions
boolean	diffForUpdate(FunctionDescription.Update res, FunctionDescription fromDB)	Update the boolean fields in -res- to true, for every field in -this- that needs to be updated from -fromDB-
boolean	equals(Object obj)
static List<FunctionDescription.Update>	generateUpdates(Iterator<FunctionDescription> iter, Map<Long,FunctionDescription> addrMap, List<FunctionDescription> badList)	Match new functions to old functions via the address, test if there is an update between the two functions, generate an update record if there is, return the list of updates
long	getAddress()
List<CallgraphEntry>	getCallgraphRecord()
ExecutableRecord	getExecutableRecord()
int	getFlags()
String	getFunctionName()
RowKey	getId()
SignatureRecord	getSignatureRecord()
long	getVectorId()
int	hashCode()
String	printRaw()
static FunctionDescription	restoreXml(XmlPullParser parser, LSHVectorFactory vectorFactory, DescriptionManager man, ExecutableRecord erec)
void	saveXml(Writer fwrite)
void	setSignatureRecord(SignatureRecord srec)
void	sortCallgraph()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionDescription

public FunctionDescription(ExecutableRecord ex,
 String name,
 long addr)

Method Details

setSignatureRecord

public void setSignatureRecord(SignatureRecord srec)

getFunctionName

public String getFunctionName()

getExecutableRecord

public ExecutableRecord getExecutableRecord()

getSignatureRecord

public SignatureRecord getSignatureRecord()

getCallgraphRecord

public List<CallgraphEntry> getCallgraphRecord()

getId

public RowKey getId()

getVectorId

public long getVectorId()

getAddress

public long getAddress()

getFlags

public int getFlags()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(FunctionDescription o)

Specified by:

compareTo in interface Comparable<FunctionDescription>

sortCallgraph

public void sortCallgraph()

printRaw

public String printRaw()

saveXml

public void saveXml(Writer fwrite)
             throws IOException

Throws:

IOException

diffForUpdate

public boolean diffForUpdate(FunctionDescription.Update res,
 FunctionDescription fromDB)

Update the boolean fields in -res- to true, for every field in -this- that needs to be updated from -fromDB-

Parameters:

res - stores the boolean results for which fields to update

fromDB - is the metadata to compare with -this- to decided if updates are necessary

Returns:

true if one or more updates is necessary

restoreXml

public static FunctionDescription restoreXml(XmlPullParser parser,
 LSHVectorFactory vectorFactory,
 DescriptionManager man,
 ExecutableRecord erec)
                                      throws LSHException

Throws:

LSHException

createAddressToFunctionMap

public static Map<Long,FunctionDescription> createAddressToFunctionMap(Iterator<FunctionDescription> iter)

Create a map from addresses to functions

Parameters:

iter - is the list of functions to map

Returns:

the Map

generateUpdates

public static List<FunctionDescription.Update> generateUpdates(Iterator<FunctionDescription> iter,
 Map<Long,FunctionDescription> addrMap,
 List<FunctionDescription> badList)

Match new functions to old functions via the address, test if there is an update between the two functions, generate an update record if there is, return the list of updates

Parameters:

iter - is the list of NEW functions

addrMap - is a map from address to OLD functions

badList - is a container for new functions that could not be mapped to old

Returns:

the list of Update records