Class SleighInstructionPrototype
- java.lang.Object
-
- ghidra.app.plugin.processors.sleigh.SleighInstructionPrototype
-
- All Implemented Interfaces:
InstructionPrototype
public class SleighInstructionPrototype extends java.lang.Object implements InstructionPrototype
The InstructionPrototype for sleigh languages. The prototype is unique up to the tree of Constructors. Variations in the bit pattern that none of the Constructor mask/values care about get lumped under the same prototype
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSleighInstructionPrototype.FlowRecordstatic classSleighInstructionPrototype.FlowSummary
-
Field Summary
Fields Modifier and Type Field Description static intBRANCH_INDIRECTstatic intBRANCH_TO_ENDstatic intCALLstatic intCALL_INDIRECTstatic intCROSSBUILDstatic intJUMPOUTstatic intLABELstatic intNO_FALLTHRUstatic intRETURN-
Fields inherited from interface ghidra.program.model.lang.InstructionPrototype
INVALID_DEPTH_CHANGE
-
-
Constructor Summary
Constructors Constructor Description SleighInstructionPrototype(SleighLanguage lang, MemBuffer buf, ProcessorContextView context, ContextCache cache, boolean inDelaySlot, SleighDebugLogger debug)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringdumpConstructorTree()Used for testing and diagnostics: list the constructor line numbers used to resolve this encoding This includes braces to describe the tree structurebooleanequals(java.lang.Object obj)static FlowTypeflowListToFlowType(java.util.List<SleighInstructionPrototype.FlowRecord> flowstate)AddressgetAddress(int opIndex, InstructionContext context)If the indicated operand is an address, this gets the address value for that operandintgetDelaySlotByteCount()intgetDelaySlotDepth(InstructionContext context)Get the number of delay slot instructions for this argument.AddressgetFallThrough(InstructionContext context)Get the Address for default flow after instruction.intgetFallThroughOffset(InstructionContext context)Get the byte offset to the default flow after instruction.Address[]getFlows(InstructionContext context)Get an array of Address objects for all flows other than a fall-through, null if no flows.FlowTypegetFlowType(InstructionContext context)Get the flow type of this instruction.java.lang.Object[]getInputObjects(InstructionContext context)Get the Result objects produced/affected by this instruction These would probably only be Register or AddressMaskgetInstructionMask()Get a Mask that describe which bits of this instruction determine the opcode.LanguagegetLanguage()Get processor language module associated with this prototype.intgetLength()Get the length of this CodeProtoype.java.lang.StringgetMnemonic(InstructionContext context)Get the mnemonic for this CodeProtype.intgetNumOperands()Return the number of operands in this instruction.RefTypegetOperandRefType(int opIndex, InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)Get the suggested operand reference type.MaskgetOperandValueMask(int operandIndex)Get a Mask that describe which bits of this instruction determine the operand value.java.lang.Object[]getOpObjects(int opIndex, InstructionContext context)Get objects used by this operand (Address, Scalar, Register ...)java.util.ArrayList<java.lang.Object>getOpRepresentationList(int opIndex, InstructionContext context)Get a List of Objects that can be used to render an operands representation.intgetOpType(int opIndex, InstructionContext context)Get the type of a specific operand.SleighParserContextgetParserContext(MemBuffer buf, ProcessorContextView processorContext)Get a new instance of a ParserContext.PcodeOp[]getPcode(InstructionContext context, int opIndex)Get an array of PCode operations (micro code) that a particular operand performs to compute its value.PcodeOp[]getPcode(InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)Get an array of PCode operations (micro code) that this instruction performs.PackedBytesgetPcodePacked(InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)Same as getPcode but returns the operations in a packed format to optimize transfer to other processesParserContextgetPseudoParserContext(Address addr, MemBuffer buffer, ProcessorContextView processorContext)Get a ParserContext by parsing bytes outside of the normal disassembly processRegistergetRegister(int opIndex, InstructionContext context)If the indicated operand is a register, this gets the register value for that operandjava.lang.Object[]getResultObjects(InstructionContext context)Get the Result objects produced/affected by this instruction These would probably only be Register or AddressScalargetScalar(int opIndex, InstructionContext context)If the indicated operand is a scalar, this gets the scalar value for that operandjava.lang.StringgetSeparator(int opIndex, InstructionContext context)Get the separator strings between an operand.booleanhasCrossBuildDependency()booleanhasDelaySlots()booleanhasDelimeter(int opIndex)Return true if the operand at opIndex should have a delimiter following it.inthashCode()booleanisInDelaySlot()Return true if this prototype was disassembled in a delay slot.static SleighInstructionPrototype.FlowSummarywalkTemplates(OpTplWalker walker)Walk the pcode templates in the order they would be emitted.
-
-
-
Field Detail
-
RETURN
public static final int RETURN
- See Also:
- Constant Field Values
-
CALL_INDIRECT
public static final int CALL_INDIRECT
- See Also:
- Constant Field Values
-
BRANCH_INDIRECT
public static final int BRANCH_INDIRECT
- See Also:
- Constant Field Values
-
CALL
public static final int CALL
- See Also:
- Constant Field Values
-
JUMPOUT
public static final int JUMPOUT
- See Also:
- Constant Field Values
-
NO_FALLTHRU
public static final int NO_FALLTHRU
- See Also:
- Constant Field Values
-
BRANCH_TO_END
public static final int BRANCH_TO_END
- See Also:
- Constant Field Values
-
CROSSBUILD
public static final int CROSSBUILD
- See Also:
- Constant Field Values
-
LABEL
public static final int LABEL
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SleighInstructionPrototype
public SleighInstructionPrototype(SleighLanguage lang, MemBuffer buf, ProcessorContextView context, ContextCache cache, boolean inDelaySlot, SleighDebugLogger debug) throws UnknownInstructionException, MemoryAccessException
-
-
Method Detail
-
getLength
public int getLength()
Description copied from interface:InstructionPrototypeGet the length of this CodeProtoype.- Specified by:
getLengthin interfaceInstructionPrototype- Returns:
- the length of this CodeProtoype.
-
hasDelaySlots
public boolean hasDelaySlots()
- Specified by:
hasDelaySlotsin interfaceInstructionPrototype- Returns:
- true if instruction prototype expects one or more delay slotted instructions to exist.
-
hasCrossBuildDependency
public boolean hasCrossBuildDependency()
- Specified by:
hasCrossBuildDependencyin interfaceInstructionPrototype- Returns:
- true if instruction semantics have a CrossBuild instruction dependency which may require a robust InstructionContext with access to preceding instructions
-
walkTemplates
public static SleighInstructionPrototype.FlowSummary walkTemplates(OpTplWalker walker)
Walk the pcode templates in the order they would be emitted. Collect flowFlags FlowRecords- Parameters:
sectionnum- is the named section to walk
-
flowListToFlowType
public static FlowType flowListToFlowType(java.util.List<SleighInstructionPrototype.FlowRecord> flowstate)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
getInstructionMask
public Mask getInstructionMask()
Description copied from interface:InstructionPrototypeGet a Mask that describe which bits of this instruction determine the opcode.- Specified by:
getInstructionMaskin interfaceInstructionPrototype- Returns:
- a Mask for the opcode bits or null if unknown.
-
getOperandValueMask
public Mask getOperandValueMask(int operandIndex)
Description copied from interface:InstructionPrototypeGet a Mask that describe which bits of this instruction determine the operand value.- Specified by:
getOperandValueMaskin interfaceInstructionPrototype- Returns:
- a Mask for the operand bits or null if unknown.
-
getFlowType
public FlowType getFlowType(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the flow type of this instruction. Used for analysis purposes. i.e., how this instruction flows to the next instruction.- Specified by:
getFlowTypein interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- flow type.
-
getDelaySlotByteCount
public int getDelaySlotByteCount()
- Specified by:
getDelaySlotByteCountin interfaceInstructionPrototype- Returns:
- the number of delay-slot instruction bytes which correspond to this prototype.
-
getDelaySlotDepth
public int getDelaySlotDepth(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the number of delay slot instructions for this argument. This should be 0 for instructions which don't have a delay slot. This is used to support the delay slots found on some RISC processors such as SPARC and the PA-RISC. This returns an integer instead of a boolean in case some other processor executes more than one instruction from a delay slot.- Specified by:
getDelaySlotDepthin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- the number of delay slot instructions for this instruction.
-
isInDelaySlot
public boolean isInDelaySlot()
Description copied from interface:InstructionPrototypeReturn true if this prototype was disassembled in a delay slot.- Specified by:
isInDelaySlotin interfaceInstructionPrototype
-
getNumOperands
public int getNumOperands()
Description copied from interface:InstructionPrototypeReturn the number of operands in this instruction.- Specified by:
getNumOperandsin interfaceInstructionPrototype
-
getOpType
public int getOpType(int opIndex, InstructionContext context)Description copied from interface:InstructionPrototypeGet the type of a specific operand.- Specified by:
getOpTypein interfaceInstructionPrototype- Parameters:
opIndex- the index of the operand. (zero based)context- the instruction context.- Returns:
- the type of the operand.
-
getFallThrough
public Address getFallThrough(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the Address for default flow after instruction.- Specified by:
getFallThroughin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- Address of fall through flow or null if flow does not fall through this instruction.
-
getFallThroughOffset
public int getFallThroughOffset(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the byte offset to the default flow after instruction. If this instruction does not have a fall-through due to flow behavior, this method will still return an offset which accounts for the instruction length including delay slotted instructions if applicable.- Specified by:
getFallThroughOffsetin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- int how much to add to the current address to get the fall through address.
-
getFlows
public Address[] getFlows(InstructionContext context)
Description copied from interface:InstructionPrototypeGet an array of Address objects for all flows other than a fall-through, null if no flows.- Specified by:
getFlowsin interfaceInstructionPrototype- Parameters:
context- the instruction context.- Returns:
- an array of Address objects for all flows other than a fall-through, null if no flows.
-
getSeparator
public java.lang.String getSeparator(int opIndex, InstructionContext context)Description copied from interface:InstructionPrototypeGet the separator strings between an operand. The separator string for 0 are the characters before the first operand. The separator string for numOperands+1 are the characters after the last operand.- Specified by:
getSeparatorin interfaceInstructionPrototype- Parameters:
opIndex- valid values are 0 thru numOperands+1context- the instruction context- Returns:
- separator string, or null if there is no string
-
getOpRepresentationList
public java.util.ArrayList<java.lang.Object> getOpRepresentationList(int opIndex, InstructionContext context)Description copied from interface:InstructionPrototypeGet a List of Objects that can be used to render an operands representation.- Specified by:
getOpRepresentationListin interfaceInstructionPrototype- Parameters:
opIndex- operand to get the Representation Listcontext- the instruction context- Returns:
- ArrayList of Register, Address, Scalar, VariableOffset and Character objects of null if the operation isn't supported
-
getAddress
public Address getAddress(int opIndex, InstructionContext context)
Description copied from interface:InstructionPrototypeIf the indicated operand is an address, this gets the address value for that operand- Specified by:
getAddressin interfaceInstructionPrototype- Parameters:
opIndex- index of the operand.context- the instruction context.- Returns:
- the address indicated by the operand
-
getScalar
public Scalar getScalar(int opIndex, InstructionContext context)
Description copied from interface:InstructionPrototypeIf the indicated operand is a scalar, this gets the scalar value for that operand- Specified by:
getScalarin interfaceInstructionPrototype- Parameters:
opIndex- index of the operand.context- the instruction context- Returns:
- the scalar for the indicated operand
-
getRegister
public Register getRegister(int opIndex, InstructionContext context)
Description copied from interface:InstructionPrototypeIf the indicated operand is a register, this gets the register value for that operand- Specified by:
getRegisterin interfaceInstructionPrototype- Parameters:
opIndex- index of the operand.context- the instruction context- Returns:
- a register description for the indicated operand
-
getOpObjects
public java.lang.Object[] getOpObjects(int opIndex, InstructionContext context)Description copied from interface:InstructionPrototypeGet objects used by this operand (Address, Scalar, Register ...)- Specified by:
getOpObjectsin interfaceInstructionPrototype- Parameters:
opIndex- the index of the operand. (zero based)context- the instruction context- Returns:
- an array of objects found at this operand.
-
hasDelimeter
public boolean hasDelimeter(int opIndex)
Description copied from interface:InstructionPrototypeReturn true if the operand at opIndex should have a delimiter following it.- Specified by:
hasDelimeterin interfaceInstructionPrototype- Parameters:
opIndex- the index of the operand to test for having a delimiter.
-
getInputObjects
public java.lang.Object[] getInputObjects(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the Result objects produced/affected by this instruction These would probably only be Register or Address- Specified by:
getInputObjectsin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- an array of objects that are used by this instruction
-
getResultObjects
public java.lang.Object[] getResultObjects(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the Result objects produced/affected by this instruction These would probably only be Register or Address- Specified by:
getResultObjectsin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- an array of objects that are affected by this instruction
-
getPcode
public PcodeOp[] getPcode(InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)
Description copied from interface:InstructionPrototypeGet an array of PCode operations (micro code) that this instruction performs.- Specified by:
getPcodein interfaceInstructionPrototype- Parameters:
context- the instruction contextoverride- if not null, may indicate that different elements of the pcode generation are overriddenuniqueFactory- must be specified if flowOverride is not null- Returns:
- array of PCODE, zero length array if language doesn't support PCODE for this instruction
-
getPcodePacked
public PackedBytes getPcodePacked(InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)
Description copied from interface:InstructionPrototypeSame as getPcode but returns the operations in a packed format to optimize transfer to other processes- Specified by:
getPcodePackedin interfaceInstructionPrototype- Parameters:
context- the instruction contextoverride- if not null, may indicate that different elements of the pcode generation are overriddenuniqueFactory- must be specified if flowOverride is not null- Returns:
-
getPcode
public PcodeOp[] getPcode(InstructionContext context, int opIndex)
Description copied from interface:InstructionPrototypeGet an array of PCode operations (micro code) that a particular operand performs to compute its value.- Specified by:
getPcodein interfaceInstructionPrototype- Parameters:
context- the instruction contextopIndex- the index of the operand for which to get PCode.- Returns:
- array of PCODE, zero length array if language doesn't support PCODE for this instruction
-
getOperandRefType
public RefType getOperandRefType(int opIndex, InstructionContext context, PcodeOverride override, UniqueAddressFactory uniqueFactory)
Description copied from interface:InstructionPrototypeGet the suggested operand reference type.- Specified by:
getOperandRefTypein interfaceInstructionPrototype- Parameters:
opIndex- the index of the operand. (zero based)context- the instruction contextoverride- if not null, steers local overrides of pcode generationuniqueFactory- must be specified if flowOverride is not null- Returns:
- reference type.
-
getMnemonic
public java.lang.String getMnemonic(InstructionContext context)
Description copied from interface:InstructionPrototypeGet the mnemonic for this CodeProtype. Examples: "MOV" and "CALL" for instructions and "DB" and "DA" for data.- Specified by:
getMnemonicin interfaceInstructionPrototype- Parameters:
context- the instruction context- Returns:
- the mnemonic for this CodePrototype.
-
getParserContext
public SleighParserContext getParserContext(MemBuffer buf, ProcessorContextView processorContext) throws MemoryAccessException
Description copied from interface:InstructionPrototypeGet a new instance of a ParserContext.- Specified by:
getParserContextin interfaceInstructionPrototype- Returns:
- instruction ParserContext
- Throws:
MemoryAccessException
-
getPseudoParserContext
public ParserContext getPseudoParserContext(Address addr, MemBuffer buffer, ProcessorContextView processorContext) throws InsufficientBytesException, UnknownInstructionException, UnknownContextException, MemoryAccessException
Description copied from interface:InstructionPrototypeGet a ParserContext by parsing bytes outside of the normal disassembly process- Specified by:
getPseudoParserContextin interfaceInstructionPrototype- Parameters:
addr- where the ParserContext is neededbuffer- of actual bytes- Returns:
- Throws:
InsufficientBytesExceptionUnknownInstructionExceptionUnknownContextExceptionMemoryAccessException
-
getLanguage
public Language getLanguage()
Description copied from interface:InstructionPrototypeGet processor language module associated with this prototype.- Specified by:
getLanguagein interfaceInstructionPrototype- Returns:
- language module
-
dumpConstructorTree
public java.lang.String dumpConstructorTree()
Used for testing and diagnostics: list the constructor line numbers used to resolve this encoding This includes braces to describe the tree structure- Returns:
- the constructor tree
- See Also:
AssemblyResolvedConstructor.dumpConstructorTree()
-
-