Class Instruction.Argument

java.lang.Object

com.oracle.truffle.api.bytecode.Instruction.Argument

Enclosing class:

Instruction

public abstract static class Instruction.Argument
extends Object

Represents metadata for an argument of an instruction in a bytecode node.

Compatibility note: The data contained in instruction classes is subject to change without notice between Truffle versions. This introspection API is therefore intended to be used for debugging and tracing purposes only. Do not rely on instructions for your language semantics.

Since:

24.2

See Also:

• Instruction.getArguments()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Instruction.Argument.BranchProfile	Represents a branch profile.
static enum	Instruction.Argument.Kind	Represents the kind of an Instruction.Argument.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Argument(Object token)	Internal constructor for generated code.

Method Summary

Modifier and Type	Method	Description
Instruction.Argument.BranchProfile	asBranchProfile()	Converts this argument to a branch profile.
int	asBytecodeIndex()	Converts this argument to a bytecode index.
Node	asCachedNode()	Converts this argument to a cached node.
Object	asConstant()	Converts this argument to a object constant.
int	asInteger()	Converts this argument to an int value.
int	asLocalIndex()	Converts this argument to a local index.
int	asLocalOffset()	Converts this argument to a local offset.
TagTreeNode	asTagNode()	Converts this argument to a tag tree node.
abstract Instruction.Argument.Kind	getKind()	Returns the Instruction.Argument.Kind of this argument.
abstract String	getName()	Returns a human readable name for this argument.
final List<Introspection.SpecializationInfo>	getSpecializationInfo()	Converts this argument to a specialization info.
final String	toString()

Methods inherited from class Object

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

Constructor Details

Argument

protected Argument(Object token)

Internal constructor for generated code. Do not use.

Since:

24.2

Method Details

getKind

public abstract Instruction.Argument.Kind getKind()

Returns the Instruction.Argument.Kind of this argument. The kind determines which asX method can be called on a given argument.

For example, if the kind is Instruction.Argument.Kind.INTEGER, the asInteger() method will return the integer value. All other asX methods (e.g., asBranchProfile()) will throw an exception.

Since:

24.2

getName

public abstract String getName()

Returns a human readable name for this argument. This could be for example "localOffset" for a local variable access instruction. Arguments with the same getKind() may have different names. A name is typically more descriptive than just the kind and should be preferred over the kind for debug output.

Since:

24.2

asInteger

public int asInteger()
              throws UnsupportedOperationException

Converts this argument to an int value. This method is only supported if the argument kind is Instruction.Argument.Kind.INTEGER. If called for arguments of other kinds then an UnsupportedOperationException is thrown.

Throws:

UnsupportedOperationException

Since:

24.2

asBytecodeIndex

public int asBytecodeIndex()

Converts this argument to a bytecode index. This method is only supported if the argument kind is Instruction.Argument.Kind.BYTECODE_INDEX. If called for arguments of other kinds then an UnsupportedOperationException is thrown. If the returned value is >= 0 then the bytecode index can be used to be converted to a BytecodeLocation.

Since:

24.2

asConstant

public Object asConstant()

Converts this argument to a object constant. This method is only supported if the argument kind is Instruction.Argument.Kind.CONSTANT. If called for arguments of other kinds then an UnsupportedOperationException is thrown.

Since:

24.2

asCachedNode

public Node asCachedNode()

Converts this argument to a cached node. This method is only supported if the argument kind is Instruction.Argument.Kind.NODE_PROFILE. If called for arguments of other kinds then an UnsupportedOperationException is thrown. The returned value is never null if the BytecodeTier is BytecodeTier.CACHED.

Since:

24.2

asTagNode

public TagTreeNode asTagNode()

Converts this argument to a tag tree node. This method is only supported if the argument kind is Instruction.Argument.Kind.TAG_NODE. If called for arguments of other kinds then an UnsupportedOperationException is thrown. The returned value is never null.

Since:

24.2

asLocalOffset

public int asLocalOffset()

Converts this argument to a local offset. This method is only supported if the argument kind is Instruction.Argument.Kind.LOCAL_OFFSET. If called for arguments of other kinds then an UnsupportedOperationException is thrown. This index may be used to access locals with the local access methods in BytecodeNode.

Since:

24.2

See Also:

• BytecodeNode.getLocalValue(int, com.oracle.truffle.api.frame.Frame, int)

asLocalIndex

public int asLocalIndex()

Converts this argument to a local index. This method is only supported if the argument kind is Instruction.Argument.Kind.LOCAL_INDEX. If called for arguments of other kinds then an UnsupportedOperationException is thrown. The local index can be used to index into the list of locals.

Since:

24.2

See Also:

• BytecodeNode.getLocals()

asBranchProfile

public Instruction.Argument.BranchProfile asBranchProfile()

Converts this argument to a branch profile. This method is only supported if the argument kind is Instruction.Argument.Kind.BRANCH_PROFILE. If called for arguments of other kinds then an UnsupportedOperationException is thrown. The returned value is never null.

Since:

24.2

getSpecializationInfo

public final List<Introspection.SpecializationInfo> getSpecializationInfo()

Converts this argument to a specialization info. This method is only supported if the argument kind is Instruction.Argument.Kind.NODE_PROFILE. If called for arguments of other kinds then an UnsupportedOperationException is thrown. The specialization info is only available if GenerateBytecode.enableSpecializationIntrospection() is set to true.

Since:

24.2

toString

public final String toString()

Overrides:

toString in class Object

Since:

24.2