src/jdk/internal/dynalink/DynamicLinkerFactory.java

Thu, 14 Feb 2013 13:22:26 +0100

author
attila
date
Thu, 14 Feb 2013 13:22:26 +0100
changeset 90
5a820fb11814
child 101
f8221ce53c2e
permissions
-rw-r--r--

8008085: Integrate Dynalink source code into Nashorn codebase
Reviewed-by: jlaskey, lagergren, sundar

attila@90 1 /*
attila@90 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
attila@90 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
attila@90 4 *
attila@90 5 * This code is free software; you can redistribute it and/or modify it
attila@90 6 * under the terms of the GNU General Public License version 2 only, as
attila@90 7 * published by the Free Software Foundation. Oracle designates this
attila@90 8 * particular file as subject to the "Classpath" exception as provided
attila@90 9 * by Oracle in the LICENSE file that accompanied this code.
attila@90 10 *
attila@90 11 * This code is distributed in the hope that it will be useful, but WITHOUT
attila@90 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
attila@90 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
attila@90 14 * version 2 for more details (a copy is included in the LICENSE file that
attila@90 15 * accompanied this code).
attila@90 16 *
attila@90 17 * You should have received a copy of the GNU General Public License version
attila@90 18 * 2 along with this work; if not, write to the Free Software Foundation,
attila@90 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
attila@90 20 *
attila@90 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
attila@90 22 * or visit www.oracle.com if you need additional information or have any
attila@90 23 * questions.
attila@90 24 */
attila@90 25
attila@90 26 /*
attila@90 27 * This file is available under and governed by the GNU General Public
attila@90 28 * License version 2 only, as published by the Free Software Foundation.
attila@90 29 * However, the following notice accompanied the original version of this
attila@90 30 * file, and Oracle licenses the original version of this file under the BSD
attila@90 31 * license:
attila@90 32 */
attila@90 33 /*
attila@90 34 Copyright 2009-2013 Attila Szegedi
attila@90 35
attila@90 36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
attila@90 37 and the BSD License (the "BSD License"), with licensee being free to
attila@90 38 choose either of the two at their discretion.
attila@90 39
attila@90 40 You may not use this file except in compliance with either the Apache
attila@90 41 License or the BSD License.
attila@90 42
attila@90 43 If you choose to use this file in compliance with the Apache License, the
attila@90 44 following notice applies to you:
attila@90 45
attila@90 46 You may obtain a copy of the Apache License at
attila@90 47
attila@90 48 http://www.apache.org/licenses/LICENSE-2.0
attila@90 49
attila@90 50 Unless required by applicable law or agreed to in writing, software
attila@90 51 distributed under the License is distributed on an "AS IS" BASIS,
attila@90 52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
attila@90 53 implied. See the License for the specific language governing
attila@90 54 permissions and limitations under the License.
attila@90 55
attila@90 56 If you choose to use this file in compliance with the BSD License, the
attila@90 57 following notice applies to you:
attila@90 58
attila@90 59 Redistribution and use in source and binary forms, with or without
attila@90 60 modification, are permitted provided that the following conditions are
attila@90 61 met:
attila@90 62 * Redistributions of source code must retain the above copyright
attila@90 63 notice, this list of conditions and the following disclaimer.
attila@90 64 * Redistributions in binary form must reproduce the above copyright
attila@90 65 notice, this list of conditions and the following disclaimer in the
attila@90 66 documentation and/or other materials provided with the distribution.
attila@90 67 * Neither the name of the copyright holder nor the names of
attila@90 68 contributors may be used to endorse or promote products derived from
attila@90 69 this software without specific prior written permission.
attila@90 70
attila@90 71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
attila@90 72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
attila@90 73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
attila@90 74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
attila@90 75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
attila@90 76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
attila@90 77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
attila@90 78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
attila@90 79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
attila@90 80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
attila@90 81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
attila@90 82 */
attila@90 83
attila@90 84 package jdk.internal.dynalink;
attila@90 85
attila@90 86 import java.lang.invoke.MutableCallSite;
attila@90 87 import java.util.ArrayList;
attila@90 88 import java.util.Arrays;
attila@90 89 import java.util.Collections;
attila@90 90 import java.util.HashSet;
attila@90 91 import java.util.LinkedList;
attila@90 92 import java.util.List;
attila@90 93 import java.util.Set;
attila@90 94 import jdk.internal.dynalink.beans.BeansLinker;
attila@90 95 import jdk.internal.dynalink.linker.GuardingDynamicLinker;
attila@90 96 import jdk.internal.dynalink.linker.GuardingTypeConverterFactory;
attila@90 97 import jdk.internal.dynalink.linker.LinkRequest;
attila@90 98 import jdk.internal.dynalink.support.AutoDiscovery;
attila@90 99 import jdk.internal.dynalink.support.BottomGuardingDynamicLinker;
attila@90 100 import jdk.internal.dynalink.support.CompositeGuardingDynamicLinker;
attila@90 101 import jdk.internal.dynalink.support.CompositeTypeBasedGuardingDynamicLinker;
attila@90 102 import jdk.internal.dynalink.support.LinkerServicesImpl;
attila@90 103 import jdk.internal.dynalink.support.TypeConverterFactory;
attila@90 104
attila@90 105
attila@90 106 /**
attila@90 107 * A factory class for creating {@link DynamicLinker}s. The most usual dynamic linker is a linker that is a composition
attila@90 108 * of all {@link GuardingDynamicLinker}s known and pre-created by the caller as well as any
attila@90 109 * {@link AutoDiscovery automatically discovered} guarding linkers and the standard fallback {@link BeansLinker}. See
attila@90 110 * {@link DynamicLinker} documentation for tips on how to use this class.
attila@90 111 *
attila@90 112 * @author Attila Szegedi
attila@90 113 */
attila@90 114 public class DynamicLinkerFactory {
attila@90 115
attila@90 116 /**
attila@90 117 * Default value for {@link #setUnstableRelinkThreshold(int) unstable relink threshold}.
attila@90 118 */
attila@90 119 public static final int DEFAULT_UNSTABLE_RELINK_THRESHOLD = 8;
attila@90 120
attila@90 121 private ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
attila@90 122 private List<? extends GuardingDynamicLinker> prioritizedLinkers;
attila@90 123 private List<? extends GuardingDynamicLinker> fallbackLinkers;
attila@90 124 private int runtimeContextArgCount = 0;
attila@90 125 private boolean syncOnRelink = false;
attila@90 126 private int unstableRelinkThreshold = DEFAULT_UNSTABLE_RELINK_THRESHOLD;
attila@90 127
attila@90 128 /**
attila@90 129 * Sets the class loader for automatic discovery of available linkers. If not set explicitly, then the thread
attila@90 130 * context class loader at the time of the constructor invocation will be used.
attila@90 131 *
attila@90 132 * @param classLoader the class loader used for the autodiscovery of available linkers.
attila@90 133 */
attila@90 134 public void setClassLoader(ClassLoader classLoader) {
attila@90 135 this.classLoader = classLoader;
attila@90 136 }
attila@90 137
attila@90 138 /**
attila@90 139 * Sets the prioritized linkers. Language runtimes using this framework will usually precreate at least the linker
attila@90 140 * for their own language. These linkers will be consulted first in the resulting dynamic linker, before any
attila@90 141 * autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the prioritized
attila@90 142 * linkers, it will be ignored and the explicit prioritized instance will be used.
attila@90 143 *
attila@90 144 * @param prioritizedLinkers the list of prioritized linkers. Null can be passed to indicate no prioritized linkers
attila@90 145 * (this is also the default value).
attila@90 146 */
attila@90 147 public void setPrioritizedLinkers(List<? extends GuardingDynamicLinker> prioritizedLinkers) {
attila@90 148 this.prioritizedLinkers =
attila@90 149 prioritizedLinkers == null ? null : new ArrayList<>(prioritizedLinkers);
attila@90 150 }
attila@90 151
attila@90 152 /**
attila@90 153 * Sets the prioritized linkers. Language runtimes using this framework will usually precreate at least the linker
attila@90 154 * for their own language. These linkers will be consulted first in the resulting dynamic linker, before any
attila@90 155 * autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the prioritized
attila@90 156 * linkers, it will be ignored and the explicit prioritized instance will be used.
attila@90 157 *
attila@90 158 * @param prioritizedLinkers a list of prioritized linkers.
attila@90 159 */
attila@90 160 public void setPrioritizedLinkers(GuardingDynamicLinker... prioritizedLinkers) {
attila@90 161 setPrioritizedLinkers(Arrays.asList(prioritizedLinkers));
attila@90 162 }
attila@90 163
attila@90 164 /**
attila@90 165 * Sets a single prioritized linker. Identical to calling {@link #setPrioritizedLinkers(List)} with a single-element
attila@90 166 * list.
attila@90 167 *
attila@90 168 * @param prioritizedLinker the single prioritized linker. Must not be null.
attila@90 169 * @throws IllegalArgumentException if null is passed.
attila@90 170 */
attila@90 171 public void setPrioritizedLinker(GuardingDynamicLinker prioritizedLinker) {
attila@90 172 if(prioritizedLinker == null) {
attila@90 173 throw new IllegalArgumentException("prioritizedLinker == null");
attila@90 174 }
attila@90 175 this.prioritizedLinkers = Collections.singletonList(prioritizedLinker);
attila@90 176 }
attila@90 177
attila@90 178 /**
attila@90 179 * Sets the fallback linkers. These linkers will be consulted last in the resulting composite linker, after any
attila@90 180 * autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the fallback
attila@90 181 * linkers, it will be ignored and the explicit fallback instance will be used.
attila@90 182 *
attila@90 183 * @param fallbackLinkers the list of fallback linkers. Can be empty to indicate the caller wishes to set no
attila@90 184 * fallback linkers.
attila@90 185 */
attila@90 186 public void setFallbackLinkers(List<? extends GuardingDynamicLinker> fallbackLinkers) {
attila@90 187 this.fallbackLinkers = fallbackLinkers == null ? null : new ArrayList<>(fallbackLinkers);
attila@90 188 }
attila@90 189
attila@90 190 /**
attila@90 191 * Sets the fallback linkers. These linkers will be consulted last in the resulting composite linker, after any
attila@90 192 * autodiscovered linkers. If the framework also autodiscovers a linker of the same class as one of the fallback
attila@90 193 * linkers, it will be ignored and the explicit fallback instance will be used.
attila@90 194 *
attila@90 195 * @param fallbackLinkers the list of fallback linkers. Can be empty to indicate the caller wishes to set no
attila@90 196 * fallback linkers. If it is left as null, the standard fallback {@link BeansLinker} will be used.
attila@90 197 */
attila@90 198 public void setFallbackLinkers(GuardingDynamicLinker... fallbackLinkers) {
attila@90 199 setFallbackLinkers(Arrays.asList(fallbackLinkers));
attila@90 200 }
attila@90 201
attila@90 202 /**
attila@90 203 * Sets the number of arguments in the call sites that represent the stack context of the language runtime creating
attila@90 204 * the linker. If the language runtime uses no context information passed on stack, then it should be zero
attila@90 205 * (the default value). If it is set to nonzero value, then every dynamic call site emitted by this runtime must
attila@90 206 * have the argument list of the form: {@code (this, contextArg1[, contextArg2[, ...]], normalArgs)}. It is
attila@90 207 * advisable to only pass one context-specific argument, though, of an easily recognizable, runtime specific type
attila@90 208 * encapsulating the runtime thread local state.
attila@90 209 *
attila@90 210 * @param runtimeContextArgCount the number of language runtime context arguments in call sites.
attila@90 211 */
attila@90 212 public void setRuntimeContextArgCount(int runtimeContextArgCount) {
attila@90 213 if(runtimeContextArgCount < 0) {
attila@90 214 throw new IllegalArgumentException("runtimeContextArgCount < 0");
attila@90 215 }
attila@90 216 this.runtimeContextArgCount = runtimeContextArgCount;
attila@90 217 }
attila@90 218
attila@90 219 /**
attila@90 220 * Sets whether the linker created by this factory will invoke {@link MutableCallSite#syncAll(MutableCallSite[])}
attila@90 221 * after a call site is relinked. Defaults to false. You probably want to set it to true if your runtime supports
attila@90 222 * multithreaded execution of dynamically linked code.
attila@90 223 * @param syncOnRelink true for invoking sync on relink, false otherwise.
attila@90 224 */
attila@90 225 public void setSyncOnRelink(boolean syncOnRelink) {
attila@90 226 this.syncOnRelink = syncOnRelink;
attila@90 227 }
attila@90 228
attila@90 229 /**
attila@90 230 * Sets the unstable relink threshold; the number of times a call site is relinked after which it will be
attila@90 231 * considered unstable, and subsequent link requests for it will indicate this.
attila@90 232 * @param unstableRelinkThreshold the new threshold. Must not be less than zero. The value of zero means that
attila@90 233 * call sites will never be considered unstable.
attila@90 234 * @see LinkRequest#isCallSiteUnstable()
attila@90 235 */
attila@90 236 public void setUnstableRelinkThreshold(int unstableRelinkThreshold) {
attila@90 237 if(unstableRelinkThreshold < 0) {
attila@90 238 throw new IllegalArgumentException("unstableRelinkThreshold < 0");
attila@90 239 }
attila@90 240 this.unstableRelinkThreshold = unstableRelinkThreshold;
attila@90 241 }
attila@90 242
attila@90 243 /**
attila@90 244 * Creates a new dynamic linker consisting of all the prioritized, autodiscovered, and fallback linkers.
attila@90 245 *
attila@90 246 * @return the new dynamic Linker
attila@90 247 */
attila@90 248 public DynamicLinker createLinker() {
attila@90 249 // Treat nulls appropriately
attila@90 250 if(prioritizedLinkers == null) {
attila@90 251 prioritizedLinkers = Collections.emptyList();
attila@90 252 }
attila@90 253 if(fallbackLinkers == null) {
attila@90 254 fallbackLinkers = Collections.singletonList(new BeansLinker());
attila@90 255 }
attila@90 256
attila@90 257 // Gather classes of all precreated (prioritized and fallback) linkers.
attila@90 258 // We'll filter out any discovered linkers of the same class.
attila@90 259 final Set<Class<? extends GuardingDynamicLinker>> knownLinkerClasses = new HashSet<>();
attila@90 260 addClasses(knownLinkerClasses, prioritizedLinkers);
attila@90 261 addClasses(knownLinkerClasses, fallbackLinkers);
attila@90 262
attila@90 263 final List<GuardingDynamicLinker> discovered = AutoDiscovery.loadLinkers(classLoader);
attila@90 264 // Now, concatenate ...
attila@90 265 final List<GuardingDynamicLinker> linkers = new ArrayList<>(prioritizedLinkers.size() + discovered.size()
attila@90 266 + fallbackLinkers.size());
attila@90 267 // ... prioritized linkers, ...
attila@90 268 linkers.addAll(prioritizedLinkers);
attila@90 269 // ... filtered discovered linkers, ...
attila@90 270 for(GuardingDynamicLinker linker: discovered) {
attila@90 271 if(!knownLinkerClasses.contains(linker.getClass())) {
attila@90 272 linkers.add(linker);
attila@90 273 }
attila@90 274 }
attila@90 275 // ... and finally fallback linkers.
attila@90 276 linkers.addAll(fallbackLinkers);
attila@90 277 final List<GuardingDynamicLinker> optimized = CompositeTypeBasedGuardingDynamicLinker.optimize(linkers);
attila@90 278 final GuardingDynamicLinker composite;
attila@90 279 switch(linkers.size()) {
attila@90 280 case 0: {
attila@90 281 composite = BottomGuardingDynamicLinker.INSTANCE;
attila@90 282 break;
attila@90 283 }
attila@90 284 case 1: {
attila@90 285 composite = optimized.get(0);
attila@90 286 break;
attila@90 287 }
attila@90 288 default: {
attila@90 289 composite = new CompositeGuardingDynamicLinker(optimized);
attila@90 290 break;
attila@90 291 }
attila@90 292 }
attila@90 293
attila@90 294 final List<GuardingTypeConverterFactory> typeConverters = new LinkedList<>();
attila@90 295 for(GuardingDynamicLinker linker: linkers) {
attila@90 296 if(linker instanceof GuardingTypeConverterFactory) {
attila@90 297 typeConverters.add((GuardingTypeConverterFactory)linker);
attila@90 298 }
attila@90 299 }
attila@90 300
attila@90 301 return new DynamicLinker(new LinkerServicesImpl(new TypeConverterFactory(typeConverters), composite),
attila@90 302 runtimeContextArgCount, syncOnRelink, unstableRelinkThreshold);
attila@90 303 }
attila@90 304
attila@90 305 private static void addClasses(Set<Class<? extends GuardingDynamicLinker>> knownLinkerClasses,
attila@90 306 List<? extends GuardingDynamicLinker> linkers) {
attila@90 307 for(GuardingDynamicLinker linker: linkers) {
attila@90 308 knownLinkerClasses.add(linker.getClass());
attila@90 309 }
attila@90 310 }
attila@90 311 }

mercurial