Package ghidra.app.plugin.assembler.sleigh.sem

Class DefaultAssemblyResolvedPatterns

java.lang.Object

ghidra.app.plugin.assembler.sleigh.sem.AbstractAssemblyResolution

ghidra.app.plugin.assembler.sleigh.sem.DefaultAssemblyResolvedPatterns

All Implemented Interfaces:

AssemblyResolution, AssemblyResolvedPatterns, Comparable<AssemblyResolution>

public class DefaultAssemblyResolvedPatterns
extends AbstractAssemblyResolution
implements AssemblyResolvedPatterns

A AssemblyResolution indicating successful application of a constructor

This is almost analogous to DisjointPattern, in that is joins an instruction AssemblyPatternBlock with a corresponding context AssemblyPatternBlock. However, this object is mutable, and it collects backfill records, as well as forbidden patterns.

When the applied constructor is from the "instruction" subtable, this represents a fully- constructed instruction with required context. All backfill records ought to be resolved and applied before the final result is given to the user, i.e., passed into the AssemblySelector. If at any time during the resolution or backfill process, the result becomes confined to one of the forbidden patterns, it must be dropped, since the encoding will actually invoke a more specific SLEIGH constructor.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<AssemblyResolvedBackfill>	backfills
protected final Constructor	cons
protected final AssemblyPatternBlock	ctx
protected static final String	CTX
protected final Set<AssemblyResolvedPatterns>	forbids
protected final AssemblyPatternBlock	ins
protected static final String	INS
protected static final Pattern	pat
protected static final String	SEP

Fields inherited from class ghidra.app.plugin.assembler.sleigh.sem.AbstractAssemblyResolution

children, description, factory, right

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultAssemblyResolvedPatterns(AbstractAssemblyResolutionFactory<?,?> factory, String description, Constructor cons, List<? extends AssemblyResolution> children, AssemblyResolution right, AssemblyPatternBlock ins, AssemblyPatternBlock ctx, Set<AssemblyResolvedBackfill> backfills, Set<AssemblyResolvedPatterns> forbids)

Method Summary

