Thejava.lang.invoke package provides low-level primitives for interacting with the Java Virtual Machine.

As described in the Java Virtual Machine Specification, certain types in this package are given special treatment by the virtual machine:

• The classesMethodHandle andVarHandle containsignature polymorphic methods which can be linked regardless of their type descriptor. Normally, method linkage requires exact matching of type descriptors.
• The JVM bytecode format supports immediate constants of the classesMethodHandle andMethodType.
• Theinvokedynamic instruction makes use of bootstrapMethodHandle constants to dynamically resolveCallSite objects for custom method invocation behavior.
• Theldc instruction makes use of bootstrapMethodHandle constants to dynamically resolve custom constant values.

Dynamic resolution of call sites and constants

The following low-level information summarizes relevant parts of the Java Virtual Machine specification. For full details, please see the current version of that specification.

Dynamically-computed call sites

Aninvokedynamic instruction is originally in an unlinked state. In this state, there is no target method for the instruction to invoke.

Before the JVM can execute aninvokedynamic instruction, the instruction must first belinked. Linking is accomplished by calling abootstrap method which is given the static information content of the call, and which must produce aCallSite that gives the behavior of the invocation.

Eachinvokedynamic instruction statically specifies its own bootstrap method as a constant pool reference. The constant pool reference also specifies the invocation's name and method type descriptor, just likeinvokestatic and the other invoke instructions.

Dynamically-computed constants

The constant pool may contain constants taggedCONSTANT_Dynamic, equipped with bootstrap methods which perform their resolution. Such adynamic constant is originally in an unresolved state. Before the JVM can use a dynamically-computed constant, it must first beresolved. Dynamically-computed constant resolution is accomplished by calling abootstrap method which is given the static information content of the constant, and which must produce a value of the constant's statically declared type.

Each dynamically-computed constant statically specifies its own bootstrap method as a constant pool reference. The constant pool reference also specifies the constant's name and field type descriptor, just likegetstatic and the other field reference instructions. (Roughly speaking, a dynamically-computed constant is to a dynamically-computed call site as aCONSTANT_Fieldref is to aCONSTANT_Methodref.)

Execution of bootstrap methods

Resolving a dynamically-computed call site or constant starts with resolving constants from the constant pool for the following items:

• the bootstrap method, aCONSTANT_MethodHandle
• theClass orMethodType derived from type component of theCONSTANT_NameAndType descriptor
• static arguments, if any (note that static arguments can themselves be dynamically-computed constants)

The bootstrap method is then invoked, as if byMethodHandle.invoke, with the following arguments:

• aMethodHandles.Lookup, which is a lookup object on thecaller class in which dynamically-computed constant or call site occurs
• aString, the name mentioned in theCONSTANT_NameAndType
• aMethodType orClass, the resolved type descriptor of theCONSTANT_NameAndType
• aClass, the resolved type descriptor of the constant, if it is a dynamic constant
• the additional resolved static arguments, if any

For a dynamically-computed call site, the returned result must be a non-null reference to aCallSite. The type of the call site's target must be exactly equal to the type derived from the invocation's type descriptor and passed to the bootstrap method. If these conditions are not met, aBootstrapMethodError is thrown. On success the call site then becomes permanently linked to theinvokedynamic instruction.

For a dynamically-computed constant, the first parameter of the bootstrap method must be assignable toMethodHandles.Lookup. If this condition is not met, aBootstrapMethodError is thrown. On success the result of the bootstrap method is cached as the resolved constant value.

If an exception,E say, occurs during execution of the bootstrap method, then resolution fails and terminates abnormally.E is rethrown if the type ofE isError or a subclass, otherwise aBootstrapMethodError that wrapsE is thrown. If this happens, the same error will be thrown for all subsequent attempts to execute theinvokedynamic instruction or load the dynamically-computed constant.

Timing of resolution

Aninvokedynamic instruction is linked just before its first execution. A dynamically-computed constant is resolved just before the first time it is used (by pushing it on the stack or linking it as a bootstrap method parameter). The bootstrap method call implementing the linkage occurs within a thread that is attempting a first execution or first use.

If there are several such threads, the bootstrap method may be invoked in several threads concurrently. Therefore, bootstrap methods which access global application data must take the usual precautions against race conditions. In any case, everyinvokedynamic instruction is either unlinked or linked to a uniqueCallSite object.

