Package ghidra.pcode.emu.jit.op

Record Class JitPhiOp

java.lang.Object
java.lang.Record
ghidra.pcode.emu.jit.op.JitPhiOp
Record Components:
block - the block containing the op that generated this phi node
out - the use-def variable node for the output
options - the map between block flows and options
All Implemented Interfaces:
JitDefOp, JitOp, JitSyntheticOp
public record JitPhiOp(JitControlFlowModel.JitBlock block, JitOutVar out, org.apache.commons.collections4.BidiMap<JitControlFlowModel.BlockFlow,JitVal> options) extends Record implements JitDefOp, JitSyntheticOp
The synthetic use-def node for phi nodes.

  • Constructor Details

    • JitPhiOp

      public JitPhiOp(JitControlFlowModel.JitBlock block, JitOutVar out)
      Construct a phi node without any options, yet.
      Parameters:
      block - the block containing the op that generated this phi node
      out - the use-def variable node for the output

    • JitPhiOp

      public JitPhiOp(JitControlFlowModel.JitBlock block, JitOutVar out, org.apache.commons.collections4.BidiMap<JitControlFlowModel.BlockFlow,JitVal> options)
      Creates an instance of a JitPhiOp record class.
      Parameters:
      block - the value for the block record component
      out - the value for the out record component
      options - the value for the options record component

  • Method Details

    • addOption

      public void addOption(JitControlFlowModel.BlockFlow flow, JitVal option)
      Add an option assuming the given flow is taken
      Parameters:
      flow - the flow
      option - the option

    • hasInputOption

      public boolean hasInputOption()
      Check if one of the options is an input to the passage.
      Returns:
      true if an input option is present.

    • addInputOption

      public void addInputOption()
      Add the input option, if not already present

    • link

      public void link()
      Description copied from interface: JitOp
      Add this op to the JitVal.uses() of each input operand, and (if applicable) set the JitOutVar.definition() of the output operand to this op.
      Specified by:
      link in interface JitDefOp
      Specified by:
      link in interface JitOp

    • unlink

      public void unlink()
      Description copied from interface: JitOp
      Remove this op from the JitVal.uses() of each input operand, and (if applicable) unset the JitOutVar.definition() of the output operand.
      Specified by:
      unlink in interface JitDefOp
      Specified by:
      unlink in interface JitOp

    • inputs

      public List<JitVal> inputs()
      The input operand use-def nodes in some defined order
      Specified by:
      inputs in interface JitOp
      Returns:
      the list of inputs
      Implementation Notes:
      While this says I should care about some defined order, it's only so that the type of each operand can be derived. They all take the copy type, so I'm not concerned.

    • typeFor

      public JitTypeBehavior typeFor(int position)
      Description copied from interface: JitOp
      Get the required type behavior for the input at the given position in JitOp.inputs()
      Specified by:
      typeFor in interface JitOp
      Parameters:
      position - the input position
      Returns:
      the behavior

    • optionType

      public JitTypeBehavior optionType()
      We do not require a particular type for the value, but we note the result is the same.
      Returns:
      JitTypeBehavior.COPY

    • type

      public JitTypeBehavior type()
      Description copied from interface: JitDefOp
      The required type behavior for the output
      Specified by:
      type in interface JitDefOp
      Returns:
      the behavior

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • block

      public JitControlFlowModel.JitBlock block()
      Returns the value of the block record component.
      Returns:
      the value of the block record component

    • out

      public JitOutVar out()
      Returns the value of the out record component.
      Specified by:
      out in interface JitDefOp
      Returns:
      the value of the out record component

    • options

      public org.apache.commons.collections4.BidiMap<JitControlFlowModel.BlockFlow,JitVal> options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component