Modifier and Type	Method	Description
AssemblyResolution	backfill(RecursiveDescentSolver solver, Map<String,Long> vals)	Apply as many backfill records as possible
boolean	bitsEqual(AssemblyResolvedPatterns that)	Check if this and another resolution have equal encodings
AssemblyResolution	checkNotForbidden()	Check if the current encoding is forbidden by one of the attached patterns
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolutionBuilder<?,?>	checkNotForbiddenBuilder()
protected String	childrenToString(String indent)	Get the child portion of AbstractAssemblyResolution.toString()
AssemblyResolvedPatterns	combine(AssemblyResolvedBackfill bf)	Combine the given backfill record into this resolution
AssemblyResolvedPatterns	combine(AssemblyResolvedPatterns that)	Combine the encodings and backfills of the given resolution into this one
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	combineBuilder(AssemblyResolvedBackfill bf)
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	combineBuilder(AssemblyResolvedPatterns that)
AssemblyResolvedPatterns	combineLessBackfill(AssemblyResolvedPatterns that, AssemblyResolvedBackfill bf)	Combine a backfill result
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	combineLessBackfillBuilder(AssemblyResolvedPatterns that, AssemblyResolvedBackfill bf)
protected int	computeHash()
AssemblyResolvedPatterns	copyAppendDescription(String append)	Duplicate this resolution, with additional description text appended
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	copyAppendDescriptionBuilder(String append)
String	dumpConstructorTree()	Used for testing and diagnostics: list the constructor line numbers used to resolve this encoding
boolean	equals(Object obj)
boolean	equivalentConstructState(ConstructState state)	Check if this assembled construct state is the same as the given dis-assembled construct state.
Set<AssemblyResolvedBackfill>	getBackfills()	Get the backfill records for this resolution, if any
Constructor	getConstructor()
AssemblyPatternBlock	getContext()	Get the context block
int	getDefinedInstructionLength()	Get the length of the instruction encoding, excluding trailing undefined bytes
Set<AssemblyResolvedPatterns>	getForbids()	Get the forbidden patterns for this resolution
AssemblyPatternBlock	getInstruction()	Get the instruction block
int	getInstructionLength()	Get the length of the instruction encoding
protected static int	getOpIndex(String piece)
protected static ConstructState	getPureRecursion(ConstructState state)	If the construct state is a ^instruction or other purely-recursive constructor, get its single child.
int	getSpecificity()	Count the number of bits specified in the resolution patterns
boolean	hasBackfills()	Check if this resolution has pending backfills to apply
boolean	hasChildren()	Check if this record has children
boolean	isBackfill()	Check if this record describes a backfill
boolean	isError()	Check if this record describes an error
String	lineToString()	Display the resolution result in one line (omitting child details)
AssemblyResolvedPatterns	maskOut(ContextOp cop)	Set all bits read by a given context operation to unknown
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	maskOutBuilder(ContextOp cop)
AssemblyResolvedPatterns	nopLeftSibling()	Generate a new nop right this resolution to its right.
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	nopLeftSiblingBuilder()
AssemblyResolvedPatterns	parent(String description, int opCount)	Get this same resolution, pushing its right siblings down to its children
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	parentBuilder(String description, int opCount)
protected boolean	partsEqual(DefaultAssemblyResolvedPatterns that)
Iterable<byte[]>	possibleInsVals(AssemblyPatternBlock forCtx)	Get an iterable over all the possible fillings of the instruction pattern given a context
MaskedLong	readContext(int start, int len)	Decode a portion of the context block
MaskedLong	readContextOp(ContextOp cop)	Decode the value from the context located where the given context operation would write
MaskedLong	readInstruction(int start, int len)	Decode a portion of the instruction block
AssemblyResolvedPatterns	shift(int amt)	Shift the resolution's instruction pattern to the right, if applicable
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	shiftBuilder(int amt)
AssemblyResolvedPatterns	solveContextChangesForForbids(AssemblyConstructorSemantic sem, Map<String,Long> vals)	Solve and apply context changes in reverse to forbidden patterns
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	solveContextChangesForForbidsBuilder(AssemblyConstructorSemantic sem, Map<String,Long> vals)
AssemblyResolvedPatterns	truncate(int amt)	Truncate (unshift) the resolved instruction pattern from the left NOTE: This drops all backfill and forbidden pattern records, since this method is typically used to read token fields rather than passed around for resolution.
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	truncateBuilder(int amt)
AssemblyResolvedPatterns	withConstructor(Constructor cons)	Create a copy of this resolution with a replaced constructor
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	withConstructorBuilder(Constructor cons)
AssemblyResolvedPatterns	withContext(AssemblyPatternBlock ctx)	Create a copy of this resolution with a new context
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	withContextBuilder(AssemblyPatternBlock ctx)
AssemblyResolvedPatterns	withDescription(String description)	Create a copy of this resolution with a new description
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	withDescriptionBuilder(String description)
AssemblyResolvedPatterns	withForbids(Set<AssemblyResolvedPatterns> more)	Create a new resolution from this one with the given forbidden patterns recorded
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	withForbidsBuilder(Set<AssemblyResolvedPatterns> more)
AssemblyResolvedPatterns	withRight(AssemblyResolution right)	Get this same resolution, but with the given right sibling
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	withRightBuilder(AssemblyResolution right)
AssemblyResolvedPatterns	writeContextOp(ContextOp cop, MaskedLong val)	Encode the given value into the context block as specified by an operation
protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?>	writeContextOpBuilder(ContextOp cop, MaskedLong val)

Methods inherited from class ghidra.app.plugin.assembler.sleigh.sem.AbstractAssemblyResolution

collectAllRight, compareTo, getAllRight, getChildren, getDescription, getRight, hashCode, toString, toString, withoutRight

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.app.plugin.assembler.sleigh.sem.AssemblyResolution

collectAllRight, getChildren, getDescription, getRight, toString, toString

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

INS

protected static final String INS

See Also:

• Constant Field Values

CTX

protected static final String CTX

See Also:

• Constant Field Values

SEP

protected static final String SEP

See Also:

• Constant Field Values

cons

protected final Constructor cons

ins

protected final AssemblyPatternBlock ins

ctx

protected final AssemblyPatternBlock ctx

backfills

protected final Set<AssemblyResolvedBackfill> backfills

forbids

protected final Set<AssemblyResolvedPatterns> forbids

pat

protected static final Pattern pat

Constructor Details

DefaultAssemblyResolvedPatterns

