|
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.support; |
|
85 |
|
86 import java.lang.invoke.MethodHandle; |
|
87 import java.lang.invoke.MethodHandles; |
|
88 import java.lang.invoke.MethodType; |
|
89 import java.lang.invoke.WrongMethodTypeException; |
|
90 import java.util.LinkedList; |
|
91 import java.util.List; |
|
92 import jdk.internal.dynalink.linker.ConversionComparator; |
|
93 import jdk.internal.dynalink.linker.ConversionComparator.Comparison; |
|
94 import jdk.internal.dynalink.linker.GuardedInvocation; |
|
95 import jdk.internal.dynalink.linker.GuardingTypeConverterFactory; |
|
96 import jdk.internal.dynalink.linker.LinkerServices; |
|
97 |
|
98 |
|
99 /** |
|
100 * A factory for type converters. This class is the main implementation behind the |
|
101 * {@link LinkerServices#asType(MethodHandle, MethodType)}. It manages the known {@link GuardingTypeConverterFactory} |
|
102 * instances and creates appropriate converters for method handles. |
|
103 * |
|
104 * @author Attila Szegedi |
|
105 */ |
|
106 public class TypeConverterFactory { |
|
107 |
|
108 private final GuardingTypeConverterFactory[] factories; |
|
109 private final ConversionComparator[] comparators; |
|
110 |
|
111 private final ClassValue<ClassMap<MethodHandle>> converterMap = new ClassValue<ClassMap<MethodHandle>>() { |
|
112 @Override |
|
113 protected ClassMap<MethodHandle> computeValue(final Class<?> sourceType) { |
|
114 return new ClassMap<MethodHandle>(sourceType.getClassLoader()) { |
|
115 @Override |
|
116 protected MethodHandle computeValue(Class<?> targetType) { |
|
117 try { |
|
118 return createConverter(sourceType, targetType); |
|
119 } catch (RuntimeException e) { |
|
120 throw e; |
|
121 } catch (Exception e) { |
|
122 throw new RuntimeException(e); |
|
123 } |
|
124 } |
|
125 }; |
|
126 } |
|
127 }; |
|
128 |
|
129 private final ClassValue<ClassMap<MethodHandle>> converterIdentityMap = new ClassValue<ClassMap<MethodHandle>>() { |
|
130 @Override |
|
131 protected ClassMap<MethodHandle> computeValue(final Class<?> sourceType) { |
|
132 return new ClassMap<MethodHandle>(sourceType.getClassLoader()) { |
|
133 @Override |
|
134 protected MethodHandle computeValue(Class<?> targetType) { |
|
135 if(!canAutoConvert(sourceType, targetType)) { |
|
136 final MethodHandle converter = getTypeConverterNull(sourceType, targetType); |
|
137 if(converter != null) { |
|
138 return converter; |
|
139 } |
|
140 } |
|
141 return IDENTITY_CONVERSION.asType(MethodType.methodType(targetType, sourceType)); |
|
142 } |
|
143 }; |
|
144 } |
|
145 }; |
|
146 |
|
147 /** |
|
148 * Creates a new type converter factory from the available {@link GuardingTypeConverterFactory} instances. |
|
149 * |
|
150 * @param factories the {@link GuardingTypeConverterFactory} instances to compose. |
|
151 */ |
|
152 public TypeConverterFactory(Iterable<? extends GuardingTypeConverterFactory> factories) { |
|
153 final List<GuardingTypeConverterFactory> l = new LinkedList<>(); |
|
154 final List<ConversionComparator> c = new LinkedList<>(); |
|
155 for(GuardingTypeConverterFactory factory: factories) { |
|
156 l.add(factory); |
|
157 if(factory instanceof ConversionComparator) { |
|
158 c.add((ConversionComparator)factory); |
|
159 } |
|
160 } |
|
161 this.factories = l.toArray(new GuardingTypeConverterFactory[l.size()]); |
|
162 this.comparators = c.toArray(new ConversionComparator[c.size()]); |
|
163 |
|
164 } |
|
165 |
|
166 /** |
|
167 * Similar to {@link MethodHandle#asType(MethodType)} except it also hooks in method handles produced by |
|
168 * {@link GuardingTypeConverterFactory} implementations, providing for language-specific type coercing of |
|
169 * parameters. It will apply {@link MethodHandle#asType(MethodType)} for all primitive-to-primitive, |
|
170 * wrapper-to-primitive, primitive-to-wrapper conversions as well as for all upcasts. For all other conversions, |
|
171 * it'll insert {@link MethodHandles#filterArguments(MethodHandle, int, MethodHandle...)} with composite filters |
|
172 * provided by {@link GuardingTypeConverterFactory} implementations. |
|
173 * |
|
174 * @param handle target method handle |
|
175 * @param fromType the types of source arguments |
|
176 * @return a method handle that is a suitable combination of {@link MethodHandle#asType(MethodType)} and |
|
177 * {@link MethodHandles#filterArguments(MethodHandle, int, MethodHandle...)} with |
|
178 * {@link GuardingTypeConverterFactory} produced type converters as filters. |
|
179 */ |
|
180 public MethodHandle asType(MethodHandle handle, final MethodType fromType) { |
|
181 MethodHandle newHandle = handle; |
|
182 final MethodType toType = newHandle.type(); |
|
183 final int l = toType.parameterCount(); |
|
184 if(l != fromType.parameterCount()) { |
|
185 throw new WrongMethodTypeException("Parameter counts differ: " + handle.type() + " vs. " + fromType); |
|
186 } |
|
187 int pos = 0; |
|
188 final List<MethodHandle> converters = new LinkedList<>(); |
|
189 for(int i = 0; i < l; ++i) { |
|
190 final Class<?> fromParamType = fromType.parameterType(i); |
|
191 final Class<?> toParamType = toType.parameterType(i); |
|
192 if(canAutoConvert(fromParamType, toParamType)) { |
|
193 newHandle = applyConverters(newHandle, pos, converters); |
|
194 } else { |
|
195 final MethodHandle converter = getTypeConverterNull(fromParamType, toParamType); |
|
196 if(converter != null) { |
|
197 if(converters.isEmpty()) { |
|
198 pos = i; |
|
199 } |
|
200 converters.add(converter); |
|
201 } else { |
|
202 newHandle = applyConverters(newHandle, pos, converters); |
|
203 } |
|
204 } |
|
205 } |
|
206 newHandle = applyConverters(newHandle, pos, converters); |
|
207 |
|
208 // Convert return type |
|
209 final Class<?> fromRetType = fromType.returnType(); |
|
210 final Class<?> toRetType = toType.returnType(); |
|
211 if(fromRetType != Void.TYPE && toRetType != Void.TYPE) { |
|
212 if(!canAutoConvert(toRetType, fromRetType)) { |
|
213 final MethodHandle converter = getTypeConverterNull(toRetType, fromRetType); |
|
214 if(converter != null) { |
|
215 newHandle = MethodHandles.filterReturnValue(newHandle, converter); |
|
216 } |
|
217 } |
|
218 } |
|
219 |
|
220 // Take care of automatic conversions |
|
221 return newHandle.asType(fromType); |
|
222 } |
|
223 |
|
224 private static MethodHandle applyConverters(MethodHandle handle, int pos, List<MethodHandle> converters) { |
|
225 if(converters.isEmpty()) { |
|
226 return handle; |
|
227 } |
|
228 final MethodHandle newHandle = |
|
229 MethodHandles.filterArguments(handle, pos, converters.toArray(new MethodHandle[converters.size()])); |
|
230 converters.clear(); |
|
231 return newHandle; |
|
232 } |
|
233 |
|
234 /** |
|
235 * Returns true if there might exist a conversion between the requested types (either an automatic JVM conversion, |
|
236 * or one provided by any available {@link GuardingTypeConverterFactory}), or false if there definitely does not |
|
237 * exist a conversion between the requested types. Note that returning true does not guarantee that the conversion |
|
238 * will succeed at runtime (notably, if the "from" or "to" types are sufficiently generic), but returning false |
|
239 * guarantees that it would fail. |
|
240 * |
|
241 * @param from the source type for the conversion |
|
242 * @param to the target type for the conversion |
|
243 * @return true if there can be a conversion, false if there can not. |
|
244 */ |
|
245 public boolean canConvert(final Class<?> from, final Class<?> to) { |
|
246 return canAutoConvert(from, to) || getTypeConverterNull(from, to) != null; |
|
247 } |
|
248 |
|
249 /** |
|
250 * Determines which of the two type conversions from a source type to the two target types is preferred. This is |
|
251 * used for dynamic overloaded method resolution. If the source type is convertible to exactly one target type with |
|
252 * a method invocation conversion, it is chosen, otherwise available {@link ConversionComparator}s are consulted. |
|
253 * @param sourceType the source type. |
|
254 * @param targetType1 one potential target type |
|
255 * @param targetType2 another potential target type. |
|
256 * @return one of Comparison constants that establish which - if any - of the target types is preferable for the |
|
257 * conversion. |
|
258 */ |
|
259 public Comparison compareConversion(Class<?> sourceType, Class<?> targetType1, Class<?> targetType2) { |
|
260 for(ConversionComparator comparator: comparators) { |
|
261 final Comparison result = comparator.compareConversion(sourceType, targetType1, targetType2); |
|
262 if(result != Comparison.INDETERMINATE) { |
|
263 return result; |
|
264 } |
|
265 } |
|
266 if(TypeUtilities.isMethodInvocationConvertible(sourceType, targetType1)) { |
|
267 if(!TypeUtilities.isMethodInvocationConvertible(sourceType, targetType2)) { |
|
268 return Comparison.TYPE_1_BETTER; |
|
269 } |
|
270 } else if(TypeUtilities.isMethodInvocationConvertible(sourceType, targetType2)) { |
|
271 return Comparison.TYPE_2_BETTER; |
|
272 } |
|
273 return Comparison.INDETERMINATE; |
|
274 } |
|
275 |
|
276 /** |
|
277 * Determines whether it's safe to perform an automatic conversion between the source and target class. |
|
278 * |
|
279 * @param fromType convert from this class |
|
280 * @param toType convert to this class |
|
281 * @return true if it's safe to let MethodHandles.convertArguments() to handle this conversion. |
|
282 */ |
|
283 /*private*/ static boolean canAutoConvert(final Class<?> fromType, final Class<?> toType) { |
|
284 return TypeUtilities.isMethodInvocationConvertible(fromType, toType); |
|
285 } |
|
286 |
|
287 /*private*/ MethodHandle getTypeConverterNull(Class<?> sourceType, Class<?> targetType) { |
|
288 final MethodHandle converter = converterMap.get(sourceType).get(targetType); |
|
289 return converter == IDENTITY_CONVERSION ? null : converter; |
|
290 } |
|
291 |
|
292 /** |
|
293 * Given a source and target type, returns a method handle that converts between them. Never returns null; in worst |
|
294 * case it will return an identity conversion (that might fail for some values at runtime). You can use this method |
|
295 * if you have a piece of your program that is written in Java, and you need to reuse existing type conversion |
|
296 * machinery in a non-invokedynamic context. |
|
297 * @param sourceType the type to convert from |
|
298 * @param targetType the type to convert to |
|
299 * @return a method handle performing the conversion. |
|
300 */ |
|
301 public MethodHandle getTypeConverter(Class<?> sourceType, Class<?> targetType) { |
|
302 return converterIdentityMap.get(sourceType).get(targetType); |
|
303 } |
|
304 |
|
305 /*private*/ MethodHandle createConverter(Class<?> sourceType, Class<?> targetType) throws Exception { |
|
306 final MethodType type = MethodType.methodType(targetType, sourceType); |
|
307 final MethodHandle identity = IDENTITY_CONVERSION.asType(type); |
|
308 MethodHandle last = identity; |
|
309 for(int i = factories.length; i-- > 0;) { |
|
310 final GuardedInvocation next = factories[i].convertToType(sourceType, targetType); |
|
311 if(next != null) { |
|
312 next.assertType(type); |
|
313 last = next.compose(last); |
|
314 } |
|
315 } |
|
316 return last == identity ? IDENTITY_CONVERSION : last; |
|
317 } |
|
318 |
|
319 /*private*/ static final MethodHandle IDENTITY_CONVERSION = MethodHandles.identity(Object.class); |
|
320 } |