In an application which requiresinvokedynamic instructions with individually mutable behaviors, their bootstrap methods should produce distinctCallSite objects, one for each linkage request. Alternatively, an application can link a singleCallSite object to severalinvokedynamic instructions, in which case a change to the target method will become visible at each of the instructions.

If several threads simultaneously execute a bootstrap method for a single dynamically-computed call site or constant, the JVM must choose one bootstrap method result and install it visibly to all threads. Any other bootstrap method calls are allowed to complete, but their results are ignored.

Discussion: These rules do not enable the JVM to share call sites, or to issue “causeless” bootstrap method calls. Everyinvokedynamic instruction transitions at most once from unlinked to linked, just before its first invocation. There is no way to undo the effect of a completed bootstrap method call.

Types of bootstrap methods

For a dynamically-computed call site, the bootstrap method is invoked with parameter typesMethodHandles.Lookup,String,MethodType, and the types of any static arguments; the return type isCallSite.

For a dynamically-computed constant, the bootstrap method is invoked with parameter typesMethodHandles.Lookup,String,Class, and the types of any static arguments; the return type is the type represented by theClass.

BecauseMethodHandle.invoke allows for adaptations between the invoked method type and the bootstrap method handle's method type, there is flexibility in the declaration of the bootstrap method. For a dynamically-computed constant the first parameter type of the bootstrap method handle must be assignable toMethodHandles.Lookup, other than that constraint the same degree of flexibility applies to bootstrap methods of dynamically-computed call sites and dynamically-computed constants. Note: this constraint allows for the future possibility where the bootstrap method is invoked with just the parameter types of static arguments, thereby supporting a wider range of methods compatible with the static arguments (such as methods that don't declare or require the lookup, name, and type meta-data parameters).

For example, for dynamically-computed call site, the first argument could beObject instead ofMethodHandles.Lookup, and the return type could also beObject instead ofCallSite. (Note that the types and number of the stacked arguments limit the legal kinds of bootstrap methods to appropriately typed static methods and constructors.)

If a pushed value is a primitive type, it may be converted to a reference by boxing conversion. If the bootstrap method is a variable arity method (its modifier bit0x0080 is set), then some or all of the arguments specified here may be collected into a trailing array parameter. (This is not a special rule, but rather a useful consequence of the interaction betweenCONSTANT_MethodHandle constants, the modifier bit for variable arity methods, and theasVarargsCollector transformation.)

Given these rules, here are examples of legal bootstrap method declarations for dynamically-computed call sites, given various numbersN of extra arguments. The first row (marked*) will work for any number of extra arguments.

Static argument types

N	Sample bootstrap method
*	CallSite bootstrap(Lookup caller, String name, MethodType type, Object... args) CallSite bootstrap(Object... args) CallSite bootstrap(Object caller, Object... nameAndTypeWithArgs)
0	CallSite bootstrap(Lookup caller, String name, MethodType type) CallSite bootstrap(Lookup caller, Object... nameAndType)
1	CallSite bootstrap(Lookup caller, String name, MethodType type, Object arg)
2	CallSite bootstrap(Lookup caller, String name, MethodType type, Object... args) CallSite bootstrap(Lookup caller, String name, MethodType type, String... args) CallSite bootstrap(Lookup caller, String name, MethodType type, String x, int y)

The last example assumes that the extra arguments are of typeString andInteger (orint), respectively. The second-to-last example assumes that all extra arguments are of typeString. The other examples work with all types of extra arguments. Note that all the examples except the second and third also work with dynamically-computed constants if the return type is changed to be compatible with the constant's declared type (such asObject, which is always compatible).

Since dynamically-computed constants can be provided as static arguments to bootstrap methods, there are no limitations on the types of bootstrap arguments. However, arguments of typeboolean,byte,short, orchar cannot bedirectly supplied byCONSTANT_Integer constant pool entries, since theasType conversions do not perform the necessary narrowing primitive conversions.

In the above examples, the return type is alwaysCallSite, but that is not a necessary feature of bootstrap methods. In the case of a dynamically-computed call site, the only requirement is that the return type of the bootstrap method must be convertible (using theasType conversions) toCallSite, which means the bootstrap method return type might beObject orConstantCallSite. In the case of a dynamically-resolved constant, the return type of the bootstrap method must be convertible to the type of the constant, as represented by its field type descriptor. For example, if the dynamic constant has a field type descriptor of"C" (char) then the bootstrap method return type could beObject,Character, orchar, but notint orInteger.