protected DefaultAssemblyResolvedPatterns(AbstractAssemblyResolutionFactory<?,?> factory,
 String description,
 Constructor cons,
 List<? extends AssemblyResolution> children,
 AssemblyResolution right,
 AssemblyPatternBlock ins,
 AssemblyPatternBlock ctx,
 Set<AssemblyResolvedBackfill> backfills,
 Set<AssemblyResolvedPatterns> forbids)

Method Details

computeHash

protected int computeHash()

Specified by:

computeHash in class AbstractAssemblyResolution

partsEqual

protected boolean partsEqual(DefaultAssemblyResolvedPatterns that)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

shiftBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> shiftBuilder(int amt)

shift

public AssemblyResolvedPatterns shift(int amt)

Description copied from interface: AssemblyResolution

Shift the resolution's instruction pattern to the right, if applicable

This also shifts any backfill and forbidden pattern records.

Specified by:

shift in interface AssemblyResolution

Specified by:

shift in interface AssemblyResolvedPatterns

Specified by:

shift in class AbstractAssemblyResolution

Parameters:

amt - the number of bytes to shift.

Returns:

the result

truncateBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> truncateBuilder(int amt)

truncate

public AssemblyResolvedPatterns truncate(int amt)

Description copied from interface: AssemblyResolvedPatterns

Truncate (unshift) the resolved instruction pattern from the left NOTE: This drops all backfill and forbidden pattern records, since this method is typically used to read token fields rather than passed around for resolution.

Specified by:

truncate in interface AssemblyResolvedPatterns

Parameters:

amt - the number of bytes to remove from the left

Returns:

the result

checkNotForbiddenBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolutionBuilder<?,?> checkNotForbiddenBuilder()

checkNotForbidden

public AssemblyResolution checkNotForbidden()

Description copied from interface: AssemblyResolvedPatterns

Check if the current encoding is forbidden by one of the attached patterns

The pattern becomes forbidden if this encoding's known bits are an overset of any forbidden pattern's known bits.

Specified by:

checkNotForbidden in interface AssemblyResolvedPatterns

Returns:

false if the pattern is forbidden (and thus in error), true if permitted

bitsEqual

public boolean bitsEqual(AssemblyResolvedPatterns that)

Description copied from interface: AssemblyResolvedPatterns

Check if this and another resolution have equal encodings

This is like Object.equals(Object), but it ignores backfill records and forbidden patterns.

Specified by:

bitsEqual in interface AssemblyResolvedPatterns

Parameters:

that - the other resolution

Returns:

true if both have equal encodings

combineBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> combineBuilder(AssemblyResolvedPatterns that)

combineLessBackfillBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> combineLessBackfillBuilder(AssemblyResolvedPatterns that,
 AssemblyResolvedBackfill bf)

combine

public AssemblyResolvedPatterns combine(AssemblyResolvedPatterns that)

Description copied from interface: AssemblyResolvedPatterns

Combine the encodings and backfills of the given resolution into this one

This combines corresponding pattern blocks (assuming they agree), collects backfill records, and collects forbidden patterns.

Specified by:

combine in interface AssemblyResolvedPatterns

Parameters:

that - the other resolution

Returns:

the result if successful, or null

combineLessBackfill

public AssemblyResolvedPatterns combineLessBackfill(AssemblyResolvedPatterns that,
 AssemblyResolvedBackfill bf)

Combine a backfill result

When a backfill is successful, the result should be combined with the owning resolution. In addition, for bookkeeping's sake, the resolved record should be removed from the list of backfills.

Specified by:

combineLessBackfill in interface AssemblyResolvedPatterns

Parameters:

that - the result from backfilling

bf - the resolved backfilled record

Returns:

the result if successful, or null

combineBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> combineBuilder(AssemblyResolvedBackfill bf)

combine

public AssemblyResolvedPatterns combine(AssemblyResolvedBackfill bf)

Description copied from interface: AssemblyResolvedPatterns

Combine the given backfill record into this resolution

Specified by:

combine in interface AssemblyResolvedPatterns

Parameters:

bf - the backfill record

Returns:

the result

withForbidsBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> withForbidsBuilder(Set<AssemblyResolvedPatterns> more)

withForbids

public AssemblyResolvedPatterns withForbids(Set<AssemblyResolvedPatterns> more)

Description copied from interface: AssemblyResolvedPatterns

Create a new resolution from this one with the given forbidden patterns recorded

Specified by:

