1 /*
2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.nashorn.internal.runtime.linker;
27
28 import static jdk.nashorn.internal.codegen.CompilerConstants.staticCallNoLookup;
29 import static jdk.nashorn.internal.runtime.ECMAErrors.typeError;
30
31 import java.lang.invoke.CallSite;
32 import java.lang.invoke.ConstantCallSite;
33 import java.lang.invoke.MethodHandle;
34 import java.lang.invoke.MethodHandles;
35 import java.lang.invoke.MethodHandles.Lookup;
36 import java.lang.invoke.MethodType;
37 import jdk.internal.dynalink.CallSiteDescriptor;
38 import jdk.internal.dynalink.DynamicLinker;
39 import jdk.internal.dynalink.DynamicLinkerFactory;
40 import jdk.internal.dynalink.GuardedInvocationFilter;
41 import jdk.internal.dynalink.beans.BeansLinker;
42 import jdk.internal.dynalink.beans.StaticClass;
43 import jdk.internal.dynalink.linker.GuardedInvocation;
44 import jdk.internal.dynalink.linker.LinkRequest;
45 import jdk.internal.dynalink.linker.LinkerServices;
46 import jdk.internal.dynalink.linker.MethodTypeConversionStrategy;
47 import jdk.internal.dynalink.support.TypeUtilities;
48 import jdk.nashorn.api.scripting.JSObject;
49 import jdk.nashorn.internal.codegen.CompilerConstants.Call;
50 import jdk.nashorn.internal.codegen.ObjectClassGenerator;
51 import jdk.nashorn.internal.lookup.MethodHandleFactory;
52 import jdk.nashorn.internal.lookup.MethodHandleFunctionality;
53 import jdk.nashorn.internal.runtime.ECMAException;
54 import jdk.nashorn.internal.runtime.JSType;
55 import jdk.nashorn.internal.runtime.OptimisticReturnFilters;
56 import jdk.nashorn.internal.runtime.ScriptFunction;
57 import jdk.nashorn.internal.runtime.ScriptRuntime;
58 import jdk.nashorn.internal.runtime.options.Options;
59
60 /**
61 * This class houses bootstrap method for invokedynamic instructions generated by compiler.
62 */
63 public final class Bootstrap {
64 /** Reference to the seed boostrap function */
65 public static final Call BOOTSTRAP = staticCallNoLookup(Bootstrap.class, "bootstrap", CallSite.class, Lookup.class, String.class, MethodType.class, int.class);
66
67 private static final MethodHandleFunctionality MH = MethodHandleFactory.getFunctionality();
68
69 private static final MethodHandle VOID_TO_OBJECT = MH.constant(Object.class, ScriptRuntime.UNDEFINED);
70
71 /**
72 * The default dynalink relink threshold for megamorphism is 8. In the case
73 * of object fields only, it is fine. However, with dual fields, in order to get
74 * performance on benchmarks with a lot of object instantiation and then field
75 * reassignment, it can take slightly more relinks to become stable with type
76 * changes swapping out an entire property map and making a map guard fail.
77 * Since we need to set this value statically it must work with possibly changing
78 * optimistic types and dual fields settings. A higher value does not seem to have
79 * any other negative performance implication when running with object-only fields,
80 * so we choose a higher value here.
81 *
82 * See for example octane.gbemu, run with --log=fields:warning to study
83 * megamorphic behavior
84 */
85 private static final int NASHORN_DEFAULT_UNSTABLE_RELINK_THRESHOLD = 16;
86
87 // do not create me!!
88 private Bootstrap() {
89 }
90
91 private static final DynamicLinker dynamicLinker;
92 static {
93 final DynamicLinkerFactory factory = new DynamicLinkerFactory();
94 final NashornBeansLinker nashornBeansLinker = new NashornBeansLinker();
95 factory.setPrioritizedLinkers(
96 new NashornLinker(),
97 new NashornPrimitiveLinker(),
98 new NashornStaticClassLinker(),
99 new BoundCallableLinker(),
100 new JavaSuperAdapterLinker(),
101 new JSObjectLinker(nashornBeansLinker),
102 new BrowserJSObjectLinker(nashornBeansLinker),
103 new ReflectionCheckLinker());
104 factory.setFallbackLinkers(nashornBeansLinker, new NashornBottomLinker());
105 factory.setSyncOnRelink(true);
106 factory.setPrelinkFilter(new GuardedInvocationFilter() {
107 @Override
108 public GuardedInvocation filter(final GuardedInvocation inv, final LinkRequest request, final LinkerServices linkerServices) {
109 final CallSiteDescriptor desc = request.getCallSiteDescriptor();
110 return OptimisticReturnFilters.filterOptimisticReturnValue(inv, desc).asType(linkerServices, desc.getMethodType());
111 }
112 });
113 factory.setAutoConversionStrategy(new MethodTypeConversionStrategy() {
114 @Override
115 public MethodHandle asType(final MethodHandle target, final MethodType newType) {
116 return unboxReturnType(target, newType);
117 }
118 });
119 factory.setInternalObjectsFilter(NashornBeansLinker.createHiddenObjectFilter());
120 final int relinkThreshold = Options.getIntProperty("nashorn.unstable.relink.threshold", NASHORN_DEFAULT_UNSTABLE_RELINK_THRESHOLD);
121 if (relinkThreshold > -1) {
122 factory.setUnstableRelinkThreshold(relinkThreshold);
123 }
124
125 // Linkers for any additional language runtimes deployed alongside Nashorn will be picked up by the factory.
126 factory.setClassLoader(Bootstrap.class.getClassLoader());
127
128 dynamicLinker = factory.createLinker();
129 }
130
131 /**
132 * Returns if the given object is a "callable"
133 * @param obj object to be checked for callability
134 * @return true if the obj is callable
135 */
136 public static boolean isCallable(final Object obj) {
137 if (obj == ScriptRuntime.UNDEFINED || obj == null) {
138 return false;
139 }
140
141 return obj instanceof ScriptFunction ||
142 isJSObjectFunction(obj) ||
143 BeansLinker.isDynamicMethod(obj) ||
144 obj instanceof BoundCallable ||
145 isFunctionalInterfaceObject(obj) ||
146 obj instanceof StaticClass;
147 }
148
149 /**
150 * Returns true if the given object is a strict callable
151 * @param callable the callable object to be checked for strictness
152 * @return true if the obj is a strict callable, false if it is a non-strict callable.
153 * @throws ECMAException with {@code TypeError} if the object is not a callable.
154 */
155 public static boolean isStrictCallable(final Object callable) {
156 if (callable instanceof ScriptFunction) {
157 return ((ScriptFunction)callable).isStrict();
158 } else if (isJSObjectFunction(callable)) {
159 return ((JSObject)callable).isStrictFunction();
160 } else if (callable instanceof BoundCallable) {
161 return isStrictCallable(((BoundCallable)callable).getCallable());
162 } else if (BeansLinker.isDynamicMethod(callable) || callable instanceof StaticClass) {
163 return false;
164 }
165 throw notFunction(callable);
166 }
167
168 private static ECMAException notFunction(final Object obj) {
169 return typeError("not.a.function", ScriptRuntime.safeToString(obj));
170 }
171
172 private static boolean isJSObjectFunction(final Object obj) {
173 return obj instanceof JSObject && ((JSObject)obj).isFunction();
174 }
175
176 /**
177 * Returns if the given object is a dynalink Dynamic method
178 * @param obj object to be checked
179 * @return true if the obj is a dynamic method
180 */
181 public static boolean isDynamicMethod(final Object obj) {
182 return BeansLinker.isDynamicMethod(obj instanceof BoundCallable ? ((BoundCallable)obj).getCallable() : obj);
183 }
184
185 /**
186 * Returns if the given object is an instance of an interface annotated with
187 * java.lang.FunctionalInterface
188 * @param obj object to be checked
189 * @return true if the obj is an instance of @FunctionalInterface interface
190 */
191 public static boolean isFunctionalInterfaceObject(final Object obj) {
192 return !JSType.isPrimitive(obj) && (NashornBeansLinker.getFunctionalInterfaceMethodName(obj.getClass()) != null);
193 }
194
195 /**
196 * Create a call site and link it for Nashorn. This version of the method conforms to the invokedynamic bootstrap
197 * method expected signature and is referenced from Nashorn generated bytecode as the bootstrap method for all
198 * invokedynamic instructions.
199 * @param lookup MethodHandle lookup. Ignored as Nashorn only uses public lookup.
200 * @param opDesc Dynalink dynamic operation descriptor.
201 * @param type Method type.
202 * @param flags flags for call type, trace/profile etc.
203 * @return CallSite with MethodHandle to appropriate method or null if not found.
204 */
205 public static CallSite bootstrap(final Lookup lookup, final String opDesc, final MethodType type, final int flags) {
206 return dynamicLinker.link(LinkerCallSite.newLinkerCallSite(lookup, opDesc, type, flags));
207 }
208
209 /**
210 * Boostrapper for math calls that may overflow
211 * @param lookup lookup
212 * @param name name of operation
213 * @param type method type
214 * @param programPoint program point to bind to callsite
215 *
216 * @return callsite for a math intrinsic node
217 */
218 public static CallSite mathBootstrap(final Lookup lookup, final String name, final MethodType type, final int programPoint) {
219 final MethodHandle mh;
220 switch (name) {
221 case "iadd":
222 mh = JSType.ADD_EXACT.methodHandle();
223 break;
224 case "isub":
225 mh = JSType.SUB_EXACT.methodHandle();
226 break;
227 case "imul":
228 mh = JSType.MUL_EXACT.methodHandle();
229 break;
230 case "idiv":
231 mh = JSType.DIV_EXACT.methodHandle();
232 break;
233 case "irem":
234 mh = JSType.REM_EXACT.methodHandle();
235 break;
236 case "ineg":
237 mh = JSType.NEGATE_EXACT.methodHandle();
238 break;
239 default:
240 throw new AssertionError("unsupported math intrinsic");
241 }
242 return new ConstantCallSite(MH.insertArguments(mh, mh.type().parameterCount() - 1, programPoint));
243 }
244
245 /**
246 * Returns a dynamic invoker for a specified dynamic operation using the public lookup. You can use this method to
247 * create a method handle that when invoked acts completely as if it were a Nashorn-linked call site. An overview of
248 * available dynamic operations can be found in the
249 * <a href="https://github.com/szegedi/dynalink/wiki/User-Guide-0.6">Dynalink User Guide</a>, but we'll show few
250 * examples here:
251 * <ul>
252 * <li>Get a named property with fixed name:
253 * <pre>
254 * MethodHandle getColor = Boostrap.createDynamicInvoker("dyn:getProp:color", Object.class, Object.class);
255 * Object obj = ...; // somehow obtain the object
256 * Object color = getColor.invokeExact(obj);
257 * </pre>
258 * </li>
259 * <li>Get a named property with variable name:
260 * <pre>
261 * MethodHandle getProperty = Boostrap.createDynamicInvoker("dyn:getElem", Object.class, Object.class, String.class);
262 * Object obj = ...; // somehow obtain the object
263 * Object color = getProperty.invokeExact(obj, "color");
264 * Object shape = getProperty.invokeExact(obj, "shape");
265 * MethodHandle getNumProperty = Boostrap.createDynamicInvoker("dyn:getElem", Object.class, Object.class, int.class);
266 * Object elem42 = getNumProperty.invokeExact(obj, 42);
267 * </pre>
268 * </li>
269 * <li>Set a named property with fixed name:
270 * <pre>
271 * MethodHandle setColor = Boostrap.createDynamicInvoker("dyn:setProp:color", void.class, Object.class, Object.class);
272 * Object obj = ...; // somehow obtain the object
273 * setColor.invokeExact(obj, Color.BLUE);
274 * </pre>
275 * </li>
276 * <li>Set a property with variable name:
277 * <pre>
278 * MethodHandle setProperty = Boostrap.createDynamicInvoker("dyn:setElem", void.class, Object.class, String.class, Object.class);
279 * Object obj = ...; // somehow obtain the object
280 * setProperty.invokeExact(obj, "color", Color.BLUE);
281 * setProperty.invokeExact(obj, "shape", Shape.CIRCLE);
282 * </pre>
283 * </li>
284 * <li>Call a function on an object; two-step variant. This is the actual variant used by Nashorn-generated code:
285 * <pre>
286 * MethodHandle findFooFunction = Boostrap.createDynamicInvoker("dyn:getMethod:foo", Object.class, Object.class);
287 * Object obj = ...; // somehow obtain the object
288 * Object foo_fn = findFooFunction.invokeExact(obj);
289 * MethodHandle callFunctionWithTwoArgs = Boostrap.createDynamicInvoker("dyn:call", Object.class, Object.class, Object.class, Object.class, Object.class);
290 * // Note: "call" operation takes a function, then a "this" value, then the arguments:
291 * Object foo_retval = callFunctionWithTwoArgs.invokeExact(foo_fn, obj, arg1, arg2);
292 * </pre>
293 * </li>
294 * <li>Call a function on an object; single-step variant. Although Nashorn doesn't use this variant and never
295 * emits any INVOKEDYNAMIC instructions with {@code dyn:getMethod}, it still supports this standard Dynalink
296 * operation:
297 * <pre>
298 * MethodHandle callFunctionFooWithTwoArgs = Boostrap.createDynamicInvoker("dyn:callMethod:foo", Object.class, Object.class, Object.class, Object.class);
299 * Object obj = ...; // somehow obtain the object
300 * Object foo_retval = callFunctionFooWithTwoArgs.invokeExact(obj, arg1, arg2);
301 * </pre>
302 * </li>
303 * </ul>
304 * Few additional remarks:
305 * <ul>
306 * <li>Just as Nashorn works with any Java object, the invokers returned from this method can also be applied to
307 * arbitrary Java objects in addition to Nashorn JavaScript objects.</li>
308 * <li>For invoking a named function on an object, you can also use the {@link InvokeByName} convenience class.</li>
309 * <li>For Nashorn objects {@code getElem}, {@code getProp}, and {@code getMethod} are handled almost identically,
310 * since JavaScript doesn't distinguish between different kinds of properties on an object. Either can be used with
311 * fixed property name or a variable property name. The only significant difference is handling of missing
312 * properties: {@code getMethod} for a missing member will link to a potential invocation of
313 * {@code __noSuchMethod__} on the object, {@code getProp} for a missing member will link to a potential invocation
314 * of {@code __noSuchProperty__}, while {@code getElem} for a missing member will link to an empty getter.</li>
315 * <li>In similar vein, {@code setElem} and {@code setProp} are handled identically on Nashorn objects.</li>
316 * <li>There's no rule that the variable property identifier has to be a {@code String} for {@code getProp/setProp}
317 * and {@code int} for {@code getElem/setElem}. You can declare their type to be {@code int}, {@code double},
318 * {@code Object}, and so on regardless of the kind of the operation.</li>
319 * <li>You can be as specific in parameter types as you want. E.g. if you know that the receiver of the operation
320 * will always be {@code ScriptObject}, you can pass {@code ScriptObject.class} as its parameter type. If you happen
321 * to link to a method that expects different types, (you can use these invokers on POJOs too, after all, and end up
322 * linking with their methods that have strongly-typed signatures), all necessary conversions allowed by either Java
323 * or JavaScript will be applied: if invoked methods specify either primitive or wrapped Java numeric types, or
324 * {@code String} or {@code boolean/Boolean}, then the parameters might be subjected to standard ECMAScript
325 * {@code ToNumber}, {@code ToString}, and {@code ToBoolean} conversion, respectively. Less obviously, if the
326 * expected parameter type is a SAM type, and you pass a JavaScript function, a proxy object implementing the SAM
327 * type and delegating to the function will be passed. Linkage can often be optimized when linkers have more
328 * specific type information than "everything can be an object".</li>
329 * <li>You can also be as specific in return types as you want. For return types any necessary type conversion
330 * available in either Java or JavaScript will be automatically applied, similar to the process described for
331 * parameters, only in reverse direction: if you specify any either primitive or wrapped Java numeric type, or
332 * {@code String} or {@code boolean/Boolean}, then the return values will be subjected to standard ECMAScript
333 * {@code ToNumber}, {@code ToString}, and {@code ToBoolean} conversion, respectively. Less obviously, if the return
334 * type is a SAM type, and the return value is a JavaScript function, a proxy object implementing the SAM type and
335 * delegating to the function will be returned.</li>
336 * </ul>
337 * @param opDesc Dynalink dynamic operation descriptor.
338 * @param rtype the return type for the operation
339 * @param ptypes the parameter types for the operation
340 * @return MethodHandle for invoking the operation.
341 */
342 public static MethodHandle createDynamicInvoker(final String opDesc, final Class<?> rtype, final Class<?>... ptypes) {
343 return createDynamicInvoker(opDesc, MethodType.methodType(rtype, ptypes));
344 }
345
346 /**
347 * Returns a dynamic invoker for a specified dynamic operation using the public lookup. Similar to
348 * {@link #createDynamicInvoker(String, Class, Class...)} but with an additional parameter to
349 * set the call site flags of the dynamic invoker.
350 * @param opDesc Dynalink dynamic operation descriptor.
351 * @param flags the call site flags for the operation
352 * @param rtype the return type for the operation
353 * @param ptypes the parameter types for the operation
354 * @return MethodHandle for invoking the operation.
355 */
356 public static MethodHandle createDynamicInvoker(final String opDesc, final int flags, final Class<?> rtype, final Class<?>... ptypes) {
357 return bootstrap(MethodHandles.publicLookup(), opDesc, MethodType.methodType(rtype, ptypes), flags).dynamicInvoker();
358 }
359
360 /**
361 * Returns a dynamic invoker for a specified dynamic operation using the public lookup. Similar to
362 * {@link #createDynamicInvoker(String, Class, Class...)} but with return and parameter types composed into a
363 * method type in the signature. See the discussion of that method for details.
364 * @param opDesc Dynalink dynamic operation descriptor.
365 * @param type the method type for the operation
366 * @return MethodHandle for invoking the operation.
367 */
368 public static MethodHandle createDynamicInvoker(final String opDesc, final MethodType type) {
369 return bootstrap(MethodHandles.publicLookup(), opDesc, type, 0).dynamicInvoker();
370 }
371
372 /**
373 * Binds any object Nashorn can use as a [[Callable]] to a receiver and optionally arguments.
374 * @param callable the callable to bind
375 * @param boundThis the bound "this" value.
376 * @param boundArgs the bound arguments. Can be either null or empty array to signify no arguments are bound.
377 * @return a bound callable.
378 * @throws ECMAException with {@code TypeError} if the object is not a callable.
379 */
380 public static Object bindCallable(final Object callable, final Object boundThis, final Object[] boundArgs) {
381 if (callable instanceof ScriptFunction) {
382 return ((ScriptFunction)callable).createBound(boundThis, boundArgs);
383 } else if (callable instanceof BoundCallable) {
384 return ((BoundCallable)callable).bind(boundArgs);
385 } else if (isCallable(callable)) {
386 return new BoundCallable(callable, boundThis, boundArgs);
387 }
388 throw notFunction(callable);
389 }
390
391 /**
392 * Creates a super-adapter for an adapter, that is, an adapter to the adapter that allows invocation of superclass
393 * methods on it.
394 * @param adapter the original adapter
395 * @return a new adapter that can be used to invoke super methods on the original adapter.
396 */
397 public static Object createSuperAdapter(final Object adapter) {
398 return new JavaSuperAdapter(adapter);
399 }
400
401 /**
402 * If the given class is a reflection-specific class (anything in {@code java.lang.reflect} and
403 * {@code java.lang.invoke} package, as well a {@link Class} and any subclass of {@link ClassLoader}) and there is
404 * a security manager in the system, then it checks the {@code nashorn.JavaReflection} {@code RuntimePermission}.
405 * @param clazz the class being tested
406 * @param isStatic is access checked for static members (or instance members)
407 */
408 public static void checkReflectionAccess(final Class<?> clazz, final boolean isStatic) {
409 ReflectionCheckLinker.checkReflectionAccess(clazz, isStatic);
410 }
411
412 /**
413 * Returns the Nashorn's internally used dynamic linker's services object. Note that in code that is processing a
414 * linking request, you will normally use the {@code LinkerServices} object passed by whatever top-level linker
415 * invoked the linking (if the call site is in Nashorn-generated code, you'll get this object anyway). You should
416 * only resort to retrieving a linker services object using this method when you need some linker services (e.g.
417 * type converter method handles) outside of a code path that is linking a call site.
418 * @return Nashorn's internal dynamic linker's services object.
419 */
420 public static LinkerServices getLinkerServices() {
421 return dynamicLinker.getLinkerServices();
422 }
423
424 /**
425 * Takes a guarded invocation, and ensures its method and guard conform to the type of the call descriptor, using
426 * all type conversions allowed by the linker's services. This method is used by Nashorn's linkers as a last step
427 * before returning guarded invocations. Most of the code used to produce the guarded invocations does not make an
428 * effort to coordinate types of the methods, and so a final type adjustment before a guarded invocation is returned
429 * to the aggregating linker is the responsibility of the linkers themselves.
430 * @param inv the guarded invocation that needs to be type-converted. Can be null.
431 * @param linkerServices the linker services object providing the type conversions.
432 * @param desc the call site descriptor to whose method type the invocation needs to conform.
433 * @return the type-converted guarded invocation. If input is null, null is returned. If the input invocation
434 * already conforms to the requested type, it is returned unchanged.
435 */
436 static GuardedInvocation asTypeSafeReturn(final GuardedInvocation inv, final LinkerServices linkerServices, final CallSiteDescriptor desc) {
437 return inv == null ? null : inv.asTypeSafeReturn(linkerServices, desc.getMethodType());
438 }
439
440 /**
441 * Adapts the return type of the method handle with {@code explicitCastArguments} when it is an unboxing
442 * conversion. This will ensure that nulls are unwrapped to false or 0.
443 * @param target the target method handle
444 * @param newType the desired new type. Note that this method does not adapt the method handle completely to the
445 * new type, it only adapts the return type; this is allowed as per
446 * {@link DynamicLinkerFactory#setAutoConversionStrategy(MethodTypeConversionStrategy)}, which is what this method
447 * is used for.
448 * @return the method handle with adapted return type, if it required an unboxing conversion.
449 */
450 private static MethodHandle unboxReturnType(final MethodHandle target, final MethodType newType) {
451 final MethodType targetType = target.type();
452 final Class<?> oldReturnType = targetType.returnType();
453 final Class<?> newReturnType = newType.returnType();
454 if (TypeUtilities.isWrapperType(oldReturnType)) {
455 if (newReturnType.isPrimitive()) {
456 // The contract of setAutoConversionStrategy is such that the difference between newType and targetType
457 // can only be JLS method invocation conversions.
458 assert TypeUtilities.isMethodInvocationConvertible(oldReturnType, newReturnType);
459 return MethodHandles.explicitCastArguments(target, targetType.changeReturnType(newReturnType));
460 }
461 } else if (oldReturnType == void.class && newReturnType == Object.class) {
462 return MethodHandles.filterReturnValue(target, VOID_TO_OBJECT);
463 }
464 return target;
465 }
466 }