Package ghidra.app.plugin.assembler.sleigh

Class AbstractSleighAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>

java.lang.Object

ghidra.app.plugin.assembler.sleigh.AbstractSleighAssemblerBuilder<RP,A>

All Implemented Interfaces:

GenericAssemblerBuilder<RP,A>

Direct Known Subclasses:

SleighAssemblerBuilder

public abstract class AbstractSleighAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>
extends Object
implements GenericAssemblerBuilder<RP,A>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,AssemblySymbol>	builtSymbols
protected AssemblyContextGraph	ctxGraph
protected static final DbgTimer	dbg
protected AssemblyDefaultContext	defaultContext
protected final AbstractAssemblyResolutionFactory<RP,?>	factory
protected boolean	generated
protected AssemblyGrammar	grammar
protected final SleighLanguage	lang
protected AssemblyParser	parser

Constructor Summary

Constructors

Constructor	Description
AbstractSleighAssemblerBuilder(SleighLanguage lang)

Method Summary

Modifier and Type	Method	Description
protected void	addProduction(AssemblyGrammar subgrammar, AssemblyNonTerminal lhs, AssemblySentential<AssemblyNonTerminal> rhs, DisjointPattern pattern, Constructor cons, List<Integer> indices)	Extension point: Allows a chance to modify or derive a new production from a given one.
protected void	buildContext()	Build the default context for the language
protected void	buildContextGraph()	Build the context transition graph for the language
protected void	buildGrammar()	Build the full grammar for the language
protected void	buildParser()	Build the parser for the language
protected AssemblyGrammar	buildSubGrammar(SubtableSymbol subtable)	Build a portion of the grammar representing a table of constructors
protected void	generateAssembler()	Do the actual work to construct an assembler from a SLEIGH language
A	getAssembler(AssemblySelector selector)	Build an assembler with the given selector callback
A	getAssembler(AssemblySelector selector, Program program)	Build an assembler with the given selector callback and program binding
protected AssemblyGrammar	getGrammar()	Get the built grammar for the language
protected HandleTpl	getHandleTpl(Constructor cons, OperandSymbol opsym)	Obtain the p-code result handle for the given operand
SleighLanguage	getLanguage()	Get the language for which this instance builds an assembler
LanguageID	getLanguageID()	Get the ID of the language for which this instance builds an assembler
protected AssemblyParser	getParser()	Get the built parser for the language
protected AssemblySymbol	getSymbolFor(Constructor cons, OperandSymbol opsym)	Convert the given operand symbol to an AssemblySymbol
protected org.apache.commons.collections4.MultiValuedMap<String,Integer>	invNameSymbol(NameSymbol ns)	Invert a name table to a map suitable for use with AssemblyStringMapTerminal
protected Map<Long,Integer>	invValueMap(ValueMapSymbol vm)	Invert a value map to a map suitable for use with AssemblyNumericMapTerminal
protected org.apache.commons.collections4.MultiValuedMap<String,Integer>	invVarnodeList(VarnodeListSymbol vnlist)	Invert a varnode list to a map suitable for use with AssemblyStringMapTerminal
protected abstract A	newAssembler(AssemblySelector selector)
protected abstract A	newAssembler(AssemblySelector selector, Program program)
protected abstract AbstractAssemblyResolutionFactory<RP,?>	newResolutionFactory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dbg

protected static final DbgTimer dbg

lang

protected final SleighLanguage lang

factory

protected final AbstractAssemblyResolutionFactory<RP extends AssemblyResolvedPatterns,?> factory

grammar

protected AssemblyGrammar grammar

defaultContext

protected AssemblyDefaultContext defaultContext

ctxGraph

protected AssemblyContextGraph ctxGraph

parser

protected AssemblyParser parser

generated

protected boolean generated

builtSymbols

protected Map<String,AssemblySymbol> builtSymbols

Constructor Details

AbstractSleighAssemblerBuilder

public AbstractSleighAssemblerBuilder(SleighLanguage lang)

Method Details

newResolutionFactory

protected abstract AbstractAssemblyResolutionFactory<RP,?> newResolutionFactory()

newAssembler

protected abstract A newAssembler(AssemblySelector selector)

newAssembler

protected abstract A newAssembler(AssemblySelector selector,
 Program program)

getLanguageID

public LanguageID getLanguageID()

Description copied from interface: GenericAssemblerBuilder

Get the ID of the language for which this instance builds an assembler