withForbids in interface AssemblyResolvedPatterns

Parameters:

more - the additional forbidden patterns to record

Returns:

the new resolution

withDescriptionBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> withDescriptionBuilder(String description)

withDescription

public AssemblyResolvedPatterns withDescription(String description)

Description copied from interface: AssemblyResolvedPatterns

Create a copy of this resolution with a new description

Specified by:

withDescription in interface AssemblyResolvedPatterns

Parameters:

description - the new description

Returns:

the copy

withConstructorBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> withConstructorBuilder(Constructor cons)

withConstructor

public AssemblyResolvedPatterns withConstructor(Constructor cons)

Description copied from interface: AssemblyResolvedPatterns

Create a copy of this resolution with a replaced constructor

Specified by:

withConstructor in interface AssemblyResolvedPatterns

Parameters:

cons - the new constructor

Returns:

the copy

writeContextOpBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> writeContextOpBuilder(ContextOp cop,
 MaskedLong val)

writeContextOp

public AssemblyResolvedPatterns writeContextOp(ContextOp cop,
 MaskedLong val)

Description copied from interface: AssemblyResolvedPatterns

Encode the given value into the context block as specified by an operation

This is the forward (as in disassembly) direction of applying context operations. The pattern expression is evaluated, and the result is written as specified.

Specified by:

writeContextOp in interface AssemblyResolvedPatterns

Parameters:

cop - the context operation specifying the location of the value to encode

val - the masked value to encode

Returns:

the result

readContextOp

public MaskedLong readContextOp(ContextOp cop)

Description copied from interface: AssemblyResolvedPatterns

Decode the value from the context located where the given context operation would write

This is used to read the value from the left-hand-side "variable" of a context operation. It seems backward, because it is. When assembling, the right-hand-side expression of a context operation must be solved. This means the "variable" is known from the context(s) of the resolved children constructors. The value read is then used as the goal in solving the expression.

Specified by:

readContextOp in interface AssemblyResolvedPatterns

Parameters:

cop - the context operation whose "variable" to read.

Returns:

the masked result.

copyAppendDescriptionBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> copyAppendDescriptionBuilder(String append)

copyAppendDescription

public AssemblyResolvedPatterns copyAppendDescription(String append)

Duplicate this resolution, with additional description text appended

Parameters:

append - the text to append

Returns:

the duplicate NOTE: An additional separator ": " is inserted

withRightBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> withRightBuilder(AssemblyResolution right)

withRight

public AssemblyResolvedPatterns withRight(AssemblyResolution right)

Description copied from class: AbstractAssemblyResolution

Get this same resolution, but with the given right sibling

Specified by:

withRight in interface AssemblyResolvedPatterns

Specified by:

withRight in class AbstractAssemblyResolution

Parameters:

right - the right sibling

Returns:

the resolution

nopLeftSiblingBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> nopLeftSiblingBuilder()

nopLeftSibling

public AssemblyResolvedPatterns nopLeftSibling()

Description copied from interface: AssemblyResolvedPatterns

Generate a new nop right this resolution to its right.

Alternatively phrased: append a nop to the left of this list of siblings, returning the new head.

Specified by:

nopLeftSibling in interface AssemblyResolvedPatterns

Returns:

the nop resolution

parentBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> parentBuilder(String description,
 int opCount)

parent

public AssemblyResolvedPatterns parent(String description,
 int opCount)

Description copied from interface: AssemblyResolution

Get this same resolution, pushing its right siblings down to its children

Specified by:

parent in interface AssemblyResolution

Specified by:

parent in interface AssemblyResolvedPatterns

maskOutBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> maskOutBuilder(ContextOp cop)

maskOut

public AssemblyResolvedPatterns maskOut(ContextOp cop)

Description copied from interface: AssemblyResolvedPatterns

Set all bits read by a given context operation to unknown

Specified by:

maskOut in interface AssemblyResolvedPatterns

Parameters:

cop - the context operation

Returns:

the result

See Also:

• AssemblyPatternBlock.maskOut(ContextOp)

backfill

public AssemblyResolution backfill(RecursiveDescentSolver solver,
 Map<String,Long> vals)

Description copied from interface: AssemblyResolvedPatterns

Apply as many backfill records as possible

