src/jdk/internal/dynalink/beans/SingleDynamicMethod.java

changeset 0
b1a7da25b547
child 952
6d5471a497fb
equal deleted inserted replaced
-1:000000000000 0:b1a7da25b547
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 /*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file, and Oracle licenses the original version of this file under the BSD
31 * license:
32 */
33 /*
34 Copyright 2009-2013 Attila Szegedi
35
36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
37 and the BSD License (the "BSD License"), with licensee being free to
38 choose either of the two at their discretion.
39
40 You may not use this file except in compliance with either the Apache
41 License or the BSD License.
42
43 If you choose to use this file in compliance with the Apache License, the
44 following notice applies to you:
45
46 You may obtain a copy of the Apache License at
47
48 http://www.apache.org/licenses/LICENSE-2.0
49
50 Unless required by applicable law or agreed to in writing, software
51 distributed under the License is distributed on an "AS IS" BASIS,
52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
53 implied. See the License for the specific language governing
54 permissions and limitations under the License.
55
56 If you choose to use this file in compliance with the BSD License, the
57 following notice applies to you:
58
59 Redistribution and use in source and binary forms, with or without
60 modification, are permitted provided that the following conditions are
61 met:
62 * Redistributions of source code must retain the above copyright
63 notice, this list of conditions and the following disclaimer.
64 * Redistributions in binary form must reproduce the above copyright
65 notice, this list of conditions and the following disclaimer in the
66 documentation and/or other materials provided with the distribution.
67 * Neither the name of the copyright holder nor the names of
68 contributors may be used to endorse or promote products derived from
69 this software without specific prior written permission.
70
71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
82 */
83
84 package jdk.internal.dynalink.beans;
85
86 import java.lang.invoke.MethodHandle;
87 import java.lang.invoke.MethodHandles;
88 import java.lang.invoke.MethodType;
89 import java.lang.reflect.Array;
90 import java.util.StringTokenizer;
91 import jdk.internal.dynalink.CallSiteDescriptor;
92 import jdk.internal.dynalink.linker.LinkerServices;
93 import jdk.internal.dynalink.support.Guards;
94 import jdk.internal.dynalink.support.Lookup;
95
96 /**
97 * Base class for dynamic methods that dispatch to a single target Java method or constructor. Handles adaptation of the
98 * target method to a call site type (including mapping variable arity methods to a call site signature with different
99 * arity).
100 * @author Attila Szegedi
101 * @version $Id: $
102 */
103 abstract class SingleDynamicMethod extends DynamicMethod {
104
105 private static final MethodHandle CAN_CONVERT_TO = Lookup.findOwnStatic(MethodHandles.lookup(), "canConvertTo", boolean.class, LinkerServices.class, Class.class, Object.class);
106
107 SingleDynamicMethod(String name) {
108 super(name);
109 }
110
111 /**
112 * Returns true if this method is variable arity.
113 * @return true if this method is variable arity.
114 */
115 abstract boolean isVarArgs();
116
117 /**
118 * Returns this method's native type.
119 * @return this method's native type.
120 */
121 abstract MethodType getMethodType();
122
123 /**
124 * Given a specified lookup, returns a method handle to this method's target.
125 * @param lookup the lookup to use.
126 * @return the handle to this method's target method.
127 */
128 abstract MethodHandle getTarget(MethodHandles.Lookup lookup);
129
130 @Override
131 MethodHandle getInvocation(CallSiteDescriptor callSiteDescriptor, LinkerServices linkerServices) {
132 return getInvocation(getTarget(callSiteDescriptor.getLookup()), callSiteDescriptor.getMethodType(),
133 linkerServices);
134 }
135
136 @Override
137 SingleDynamicMethod getMethodForExactParamTypes(String paramTypes) {
138 return typeMatchesDescription(paramTypes, getMethodType()) ? this : null;
139 }
140
141 @Override
142 boolean contains(SingleDynamicMethod method) {
143 return getMethodType().parameterList().equals(method.getMethodType().parameterList());
144 }
145
146 static String getMethodNameWithSignature(MethodType type, String methodName) {
147 final String typeStr = type.toString();
148 final int retTypeIndex = typeStr.lastIndexOf(')') + 1;
149 int secondParamIndex = typeStr.indexOf(',') + 1;
150 if(secondParamIndex == 0) {
151 secondParamIndex = retTypeIndex - 1;
152 }
153 return typeStr.substring(retTypeIndex) + " " + methodName + "(" + typeStr.substring(secondParamIndex, retTypeIndex);
154 }
155
156 /**
157 * Given a method handle and a call site type, adapts the method handle to the call site type. Performs type
158 * conversions as needed using the specified linker services, and in case that the method handle is a vararg
159 * collector, matches it to the arity of the call site.
160 * @param target the method handle to adapt
161 * @param callSiteType the type of the call site
162 * @param linkerServices the linker services used for type conversions
163 * @return the adapted method handle.
164 */
165 static MethodHandle getInvocation(MethodHandle target, MethodType callSiteType, LinkerServices linkerServices) {
166 final MethodType methodType = target.type();
167 final int paramsLen = methodType.parameterCount();
168 final boolean varArgs = target.isVarargsCollector();
169 final MethodHandle fixTarget = varArgs ? target.asFixedArity() : target;
170 final int fixParamsLen = varArgs ? paramsLen - 1 : paramsLen;
171 final int argsLen = callSiteType.parameterCount();
172 if(argsLen < fixParamsLen) {
173 // Less actual arguments than number of fixed declared arguments; can't invoke.
174 return null;
175 }
176 // Method handle has the same number of fixed arguments as the call site type
177 if(argsLen == fixParamsLen) {
178 // Method handle that matches the number of actual arguments as the number of fixed arguments
179 final MethodHandle matchedMethod;
180 if(varArgs) {
181 // If vararg, add a zero-length array of the expected type as the last argument to signify no variable
182 // arguments.
183 matchedMethod = MethodHandles.insertArguments(fixTarget, fixParamsLen, Array.newInstance(
184 methodType.parameterType(fixParamsLen).getComponentType(), 0));
185 } else {
186 // Otherwise, just use the method
187 matchedMethod = fixTarget;
188 }
189 return createConvertingInvocation(matchedMethod, linkerServices, callSiteType);
190 }
191
192 // What's below only works for varargs
193 if(!varArgs) {
194 return null;
195 }
196
197 final Class<?> varArgType = methodType.parameterType(fixParamsLen);
198 // Handle a somewhat sinister corner case: caller passes exactly one argument in the vararg position, and we
199 // must handle both a prepacked vararg array as well as a genuine 1-long vararg sequence.
200 if(argsLen == paramsLen) {
201 final Class<?> callSiteLastArgType = callSiteType.parameterType(fixParamsLen);
202 if(varArgType.isAssignableFrom(callSiteLastArgType)) {
203 // Call site signature guarantees we'll always be passed a single compatible array; just link directly
204 // to the method, introducing necessary conversions. Also, preserve it being a variable arity method.
205 return createConvertingInvocation(target, linkerServices, callSiteType).asVarargsCollector(
206 callSiteLastArgType);
207 }
208
209 // This method handle takes the single argument and packs it into a newly allocated single-element array. It
210 // will be used when the incoming argument can't be converted to the vararg array type (the "vararg packer"
211 // method).
212 final MethodHandle varArgCollectingInvocation = createConvertingInvocation(collectArguments(fixTarget,
213 argsLen), linkerServices, callSiteType);
214
215 // Is call site type assignable from an array type (e.g. Object:int[], or Object[]:String[])
216 final boolean isAssignableFromArray = callSiteLastArgType.isAssignableFrom(varArgType);
217 // Do we have a custom conversion that can potentially convert the call site type to an array?
218 final boolean isCustomConvertible = linkerServices.canConvert(callSiteLastArgType, varArgType);
219 if(!isAssignableFromArray && !isCustomConvertible) {
220 // Call site signature guarantees the argument can definitely not be converted to an array (i.e. it is
221 // primitive), and no conversion can help with it either. Link immediately to a vararg-packing method
222 // handle.
223 return varArgCollectingInvocation;
224 }
225
226 // This method handle employs language-specific conversions to convert the last argument into an array of
227 // vararg type.
228 final MethodHandle arrayConvertingInvocation = createConvertingInvocation(MethodHandles.filterArguments(
229 fixTarget, fixParamsLen, linkerServices.getTypeConverter(callSiteLastArgType, varArgType)),
230 linkerServices, callSiteType);
231
232 // This method handle determines whether the value can be converted to the array of vararg type using a
233 // language-specific conversion.
234 final MethodHandle canConvertArgToArray = MethodHandles.insertArguments(CAN_CONVERT_TO, 0, linkerServices,
235 varArgType);
236
237 // This one adjusts the previous one for the location of the argument and the call site type.
238 final MethodHandle canConvertLastArgToArray = MethodHandles.dropArguments(canConvertArgToArray, 0,
239 MethodType.genericMethodType(fixParamsLen).parameterList()).asType(callSiteType.changeReturnType(boolean.class));
240
241 // This one takes the previous ones and combines them into a method handle that converts the argument into
242 // a vararg array when it can, otherwise falls back to the vararg packer.
243 final MethodHandle convertToArrayWhenPossible = MethodHandles.guardWithTest(canConvertLastArgToArray,
244 arrayConvertingInvocation, varArgCollectingInvocation);
245
246 if(isAssignableFromArray) {
247 return MethodHandles.guardWithTest(
248 // Is incoming parameter already a compatible array?
249 Guards.isInstance(varArgType, fixParamsLen, callSiteType),
250 // Yes: just pass it to the method
251 createConvertingInvocation(fixTarget, linkerServices, callSiteType),
252 // No: either go through a custom conversion, or if it is not possible, go directly to the
253 // vararg packer.
254 isCustomConvertible ? convertToArrayWhenPossible : varArgCollectingInvocation);
255 }
256
257 // Just do the custom conversion with fallback to the vararg packer logic.
258 assert isCustomConvertible;
259 return convertToArrayWhenPossible;
260 }
261
262 // Remaining case: more than one vararg.
263 return createConvertingInvocation(collectArguments(fixTarget, argsLen), linkerServices, callSiteType);
264 }
265
266 @SuppressWarnings("unused")
267 private static boolean canConvertTo(final LinkerServices linkerServices, Class<?> to, Object obj) {
268 return obj == null ? false : linkerServices.canConvert(obj.getClass(), to);
269 }
270
271 /**
272 * Creates a method handle out of the original target that will collect the varargs for the exact component type of
273 * the varArg array. Note that this will nicely trigger language-specific type converters for exactly those varargs
274 * for which it is necessary when later passed to linkerServices.convertArguments().
275 *
276 * @param target the original method handle
277 * @param parameterCount the total number of arguments in the new method handle
278 * @return a collecting method handle
279 */
280 static MethodHandle collectArguments(MethodHandle target, final int parameterCount) {
281 final MethodType methodType = target.type();
282 final int fixParamsLen = methodType.parameterCount() - 1;
283 final Class<?> arrayType = methodType.parameterType(fixParamsLen);
284 return target.asCollector(arrayType, parameterCount - fixParamsLen);
285 }
286
287 private static MethodHandle createConvertingInvocation(final MethodHandle sizedMethod,
288 final LinkerServices linkerServices, final MethodType callSiteType) {
289 return linkerServices.asType(sizedMethod, callSiteType);
290 }
291
292 private static boolean typeMatchesDescription(String paramTypes, MethodType type) {
293 final StringTokenizer tok = new StringTokenizer(paramTypes, ", ");
294 for(int i = 1; i < type.parameterCount(); ++i) { // i = 1 as we ignore the receiver
295 if(!(tok.hasMoreTokens() && typeNameMatches(tok.nextToken(), type.parameterType(i)))) {
296 return false;
297 }
298 }
299 return !tok.hasMoreTokens();
300 }
301
302 private static boolean typeNameMatches(String typeName, Class<?> type) {
303 return typeName.equals(typeName.indexOf('.') == -1 ? type.getSimpleName() : type.getCanonicalName());
304 }
305 }

mercurial