com.oracle.truffle.api.dsl

Annotation Type GenerateInline

@Retention(value=CLASS)
 @Target(value=TYPE)
public @interface GenerateInline

Generates code for a node that makes this node inlinable when used in cached parameters of specializations. Inlining nodes significantly reduces the footprint of cached nodes as node allocations are avoided. A node subclass must fullfill the following requirements in order to be inlinable:

• All execute methods of a the node must have a node as first parameter type.
• The node has no instance fields and must not use NodeChild or NodeField.
• The cached node types must not be recursive.

Truffle DSL emits warnings if the use of this annotation is recommended. In addition to inlining nodes automatically using this annotation, manually written nodes can also be written to become inlinable. See InlineSupport for details. Please see the node object inlining tutorial for details on how to use this annotation.

Since:

23.0

See Also:

GenerateCached, GenerateUncached, GenerateAOT, InlineSupport

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	inherit If true enables inheritance of GenerateInline.value() to subclasses.
boolean	value If true enables the generation of a inlined version of this specializing node.

Element Detail

value

public abstract boolean value

If true enables the generation of a inlined version of this specializing node. It is enabled by default.

Since:

23.0

Default:

true

inherit

public abstract boolean inherit

If true enables inheritance of GenerateInline.value() to subclasses. It is false by default.

Since:

23.0

Default:

false