Specified by:

getLanguageID in interface GenericAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>

Returns:

the language ID

getLanguage

public SleighLanguage getLanguage()

Description copied from interface: GenericAssemblerBuilder

Get the language for which this instance builds an assembler

Specified by:

getLanguage in interface GenericAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>

Returns:

the language

generateAssembler

protected void generateAssembler()
                          throws SleighException

Do the actual work to construct an assembler from a SLEIGH language

Throws:

SleighException - if there's an issue accessing the language

getAssembler

public A getAssembler(AssemblySelector selector)

Description copied from interface: GenericAssemblerBuilder

Build an assembler with the given selector callback

Specified by:

getAssembler in interface GenericAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>

Parameters:

selector - the selector callback

Returns:

the built assembler

getAssembler

public A getAssembler(AssemblySelector selector,
 Program program)

Description copied from interface: GenericAssemblerBuilder

Build an assembler with the given selector callback and program binding

Specified by:

getAssembler in interface GenericAssemblerBuilder<RP extends AssemblyResolvedPatterns,A extends GenericAssembler<RP>>

Parameters:

selector - the selector callback

program - the bound program

Returns:

the built assembler

invVarnodeList

protected org.apache.commons.collections4.MultiValuedMap<String,Integer> invVarnodeList(VarnodeListSymbol vnlist)

Invert a varnode list to a map suitable for use with AssemblyStringMapTerminal

Parameters:

vnlist - the varnode list symbol

Returns:

the inverted string map

invValueMap

protected Map<Long,Integer> invValueMap(ValueMapSymbol vm)

Invert a value map to a map suitable for use with AssemblyNumericMapTerminal

Parameters:

vm - the value map symbol

Returns:

the inverted numeric map

invNameSymbol

protected org.apache.commons.collections4.MultiValuedMap<String,Integer> invNameSymbol(NameSymbol ns)

Invert a name table to a map suitable for use with AssemblyStringMapTerminal

Parameters:

ns - the name symbol

Returns:

the inverted string map

getSymbolFor

protected AssemblySymbol getSymbolFor(Constructor cons,
 OperandSymbol opsym)

Convert the given operand symbol to an AssemblySymbol

For subtables, this results in a non-terminal, for all others, the result in a terminal.

Parameters:

cons - the constructor to which the operand belongs

opsym - the operand symbol to convert

Returns:

the converted assembly grammar symbol

getHandleTpl

protected HandleTpl getHandleTpl(Constructor cons,
 OperandSymbol opsym)

Obtain the p-code result handle for the given operand

This handles a special case, where a constructor prints just one operand and exports that same operand, often with an explicit size, or as an address in a given space. In such cases, the listing displays that operand according to that exported size.

For assembly, this gives a few opportunities: 1) We can/must ensure the specified value fits, by checking the size. 2) We can/must mask the goal when solving the defining pattern expression for the operand. 3)) We can/must check that a label's address space matches that represented by the operand, when used for a numeric terminal.

Parameters:

cons - the constructor from which the production is being derived

opsym - the operand symbol corresponding to the grammatical symbol, whose size we wish to determine.

Returns:

the size of the operand in bits

buildSubGrammar

protected AssemblyGrammar buildSubGrammar(SubtableSymbol subtable)

Build a portion of the grammar representing a table of constructors

Parameters:

subtable - the table

Returns:

the partial grammar

addProduction

protected void addProduction(AssemblyGrammar subgrammar,
 AssemblyNonTerminal lhs,
 AssemblySentential<AssemblyNonTerminal> rhs,
 DisjointPattern pattern,
 Constructor cons,
 List<Integer> indices)

Extension point: Allows a chance to modify or derive a new production from a given one.

Parameters:

subgrammar - the sub-grammar for the sub-table symbol being processed

See Also:

• AssemblyGrammar.addProduction(AssemblyNonTerminal, AssemblySentential, DisjointPattern, Constructor, List)

buildGrammar

protected void buildGrammar()

Build the full grammar for the language

buildContext

protected void buildContext()

Build the default context for the language

buildContextGraph

protected void buildContextGraph()

Build the context transition graph for the language

buildParser

protected void buildParser()

Build the parser for the language

getGrammar

protected AssemblyGrammar getGrammar()

Get the built grammar for the language

Returns:

the grammar

getParser

protected AssemblyParser getParser()

Get the built parser for the language

Returns:

the parser