jaroslav@1646: * {@code CallSite} is an abstract class which does not allow jaroslav@1646: * direct subclassing by users. It has three immediate, jaroslav@1646: * concrete subclasses that may be either instantiated or subclassed. jaroslav@1646: *
jaroslav@1646: * A non-constant call site may be relinked by changing its target. jaroslav@1646: * The new target must have the same {@linkplain MethodHandle#type() type} jaroslav@1646: * as the previous target. jaroslav@1646: * Thus, though a call site can be relinked to a series of jaroslav@1646: * successive targets, it cannot change its type. jaroslav@1646: *
jaroslav@1646: * Here is a sample use of call sites and bootstrap methods which links every jaroslav@1646: * dynamic call site to print its arguments: jaroslav@1646:
{@code
jaroslav@1646: static void test() throws Throwable {
jaroslav@1646: // THE FOLLOWING LINE IS PSEUDOCODE FOR A JVM INSTRUCTION
jaroslav@1646: InvokeDynamic[#bootstrapDynamic].baz("baz arg", 2, 3.14);
jaroslav@1646: }
jaroslav@1646: private static void printArgs(Object... args) {
jaroslav@1646: System.out.println(java.util.Arrays.deepToString(args));
jaroslav@1646: }
jaroslav@1646: private static final MethodHandle printArgs;
jaroslav@1646: static {
jaroslav@1646: MethodHandles.Lookup lookup = MethodHandles.lookup();
jaroslav@1646: Class thisClass = lookup.lookupClass(); // (who am I?)
jaroslav@1646: printArgs = lookup.findStatic(thisClass,
jaroslav@1646: "printArgs", MethodType.methodType(void.class, Object[].class));
jaroslav@1646: }
jaroslav@1646: private static CallSite bootstrapDynamic(MethodHandles.Lookup caller, String name, MethodType type) {
jaroslav@1646: // ignore caller and name, but match the type:
jaroslav@1646: return new ConstantCallSite(printArgs.asType(type));
jaroslav@1646: }
jaroslav@1646: }jaroslav@1646: * Before this {@code CallSite} object is returned from a bootstrap method, jaroslav@1646: * it is usually provided with a more useful target method, jaroslav@1646: * via a call to {@link CallSite#setTarget(MethodHandle) setTarget}. jaroslav@1646: * @throws NullPointerException if the proposed type is null jaroslav@1646: */ jaroslav@1646: /*package-private*/ jaroslav@1646: CallSite(MethodType type) { jaroslav@1646: target = type.invokers().uninitializedCallSite(); jaroslav@1646: } jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Make a call site object equipped with an initial target method handle. jaroslav@1646: * @param target the method handle which will be the initial target of the call site jaroslav@1646: * @throws NullPointerException if the proposed target is null jaroslav@1646: */ jaroslav@1646: /*package-private*/ jaroslav@1646: CallSite(MethodHandle target) { jaroslav@1646: target.type(); // null check jaroslav@1646: this.target = target; jaroslav@1646: } jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Make a call site object equipped with an initial target method handle. jaroslav@1646: * @param targetType the desired type of the call site jaroslav@1646: * @param createTargetHook a hook which will bind the call site to the target method handle jaroslav@1646: * @throws WrongMethodTypeException if the hook cannot be invoked on the required arguments, jaroslav@1646: * or if the target returned by the hook is not of the given {@code targetType} jaroslav@1646: * @throws NullPointerException if the hook returns a null value jaroslav@1646: * @throws ClassCastException if the hook returns something other than a {@code MethodHandle} jaroslav@1646: * @throws Throwable anything else thrown by the hook function jaroslav@1646: */ jaroslav@1646: /*package-private*/ jaroslav@1646: CallSite(MethodType targetType, MethodHandle createTargetHook) throws Throwable { jaroslav@1646: this(targetType); jaroslav@1646: ConstantCallSite selfCCS = (ConstantCallSite) this; jaroslav@1646: MethodHandle boundTarget = (MethodHandle) createTargetHook.invokeWithArguments(selfCCS); jaroslav@1646: checkTargetChange(this.target, boundTarget); jaroslav@1646: this.target = boundTarget; jaroslav@1646: } jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Returns the type of this call site's target. jaroslav@1646: * Although targets may change, any call site's type is permanent, and can never change to an unequal type. jaroslav@1646: * The {@code setTarget} method enforces this invariant by refusing any new target that does jaroslav@1646: * not have the previous target's type. jaroslav@1646: * @return the type of the current target, which is also the type of any future target jaroslav@1646: */ jaroslav@1646: public MethodType type() { jaroslav@1646: // warning: do not call getTarget here, because CCS.getTarget can throw IllegalStateException jaroslav@1646: return target.type(); jaroslav@1646: } jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Returns the target method of the call site, according to the jaroslav@1646: * behavior defined by this call site's specific class. jaroslav@1646: * The immediate subclasses of {@code CallSite} document the jaroslav@1646: * class-specific behaviors of this method. jaroslav@1646: * jaroslav@1646: * @return the current linkage state of the call site, its target method handle jaroslav@1646: * @see ConstantCallSite jaroslav@1646: * @see VolatileCallSite jaroslav@1646: * @see #setTarget jaroslav@1646: * @see ConstantCallSite#getTarget jaroslav@1646: * @see MutableCallSite#getTarget jaroslav@1646: * @see VolatileCallSite#getTarget jaroslav@1646: */ jaroslav@1646: public abstract MethodHandle getTarget(); jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Updates the target method of this call site, according to the jaroslav@1646: * behavior defined by this call site's specific class. jaroslav@1646: * The immediate subclasses of {@code CallSite} document the jaroslav@1646: * class-specific behaviors of this method. jaroslav@1646: *
jaroslav@1646: * The type of the new target must be {@linkplain MethodType#equals equal to} jaroslav@1646: * the type of the old target. jaroslav@1646: * jaroslav@1646: * @param newTarget the new target jaroslav@1646: * @throws NullPointerException if the proposed new target is null jaroslav@1646: * @throws WrongMethodTypeException if the proposed new target jaroslav@1646: * has a method type that differs from the previous target jaroslav@1646: * @see CallSite#getTarget jaroslav@1646: * @see ConstantCallSite#setTarget jaroslav@1646: * @see MutableCallSite#setTarget jaroslav@1646: * @see VolatileCallSite#setTarget jaroslav@1646: */ jaroslav@1646: public abstract void setTarget(MethodHandle newTarget); jaroslav@1646: jaroslav@1646: void checkTargetChange(MethodHandle oldTarget, MethodHandle newTarget) { jaroslav@1646: MethodType oldType = oldTarget.type(); jaroslav@1646: MethodType newType = newTarget.type(); // null check! jaroslav@1646: if (!newType.equals(oldType)) jaroslav@1646: throw wrongTargetType(newTarget, oldType); jaroslav@1646: } jaroslav@1646: jaroslav@1646: private static WrongMethodTypeException wrongTargetType(MethodHandle target, MethodType type) { jaroslav@1646: return new WrongMethodTypeException(String.valueOf(target)+" should be of type "+type); jaroslav@1646: } jaroslav@1646: jaroslav@1646: /** jaroslav@1646: * Produces a method handle equivalent to an invokedynamic instruction jaroslav@1646: * which has been linked to this call site. jaroslav@1646: *
jaroslav@1646: * This method is equivalent to the following code: jaroslav@1646: *
{@code
jaroslav@1646: * MethodHandle getTarget, invoker, result;
jaroslav@1646: * getTarget = MethodHandles.publicLookup().bind(this, "getTarget", MethodType.methodType(MethodHandle.class));
jaroslav@1646: * invoker = MethodHandles.exactInvoker(this.type());
jaroslav@1646: * result = MethodHandles.foldArguments(invoker, getTarget)
jaroslav@1646: * }