Each backfill record is resolved in turn, if the record cannot be resolved, it remains listed. If the record can be resolved, but it conflicts, an error record is returned. Each time a record is resolved and combined successfully, all remaining records are tried again. The result is the combined resolved backfills, with only the unresolved backfill records listed.

Specified by:

backfill in interface AssemblyResolvedPatterns

Parameters:

solver - the solver, usually the same as the original attempt to solve.

vals - the values.

Returns:

the result, or an error.

lineToString

public String lineToString()

Description copied from interface: AssemblyResolution

Display the resolution result in one line (omitting child details)

Specified by:

lineToString in interface AssemblyResolution

Returns:

the display description

hasBackfills

public boolean hasBackfills()

Description copied from interface: AssemblyResolvedPatterns

Check if this resolution has pending backfills to apply

Specified by:

hasBackfills in interface AssemblyResolvedPatterns

Returns:

true if there are backfills

solveContextChangesForForbidsBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> solveContextChangesForForbidsBuilder(AssemblyConstructorSemantic sem,
 Map<String,Long> vals)

solveContextChangesForForbids

public AssemblyResolvedPatterns solveContextChangesForForbids(AssemblyConstructorSemantic sem,
 Map<String,Long> vals)

Description copied from interface: AssemblyResolvedPatterns

Solve and apply context changes in reverse to forbidden patterns

To avoid circumstances where a context change during disassembly would invoke a more specific sub-constructor than was used to assembly the instruction, we must solve the forbidden patterns in tandem with the overall resolution. If the context of any forbidden pattern cannot be solved, we simply drop the forbidden pattern -- the lack of a solution implies there is no way the context change could produce the forbidden pattern.

Specified by:

solveContextChangesForForbids in interface AssemblyResolvedPatterns

Parameters:

sem - the constructor whose context changes to solve

vals - any defined symbols

Returns:

the result

See Also:

• AssemblyConstructorSemantic.solveContextChanges(AssemblyResolvedPatterns, Map)

getInstructionLength

public int getInstructionLength()

Description copied from interface: AssemblyResolvedPatterns

Get the length of the instruction encoding

This is used to ensure each operand is encoded at the correct offset

NOTE: this DOES include the offset
NOTE: this DOES include pending backfills

Specified by:

getInstructionLength in interface AssemblyResolvedPatterns

Returns:

the length of the instruction block

getDefinedInstructionLength

public int getDefinedInstructionLength()

Description copied from interface: AssemblyResolvedPatterns

Get the length of the instruction encoding, excluding trailing undefined bytes

NOTE: this DOES include the offset
NOTE: this DOES NOT include pending backfills

Specified by:

getDefinedInstructionLength in interface AssemblyResolvedPatterns

Returns:

the length of the defined bytes in the instruction block

getInstruction

public AssemblyPatternBlock getInstruction()

Description copied from interface: AssemblyResolvedPatterns

Get the instruction block

Specified by:

getInstruction in interface AssemblyResolvedPatterns

Returns:

the instruction block

getContext

public AssemblyPatternBlock getContext()

Description copied from interface: AssemblyResolvedPatterns

Get the context block

Specified by:

getContext in interface AssemblyResolvedPatterns

Returns:

the context block

withContextBuilder

protected AbstractAssemblyResolutionFactory.AbstractAssemblyResolvedPatternsBuilder<?> withContextBuilder(AssemblyPatternBlock ctx)

withContext

public AssemblyResolvedPatterns withContext(AssemblyPatternBlock ctx)

Description copied from interface: AssemblyResolvedPatterns

Create a copy of this resolution with a new context

Specified by:

withContext in interface AssemblyResolvedPatterns

Parameters:

ctx - the new context

Returns:

the copy

readInstruction

public MaskedLong readInstruction(int start,
 int len)

Description copied from interface: AssemblyResolvedPatterns

Decode a portion of the instruction block

Specified by:

readInstruction in interface AssemblyResolvedPatterns

Parameters:

start - the first byte to decode

len - the number of bytes to decode

Returns:

the read masked value

See Also:

• AssemblyPatternBlock.readBytes(int, int)

readContext

public MaskedLong readContext(int start,
 int len)

Description copied from interface: AssemblyResolvedPatterns

Decode a portion of the context block

Specified by:

readContext in interface AssemblyResolvedPatterns

Parameters:

start - the first byte to decode

len - the number of bytes to decode

Returns:

the read masked value

See Also:

