Thu, 14 Feb 2013 13:22:26 +0100
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.linker; |
attila@90 | 85 | |
attila@90 | 86 | import java.lang.invoke.MethodHandle; |
attila@90 | 87 | import java.lang.invoke.MethodHandles; |
attila@90 | 88 | import java.lang.invoke.MethodType; |
attila@90 | 89 | import java.lang.invoke.SwitchPoint; |
attila@90 | 90 | import java.lang.invoke.WrongMethodTypeException; |
attila@90 | 91 | import java.util.List; |
attila@90 | 92 | import jdk.internal.dynalink.CallSiteDescriptor; |
attila@90 | 93 | import jdk.internal.dynalink.support.Guards; |
attila@90 | 94 | |
attila@90 | 95 | |
attila@90 | 96 | /** |
attila@90 | 97 | * Represents a conditionally valid method handle. It is an immutable triple of an invocation method handle, a guard |
attila@90 | 98 | * method handle that defines the applicability of the invocation handle, and a switch point that can be used for |
attila@90 | 99 | * external invalidation of the invocation handle. The invocation handle is suitable for invocation if the guard |
attila@90 | 100 | * handle returns true for its arguments, and as long as the switch point is not invalidated. Both the guard and the |
attila@90 | 101 | * switch point are optional; neither, one, or both can be present. |
attila@90 | 102 | * |
attila@90 | 103 | * @author Attila Szegedi |
attila@90 | 104 | */ |
attila@90 | 105 | public class GuardedInvocation { |
attila@90 | 106 | private final MethodHandle invocation; |
attila@90 | 107 | private final MethodHandle guard; |
attila@90 | 108 | private final SwitchPoint switchPoint; |
attila@90 | 109 | |
attila@90 | 110 | /** |
attila@90 | 111 | * Creates a new guarded invocation. |
attila@90 | 112 | * |
attila@90 | 113 | * @param invocation the method handle representing the invocation. Must not be null. |
attila@90 | 114 | * @param guard the method handle representing the guard. Must have the same method type as the invocation, except |
attila@90 | 115 | * it must return boolean. For some useful guards, check out the {@link Guards} class. It can be null to represent |
attila@90 | 116 | * an unconditional invocation, although that is unusual. |
attila@90 | 117 | * @throws NullPointerException if invocation is null. |
attila@90 | 118 | */ |
attila@90 | 119 | public GuardedInvocation(MethodHandle invocation, MethodHandle guard) { |
attila@90 | 120 | this(invocation, guard, null); |
attila@90 | 121 | } |
attila@90 | 122 | |
attila@90 | 123 | /** |
attila@90 | 124 | * Creates a new guarded invocation. |
attila@90 | 125 | * |
attila@90 | 126 | * @param invocation the method handle representing the invocation. Must not be null. |
attila@90 | 127 | * @param guard the method handle representing the guard. Must have the same method type as the invocation, except |
attila@90 | 128 | * it must return boolean. For some useful guards, check out the {@link Guards} class. It can be null. If both it |
attila@90 | 129 | * and the switch point are null, this represents an unconditional invocation, which is legal but unusual. |
attila@90 | 130 | * @param switchPoint the optional switch point that can be used to invalidate this linkage. |
attila@90 | 131 | * @throws NullPointerException if invocation is null. |
attila@90 | 132 | */ |
attila@90 | 133 | public GuardedInvocation(MethodHandle invocation, MethodHandle guard, SwitchPoint switchPoint) { |
attila@90 | 134 | invocation.getClass(); // NPE check |
attila@90 | 135 | this.invocation = invocation; |
attila@90 | 136 | this.guard = guard; |
attila@90 | 137 | this.switchPoint = switchPoint; |
attila@90 | 138 | } |
attila@90 | 139 | |
attila@90 | 140 | /** |
attila@90 | 141 | * Creates a new guarded invocation. |
attila@90 | 142 | * |
attila@90 | 143 | * @param invocation the method handle representing the invocation. Must not be null. |
attila@90 | 144 | * @param switchPoint the optional switch point that can be used to invalidate this linkage. |
attila@90 | 145 | * @param guard the method handle representing the guard. Must have the same method type as the invocation, except |
attila@90 | 146 | * it must return boolean. For some useful guards, check out the {@link Guards} class. It can be null. If both it |
attila@90 | 147 | * and the switch point are null, this represents an unconditional invocation, which is legal but unusual. |
attila@90 | 148 | * @throws NullPointerException if invocation is null. |
attila@90 | 149 | */ |
attila@90 | 150 | public GuardedInvocation(MethodHandle invocation, SwitchPoint switchPoint, MethodHandle guard) { |
attila@90 | 151 | this(invocation, guard, switchPoint); |
attila@90 | 152 | } |
attila@90 | 153 | /** |
attila@90 | 154 | * Returns the invocation method handle. |
attila@90 | 155 | * |
attila@90 | 156 | * @return the invocation method handle. It will never be null. |
attila@90 | 157 | */ |
attila@90 | 158 | public MethodHandle getInvocation() { |
attila@90 | 159 | return invocation; |
attila@90 | 160 | } |
attila@90 | 161 | |
attila@90 | 162 | /** |
attila@90 | 163 | * Returns the guard method handle. |
attila@90 | 164 | * |
attila@90 | 165 | * @return the guard method handle. Can be null. |
attila@90 | 166 | */ |
attila@90 | 167 | public MethodHandle getGuard() { |
attila@90 | 168 | return guard; |
attila@90 | 169 | } |
attila@90 | 170 | |
attila@90 | 171 | /** |
attila@90 | 172 | * Returns the switch point that can be used to invalidate the invocation handle. |
attila@90 | 173 | * |
attila@90 | 174 | * @return the switch point that can be used to invalidate the invocation handle. Can be null. |
attila@90 | 175 | */ |
attila@90 | 176 | public SwitchPoint getSwitchPoint() { |
attila@90 | 177 | return switchPoint; |
attila@90 | 178 | } |
attila@90 | 179 | |
attila@90 | 180 | /** |
attila@90 | 181 | * Returns true if and only if this guarded invocation has a switchpoint, and that switchpoint has been invalidated. |
attila@90 | 182 | * @return true if and only if this guarded invocation has a switchpoint, and that switchpoint has been invalidated. |
attila@90 | 183 | */ |
attila@90 | 184 | public boolean hasBeenInvalidated() { |
attila@90 | 185 | return switchPoint != null && switchPoint.hasBeenInvalidated(); |
attila@90 | 186 | } |
attila@90 | 187 | |
attila@90 | 188 | /** |
attila@90 | 189 | * Asserts that the invocation is of the specified type, and the guard (if present) is of the specified type with a |
attila@90 | 190 | * boolean return type. |
attila@90 | 191 | * |
attila@90 | 192 | * @param type the asserted type |
attila@90 | 193 | * @throws WrongMethodTypeException if the invocation and the guard are not of the expected method type. |
attila@90 | 194 | */ |
attila@90 | 195 | public void assertType(MethodType type) { |
attila@90 | 196 | assertType(invocation, type); |
attila@90 | 197 | if(guard != null) { |
attila@90 | 198 | assertType(guard, type.changeReturnType(Boolean.TYPE)); |
attila@90 | 199 | } |
attila@90 | 200 | } |
attila@90 | 201 | |
attila@90 | 202 | /** |
attila@90 | 203 | * Creates a new guarded invocation with different methods, preserving the switch point. |
attila@90 | 204 | * |
attila@90 | 205 | * @param newInvocation the new invocation |
attila@90 | 206 | * @param newGuard the new guard |
attila@90 | 207 | * @return a new guarded invocation with the replaced methods and the same switch point as this invocation. |
attila@90 | 208 | */ |
attila@90 | 209 | public GuardedInvocation replaceMethods(MethodHandle newInvocation, MethodHandle newGuard) { |
attila@90 | 210 | return new GuardedInvocation(newInvocation, newGuard, switchPoint); |
attila@90 | 211 | } |
attila@90 | 212 | |
attila@90 | 213 | private GuardedInvocation replaceMethodsOrThis(MethodHandle newInvocation, MethodHandle newGuard) { |
attila@90 | 214 | if(newInvocation == invocation && newGuard == guard) { |
attila@90 | 215 | return this; |
attila@90 | 216 | } |
attila@90 | 217 | return replaceMethods(newInvocation, newGuard); |
attila@90 | 218 | } |
attila@90 | 219 | |
attila@90 | 220 | /** |
attila@90 | 221 | * Changes the type of the invocation, as if {@link MethodHandle#asType(MethodType)} was applied to its invocation |
attila@90 | 222 | * and its guard, if it has one (with return type changed to boolean, and parameter count potentially truncated for |
attila@90 | 223 | * the guard). If the invocation already is of the required type, returns this object. |
attila@90 | 224 | * @param newType the new type of the invocation. |
attila@90 | 225 | * @return a guarded invocation with the new type applied to it. |
attila@90 | 226 | */ |
attila@90 | 227 | public GuardedInvocation asType(MethodType newType) { |
attila@90 | 228 | return replaceMethodsOrThis(invocation.asType(newType), guard == null ? null : Guards.asType(guard, newType)); |
attila@90 | 229 | } |
attila@90 | 230 | |
attila@90 | 231 | /** |
attila@90 | 232 | * Changes the type of the invocation, as if {@link LinkerServices#asType(MethodHandle, MethodType)} was applied to |
attila@90 | 233 | * its invocation and its guard, if it has one (with return type changed to boolean, and parameter count potentially |
attila@90 | 234 | * truncated for the guard). If the invocation already is of the required type, returns this object. |
attila@90 | 235 | * @param linkerServices the linker services to use for the conversion |
attila@90 | 236 | * @param newType the new type of the invocation. |
attila@90 | 237 | * @return a guarded invocation with the new type applied to it. |
attila@90 | 238 | */ |
attila@90 | 239 | public GuardedInvocation asType(LinkerServices linkerServices, MethodType newType) { |
attila@90 | 240 | return replaceMethodsOrThis(linkerServices.asType(invocation, newType), guard == null ? null : |
attila@90 | 241 | Guards.asType(linkerServices, guard, newType)); |
attila@90 | 242 | } |
attila@90 | 243 | |
attila@90 | 244 | /** |
attila@90 | 245 | * Changes the type of the invocation, as if {@link MethodHandle#asType(MethodType)} was applied to its invocation |
attila@90 | 246 | * and its guard, if it has one (with return type changed to boolean for guard). If the invocation already is of the |
attila@90 | 247 | * required type, returns this object. |
attila@90 | 248 | * @param desc a call descriptor whose method type is adapted. |
attila@90 | 249 | * @return a guarded invocation with the new type applied to it. |
attila@90 | 250 | */ |
attila@90 | 251 | public GuardedInvocation asType(CallSiteDescriptor desc) { |
attila@90 | 252 | return asType(desc.getMethodType()); |
attila@90 | 253 | } |
attila@90 | 254 | |
attila@90 | 255 | /** |
attila@90 | 256 | * Applies argument filters to both the invocation and the guard (if there is one). |
attila@90 | 257 | * @param pos the position of the first argumen being filtered |
attila@90 | 258 | * @param filters the argument filters |
attila@90 | 259 | * @return a filtered invocation |
attila@90 | 260 | */ |
attila@90 | 261 | public GuardedInvocation filterArguments(int pos, MethodHandle... filters) { |
attila@90 | 262 | return replaceMethods(MethodHandles.filterArguments(invocation, pos, filters), guard == null ? null : |
attila@90 | 263 | MethodHandles.filterArguments(guard, pos, filters)); |
attila@90 | 264 | } |
attila@90 | 265 | |
attila@90 | 266 | /** |
attila@90 | 267 | * Makes an invocation that drops arguments in both the invocation and the guard (if there is one). |
attila@90 | 268 | * @param pos the position of the first argument being dropped |
attila@90 | 269 | * @param valueTypes the types of the values being dropped |
attila@90 | 270 | * @return an invocation that drops arguments |
attila@90 | 271 | */ |
attila@90 | 272 | public GuardedInvocation dropArguments(int pos, List<Class<?>> valueTypes) { |
attila@90 | 273 | return replaceMethods(MethodHandles.dropArguments(invocation, pos, valueTypes), guard == null ? null : |
attila@90 | 274 | MethodHandles.dropArguments(guard, pos, valueTypes)); |
attila@90 | 275 | } |
attila@90 | 276 | |
attila@90 | 277 | /** |
attila@90 | 278 | * Makes an invocation that drops arguments in both the invocation and the guard (if there is one). |
attila@90 | 279 | * @param pos the position of the first argument being dropped |
attila@90 | 280 | * @param valueTypes the types of the values being dropped |
attila@90 | 281 | * @return an invocation that drops arguments |
attila@90 | 282 | */ |
attila@90 | 283 | public GuardedInvocation dropArguments(int pos, Class<?>... valueTypes) { |
attila@90 | 284 | return replaceMethods(MethodHandles.dropArguments(invocation, pos, valueTypes), guard == null ? null : |
attila@90 | 285 | MethodHandles.dropArguments(guard, pos, valueTypes)); |
attila@90 | 286 | } |
attila@90 | 287 | |
attila@90 | 288 | |
attila@90 | 289 | /** |
attila@90 | 290 | * Composes the invocation, switchpoint, and the guard into a composite method handle that knows how to fall back. |
attila@90 | 291 | * @param fallback the fallback method handle in case switchpoint is invalidated or guard returns false. |
attila@90 | 292 | * @return a composite method handle. |
attila@90 | 293 | */ |
attila@90 | 294 | public MethodHandle compose(MethodHandle fallback) { |
attila@90 | 295 | return compose(fallback, fallback); |
attila@90 | 296 | } |
attila@90 | 297 | |
attila@90 | 298 | /** |
attila@90 | 299 | * Composes the invocation, switchpoint, and the guard into a composite method handle that knows how to fall back. |
attila@90 | 300 | * @param switchpointFallback the fallback method handle in case switchpoint is invalidated. |
attila@90 | 301 | * @param guardFallback the fallback method handle in case guard returns false. |
attila@90 | 302 | * @return a composite method handle. |
attila@90 | 303 | */ |
attila@90 | 304 | public MethodHandle compose(MethodHandle switchpointFallback, MethodHandle guardFallback) { |
attila@90 | 305 | final MethodHandle guarded = |
attila@90 | 306 | guard == null ? invocation : MethodHandles.guardWithTest(guard, invocation, guardFallback); |
attila@90 | 307 | return switchPoint == null ? guarded : switchPoint.guardWithTest(guarded, switchpointFallback); |
attila@90 | 308 | } |
attila@90 | 309 | |
attila@90 | 310 | private static void assertType(MethodHandle mh, MethodType type) { |
attila@90 | 311 | if(!mh.type().equals(type)) { |
attila@90 | 312 | throw new WrongMethodTypeException("Expected type: " + type + " actual type: " + mh.type()); |
attila@90 | 313 | } |
attila@90 | 314 | } |
attila@90 | 315 | } |