An implementation of Translate that queries a Ghidra client for p-code information. More...

#include <ghidra_translate.hh>

Inheritance diagram for GhidraTranslate:

Public Member Functions
	GhidraTranslate (ArchitectureGhidra *g)
	Constructor.

virtual void	initialize (DocumentStorage &store)
	Initialize the translator given XML configuration documents. More...

virtual void	addRegister (const string &nm, AddrSpace *base, uintb offset, int4 size)
	Add a named register to the model for this processor. More...

virtual const VarnodeData &	getRegister (const string &nm) const
	Get a register as VarnodeData given its name. More...

virtual string	getRegisterName (AddrSpace *base, uintb off, int4 size) const
	Get the name of a register given its location. More...

virtual void	getAllRegisters (map< VarnodeData, string > &reglist) const
	Get a list of all register names and the corresponding location. More...

virtual void	getUserOpNames (vector< string > &res) const
	Get a list of all user-defined pcode ops. More...

virtual int4	oneInstruction (PcodeEmit &emit, const Address &baseaddr) const
	Transform a single machine instruction into pcode. More...

virtual int4	instructionLength (const Address &baseaddr) const
	Get the length of a machine instruction. More...

virtual int4	printAssembly (AssemblyEmit &emit, const Address &baseaddr) const
	Disassemble a single machine instruction. More...

Public Member Functions inherited from Translate
	Translate (void)
	Constructor for the translator. More...

void	setDefaultFloatFormats (void)
	If no explicit float formats, set up default formats. More...

bool	isBigEndian (void) const
	Is the processor big endian? More...

const FloatFormat *	getFloatFormat (int4 size) const
	Get format for a particular floating point encoding. More...

int4	getAlignment (void) const
	Get the instruction alignment for the processor. More...

uintm	getUniqueBase (void) const
	Get the base offset for new temporary registers. More...

virtual void	registerContext (const string &name, int4 sbit, int4 ebit)
	Add a new context variable to the model for this processor. More...

virtual void	setContextDefault (const string &name, uintm val)
	Set the default value for a particular context variable. More...

virtual void	allowContextSet (bool val) const
	Toggle whether disassembly is allowed to affect context. More...

Public Member Functions inherited from AddrSpaceManager
	AddrSpaceManager (void)
	Construct an empty address space manager. More...

virtual	~AddrSpaceManager (void)
	Destroy the manager. More...

