Mon, 18 Feb 2013 16:00:15 +0100
8008371: Fix Dynalink compiler warnings and whitespace
Reviewed-by: jlaskey, sundar
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 */
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
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.
40 You may not use this file except in compliance with either the Apache
41 License or the BSD License.
43 If you choose to use this file in compliance with the Apache License, the
44 following notice applies to you:
46 You may obtain a copy of the Apache License at
48 http://www.apache.org/licenses/LICENSE-2.0
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.
56 If you choose to use this file in compliance with the BSD License, the
57 following notice applies to you:
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.
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 */
84 package jdk.internal.dynalink.beans;
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 jdk.internal.dynalink.linker.LinkerServices;
91 import jdk.internal.dynalink.support.Guards;
93 /**
94 * A dynamic method bound to exactly one, non-overloaded Java method. Handles varargs.
95 *
96 * @author Attila Szegedi
97 */
98 class SimpleDynamicMethod extends DynamicMethod {
99 private final MethodHandle target;
101 /**
102 * Creates a simple dynamic method with no name.
103 * @param target the target method handle
104 */
105 SimpleDynamicMethod(MethodHandle target) {
106 this(target, null);
107 }
109 /**
110 * Creates a new simple dynamic method, with a name constructed from the class name, method name, and handle
111 * signature.
112 *
113 * @param target the target method handle
114 * @param clazz the class declaring the method
115 * @param name the simple name of the method
116 */
117 SimpleDynamicMethod(MethodHandle target, Class<?> clazz, String name) {
118 this(target, getName(target, clazz, name));
119 }
121 SimpleDynamicMethod(MethodHandle target, String name) {
122 super(name);
123 this.target = target;
124 }
126 private static String getName(MethodHandle target, Class<?> clazz, String name) {
127 return getMethodNameWithSignature(target, getClassAndMethodName(clazz, name));
128 }
130 static String getMethodNameWithSignature(MethodHandle target, String methodName) {
131 final String typeStr = target.type().toString();
132 final int retTypeIndex = typeStr.lastIndexOf(')') + 1;
133 int secondParamIndex = typeStr.indexOf(',') + 1;
134 if(secondParamIndex == 0) {
135 secondParamIndex = retTypeIndex - 1;
136 }
137 return typeStr.substring(retTypeIndex) + " " + methodName + "(" + typeStr.substring(secondParamIndex, retTypeIndex);
138 }
140 /**
141 * Returns the target of this dynamic method
142 *
143 * @return the target of this dynamic method
144 */
145 MethodHandle getTarget() {
146 return target;
147 }
149 @Override
150 SimpleDynamicMethod getMethodForExactParamTypes(String paramTypes) {
151 return typeMatchesDescription(paramTypes, target.type()) ? this : null;
152 }
154 @Override
155 MethodHandle getInvocation(MethodType callSiteType, LinkerServices linkerServices) {
156 final MethodType methodType = target.type();
157 final int paramsLen = methodType.parameterCount();
158 final boolean varArgs = target.isVarargsCollector();
159 final MethodHandle fixTarget = varArgs ? target.asFixedArity() : target;
160 final int fixParamsLen = varArgs ? paramsLen - 1 : paramsLen;
161 final int argsLen = callSiteType.parameterCount();
162 if(argsLen < fixParamsLen) {
163 // Less actual arguments than number of fixed declared arguments; can't invoke.
164 return null;
165 }
166 // Method handle has the same number of fixed arguments as the call site type
167 if(argsLen == fixParamsLen) {
168 // Method handle that matches the number of actual arguments as the number of fixed arguments
169 final MethodHandle matchedMethod;
170 if(varArgs) {
171 // If vararg, add a zero-length array of the expected type as the last argument to signify no variable
172 // arguments.
173 matchedMethod = MethodHandles.insertArguments(fixTarget, fixParamsLen, Array.newInstance(
174 methodType.parameterType(fixParamsLen).getComponentType(), 0));
175 } else {
176 // Otherwise, just use the method
177 matchedMethod = fixTarget;
178 }
179 return createConvertingInvocation(matchedMethod, linkerServices, callSiteType);
180 }
182 // What's below only works for varargs
183 if(!varArgs) {
184 return null;
185 }
187 final Class<?> varArgType = methodType.parameterType(fixParamsLen);
188 // Handle a somewhat sinister corner case: caller passes exactly one argument in the vararg position, and we
189 // must handle both a prepacked vararg array as well as a genuine 1-long vararg sequence.
190 if(argsLen == paramsLen) {
191 final Class<?> callSiteLastArgType = callSiteType.parameterType(fixParamsLen);
192 if(varArgType.isAssignableFrom(callSiteLastArgType)) {
193 // Call site signature guarantees we'll always be passed a single compatible array; just link directly
194 // to the method.
195 return createConvertingInvocation(fixTarget, linkerServices, callSiteType);
196 }
197 if(!linkerServices.canConvert(callSiteLastArgType, varArgType)) {
198 // Call site signature guarantees the argument can definitely not be an array (i.e. it is primitive);
199 // link immediately to a vararg-packing method handle.
200 return createConvertingInvocation(collectArguments(fixTarget, argsLen), linkerServices, callSiteType);
201 }
202 // Call site signature makes no guarantees that the single argument in the vararg position will be
203 // compatible across all invocations. Need to insert an appropriate guard and fall back to generic vararg
204 // method when it is not.
205 return MethodHandles.guardWithTest(Guards.isInstance(varArgType, fixParamsLen, callSiteType),
206 createConvertingInvocation(fixTarget, linkerServices, callSiteType),
207 createConvertingInvocation(collectArguments(fixTarget, argsLen), linkerServices, callSiteType));
208 }
210 // Remaining case: more than one vararg.
211 return createConvertingInvocation(collectArguments(fixTarget, argsLen), linkerServices, callSiteType);
212 }
214 @Override
215 public boolean contains(MethodHandle mh) {
216 return target.type().parameterList().equals(mh.type().parameterList());
217 }
219 /**
220 * Creates a method handle out of the original target that will collect the varargs for the exact component type of
221 * the varArg array. Note that this will nicely trigger language-specific type converters for exactly those varargs
222 * for which it is necessary when later passed to linkerServices.convertArguments().
223 *
224 * @param target the original method handle
225 * @param parameterCount the total number of arguments in the new method handle
226 * @return a collecting method handle
227 */
228 static MethodHandle collectArguments(MethodHandle target, final int parameterCount) {
229 final MethodType methodType = target.type();
230 final int fixParamsLen = methodType.parameterCount() - 1;
231 final Class<?> arrayType = methodType.parameterType(fixParamsLen);
232 return target.asCollector(arrayType, parameterCount - fixParamsLen);
233 }
235 private static MethodHandle createConvertingInvocation(final MethodHandle sizedMethod,
236 final LinkerServices linkerServices, final MethodType callSiteType) {
237 return linkerServices.asType(sizedMethod, callSiteType);
238 }
239 }