• AssemblyPatternBlock.readBytes(int, int)

isError

public boolean isError()

Description copied from interface: AssemblyResolution

Check if this record describes an error

Specified by:

isError in interface AssemblyResolution

Returns:

true if the record is an error

isBackfill

public boolean isBackfill()

Description copied from interface: AssemblyResolution

Check if this record describes a backfill

Specified by:

isBackfill in interface AssemblyResolution

Returns:

true if the record is a backfill

hasChildren

public boolean hasChildren()

Description copied from interface: AssemblyResolution

Check if this record has children

If a subclass has another, possibly additional, notion of children that it would like to include in AssemblyResolution.toString(), it must override this method to return true when such children are present.

Specified by:

hasChildren in interface AssemblyResolution

Overrides:

hasChildren in class AbstractAssemblyResolution

Returns:

true if this record has children

childrenToString

protected String childrenToString(String indent)

Description copied from class: AbstractAssemblyResolution

Get the child portion of AbstractAssemblyResolution.toString()

If a subclass has another, possible additional, notion of children that it would like to include in AbstractAssemblyResolution.toString(), it must override this method.

Overrides:

childrenToString in class AbstractAssemblyResolution

Parameters:

indent - the current indentation

Returns:

the indented description for each child on its own line

See Also:

• AbstractAssemblyResolution.hasChildren()

dumpConstructorTree

public String dumpConstructorTree()

Description copied from interface: AssemblyResolvedPatterns

Used for testing and diagnostics: list the constructor line numbers used to resolve this encoding

This includes braces to describe the tree structure

Specified by:

dumpConstructorTree in interface AssemblyResolvedPatterns

Returns:

the constructor tree

See Also:

• ConstructState.dumpConstructorTree()

getSpecificity

public int getSpecificity()

Count the number of bits specified in the resolution patterns

Totals the specificity of the instruction and context pattern blocks.

Returns:

the number of bits in the resulting patterns

See Also:

• AssemblyPatternBlock.getSpecificity()

possibleInsVals

public Iterable<byte[]> possibleInsVals(AssemblyPatternBlock forCtx)

Description copied from interface: AssemblyResolvedPatterns

Get an iterable over all the possible fillings of the instruction pattern given a context

This is meant to be used idiomatically, as in an enhanced for loop:

 for (byte[] ins : rcon.possibleInsVals(ctx)) {
        System.out.println(format(ins));
 }
 

This is similar to calling AssemblyResolvedPatterns.getInstruction().AssemblyPatternBlock.possibleVals(), but with forbidden patterns removed. A context is required so that only those forbidden patterns matching the given context are actually removed. This method should always be preferred to the sequence mentioned above, since AssemblyPatternBlock.possibleVals() on its own may yield bytes that do not produce the desired instruction.

NOTE: The implementation is based on AssemblyPatternBlock.possibleVals(), so be aware that a single array is reused for each iterate. You should not retain a pointer to the array, but rather make a copy.

Specified by:

possibleInsVals in interface AssemblyResolvedPatterns

Parameters:

forCtx - the context at the assembly address

Returns:

the iterable

getOpIndex

protected static int getOpIndex(String piece)

getPureRecursion

protected static ConstructState getPureRecursion(ConstructState state)

If the construct state is a ^instruction or other purely-recursive constructor, get its single child.

Parameters:

state - the parent state

Returns:

the child state if recursive, or null

equivalentConstructState

public boolean equivalentConstructState(ConstructState state)

Description copied from interface: AssemblyResolvedPatterns

Check if this assembled construct state is the same as the given dis-assembled construct state.

Specified by:

equivalentConstructState in interface AssemblyResolvedPatterns

getConstructor

public Constructor getConstructor()

getBackfills

public Set<AssemblyResolvedBackfill> getBackfills()

Description copied from interface: AssemblyResolvedPatterns

Get the backfill records for this resolution, if any

Specified by:

getBackfills in interface AssemblyResolvedPatterns

Returns:

the backfills

getForbids

public Set<AssemblyResolvedPatterns> getForbids()

Description copied from interface: AssemblyResolvedPatterns

Get the forbidden patterns for this resolution

These represent patterns included in the current resolution that would actually get matched by a more specific constructor somewhere in the resolved tree, and thus are subtracted.

Specified by:

getForbids in interface AssemblyResolvedPatterns

Returns:

the forbidden patterns