Package ghidra.program.model.listing

Class InstructionStub

  • All Implemented Interfaces:
    ProcessorContext, ProcessorContextView, CodeUnit, Instruction, MemBuffer
    public class InstructionStub
extends java.lang.Object
implements Instruction
    InstructionStub can be extended for use by tests. It throws an UnsupportedOperationException for all methods in the Instruction interface. Any method that is needed for your test can then be overridden so it can provide its own test implementation and return value.

    • Constructor Summary

      Constructors 
      Constructor Description
      InstructionStub()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMnemonicReference​(Address refAddr, RefType refType, SourceType sourceType)
      Add a reference to the mnemonic for this code unit.
      void addOperandReference​(int index, Address refAddr, RefType type, SourceType sourceType)
      Add a memory reference to the operand at the given index.
      void clearFallThroughOverride()
      Restores this instruction's fallthrough address back to the default fallthrough for this instruction.
      void clearRegister​(Register register)
      Clears the register within this context.
      int compareTo​(Address addr)
      Compares the given address to the address range of this node.
      boolean contains​(Address testAddr)
      Returns true if address is contained in the range of this codeUnit
      Address getAddress()
      Get the Address which corresponds to the offset 0.
      Address getAddress​(int opIndex)
      Get the Address for the given operand index if one exists.
      java.lang.String getAddressString​(boolean showBlockName, boolean pad)
      Get the string representation of the starting address for this code unit.
      Register getBaseContextRegister()  
      java.math.BigInteger getBigInteger​(int offset, int size, boolean signed)
      returns the value at the given offset, taking into account the endianess.
      byte getByte​(int offset)
      Get one byte from memory at the current position plus offset.
      byte[] getBytes()
      Get the bytes that make up this code unit.
      int getBytes​(byte[] b, int memoryBufferOffset)
      Reads b.length bytes from this memory buffer starting at the address of this memory buffer plus the given memoryBufferOffset from that position.
      void getBytesInCodeUnit​(byte[] buffer, int bufferOffset)
      Copies max(buffer.length, code unit length) bytes into buffer starting at location offset in buffer.
      java.lang.String getComment​(int commentType)
      Get the comment for the given type
      java.lang.String[] getCommentAsArray​(int commentType)
      Get the comment for the given type and parse it into an array of strings such that each line is its own string.
      Address getDefaultFallThrough()
      Get the default fallthrough for this instruction.
      int getDefaultFallThroughOffset()
      Get default fall-through offset in bytes from start of instruction to the fallthrough instruction.
      Address[] getDefaultFlows()
      Get an array of Address objects for all default flows established by the underlying instruction prototype.
      java.lang.String getDefaultOperandRepresentation​(int opIndex)
      Get the operand representation for the given operand index without markup.
      java.util.List<java.lang.Object> getDefaultOperandRepresentationList​(int opIndex)
      Get the operand representation for the given operand index.
      int getDelaySlotDepth()
      Get the number of delay slot instructions for this argument.
      ExternalReference getExternalReference​(int opIndex)
      Gets the external reference (if any) at the opIndex
      Address getFallFrom()
      Get the Address for the instruction that fell through to this instruction.
      Address getFallThrough()
      Get the fallthrough for this instruction, factoring in any fallthrough override and delay slotted instructions.
      FlowOverride getFlowOverride()
      Returns the flow override which may have been set on this instruction.
      Address[] getFlows()
      Get an array of Address objects for all flows other than a fall-through.
      FlowType getFlowType()
      Get the flow type of this instruction (how this instruction flows to the next instruction).
      java.lang.Object[] getInputObjects()
      Get the Input objects used by this instruction.
      InstructionContext getInstructionContext()  
      int getInt​(int offset)
      returns the int at the given offset, taking into account the endianess.
      int getIntProperty​(java.lang.String name)
      Get the int property for name.
      java.lang.String getLabel()
      Get the label for this code unit.
      int getLength()
      Get length of this code unit.
      long getLong​(int offset)
      returns the long at the given offset, taking into account the endianess.
      Address getMaxAddress()
      Get the ending address for this code unit.
      Memory getMemory()
      Get the Memory object actually used by the MemBuffer.
      Address getMinAddress()
      Get the starting address for this code unit.
      Reference[] getMnemonicReferences()
      Get references for the mnemonic for this code unit.
      java.lang.String getMnemonicString()
      Get the mnemonic for this code unit, e.g., MOV, JMP
      Instruction getNext()
      Get the instruction following this one in address order.
      int getNumOperands()
      Get the number of operands for this code unit.
      Saveable getObjectProperty​(java.lang.String name)
      Get the object property for name; returns null if there is no name property for this code unit.
      Reference[] getOperandReferences​(int index)
      Get the references for the operand index.
      RefType getOperandRefType​(int index)
      Get the operand reference type for the given operand index.
      int getOperandType​(int opIndex)
      Get the type of a specific operand.
      java.lang.Object[] getOpObjects​(int opIndex)
      Get objects used by this operand (Address, Scalar, Register ...)
      PcodeOp[] getPcode()
      Get an array of PCode operations (micro code) that this instruction performs.
      PcodeOp[] getPcode​(boolean includeOverrides)
      Get an array of PCode operations (micro code) that this instruction performs.
      PcodeOp[] getPcode​(int opIndex)
      Get an array of PCode operations (micro code) that a particular operand performs to compute its value.
      Instruction getPrevious()
      Get the instruction before this one in address order.
      Reference getPrimaryReference​(int index)
      Get the primary reference for the operand index.
      Symbol getPrimarySymbol()
      Get the Primary Symbol for this code unit.
      Program getProgram()
      Returns the program that generated this CodeUnit.
      InstructionPrototype getPrototype()
      Get the prototype for this instruction.
      ReferenceIterator getReferenceIteratorTo()
      Get an iterator over all references TO this code unit.
      Reference[] getReferencesFrom()
      Get ALL memory references FROM this code unit.
      Register getRegister​(int opIndex)
      If operand is a pure Register, return the register.
      Register getRegister​(java.lang.String name)
      Get a Register given the name of a register
      java.util.List<Register> getRegisters()
      Returns all the Registers for the processor as an unmodifiable list
      RegisterValue getRegisterValue​(Register register)
      Get the RegisterValue for the given register.
      java.lang.Object[] getResultObjects()
      Get the Result objects produced/affected by this instruction These would probably only be Register or Address
      Scalar getScalar​(int opIndex)
      Returns the scalar at the given operand index.
      java.lang.String getSeparator​(int opIndex)
      Get the separator strings between an operand.
      short getShort​(int offset)
      returns the short at the given offset, taking into account the endianess.
      java.lang.String getStringProperty​(java.lang.String name)
      Get the string property for name; returns null if there is no name property for this code unit.
      Symbol[] getSymbols()
      Get the Symbols for this code unit.
      java.math.BigInteger getValue​(Register register, boolean signed)
      Get the contents of a processor register as a BigInteger object
      boolean getVoidProperty​(java.lang.String name)
      Returns whether this code unit is marked as having the name property.
      boolean hasFallthrough()
      Returns true if this instruction has a fall-through flow.
      boolean hasProperty​(java.lang.String name)
      Returns true if the codeunit has the given property defined.
      boolean hasValue​(Register register)
      Returns true if a value is defined for the given register.
      boolean isBigEndian()
      Returns true if the underlying bytes are in big-endian order, false if they are little endian.
      boolean isFallthrough()
      Returns true if this instruction has no execution flow other than fall-through.
      boolean isFallThroughOverridden()
      Returns true if this instructions fallthrough has been overriden.
      boolean isInDelaySlot()
      Return true if this instruction was disassembled in a delay slot
      boolean isSuccessor​(CodeUnit codeUnit)
      Return true if the given CodeUnit follows directly after this code unit.
      java.util.Iterator<java.lang.String> propertyNames()
      Get an iterator over the property names.
      void removeExternalReference​(int opIndex)
      Remove external reference (if any) at the given opIndex opIndex the index of the operand from which to remove any external reference.
      void removeMnemonicReference​(Address refAddr)
      Remove a reference to the mnemonic for this code unit.
      void removeOperandReference​(int index, Address refAddr)
      Remove a reference to the operand.
      void removeProperty​(java.lang.String name)
      Remove the property with the given name from this code unit.
      void setComment​(int commentType, java.lang.String comment)
      Set the comment for the given comment type.
      void setCommentAsArray​(int commentType, java.lang.String[] comment)
      Set the comment (with each line in its own string) for the given comment type
      void setFallThrough​(Address addr)
      Overrides the instruction's default fallthrough address to the given address.
      void setFlowOverride​(FlowOverride flowOverride)
      Set the flow override for this instruction.
      void setPrimaryMemoryReference​(Reference ref)
      Sets a memory reference to be the primary reference at its address/opIndex location.
      void setProperty​(java.lang.String name)
      Set the named property.
      void setProperty​(java.lang.String name, int value)
      Set the named property with the given value at the address of this codeunit.
      void setProperty​(java.lang.String name, Saveable value)
      Set the named property with the given value at the address of this codeunit.
      void setProperty​(java.lang.String name, java.lang.String value)
      Set the named property with the given value at the address of this codeunit.
      void setRegisterReference​(int opIndex, Register reg, SourceType sourceType, RefType refType)
      Sets a register reference at the offset on the specified operand index, which effectively substitutes the previous operation interpretation
      NOTE: If another reference was previously set on the operand, then it will be replaced with this register reference
      void setRegisterValue​(RegisterValue value)
      Sets the specified register value within this context.
      void setStackReference​(int opIndex, int offset, SourceType sourceType, RefType refType)
      Sets a stack reference at the offset on the specified operand index, which effectively substitutes the previous operation interpretation
      NOTE: If another reference was previously set on the operand, then it will be replaced with this stack reference
      void setValue​(Register register, java.math.BigInteger value)
      Sets the value for a Register.
      void visitProperty​(PropertyVisitor visitor, java.lang.String propertyName)
      Invokes the visit() method of the specified PropertyVisitor if the named property exists for this code unit.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • InstructionStub

        public InstructionStub()

    • Method Detail

      • getAddressString

        public java.lang.String getAddressString​(boolean showBlockName,
                                         boolean pad)
        Description copied from interface: CodeUnit
        Get the string representation of the starting address for this code unit.
        Specified by:
        getAddressString in interface CodeUnit
        Parameters:
        showBlockName - true if the string should include the memory block name
        pad - if true, the address will be padded with leading zeros. Even if pad is false, the string will be padded to make the address string contain at least 4 digits.
        Returns:
        string representation of address

      • setProperty

        public void setProperty​(java.lang.String name,
                        Saveable value)
        Description copied from interface: CodeUnit
        Set the named property with the given value at the address of this codeunit.
        Specified by:
        setProperty in interface CodeUnit
        Parameters:
        name - the name of the property.
        value - value to be stored.

      • setProperty

        public void setProperty​(java.lang.String name,
                        java.lang.String value)
        Description copied from interface: CodeUnit
        Set the named property with the given value at the address of this codeunit.
        Specified by:
        setProperty in interface CodeUnit
        Parameters:
        name - the name of the property.
        value - value to be stored.

      • setProperty

        public void setProperty​(java.lang.String name,
                        int value)
        Description copied from interface: CodeUnit
        Set the named property with the given value at the address of this codeunit.
        Specified by:
        setProperty in interface CodeUnit
        Parameters:
        name - the name of the property.
        value - value to be stored.

      • setProperty

        public void setProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Set the named property. This method is used for "void" properites. The property is either set or not set - there is no value
        Specified by:
        setProperty in interface CodeUnit
        Parameters:
        name - the name of the property.

      • getObjectProperty

        public Saveable getObjectProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Get the object property for name; returns null if there is no name property for this code unit.
        Specified by:
        getObjectProperty in interface CodeUnit
        Parameters:
        name - the name of the property

      • getStringProperty

        public java.lang.String getStringProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Get the string property for name; returns null if there is no name property for this code unit.
        Specified by:
        getStringProperty in interface CodeUnit
        Parameters:
        name - the name of the property

      • getIntProperty

        public int getIntProperty​(java.lang.String name)
                   throws NoValueException
        Description copied from interface: CodeUnit
        Get the int property for name.
        Specified by:
        getIntProperty in interface CodeUnit
        Parameters:
        name - the name of the property
        Throws:
        NoValueException - if there is not name property for this code unit

      • hasProperty

        public boolean hasProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Returns true if the codeunit has the given property defined.
        Specified by:
        hasProperty in interface CodeUnit
        Parameters:
        name - the name of the property

      • getVoidProperty

        public boolean getVoidProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Returns whether this code unit is marked as having the name property.
        Specified by:
        getVoidProperty in interface CodeUnit
        Parameters:
        name - the name of the property

      • propertyNames

        public java.util.Iterator<java.lang.String> propertyNames()
        Description copied from interface: CodeUnit
        Get an iterator over the property names.
        Specified by:
        propertyNames in interface CodeUnit

      • removeProperty

        public void removeProperty​(java.lang.String name)
        Description copied from interface: CodeUnit
        Remove the property with the given name from this code unit.
        Specified by:
        removeProperty in interface CodeUnit
        Parameters:
        name - the name of the property

      • visitProperty

        public void visitProperty​(PropertyVisitor visitor,
                          java.lang.String propertyName)
        Description copied from interface: CodeUnit
        Invokes the visit() method of the specified PropertyVisitor if the named property exists for this code unit.
        Specified by:
        visitProperty in interface CodeUnit
        Parameters:
        visitor - the class implementing the PropertyVisitor interface.
        propertyName - the name of the property to be visited.

      • getLabel

        public java.lang.String getLabel()
        Description copied from interface: CodeUnit
        Get the label for this code unit.
        Specified by:
        getLabel in interface CodeUnit

      • getSymbols

        public Symbol[] getSymbols()
        Description copied from interface: CodeUnit
        Get the Symbols for this code unit.
        Specified by:
        getSymbols in interface CodeUnit

      • getPrimarySymbol

        public Symbol getPrimarySymbol()
        Description copied from interface: CodeUnit
        Get the Primary Symbol for this code unit.
        Specified by:
        getPrimarySymbol in interface CodeUnit

      • getMinAddress

        public Address getMinAddress()
        Description copied from interface: CodeUnit
        Get the starting address for this code unit.
        Specified by:
        getMinAddress in interface CodeUnit

      • getMaxAddress

        public Address getMaxAddress()
        Description copied from interface: CodeUnit
        Get the ending address for this code unit.
        Specified by:
        getMaxAddress in interface CodeUnit

      • getMnemonicString

        public java.lang.String getMnemonicString()
        Description copied from interface: CodeUnit
        Get the mnemonic for this code unit, e.g., MOV, JMP
        Specified by:
        getMnemonicString in interface CodeUnit

      • getComment

        public java.lang.String getComment​(int commentType)
        Description copied from interface: CodeUnit
        Get the comment for the given type
        Specified by:
        getComment in interface CodeUnit
        Parameters:
        commentType - either EOL_COMMENT, PRE_COMMENT, POST_COMMENT, or REPEATABLE_COMMENT
        Returns:
        the comment string of the appropriate type or null if no comment of that type exists for this codeunit

      • getCommentAsArray

        public java.lang.String[] getCommentAsArray​(int commentType)
        Description copied from interface: CodeUnit
        Get the comment for the given type and parse it into an array of strings such that each line is its own string.
        Specified by:
        getCommentAsArray in interface CodeUnit
        Parameters:
        commentType - either EOL_COMMENT, PRE_COMMENT, POST_COMMENT, or REPEATABLE_COMMENT
        Returns:
        an array of strings where each item in the array is a line of text in the comment. If there is no comment of the requested type, an empty array is returned.

      • setComment

        public void setComment​(int commentType,
                       java.lang.String comment)
        Description copied from interface: CodeUnit
        Set the comment for the given comment type. Passing null clears the comment
        Specified by:
        setComment in interface CodeUnit
        Parameters:
        commentType - either EOL_COMMENT, PRE_COMMENT, POST_COMMENT, or REPEATABLE_COMMENT
        comment - comment for code unit; null clears the comment

      • setCommentAsArray

        public void setCommentAsArray​(int commentType,
                              java.lang.String[] comment)
        Description copied from interface: CodeUnit
        Set the comment (with each line in its own string) for the given comment type
        Specified by:
        setCommentAsArray in interface CodeUnit
        Parameters:
        commentType - either EOL_COMMENT, PRE_COMMENT, POST_COMMENT, or REPEATABLE_COMMENT
        comment - an array of strings where each string is a single line of the comment.

      • isSuccessor

        public boolean isSuccessor​(CodeUnit codeUnit)
        Description copied from interface: CodeUnit
        Return true if the given CodeUnit follows directly after this code unit.
        Specified by:
        isSuccessor in interface CodeUnit
        Parameters:
        codeUnit - the codeUnit being tested to see if it follows this codeUnit.

      • getLength

        public int getLength()
        Description copied from interface: CodeUnit
        Get length of this code unit.
        Specified by:
        getLength in interface CodeUnit

      • getBytes

        public byte[] getBytes()
                throws MemoryAccessException
        Description copied from interface: CodeUnit
        Get the bytes that make up this code unit.
        Specified by:
        getBytes in interface CodeUnit
        Returns:
        an array of bytes that are in memory at the codeunits address. The array length is the same as the codeUnits length
        Throws:
        MemoryAccessException - if the full number of bytes could not be read.

      • getBytesInCodeUnit

        public void getBytesInCodeUnit​(byte[] buffer,
                               int bufferOffset)
                        throws MemoryAccessException
        Description copied from interface: CodeUnit
        Copies max(buffer.length, code unit length) bytes into buffer starting at location offset in buffer.
        Specified by:
        getBytesInCodeUnit in interface CodeUnit
        Parameters:
        buffer - byte array to copy into
        bufferOffset - offset in byte array the copy will start
        Throws:
        MemoryAccessException - if the full number of bytes could not be read.

      • contains

        public boolean contains​(Address testAddr)
        Description copied from interface: CodeUnit
        Returns true if address is contained in the range of this codeUnit
        Specified by:
        contains in interface CodeUnit
        Parameters:
        testAddr - the address to test.

      • compareTo

        public int compareTo​(Address addr)
        Description copied from interface: CodeUnit
        Compares the given address to the address range of this node.
        Specified by:
        compareTo in interface CodeUnit
        Parameters:
        addr - address to compare.
        Returns:
        a negative integer if this addr is greater than the maximum range address zero if addr is in the range a positive integer if addr is less than minimum range address

      • addMnemonicReference

        public void addMnemonicReference​(Address refAddr,
                                 RefType refType,
                                 SourceType sourceType)
        Description copied from interface: CodeUnit
        Add a reference to the mnemonic for this code unit.
        Specified by:
        addMnemonicReference in interface CodeUnit
        Parameters:
        refAddr - address to add as a reference.
        refType - the type of reference to add.
        sourceType - the source of this reference

      • removeMnemonicReference

        public void removeMnemonicReference​(Address refAddr)
        Description copied from interface: CodeUnit
        Remove a reference to the mnemonic for this code unit.
        Specified by:
        removeMnemonicReference in interface CodeUnit
        Parameters:
        refAddr - the address to remove as a reference.

      • getMnemonicReferences

        public Reference[] getMnemonicReferences()
        Description copied from interface: CodeUnit
        Get references for the mnemonic for this code unit.
        Specified by:
        getMnemonicReferences in interface CodeUnit
        Returns:
        an array of memory references. A zero length array will be returned if there are no references for the mnemonic.

      • getOperandReferences

        public Reference[] getOperandReferences​(int index)
        Description copied from interface: CodeUnit
        Get the references for the operand index.
        Specified by:
        getOperandReferences in interface CodeUnit
        Parameters:
        index - operand index (0 is the first operand)

      • getPrimaryReference

        public Reference getPrimaryReference​(int index)
        Description copied from interface: CodeUnit
        Get the primary reference for the operand index.
        Specified by:
        getPrimaryReference in interface CodeUnit
        Parameters:
        index - operand index (0 is the first operand)

      • addOperandReference

        public void addOperandReference​(int index,
                                Address refAddr,
                                RefType type,
                                SourceType sourceType)
        Description copied from interface: CodeUnit
        Add a memory reference to the operand at the given index.
        Specified by:
        addOperandReference in interface CodeUnit
        Parameters:
        index - operand index
        refAddr - reference address
        type - the reference type to be added.
        sourceType - the source of this reference

      • removeOperandReference

        public void removeOperandReference​(int index,
                                   Address refAddr)
        Description copied from interface: CodeUnit
        Remove a reference to the operand.
        Specified by:
        removeOperandReference in interface CodeUnit
        Parameters:
        index - operand index
        refAddr - address referencing the operand

      • getReferencesFrom

        public Reference[] getReferencesFrom()
        Description copied from interface: CodeUnit
        Get ALL memory references FROM this code unit.
        Specified by:
        getReferencesFrom in interface CodeUnit
        Returns:
        an array of memory references from this codeUnit or an empty array if there are no references.

      • getProgram

        public Program getProgram()
        Description copied from interface: CodeUnit
        Returns the program that generated this CodeUnit.
        Specified by:
        getProgram in interface CodeUnit

      • getExternalReference

        public ExternalReference getExternalReference​(int opIndex)
        Description copied from interface: CodeUnit
        Gets the external reference (if any) at the opIndex
        Specified by:
        getExternalReference in interface CodeUnit
        Parameters:
        opIndex - the operand index to look for external references
        Returns:
        the external reference at the operand or null if none exists.

      • removeExternalReference

        public void removeExternalReference​(int opIndex)
        Description copied from interface: CodeUnit
        Remove external reference (if any) at the given opIndex opIndex the index of the operand from which to remove any external reference.
        Specified by:
        removeExternalReference in interface CodeUnit

      • setPrimaryMemoryReference

        public void setPrimaryMemoryReference​(Reference ref)
        Description copied from interface: CodeUnit
        Sets a memory reference to be the primary reference at its address/opIndex location. The primary reference is the one that is used in the getOperandRepresentation() method.
        Specified by:
        setPrimaryMemoryReference in interface CodeUnit
        Parameters:
        ref - the reference to be set as primary.

      • setStackReference

        public void setStackReference​(int opIndex,
                              int offset,
                              SourceType sourceType,
                              RefType refType)
        Description copied from interface: CodeUnit
        Sets a stack reference at the offset on the specified operand index, which effectively substitutes the previous operation interpretation
        NOTE: If another reference was previously set on the operand, then it will be replaced with this stack reference
        Specified by:
        setStackReference in interface CodeUnit
        Parameters:
        opIndex - the index of the operand to set this stack reference
        offset - the (+/-) offset from stack base address
        sourceType - the source of this reference
        refType - type of reference, RefType.READ,WRITE,PTR...

      • setRegisterReference

        public void setRegisterReference​(int opIndex,
                                 Register reg,
                                 SourceType sourceType,
                                 RefType refType)
        Description copied from interface: CodeUnit
        Sets a register reference at the offset on the specified operand index, which effectively substitutes the previous operation interpretation
        NOTE: If another reference was previously set on the operand, then it will be replaced with this register reference
        Specified by:
        setRegisterReference in interface CodeUnit
        Parameters:
        opIndex - the index of the operand to set this register reference
        reg - a register
        sourceType - the source of this reference
        refType - type of reference, RefType.READ,WRITE,PTR...

      • getNumOperands

        public int getNumOperands()
        Description copied from interface: CodeUnit
        Get the number of operands for this code unit.
        Specified by:
        getNumOperands in interface CodeUnit

      • getAddress

        public Address getAddress​(int opIndex)
        Description copied from interface: CodeUnit
        Get the Address for the given operand index if one exists. Data objects have one operand (the value).
        Specified by:
        getAddress in interface CodeUnit
        Parameters:
        opIndex - index of the operand.
        Returns:
        An addres if the operand represents a fully qualified address (given the context), or if the operand is a Scalar treated as an address. Null is returned if no address or scalar exists on that operand.

      • getScalar

        public Scalar getScalar​(int opIndex)
        Description copied from interface: CodeUnit
        Returns the scalar at the given operand index. Data objects have one operand (the value).
        Specified by:
        getScalar in interface CodeUnit
        Parameters:
        opIndex - index of the operand.
        Returns:
        the scalar at the given operand index or null if no scalar exists at that index.

      • getByte

        public byte getByte​(int offset)
             throws MemoryAccessException
        Description copied from interface: MemBuffer
        Get one byte from memory at the current position plus offset.
        Specified by:
        getByte in interface MemBuffer
        Parameters:
        offset - the displacement from the current position.
        Returns:
        the data at offset from the current position.
        Throws:
        MemoryAccessException - if memory cannot be read at the specified offset

      • getBytes

        public int getBytes​(byte[] b,
                    int memoryBufferOffset)
        Description copied from interface: MemBuffer
        Reads b.length bytes from this memory buffer starting at the address of this memory buffer plus the given memoryBufferOffset from that position. The actual number of bytes may be fewer if bytes can't be read.
        Specified by:
        getBytes in interface MemBuffer
        Parameters:
        b - the buffer into which bytes will be placed
        memoryBufferOffset - the offset in this memory buffer from which to start reading bytes.
        Returns:
        the number of bytes read which may be fewer than b.length if available bytes are exhausted or no bytes are available at the specified offset.

      • getAddress

        public Address getAddress()
        Description copied from interface: MemBuffer
        Get the Address which corresponds to the offset 0.
        Specified by:
        getAddress in interface MemBuffer
        Returns:
        the current address of offset 0.

      • getMemory

        public Memory getMemory()
        Description copied from interface: MemBuffer
        Get the Memory object actually used by the MemBuffer.
        Specified by:
        getMemory in interface MemBuffer
        Returns:
        the Memory used by this MemBuffer.

      • isBigEndian

        public boolean isBigEndian()
        Description copied from interface: MemBuffer
        Returns true if the underlying bytes are in big-endian order, false if they are little endian.
        Specified by:
        isBigEndian in interface MemBuffer
        Returns:
        true if the underlying bytes are in big-endian order, false if they are little endian.

      • getShort

        public short getShort​(int offset)
               throws MemoryAccessException
        Description copied from interface: MemBuffer
        returns the short at the given offset, taking into account the endianess.
        Specified by:
        getShort in interface MemBuffer
        Parameters:
        offset - the offset from the membuffers origin (the address that it is set at)
        Returns:
        the short at the given offset, taking into account the endianess.
        Throws:
        MemoryAccessException - if a 2-byte short value cannot be read at the specified offset

      • getInt

        public int getInt​(int offset)
           throws MemoryAccessException
        Description copied from interface: MemBuffer
        returns the int at the given offset, taking into account the endianess.
        Specified by:
        getInt in interface MemBuffer
        Parameters:
        offset - the offset from the membuffers origin (the address that it is set at)
        Returns:
        the int at the given offset, taking into account the endianess.
        Throws:
        MemoryAccessException - if a 4-byte integer value cannot be read at the specified offset

      • getLong

        public long getLong​(int offset)
             throws MemoryAccessException
        Description copied from interface: MemBuffer
        returns the long at the given offset, taking into account the endianess.
        Specified by:
        getLong in interface MemBuffer
        Parameters:
        offset - the offset from the membuffers origin (the address that it is set at)
        Returns:
        the long at the given offset, taking into account the endianess.
        Throws:
        MemoryAccessException - if a 8-byte long value cannot be read at the specified offset

      • getBigInteger

        public java.math.BigInteger getBigInteger​(int offset,
                                          int size,
                                          boolean signed)
                                   throws MemoryAccessException
        Description copied from interface: MemBuffer
        returns the value at the given offset, taking into account the endianess.
        Specified by:
        getBigInteger in interface MemBuffer
        Parameters:
        offset - the offset from the membuffers origin (the address that it is set at)
        size - the number of bytes to include in the value
        signed - true if value should be treated as a signed twos-compliment value.
        Returns:
        the value at the given offset, taking into account the endianess.
        Throws:
        MemoryAccessException - if the request size value cannot be read at the specified offset

      • getRegister

        public Register getRegister​(java.lang.String name)
        Description copied from interface: ProcessorContextView
        Get a Register given the name of a register
        Specified by:
        getRegister in interface ProcessorContextView
        Parameters:
        name - the name of the register.
        Returns:
        The register with the given name.

      • getValue

        public java.math.BigInteger getValue​(Register register,
                                     boolean signed)
        Description copied from interface: ProcessorContextView
        Get the contents of a processor register as a BigInteger object
        Specified by:
        getValue in interface ProcessorContextView
        Parameters:
        register - register to get the value for
        Returns:
        a BigInteger object containing the value of the register if a value exists, otherwise null.

      • getRegisterValue

        public RegisterValue getRegisterValue​(Register register)
        Description copied from interface: ProcessorContextView
        Get the RegisterValue for the given register.
        Specified by:
        getRegisterValue in interface ProcessorContextView
        Parameters:
        register - register to get the value for
        Returns:
        RegisterValue object containing the value of the register if a value exists, otherwise null.

      • hasValue

        public boolean hasValue​(Register register)
        Description copied from interface: ProcessorContextView
        Returns true if a value is defined for the given register.
        Specified by:
        hasValue in interface ProcessorContextView
        Parameters:
        register - the register to check for a value.
        Returns:
        true if the given register has a value.

      • getRegister

        public Register getRegister​(int opIndex)
        Description copied from interface: Instruction
        If operand is a pure Register, return the register.
        Specified by:
        getRegister in interface Instruction
        Parameters:
        opIndex - index of the operand.
        Returns:
        A register if the operand represents a register.

      • getOpObjects

        public java.lang.Object[] getOpObjects​(int opIndex)
        Description copied from interface: Instruction
        Get objects used by this operand (Address, Scalar, Register ...)
        Specified by:
        getOpObjects in interface Instruction
        Parameters:
        opIndex - index of the operand.

      • getInputObjects

        public java.lang.Object[] getInputObjects()
        Description copied from interface: Instruction
        Get the Input objects used by this instruction. These could be Scalars, Registers, Addresses
        Specified by:
        getInputObjects in interface Instruction
        Returns:
        an array of objects that are used by this instruction

      • getResultObjects

        public java.lang.Object[] getResultObjects()
        Description copied from interface: Instruction
        Get the Result objects produced/affected by this instruction These would probably only be Register or Address
        Specified by:
        getResultObjects in interface Instruction
        Returns:
        an array of objects that are affected by this instruction

      • getDefaultOperandRepresentation

        public java.lang.String getDefaultOperandRepresentation​(int opIndex)
        Description copied from interface: Instruction
        Get the operand representation for the given operand index without markup.
        Specified by:
        getDefaultOperandRepresentation in interface Instruction
        Parameters:
        opIndex - operand index
        Returns:
        operand represented as a string.

      • getDefaultOperandRepresentationList

        public java.util.List<java.lang.Object> getDefaultOperandRepresentationList​(int opIndex)
        Description copied from interface: Instruction
        Get the operand representation for the given operand index. A list of Register, Address, Scalar, Character and String objects is returned - without markup!
        Specified by:
        getDefaultOperandRepresentationList in interface Instruction
        Parameters:
        opIndex - operand index
        Returns:
        ArrayList of pieces of the operand representation. Unsupported languages may return null.

      • getSeparator

        public java.lang.String getSeparator​(int opIndex)
        Description copied from interface: Instruction
        Get 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:
        getSeparator in interface Instruction
        Parameters:
        opIndex - valid values are 0 thru numOperands+1
        Returns:
        separator string, or null if there is no string

      • getOperandType

        public int getOperandType​(int opIndex)
        Description copied from interface: Instruction
        Get the type of a specific operand.
        Specified by:
        getOperandType in interface Instruction
        Parameters:
        opIndex - the index of the operand. (zero based)
        Returns:
        the type of the operand.
        See Also:
        OperandType

      • getOperandRefType

        public RefType getOperandRefType​(int index)
        Description copied from interface: Instruction
        Get the operand reference type for the given operand index.
        Specified by:
        getOperandRefType in interface Instruction
        Parameters:
        index - operand index

      • getDefaultFallThroughOffset

        public int getDefaultFallThroughOffset()
        Description copied from interface: Instruction
        Get default fall-through offset in bytes from start of instruction to the fallthrough instruction. This accounts for any instructions contained with delay slots.
        Specified by:
        getDefaultFallThroughOffset in interface Instruction
        Returns:
        default fall-through offset or zero (0) if instruction has no fallthrough

      • getDefaultFallThrough

        public Address getDefaultFallThrough()
        Description copied from interface: Instruction
        Get the default fallthrough for this instruction. This accounts for any instructions contained with delay slots.
        Specified by:
        getDefaultFallThrough in interface Instruction
        Returns:
        fall-through address or null if instruction has no default fallthrough

      • getFallThrough

        public Address getFallThrough()
        Description copied from interface: Instruction
        Get the fallthrough for this instruction, factoring in any fallthrough override and delay slotted instructions.
        Specified by:
        getFallThrough in interface Instruction
        Returns:
        fall-through address or null if instruction has no fallthrough

      • getFallFrom

        public Address getFallFrom()
        Description copied from interface: Instruction
        Get the Address for the instruction that fell through to this instruction. This is useful for handling instructions that are found in a delay slot.
        Specified by:
        getFallFrom in interface Instruction

      • getFlows

        public Address[] getFlows()
        Description copied from interface: Instruction
        Get an array of Address objects for all flows other than a fall-through. This will include any flow references which have been added to the instruction.
        Specified by:
        getFlows in interface Instruction
        Returns:
        flow addresses or null if there are no flows

      • getDefaultFlows

        public Address[] getDefaultFlows()
        Description copied from interface: Instruction
        Get an array of Address objects for all default flows established by the underlying instruction prototype. References are ignored.
        Specified by:
        getDefaultFlows in interface Instruction
        Returns:
        flow addresses or null if there are no flows

      • getFlowType

        public FlowType getFlowType()
        Description copied from interface: Instruction
        Get the flow type of this instruction (how this instruction flows to the next instruction).
        Specified by:
        getFlowType in interface Instruction

      • isFallthrough

        public boolean isFallthrough()
        Description copied from interface: Instruction
        Returns true if this instruction has no execution flow other than fall-through.
        Specified by:
        isFallthrough in interface Instruction

      • hasFallthrough

        public boolean hasFallthrough()
        Description copied from interface: Instruction
        Returns true if this instruction has a fall-through flow.
        Specified by:
        hasFallthrough in interface Instruction

      • getPcode

        public PcodeOp[] getPcode()
        Description copied from interface: Instruction
        Get an array of PCode operations (micro code) that this instruction performs. Flow overrides are not factored into pcode.
        Specified by:
        getPcode in interface Instruction
        Returns:
        an array of Pcode operations, a zero length array if the language does not support PCode

      • getPcode

        public PcodeOp[] getPcode​(boolean includeOverrides)
        Description copied from interface: Instruction
        Get an array of PCode operations (micro code) that this instruction performs. NOTE: If includeOverrides is true, unique temporary varnodes may be produced which vary in size to those produced for other instructions. If your analysis is sensitive to this you should consider using InstructionPrototype.getPcode(InstructionContext, PcodeOverride, UniqueAddressFactory) instead with your own UniqueAddressFactory to prevent duplication within your scope of analysis. by this method may not be suitable for use with certain analysis
        Specified by:
        getPcode in interface Instruction
        Parameters:
        includeOverrides - if true any flow overrides will be factored into generated pcode.
        Returns:
        an array of Pcode operations, a zero length array if the language does not support PCode

      • getPcode

        public PcodeOp[] getPcode​(int opIndex)
        Description copied from interface: Instruction
        Get an array of PCode operations (micro code) that a particular operand performs to compute its value.
        Specified by:
        getPcode in interface Instruction
        Parameters:
        opIndex - index of the operand to retrieve PCode
        Returns:
        an array of PCode operations, a zero length array if the language does not support PCode

      • getDelaySlotDepth

        public int getDelaySlotDepth()
        Description copied from interface: Instruction
        Get 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:
        getDelaySlotDepth in interface Instruction

      • isInDelaySlot

        public boolean isInDelaySlot()
        Description copied from interface: Instruction
        Return true if this instruction was disassembled in a delay slot
        Specified by:
        isInDelaySlot in interface Instruction

      • setFallThrough

        public void setFallThrough​(Address addr)
        Description copied from interface: Instruction
        Overrides the instruction's default fallthrough address to the given address. The given address may be null to indicate that the instruction has no fallthrough.
        Specified by:
        setFallThrough in interface Instruction
        Parameters:
        addr - the address to be used as this instructions fallthrough address. May be null.

      • clearFallThroughOverride

        public void clearFallThroughOverride()
        Description copied from interface: Instruction
        Restores this instruction's fallthrough address back to the default fallthrough for this instruction.
        Specified by:
        clearFallThroughOverride in interface Instruction

      • isFallThroughOverridden

        public boolean isFallThroughOverridden()
        Description copied from interface: Instruction
        Returns true if this instructions fallthrough has been overriden.
        Specified by:
        isFallThroughOverridden in interface Instruction