OverloadedMethod.java revision 1551:f3b883bec2d0
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 84package jdk.dynalink.beans; 85 86import java.lang.invoke.MethodHandle; 87import java.lang.invoke.MethodHandles; 88import java.lang.invoke.MethodType; 89import java.util.ArrayList; 90import java.util.Iterator; 91import java.util.List; 92import java.util.Map; 93import java.util.concurrent.ConcurrentHashMap; 94import jdk.dynalink.internal.InternalTypeUtilities; 95import jdk.dynalink.linker.LinkerServices; 96import jdk.dynalink.linker.support.Lookup; 97 98/** 99 * Represents a subset of overloaded methods for a certain method name on a certain class. It can be either a fixarg or 100 * a vararg subset depending on the subclass. The method is for a fixed number of arguments though (as it is generated 101 * for a concrete call site). As such, all methods in the subset can be invoked with the specified number of arguments 102 * (exactly matching for fixargs, or having less than or equal fixed arguments, for varargs). 103 */ 104class OverloadedMethod { 105 private final Map<ClassString, MethodHandle> argTypesToMethods = new ConcurrentHashMap<>(); 106 private final OverloadedDynamicMethod parent; 107 private final ClassLoader callSiteClassLoader; 108 private final MethodType callSiteType; 109 private final MethodHandle invoker; 110 private final LinkerServices linkerServices; 111 private final ArrayList<MethodHandle> fixArgMethods; 112 private final ArrayList<MethodHandle> varArgMethods; 113 114 OverloadedMethod(final List<MethodHandle> methodHandles, 115 final OverloadedDynamicMethod parent, 116 final ClassLoader callSiteClassLoader, 117 final MethodType callSiteType, 118 final LinkerServices linkerServices) { 119 this.parent = parent; 120 this.callSiteClassLoader = callSiteClassLoader; 121 final Class<?> commonRetType = getCommonReturnType(methodHandles); 122 this.callSiteType = callSiteType.changeReturnType(commonRetType); 123 this.linkerServices = linkerServices; 124 125 fixArgMethods = new ArrayList<>(methodHandles.size()); 126 varArgMethods = new ArrayList<>(methodHandles.size()); 127 final int argNum = callSiteType.parameterCount(); 128 for(final MethodHandle mh: methodHandles) { 129 if(mh.isVarargsCollector()) { 130 final MethodHandle asFixed = mh.asFixedArity(); 131 if(argNum == asFixed.type().parameterCount()) { 132 fixArgMethods.add(asFixed); 133 } 134 varArgMethods.add(mh); 135 } else { 136 fixArgMethods.add(mh); 137 } 138 } 139 fixArgMethods.trimToSize(); 140 varArgMethods.trimToSize(); 141 142 final MethodHandle bound = SELECT_METHOD.bindTo(this); 143 final MethodHandle collecting = SingleDynamicMethod.collectArguments(bound, argNum).asType( 144 callSiteType.changeReturnType(MethodHandle.class)); 145 invoker = linkerServices.asTypeLosslessReturn(MethodHandles.foldArguments( 146 MethodHandles.exactInvoker(this.callSiteType), collecting), callSiteType); 147 } 148 149 MethodHandle getInvoker() { 150 return invoker; 151 } 152 153 private static final MethodHandle SELECT_METHOD = Lookup.findOwnSpecial(MethodHandles.lookup(), "selectMethod", 154 MethodHandle.class, Object[].class); 155 156 @SuppressWarnings("unused") 157 private MethodHandle selectMethod(final Object[] args) throws NoSuchMethodException { 158 final Class<?>[] argTypes = new Class<?>[args.length]; 159 for(int i = 0; i < argTypes.length; ++i) { 160 final Object arg = args[i]; 161 argTypes[i] = arg == null ? ClassString.NULL_CLASS : arg.getClass(); 162 } 163 final ClassString classString = new ClassString(argTypes); 164 MethodHandle method = argTypesToMethods.get(classString); 165 if(method == null) { 166 List<MethodHandle> methods = classString.getMaximallySpecifics(fixArgMethods, linkerServices, false); 167 if(methods.isEmpty()) { 168 methods = classString.getMaximallySpecifics(varArgMethods, linkerServices, true); 169 } 170 switch(methods.size()) { 171 case 0: { 172 method = getNoSuchMethodThrower(argTypes); 173 break; 174 } 175 case 1: { 176 method = SingleDynamicMethod.getInvocation(methods.get(0), callSiteType, linkerServices); 177 break; 178 } 179 default: { 180 // This is unfortunate - invocation time ambiguity. We can still save the day if 181 method = getAmbiguousMethodThrower(argTypes, methods); 182 break; 183 } 184 } 185 // Avoid keeping references to unrelated classes; this ruins the 186 // performance a bit, but avoids class loader memory leaks. 187 if(classString.isVisibleFrom(callSiteClassLoader)) { 188 argTypesToMethods.put(classString, method); 189 } 190 } 191 return method; 192 } 193 194 private MethodHandle getNoSuchMethodThrower(final Class<?>[] argTypes) { 195 return adaptThrower(MethodHandles.insertArguments(THROW_NO_SUCH_METHOD, 0, this, argTypes)); 196 } 197 198 private static final MethodHandle THROW_NO_SUCH_METHOD = Lookup.findOwnSpecial(MethodHandles.lookup(), 199 "throwNoSuchMethod", void.class, Class[].class); 200 201 @SuppressWarnings("unused") 202 private void throwNoSuchMethod(final Class<?>[] argTypes) throws NoSuchMethodException { 203 if(varArgMethods.isEmpty()) { 204 throw new NoSuchMethodException("None of the fixed arity signatures " + getSignatureList(fixArgMethods) + 205 " of method " + parent.getName() + " match the argument types " + argTypesString(argTypes)); 206 } 207 throw new NoSuchMethodException("None of the fixed arity signatures " + getSignatureList(fixArgMethods) + 208 " or the variable arity signatures " + getSignatureList(varArgMethods) + " of the method " + 209 parent.getName() + " match the argument types " + argTypesString(argTypes)); 210 } 211 212 private MethodHandle getAmbiguousMethodThrower(final Class<?>[] argTypes, final List<MethodHandle> methods) { 213 return adaptThrower(MethodHandles.insertArguments(THROW_AMBIGUOUS_METHOD, 0, this, argTypes, methods)); 214 } 215 216 private MethodHandle adaptThrower(final MethodHandle rawThrower) { 217 return MethodHandles.dropArguments(rawThrower, 0, callSiteType.parameterList()).asType(callSiteType); 218 } 219 220 private static final MethodHandle THROW_AMBIGUOUS_METHOD = Lookup.findOwnSpecial(MethodHandles.lookup(), 221 "throwAmbiguousMethod", void.class, Class[].class, List.class); 222 223 @SuppressWarnings("unused") 224 private void throwAmbiguousMethod(final Class<?>[] argTypes, final List<MethodHandle> methods) throws NoSuchMethodException { 225 final String arity = methods.get(0).isVarargsCollector() ? "variable" : "fixed"; 226 throw new NoSuchMethodException("Can't unambiguously select between " + arity + " arity signatures " + 227 getSignatureList(methods) + " of the method " + parent.getName() + " for argument types " + 228 argTypesString(argTypes)); 229 } 230 231 private static String argTypesString(final Class<?>[] classes) { 232 final StringBuilder b = new StringBuilder().append('['); 233 appendTypes(b, classes, false); 234 return b.append(']').toString(); 235 } 236 237 private static String getSignatureList(final List<MethodHandle> methods) { 238 final StringBuilder b = new StringBuilder().append('['); 239 final Iterator<MethodHandle> it = methods.iterator(); 240 if(it.hasNext()) { 241 appendSig(b, it.next()); 242 while(it.hasNext()) { 243 appendSig(b.append(", "), it.next()); 244 } 245 } 246 return b.append(']').toString(); 247 } 248 249 private static void appendSig(final StringBuilder b, final MethodHandle m) { 250 b.append('('); 251 appendTypes(b, m.type().parameterArray(), m.isVarargsCollector()); 252 b.append(')'); 253 } 254 255 private static void appendTypes(final StringBuilder b, final Class<?>[] classes, final boolean varArg) { 256 final int l = classes.length; 257 if(!varArg) { 258 if(l > 1) { 259 b.append(classes[1].getCanonicalName()); 260 for(int i = 2; i < l; ++i) { 261 b.append(", ").append(classes[i].getCanonicalName()); 262 } 263 } 264 } else { 265 for(int i = 1; i < l - 1; ++i) { 266 b.append(classes[i].getCanonicalName()).append(", "); 267 } 268 b.append(classes[l - 1].getComponentType().getCanonicalName()).append("..."); 269 } 270 } 271 272 private static Class<?> getCommonReturnType(final List<MethodHandle> methodHandles) { 273 final Iterator<MethodHandle> it = methodHandles.iterator(); 274 Class<?> retType = it.next().type().returnType(); 275 while(it.hasNext()) { 276 retType = InternalTypeUtilities.getCommonLosslessConversionType(retType, it.next().type().returnType()); 277 } 278 return retType; 279 } 280} 281