char	assignShortcut (spacetype tp) const
	Select a shortcut character for a new space. 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 *	getDefaultSpace (void) const
	Get the default address space of this processor. 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) const
	Resolve native constant to address.

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 (int4 spcnum, 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...

Private Member Functions
const VarnodeData &	cacheRegister (const string &nm, const VarnodeData &data) const
	Associate a Varnode with a register name. More...

void	restoreXml (const Element *el)
	Initialize this Translate from XML. More...

Private Attributes
ArchitectureGhidra *	glb
	The Ghidra Architecture and connection to the client.

map< string, VarnodeData >	nm2addr
	Mapping from register name to Varnode.

map< VarnodeData, string >	addr2nm
	Mapping rom Varnode to register name.

Additional Inherited Members
Protected Member Functions inherited from Translate
void	setBigEndian (bool val)
	Set general endianness to big if val is true. More...

void	setUniqueBase (uintm val)
	Set the base offset for new temporary registers. More...

Protected Member Functions inherited from AddrSpaceManager
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	setDefaultSpace (int4 index)
	Set the default address space. More...

void	setReverseJustified (AddrSpace *spc)
	Set reverse justified property on this space. 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...

Protected Attributes inherited from Translate
int4	alignment
	Byte modulo on which instructions are aligned.

vector< FloatFormat >	floatformats
	Floating point formats utilized by the processor.

Detailed Description

An implementation of Translate that queries a Ghidra client for p-code information.

This class provides:

P-code for instructions and
Register names

by sending a request to a Ghidra client and decoding the response. Messages are generally based on an XML format, but p-code responses in particular have a tight internal encoding.

Member Function Documentation

◆ addRegister()

virtual void GhidraTranslate::addRegister	(	const string &	nm,
		AddrSpace *	base,
		uintb	offset,
		int4	size
	)

inlinevirtual

Add a named register to the model for this processor.

Deprecated:: All registers used to be formally added to the processor model through this method.

Parameters

nm	is the name of the new register
base	is the address space containing the register
offset	is the offset of the register
size	is the number of bytes in the register

Implements Translate.

◆ cacheRegister()

const VarnodeData & GhidraTranslate::cacheRegister	(	const string &	nm,
		const VarnodeData &	data
	)		const

private

Associate a Varnode with a register name.

Parameters

nm	is the register name
data	is the Varnode description

Returns: a reference to the cached VarnodeData

References addr2nm, and nm2addr.

◆ getAllRegisters()

virtual void GhidraTranslate::getAllRegisters ( map< VarnodeData, string > & reglist ) const

inlinevirtual

Get a list of all register names and the corresponding location.

Most processors have a list of named registers and possibly other memory locations that are specific to it. This function populates a map from the location information to the name, for every named location known by the translator

Parameters

reglist is the map which will be populated by the call

Implements Translate.

◆ getRegister()

const VarnodeData & GhidraTranslate::getRegister ( const string & nm ) const

virtual

Get a register as VarnodeData given its name.

Retrieve the location and size of a register given its name

Parameters

nm	is the name of the register

Returns: the VarnodeData for the register

Implements Translate.

References ArchitectureGhidra::getRegister(), glb, and nm2addr.

Referenced by getRegisterName().

◆ getRegisterName()

string GhidraTranslate::getRegisterName	(	AddrSpace *	base,
		uintb	off,
		int4	size
	)		const

virtual

Get the name of a register given its location.

Generic references to locations in a register space can be translated into the associated register name. If the location doesn't match a register exactly, an empty string is returned.

Parameters

base	is the address space containing the location
off	is the offset of the location
size	is the size of the location

Returns: the name of the register, or an empty string

Implements Translate.

References addr2nm, getRegister(), ArchitectureGhidra::getRegisterName(), AddrSpace::getType(), glb, IPTR_PROCESSOR, VarnodeData::offset, VarnodeData::size, and VarnodeData::space.

◆ getUserOpNames()

void GhidraTranslate::getUserOpNames ( vector< string > & res ) const

virtual

Get a list of all user-defined pcode ops.

The pcode model allows processors to define new pcode instructions that are specific to that processor. These user-defined instructions are all identified by a name and an index. This method returns a list of these ops in index order.

Parameters

res	is the resulting vector of user op names

Implements Translate.

References ArchitectureGhidra::getUserOpName(), and glb.

◆ initialize()

void GhidraTranslate::initialize ( DocumentStorage & store )

virtual

Initialize the translator given XML configuration documents.

A translator gets initialized once, possibly using XML documents to configure it.

Parameters

store is a set of configuration documents

Implements Translate.

References restoreXml().

◆ instructionLength()

virtual int4 GhidraTranslate::instructionLength ( const Address & baseaddr ) const

inlinevirtual

Get the length of a machine instruction.

This method decodes an instruction at a specific address just enough to find the number of bytes it uses within the instruction stream.

Parameters

baseaddr is the Address of the instruction

Returns: the number of bytes in the instruction

Implements Translate.

◆ oneInstruction()

int4 GhidraTranslate::oneInstruction	(	PcodeEmit &	emit,
		const Address &	baseaddr
	)		const

virtual

Transform a single machine instruction into pcode.

This is the main interface to the pcode translation engine. The dump method in the emit object is invoked exactly once for each pcode operation in the translation for the machine instruction at the given address. This routine can throw either

UnimplError or
BadDataError

Parameters

emit	is the tailored pcode emitting object
baseaddr	is the Address of the machine instruction

Returns: the number of bytes in the machine instruction

Implements Translate.

References ArchitectureGhidra::getPcodePacked(), Address::getShortcut(), AddrSpaceManager::getSpace(), glb, Address::printRaw(), PcodeEmit::restorePackedOp(), and PcodeEmit::unpackOffset().

◆ printAssembly()

virtual int4 GhidraTranslate::printAssembly	(	AssemblyEmit &	emit,
		const Address &	baseaddr
	)		const

inlinevirtual

Disassemble a single machine instruction.

This is the main interface to the disassembler for the processor. It disassembles a single instruction and returns the result to the application via the dump method in the emit object.

Parameters

emit	is the disassembly emitting object
baseaddr	is the address of the machine instruction to disassemble

Implements Translate.

◆ restoreXml()

void GhidraTranslate::restoreXml ( const Element * el )

private

Initialize this Translate from XML.

The Ghidra client passes descriptions of address spaces and other information that needs to be cached by the decompiler

Parameters

el	is the element of the initialization tag

References TruncationTag::restoreXml(), AddrSpaceManager::restoreXmlSpaces(), Translate::setBigEndian(), Translate::setUniqueBase(), and AddrSpaceManager::truncateSpace().

Referenced by initialize().

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

ghidra_translate.hh
ghidra_translate.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRegister()

◆ cacheRegister()

◆ getAllRegisters()

◆ getRegister()

◆ getRegisterName()

◆ getUserOpNames()

◆ initialize()

◆ instructionLength()

◆ oneInstruction()

◆ printAssembly()

◆ restoreXml()