Common core of classes that read or write SLEIGH specification files natively. More...

#include <sleighbase.hh>

Inheritance diagram for SleighBase:

Public Member Functions
	SleighBase (void)
	Construct an uninitialized translator.

bool	isInitialized (void) const
	Return true if this is initialized.

virtual	~SleighBase (void)
	Destructor.

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

SleighSymbol *	findSymbol (const string &nm) const
	Find a specific SLEIGH symbol by name in the current scope.

SleighSymbol *	findSymbol (uintm id) const
	Find a specific SLEIGH symbol by id.

SleighSymbol *	findGlobalSymbol (const string &nm) const
	Find a specific global SLEIGH symbol by name.

void	saveXml (ostream &s) const
	Write out the SLEIGH specification as an XML <sleigh> tag. 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	initialize (DocumentStorage &store)=0
	Initialize the translator given XML configuration documents. 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...

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

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

virtual int4	printAssembly (AssemblyEmit &emit, const Address &baseaddr) const =0
	Disassemble a single machine instruction. 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...

Protected Member Functions
void	buildXrefs (void)
	Build register map. Collect user-ops and context-fields. More...

void	reregisterContext (void)
	Reregister context fields for a new executable. More...

void	restoreXml (const Element *el)
	Read a SLEIGH specification from XML. More...

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
SubtableSymbol *	root
	The root SLEIGH decoding symbol.

SymbolTable	symtab
	The SLEIGH symbol table.

uint4	maxdelayslotbytes
	Maximum number of bytes in a delay-slot directive.

uint4	unique_allocatemask
	Bits that are guaranteed to be zero in the unique allocation scheme.

uint4	numSections
	Number of named sections.

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

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

Private Attributes
vector< string >	userop
	Names of user-define p-code ops for this Translate object.

map< VarnodeData, string >	varnode_xref
	A map from Varnodes in the register space to register names.

Detailed Description

Common core of classes that read or write SLEIGH specification files natively.

This class represents what's in common across the SLEIGH infrastructure between:

Reading the various SLEIGH specification files
Building and writing out SLEIGH specification files

Member Function Documentation

◆ addRegister()

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

virtual

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.

References symtab.

◆ buildXrefs()

void SleighBase::buildXrefs ( void )

protected

Build register map. Collect user-ops and context-fields.

Assuming the symbol table is populated, iterate through the table collecting registers (for the map), user-op names, and context fields.

References Translate::registerContext(), symtab, userop, and varnode_xref.

Referenced by restoreXml().

◆ getAllRegisters()

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

virtual

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.

References varnode_xref.

◆ getRegister()

const VarnodeData & SleighBase::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 findSymbol().

◆ getRegisterName()

string SleighBase::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 VarnodeData::offset, VarnodeData::size, VarnodeData::space, and varnode_xref.

◆ getUserOpNames()

void SleighBase::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 userop.

◆ reregisterContext()

void SleighBase::reregisterContext ( void )

protected

Reregister context fields for a new executable.

If this SleighBase is being reused with a new program, the context variables need to be registered with the new program's database

References Translate::registerContext(), and symtab.

Referenced by Sleigh::initialize().

◆ restoreXml()

void SleighBase::restoreXml ( const Element * el )

protected

Read a SLEIGH specification from XML.

This parses the main <sleigh> tag (from a .sla file), which includes the description of address spaces and the symbol table, with its associated decoding tables

Parameters

el	is the root XML element

References Translate::alignment, buildXrefs(), Translate::floatformats, maxdelayslotbytes, numSections, AddrSpaceManager::restoreXmlSpaces(), root, Translate::setBigEndian(), Translate::setUniqueBase(), symtab, and unique_allocatemask.

Referenced by Sleigh::initialize().

◆ saveXml()

void SleighBase::saveXml ( ostream & s ) const

Write out the SLEIGH specification as an XML <sleigh> tag.

This does the bulk of the work of creating a .sla file

Parameters

s	is the output stream

References Translate::alignment, AddrSpaceManager::getDefaultSpace(), AddrSpaceManager::getSpace(), AddrSpace::getType(), Translate::getUniqueBase(), IPTR_CONSTANT, IPTR_FSPEC, IPTR_IOP, IPTR_JOIN, Translate::isBigEndian(), maxdelayslotbytes, numSections, AddrSpaceManager::numSpaces(), AddrSpace::saveXml(), symtab, and unique_allocatemask.

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

sleighbase.hh
sleighbase.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ addRegister()

◆ buildXrefs()

◆ getAllRegisters()

◆ getRegister()

◆ getRegisterName()

◆ getUserOpNames()

◆ reregisterContext()

◆ restoreXml()

◆ saveXml()