src/jdk/internal/dynalink/DynamicLinker.java

Thu, 24 May 2018 16:39:31 +0800

author
aoqi
date
Thu, 24 May 2018 16:39:31 +0800
changeset 1959
61ffdd1b89f2
parent 1530
fd307cc5f58c
parent 1490
d85f981c8cf8
permissions
-rw-r--r--

Merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 /*
aoqi@0 27 * This file is available under and governed by the GNU General Public
aoqi@0 28 * License version 2 only, as published by the Free Software Foundation.
aoqi@0 29 * However, the following notice accompanied the original version of this
aoqi@0 30 * file, and Oracle licenses the original version of this file under the BSD
aoqi@0 31 * license:
aoqi@0 32 */
aoqi@0 33 /*
aoqi@0 34 Copyright 2009-2013 Attila Szegedi
aoqi@0 35
aoqi@0 36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
aoqi@0 37 and the BSD License (the "BSD License"), with licensee being free to
aoqi@0 38 choose either of the two at their discretion.
aoqi@0 39
aoqi@0 40 You may not use this file except in compliance with either the Apache
aoqi@0 41 License or the BSD License.
aoqi@0 42
aoqi@0 43 If you choose to use this file in compliance with the Apache License, the
aoqi@0 44 following notice applies to you:
aoqi@0 45
aoqi@0 46 You may obtain a copy of the Apache License at
aoqi@0 47
aoqi@0 48 http://www.apache.org/licenses/LICENSE-2.0
aoqi@0 49
aoqi@0 50 Unless required by applicable law or agreed to in writing, software
aoqi@0 51 distributed under the License is distributed on an "AS IS" BASIS,
aoqi@0 52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
aoqi@0 53 implied. See the License for the specific language governing
aoqi@0 54 permissions and limitations under the License.
aoqi@0 55
aoqi@0 56 If you choose to use this file in compliance with the BSD License, the
aoqi@0 57 following notice applies to you:
aoqi@0 58
aoqi@0 59 Redistribution and use in source and binary forms, with or without
aoqi@0 60 modification, are permitted provided that the following conditions are
aoqi@0 61 met:
aoqi@0 62 * Redistributions of source code must retain the above copyright
aoqi@0 63 notice, this list of conditions and the following disclaimer.
aoqi@0 64 * Redistributions in binary form must reproduce the above copyright
aoqi@0 65 notice, this list of conditions and the following disclaimer in the
aoqi@0 66 documentation and/or other materials provided with the distribution.
aoqi@0 67 * Neither the name of the copyright holder nor the names of
aoqi@0 68 contributors may be used to endorse or promote products derived from
aoqi@0 69 this software without specific prior written permission.
aoqi@0 70
aoqi@0 71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
aoqi@0 72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
aoqi@0 73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
aoqi@0 74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
aoqi@0 75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
aoqi@0 76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
aoqi@0 77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
aoqi@0 78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
aoqi@0 79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
aoqi@0 80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
aoqi@0 81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
aoqi@0 82 */
aoqi@0 83
aoqi@0 84 package jdk.internal.dynalink;
aoqi@0 85
aoqi@0 86 import java.lang.invoke.MethodHandle;
aoqi@0 87 import java.lang.invoke.MethodHandles;
aoqi@0 88 import java.lang.invoke.MethodType;
aoqi@0 89 import java.lang.invoke.MutableCallSite;
aoqi@0 90 import java.util.List;
sundar@1231 91 import java.util.Objects;
aoqi@0 92 import jdk.internal.dynalink.linker.GuardedInvocation;
aoqi@0 93 import jdk.internal.dynalink.linker.GuardingDynamicLinker;
aoqi@0 94 import jdk.internal.dynalink.linker.LinkRequest;
aoqi@0 95 import jdk.internal.dynalink.linker.LinkerServices;
aoqi@0 96 import jdk.internal.dynalink.support.CallSiteDescriptorFactory;
aoqi@0 97 import jdk.internal.dynalink.support.LinkRequestImpl;
aoqi@0 98 import jdk.internal.dynalink.support.Lookup;
aoqi@0 99 import jdk.internal.dynalink.support.RuntimeContextLinkRequestImpl;
aoqi@0 100
aoqi@0 101 /**
mhaupt@1402 102 * The linker for {@link RelinkableCallSite} objects. Users of it (scripting
mhaupt@1402 103 * frameworks and language runtimes) have to create a linker using the
mhaupt@1402 104 * {@link DynamicLinkerFactory} and invoke its link method from the invokedynamic
mhaupt@1402 105 * bootstrap methods to set the target of all the call sites in the code they
mhaupt@1402 106 * generate. Usual usage would be to create one class per language runtime to
mhaupt@1402 107 * contain one linker instance as:
aoqi@0 108 *
aoqi@0 109 * <pre>
aoqi@0 110 * class MyLanguageRuntime {
aoqi@0 111 * private static final GuardingDynamicLinker myLanguageLinker = new MyLanguageLinker();
aoqi@0 112 * private static final DynamicLinker dynamicLinker = createDynamicLinker();
aoqi@0 113 *
aoqi@0 114 * private static DynamicLinker createDynamicLinker() {
aoqi@0 115 * final DynamicLinkerFactory factory = new DynamicLinkerFactory();
aoqi@0 116 * factory.setPrioritizedLinker(myLanguageLinker);
aoqi@0 117 * return factory.createLinker();
aoqi@0 118 * }
aoqi@0 119 *
sundar@1530 120 * public static CallSite bootstrap(MethodHandles.Lookup lookup, String name, MethodType type) {
aoqi@0 121 * return dynamicLinker.link(new MonomorphicCallSite(CallSiteDescriptorFactory.create(lookup, name, type)));
aoqi@0 122 * }
aoqi@0 123 * }
aoqi@0 124 * </pre>
aoqi@0 125 *
aoqi@0 126 * Note how there are three components you will need to provide here:
aoqi@0 127 * <ul>
mhaupt@1402 128 *
mhaupt@1402 129 * <li>You're expected to provide a {@link GuardingDynamicLinker} for your own
mhaupt@1402 130 * language. If your runtime doesn't have its own language and/or object model
mhaupt@1402 131 * (i.e., it's a generic scripting shell), you don't need to implement a dynamic
mhaupt@1402 132 * linker; you would simply not invoke the {@code setPrioritizedLinker} method
mhaupt@1402 133 * on the factory, or even better, simply use {@link DefaultBootstrapper}.</li>
mhaupt@1402 134 *
mhaupt@1402 135 * <li>The performance of the programs can depend on your choice of the class to
mhaupt@1402 136 * represent call sites. The above example used {@link MonomorphicCallSite}, but
mhaupt@1402 137 * you might want to use {@link ChainedCallSite} instead. You'll need to
mhaupt@1402 138 * experiment and decide what fits your language runtime the best. You can
mhaupt@1402 139 * subclass either of these or roll your own if you need to.</li>
mhaupt@1402 140 *
mhaupt@1402 141 * <li>You also need to provide {@link CallSiteDescriptor}s to your call sites.
mhaupt@1402 142 * They are immutable objects that contain all the information about the call
mhaupt@1402 143 * site: the class performing the lookups, the name of the method being invoked,
mhaupt@1402 144 * and the method signature. The library has a default {@link CallSiteDescriptorFactory}
mhaupt@1402 145 * for descriptors that you can use, or you can create your own descriptor
mhaupt@1402 146 * classes, especially if you need to add further information (values passed in
aoqi@0 147 * additional parameters to the bootstrap method) to them.</li>
mhaupt@1402 148 *
aoqi@0 149 * </ul>
aoqi@0 150 *
aoqi@0 151 * @author Attila Szegedi
aoqi@0 152 */
aoqi@0 153 public class DynamicLinker {
aoqi@0 154 private static final String CLASS_NAME = DynamicLinker.class.getName();
aoqi@0 155 private static final String RELINK_METHOD_NAME = "relink";
aoqi@0 156
aoqi@0 157 private static final String INITIAL_LINK_CLASS_NAME = "java.lang.invoke.MethodHandleNatives";
aoqi@0 158 private static final String INITIAL_LINK_METHOD_NAME = "linkCallSite";
aoqi@0 159
aoqi@0 160 private final LinkerServices linkerServices;
attila@963 161 private final GuardedInvocationFilter prelinkFilter;
aoqi@0 162 private final int runtimeContextArgCount;
aoqi@0 163 private final boolean syncOnRelink;
aoqi@0 164 private final int unstableRelinkThreshold;
aoqi@0 165
aoqi@0 166 /**
aoqi@0 167 * Creates a new dynamic linker.
aoqi@0 168 *
aoqi@0 169 * @param linkerServices the linkerServices used by the linker, created by the factory.
attila@963 170 * @param prelinkFilter see {@link DynamicLinkerFactory#setPrelinkFilter(GuardedInvocationFilter)}
aoqi@0 171 * @param runtimeContextArgCount see {@link DynamicLinkerFactory#setRuntimeContextArgCount(int)}
aoqi@0 172 */
attila@963 173 DynamicLinker(final LinkerServices linkerServices, final GuardedInvocationFilter prelinkFilter, final int runtimeContextArgCount,
attila@963 174 final boolean syncOnRelink, final int unstableRelinkThreshold) {
aoqi@0 175 if(runtimeContextArgCount < 0) {
aoqi@0 176 throw new IllegalArgumentException("runtimeContextArgCount < 0");
aoqi@0 177 }
aoqi@0 178 if(unstableRelinkThreshold < 0) {
aoqi@0 179 throw new IllegalArgumentException("unstableRelinkThreshold < 0");
aoqi@0 180 }
attila@963 181 this.linkerServices = linkerServices;
attila@963 182 this.prelinkFilter = prelinkFilter;
aoqi@0 183 this.runtimeContextArgCount = runtimeContextArgCount;
aoqi@0 184 this.syncOnRelink = syncOnRelink;
aoqi@0 185 this.unstableRelinkThreshold = unstableRelinkThreshold;
aoqi@0 186 }
aoqi@0 187
aoqi@0 188 /**
mhaupt@1402 189 * Links an invokedynamic call site. It will install a method handle into
mhaupt@1402 190 * the call site that invokes the relinking mechanism of this linker. Next
mhaupt@1402 191 * time the call site is invoked, it will be linked for the actual arguments
mhaupt@1402 192 * it was invoked with.
aoqi@0 193 *
mhaupt@1402 194 * @param <T> the particular subclass of {@link RelinkableCallSite} for
mhaupt@1402 195 * which to create a link.
aoqi@0 196 * @param callSite the call site to link.
mhaupt@1402 197 *
aoqi@0 198 * @return the callSite, for easy call chaining.
aoqi@0 199 */
aoqi@0 200 public <T extends RelinkableCallSite> T link(final T callSite) {
aoqi@0 201 callSite.initialize(createRelinkAndInvokeMethod(callSite, 0));
aoqi@0 202 return callSite;
aoqi@0 203 }
aoqi@0 204
aoqi@0 205 /**
mhaupt@1402 206 * Returns the object representing the lower level linker services of this
mhaupt@1402 207 * class that are normally exposed to individual language-specific linkers.
mhaupt@1402 208 * While as a user of this class you normally only care about the
mhaupt@1402 209 * {@link #link(RelinkableCallSite)} method, in certain circumstances you
mhaupt@1402 210 * might want to use the lower level services directly; either to lookup
mhaupt@1402 211 * specific method handles, to access the type converters, and so on.
mhaupt@1402 212 *
aoqi@0 213 * @return the object representing the linker services of this class.
aoqi@0 214 */
aoqi@0 215 public LinkerServices getLinkerServices() {
aoqi@0 216 return linkerServices;
aoqi@0 217 }
aoqi@0 218
aoqi@0 219 private static final MethodHandle RELINK = Lookup.findOwnSpecial(MethodHandles.lookup(), RELINK_METHOD_NAME,
aoqi@0 220 MethodHandle.class, RelinkableCallSite.class, int.class, Object[].class);
aoqi@0 221
attila@962 222 private MethodHandle createRelinkAndInvokeMethod(final RelinkableCallSite callSite, final int relinkCount) {
aoqi@0 223 // Make a bound MH of invoke() for this linker and call site
aoqi@0 224 final MethodHandle boundRelinker = MethodHandles.insertArguments(RELINK, 0, this, callSite, Integer.valueOf(
aoqi@0 225 relinkCount));
aoqi@0 226 // Make a MH that gathers all arguments to the invocation into an Object[]
aoqi@0 227 final MethodType type = callSite.getDescriptor().getMethodType();
aoqi@0 228 final MethodHandle collectingRelinker = boundRelinker.asCollector(Object[].class, type.parameterCount());
aoqi@0 229 return MethodHandles.foldArguments(MethodHandles.exactInvoker(type), collectingRelinker.asType(
aoqi@0 230 type.changeReturnType(MethodHandle.class)));
aoqi@0 231 }
aoqi@0 232
aoqi@0 233 /**
aoqi@0 234 * Relinks a call site conforming to the invocation arguments.
aoqi@0 235 *
aoqi@0 236 * @param callSite the call site itself
aoqi@0 237 * @param arguments arguments to the invocation
mhaupt@1402 238 *
aoqi@0 239 * @return return the method handle for the invocation
mhaupt@1402 240 *
aoqi@0 241 * @throws Exception rethrows any exception thrown by the linkers
aoqi@0 242 */
aoqi@0 243 @SuppressWarnings("unused")
attila@962 244 private MethodHandle relink(final RelinkableCallSite callSite, final int relinkCount, final Object... arguments) throws Exception {
aoqi@0 245 final CallSiteDescriptor callSiteDescriptor = callSite.getDescriptor();
aoqi@0 246 final boolean unstableDetectionEnabled = unstableRelinkThreshold > 0;
aoqi@0 247 final boolean callSiteUnstable = unstableDetectionEnabled && relinkCount >= unstableRelinkThreshold;
aoqi@0 248 final LinkRequest linkRequest =
attila@963 249 runtimeContextArgCount == 0 ?
attila@963 250 new LinkRequestImpl(callSiteDescriptor, callSite, relinkCount, callSiteUnstable, arguments) :
attila@963 251 new RuntimeContextLinkRequestImpl(callSiteDescriptor, callSite, relinkCount, callSiteUnstable, arguments, runtimeContextArgCount);
aoqi@0 252
aoqi@0 253 GuardedInvocation guardedInvocation = linkerServices.getGuardedInvocation(linkRequest);
aoqi@0 254
aoqi@0 255 // None found - throw an exception
aoqi@0 256 if(guardedInvocation == null) {
aoqi@0 257 throw new NoSuchDynamicMethodException(callSiteDescriptor.toString());
aoqi@0 258 }
aoqi@0 259
aoqi@0 260 // If our call sites have a runtime context, and the linker produced a context-stripped invocation, adapt the
aoqi@0 261 // produced invocation into contextual invocation (by dropping the context...)
aoqi@0 262 if(runtimeContextArgCount > 0) {
aoqi@0 263 final MethodType origType = callSiteDescriptor.getMethodType();
aoqi@0 264 final MethodHandle invocation = guardedInvocation.getInvocation();
aoqi@0 265 if(invocation.type().parameterCount() == origType.parameterCount() - runtimeContextArgCount) {
aoqi@0 266 final List<Class<?>> prefix = origType.parameterList().subList(1, runtimeContextArgCount + 1);
aoqi@0 267 final MethodHandle guard = guardedInvocation.getGuard();
aoqi@0 268 guardedInvocation = guardedInvocation.dropArguments(1, prefix);
aoqi@0 269 }
aoqi@0 270 }
aoqi@0 271
attila@963 272 // Make sure we filter the invocation before linking it into the call site. This is typically used to match the
attila@963 273 // return type of the invocation to the call site.
attila@963 274 guardedInvocation = prelinkFilter.filter(guardedInvocation, linkRequest, linkerServices);
sundar@1231 275 Objects.requireNonNull(guardedInvocation);
attila@963 276
aoqi@0 277 int newRelinkCount = relinkCount;
aoqi@0 278 // Note that the short-circuited "&&" evaluation below ensures we'll increment the relinkCount until
aoqi@0 279 // threshold + 1 but not beyond that. Threshold + 1 is treated as a special value to signal that resetAndRelink
aoqi@0 280 // has already executed once for the unstable call site; we only want the call site to throw away its current
aoqi@0 281 // linkage once, when it transitions to unstable.
aoqi@0 282 if(unstableDetectionEnabled && newRelinkCount <= unstableRelinkThreshold && newRelinkCount++ == unstableRelinkThreshold) {
aoqi@0 283 callSite.resetAndRelink(guardedInvocation, createRelinkAndInvokeMethod(callSite, newRelinkCount));
aoqi@0 284 } else {
aoqi@0 285 callSite.relink(guardedInvocation, createRelinkAndInvokeMethod(callSite, newRelinkCount));
aoqi@0 286 }
aoqi@0 287 if(syncOnRelink) {
aoqi@0 288 MutableCallSite.syncAll(new MutableCallSite[] { (MutableCallSite)callSite });
aoqi@0 289 }
aoqi@0 290 return guardedInvocation.getInvocation();
aoqi@0 291 }
aoqi@0 292
aoqi@0 293 /**
mhaupt@1402 294 * Returns a stack trace element describing the location of the call site
mhaupt@1402 295 * currently being linked on the current thread. The operation internally
mhaupt@1402 296 * creates a Throwable object and inspects its stack trace, so it's
mhaupt@1402 297 * potentially expensive. The recommended usage for it is in writing
mhaupt@1402 298 * diagnostics code.
mhaupt@1402 299 *
mhaupt@1402 300 * @return a stack trace element describing the location of the call site
mhaupt@1402 301 * currently being linked, or null if it is not invoked while a call
mhaupt@1402 302 * site is being linked.
aoqi@0 303 */
aoqi@0 304 public static StackTraceElement getLinkedCallSiteLocation() {
aoqi@0 305 final StackTraceElement[] trace = new Throwable().getStackTrace();
aoqi@0 306 for(int i = 0; i < trace.length - 1; ++i) {
aoqi@0 307 final StackTraceElement frame = trace[i];
aoqi@0 308 if(isRelinkFrame(frame) || isInitialLinkFrame(frame)) {
aoqi@0 309 return trace[i + 1];
aoqi@0 310 }
aoqi@0 311 }
aoqi@0 312 return null;
aoqi@0 313 }
aoqi@0 314
aoqi@0 315 /**
mhaupt@1402 316 * Deprecated because of imprecise name.
mhaupt@1402 317 *
aoqi@0 318 * @deprecated Use {@link #getLinkedCallSiteLocation()} instead.
mhaupt@1402 319 *
aoqi@0 320 * @return see non-deprecated method
aoqi@0 321 */
aoqi@0 322 @Deprecated
aoqi@0 323 public static StackTraceElement getRelinkedCallSiteLocation() {
aoqi@0 324 return getLinkedCallSiteLocation();
aoqi@0 325 }
aoqi@0 326
aoqi@0 327 /**
mhaupt@1402 328 * Returns {@code true} if the frame represents {@code MethodHandleNatives.linkCallSite()},
mhaupt@1402 329 * the frame immediately on top of the call site frame when the call site is
mhaupt@1402 330 * being linked for the first time.
mhaupt@1402 331 *
aoqi@0 332 * @param frame the frame
mhaupt@1402 333 *
mhaupt@1402 334 * @return {@code true} if this frame represents {@code MethodHandleNatives.linkCallSite()}.
aoqi@0 335 */
aoqi@0 336 private static boolean isInitialLinkFrame(final StackTraceElement frame) {
aoqi@0 337 return testFrame(frame, INITIAL_LINK_METHOD_NAME, INITIAL_LINK_CLASS_NAME);
aoqi@0 338 }
aoqi@0 339
aoqi@0 340 /**
mhaupt@1402 341 * Returns {@code true} if the frame represents {@code DynamicLinker.relink()},
mhaupt@1402 342 * the frame immediately on top of the call site frame when the call site is
mhaupt@1402 343 * being relinked (linked for second and subsequent times).
mhaupt@1402 344 *
aoqi@0 345 * @param frame the frame
mhaupt@1402 346 *
mhaupt@1402 347 * @return {@code true} if this frame represents {@code DynamicLinker.relink()}.
aoqi@0 348 */
aoqi@0 349 private static boolean isRelinkFrame(final StackTraceElement frame) {
aoqi@0 350 return testFrame(frame, RELINK_METHOD_NAME, CLASS_NAME);
aoqi@0 351 }
aoqi@0 352
aoqi@0 353 private static boolean testFrame(final StackTraceElement frame, final String methodName, final String className) {
aoqi@0 354 return methodName.equals(frame.getMethodName()) && className.equals(frame.getClassName());
aoqi@0 355 }
aoqi@0 356 }

mercurial