blob: 8eeb4c3954e871ed2f71c1cc25ab68db8d39f199 [file] [log] [blame]
John R Rosefb6164c2009-05-05 22:40:09 -07001/*
Shilpi Rastogiff976592016-02-10 11:04:13 +01002 * Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.
John R Rosefb6164c2009-05-05 22:40:09 -07003 * 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
Kelly O'Hairfe008ae2010-05-25 15:58:33 -07007 * published by the Free Software Foundation. Oracle designates this
John R Rosefb6164c2009-05-05 22:40:09 -07008 * particular file as subject to the "Classpath" exception as provided
Kelly O'Hairfe008ae2010-05-25 15:58:33 -07009 * by Oracle in the LICENSE file that accompanied this code.
John R Rosefb6164c2009-05-05 22:40:09 -070010 *
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 *
Kelly O'Hairfe008ae2010-05-25 15:58:33 -070021 * 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.
John R Rosefb6164c2009-05-05 22:40:09 -070024 */
25
John R Rose37188242011-03-23 23:02:31 -070026package java.lang.invoke;
John R Rosefb6164c2009-05-05 22:40:09 -070027
Paul Sandozc464a9d2015-12-03 11:17:31 +010028import jdk.internal.vm.annotation.DontInline;
29import jdk.internal.vm.annotation.ForceInline;
30import jdk.internal.vm.annotation.Stable;
31
John Rose6a177f42014-09-10 19:19:48 +040032import java.lang.reflect.Array;
Christian Thalinger360d5122012-07-24 10:47:44 -070033import java.util.Arrays;
John Rose6a177f42014-09-10 19:19:48 +040034
Christian Thalinger01d0ba62012-10-19 17:04:35 -070035import static java.lang.invoke.MethodHandleStatics.*;
Christian Thalinger360d5122012-07-24 10:47:44 -070036import static java.lang.invoke.MethodHandleNatives.Constants.*;
John R Rose37188242011-03-23 23:02:31 -070037import static java.lang.invoke.MethodHandles.Lookup.IMPL_LOOKUP;
Christian Thalinger360d5122012-07-24 10:47:44 -070038import static java.lang.invoke.LambdaForm.*;
Claes Redestad60754ca2016-08-24 16:11:21 +020039import static java.lang.invoke.LambdaForm.Kind.*;
John R Rosefb6164c2009-05-05 22:40:09 -070040
41/**
42 * Construction and caching of often-used invokers.
43 * @author jrose
44 */
John R Rosee7ebd472011-03-18 00:03:24 -070045class Invokers {
Pavel Rappo7075a992014-08-11 21:03:59 +010046 // exact type (sans leading target MH) for the outgoing call
John R Rosefb6164c2009-05-05 22:40:09 -070047 private final MethodType targetType;
48
John Rose6a177f42014-09-10 19:19:48 +040049 // Cached adapter information:
50 private final @Stable MethodHandle[] invokers = new MethodHandle[INV_LIMIT];
51 // Indexes into invokers:
52 static final int
53 INV_EXACT = 0, // MethodHandles.exactInvoker
54 INV_GENERIC = 1, // MethodHandles.invoker (generic invocation)
55 INV_BASIC = 2, // MethodHandles.basicInvoker
56 INV_LIMIT = 3;
John R Rose4f508ab2010-10-30 21:08:23 -070057
John R Rosefb6164c2009-05-05 22:40:09 -070058 /** Compute and cache information common to all collecting adapters
59 * that implement members of the erasure-family of the given erased type.
60 */
John R Roseeedbeda2011-02-11 01:26:24 -080061 /*non-public*/ Invokers(MethodType targetType) {
John R Rosefb6164c2009-05-05 22:40:09 -070062 this.targetType = targetType;
63 }
64
John R Rosee7ebd472011-03-18 00:03:24 -070065 /*non-public*/ MethodHandle exactInvoker() {
John Rose6a177f42014-09-10 19:19:48 +040066 MethodHandle invoker = cachedInvoker(INV_EXACT);
John R Rosefb6164c2009-05-05 22:40:09 -070067 if (invoker != null) return invoker;
John R Rose62ee2112013-10-05 05:30:38 -070068 invoker = makeExactOrGeneralInvoker(true);
John Rose6a177f42014-09-10 19:19:48 +040069 return setCachedInvoker(INV_EXACT, invoker);
John R Rosefb6164c2009-05-05 22:40:09 -070070 }
71
John Rose6a177f42014-09-10 19:19:48 +040072 /*non-public*/ MethodHandle genericInvoker() {
73 MethodHandle invoker = cachedInvoker(INV_GENERIC);
John R Rosefb6164c2009-05-05 22:40:09 -070074 if (invoker != null) return invoker;
John R Rose62ee2112013-10-05 05:30:38 -070075 invoker = makeExactOrGeneralInvoker(false);
John Rose6a177f42014-09-10 19:19:48 +040076 return setCachedInvoker(INV_GENERIC, invoker);
77 }
78
79 /*non-public*/ MethodHandle basicInvoker() {
80 MethodHandle invoker = cachedInvoker(INV_BASIC);
81 if (invoker != null) return invoker;
82 MethodType basicType = targetType.basicType();
83 if (basicType != targetType) {
84 // double cache; not used significantly
85 return setCachedInvoker(INV_BASIC, basicType.invokers().basicInvoker());
86 }
87 invoker = basicType.form().cachedMethodHandle(MethodTypeForm.MH_BASIC_INV);
88 if (invoker == null) {
89 MemberName method = invokeBasicMethod(basicType);
90 invoker = DirectMethodHandle.make(method);
91 assert(checkInvoker(invoker));
92 invoker = basicType.form().setCachedMethodHandle(MethodTypeForm.MH_BASIC_INV, invoker);
93 }
94 return setCachedInvoker(INV_BASIC, invoker);
95 }
96
Paul Sandoz9fb30a32016-03-24 11:21:21 +010097 /*non-public*/ MethodHandle varHandleMethodInvoker(VarHandle.AccessMode ak) {
98 // TODO cache invoker
Paul Sandoz44afe202016-05-17 12:06:41 +020099 return makeVarHandleMethodInvoker(ak, false);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100100 }
101
102 /*non-public*/ MethodHandle varHandleMethodExactInvoker(VarHandle.AccessMode ak) {
103 // TODO cache invoker
Paul Sandoz44afe202016-05-17 12:06:41 +0200104 return makeVarHandleMethodInvoker(ak, true);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100105 }
106
John Rose6a177f42014-09-10 19:19:48 +0400107 private MethodHandle cachedInvoker(int idx) {
108 return invokers[idx];
109 }
110
111 private synchronized MethodHandle setCachedInvoker(int idx, final MethodHandle invoker) {
112 // Simulate a CAS, to avoid racy duplication of results.
113 MethodHandle prev = invokers[idx];
114 if (prev != null) return prev;
115 return invokers[idx] = invoker;
John R Rosefb6164c2009-05-05 22:40:09 -0700116 }
117
John R Rose62ee2112013-10-05 05:30:38 -0700118 private MethodHandle makeExactOrGeneralInvoker(boolean isExact) {
119 MethodType mtype = targetType;
120 MethodType invokerType = mtype.invokerType();
121 int which = (isExact ? MethodTypeForm.LF_EX_INVOKER : MethodTypeForm.LF_GEN_INVOKER);
122 LambdaForm lform = invokeHandleForm(mtype, false, which);
123 MethodHandle invoker = BoundMethodHandle.bindSingle(invokerType, lform, mtype);
124 String whichName = (isExact ? "invokeExact" : "invoke");
John Rosefb7b2ac2014-09-10 19:19:49 +0400125 invoker = invoker.withInternalMemberName(MemberName.makeMethodHandleInvoke(whichName, mtype), false);
Christian Thalinger360d5122012-07-24 10:47:44 -0700126 assert(checkInvoker(invoker));
John R Rose62ee2112013-10-05 05:30:38 -0700127 maybeCompileToBytecode(invoker);
John R Rose025d0ae2011-05-26 17:37:36 -0700128 return invoker;
129 }
130
Paul Sandoz44afe202016-05-17 12:06:41 +0200131 private MethodHandle makeVarHandleMethodInvoker(VarHandle.AccessMode ak, boolean isExact) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100132 MethodType mtype = targetType;
133 MethodType invokerType = mtype.insertParameterTypes(0, VarHandle.class);
134
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100135 LambdaForm lform = varHandleMethodInvokerHandleForm(ak, mtype, isExact);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100136 VarHandle.AccessDescriptor ad = new VarHandle.AccessDescriptor(mtype, ak.at.ordinal(), ak.ordinal());
137 MethodHandle invoker = BoundMethodHandle.bindSingle(invokerType, lform, ad);
138
Paul Sandoza7aff442016-04-13 15:05:48 +0200139 invoker = invoker.withInternalMemberName(MemberName.makeVarHandleMethodInvoke(ak.methodName(), mtype), false);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100140 assert(checkVarHandleInvoker(invoker));
141
142 maybeCompileToBytecode(invoker);
143 return invoker;
144 }
145
John R Rose62ee2112013-10-05 05:30:38 -0700146 /** If the target type seems to be common enough, eagerly compile the invoker to bytecodes. */
147 private void maybeCompileToBytecode(MethodHandle invoker) {
148 final int EAGER_COMPILE_ARITY_LIMIT = 10;
149 if (targetType == targetType.erase() &&
150 targetType.parameterCount() < EAGER_COMPILE_ARITY_LIMIT) {
151 invoker.form.compileToBytecode();
152 }
153 }
154
John R Rose62ee2112013-10-05 05:30:38 -0700155 // This next one is called from LambdaForm.NamedFunction.<init>.
156 /*non-public*/ static MemberName invokeBasicMethod(MethodType basicType) {
157 assert(basicType == basicType.basicType());
Christian Thalinger360d5122012-07-24 10:47:44 -0700158 try {
159 //Lookup.findVirtual(MethodHandle.class, name, type);
John R Rose62ee2112013-10-05 05:30:38 -0700160 return IMPL_LOOKUP.resolveOrFail(REF_invokeVirtual, MethodHandle.class, "invokeBasic", basicType);
Christian Thalinger360d5122012-07-24 10:47:44 -0700161 } catch (ReflectiveOperationException ex) {
John R Rose62ee2112013-10-05 05:30:38 -0700162 throw newInternalError("JVM cannot find invoker for "+basicType, ex);
Christian Thalinger360d5122012-07-24 10:47:44 -0700163 }
164 }
165
166 private boolean checkInvoker(MethodHandle invoker) {
167 assert(targetType.invokerType().equals(invoker.type()))
168 : java.util.Arrays.asList(targetType, targetType.invokerType(), invoker);
169 assert(invoker.internalMemberName() == null ||
170 invoker.internalMemberName().getMethodType().equals(targetType));
171 assert(!invoker.isVarargsCollector());
172 return true;
173 }
174
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100175 private boolean checkVarHandleInvoker(MethodHandle invoker) {
176 MethodType invokerType = targetType.insertParameterTypes(0, VarHandle.class);
177 assert(invokerType.equals(invoker.type()))
178 : java.util.Arrays.asList(targetType, invokerType, invoker);
179 assert(invoker.internalMemberName() == null ||
180 invoker.internalMemberName().getMethodType().equals(targetType));
181 assert(!invoker.isVarargsCollector());
182 return true;
183 }
184
John Rose6a177f42014-09-10 19:19:48 +0400185 /**
186 * Find or create an invoker which passes unchanged a given number of arguments
187 * and spreads the rest from a trailing array argument.
188 * The invoker target type is the post-spread type {@code (TYPEOF(uarg*), TYPEOF(sarg*))=>RT}.
189 * All the {@code sarg}s must have a common type {@code C}. (If there are none, {@code Object} is assumed.}
190 * @param leadingArgCount the number of unchanged (non-spread) arguments
191 * @return {@code invoker.invokeExact(mh, uarg*, C[]{sarg*}) := (RT)mh.invoke(uarg*, sarg*)}
192 */
John R Rose025d0ae2011-05-26 17:37:36 -0700193 /*non-public*/ MethodHandle spreadInvoker(int leadingArgCount) {
John R Rose025d0ae2011-05-26 17:37:36 -0700194 int spreadArgCount = targetType.parameterCount() - leadingArgCount;
John Rose6a177f42014-09-10 19:19:48 +0400195 MethodType postSpreadType = targetType;
196 Class<?> argArrayType = impliedRestargType(postSpreadType, leadingArgCount);
197 if (postSpreadType.parameterSlotCount() <= MethodType.MAX_MH_INVOKER_ARITY) {
198 return genericInvoker().asSpreader(argArrayType, spreadArgCount);
John R Rose9d9d7872012-08-17 13:42:25 -0700199 }
John Rose6a177f42014-09-10 19:19:48 +0400200 // Cannot build a generic invoker here of type ginvoker.invoke(mh, a*[254]).
201 // Instead, factor sinvoker.invoke(mh, a) into ainvoker.invoke(filter(mh), a)
202 // where filter(mh) == mh.asSpreader(Object[], spreadArgCount)
203 MethodType preSpreadType = postSpreadType
204 .replaceParameterTypes(leadingArgCount, postSpreadType.parameterCount(), argArrayType);
205 MethodHandle arrayInvoker = MethodHandles.invoker(preSpreadType);
206 MethodHandle makeSpreader = MethodHandles.insertArguments(Lazy.MH_asSpreader, 1, argArrayType, spreadArgCount);
207 return MethodHandles.filterArgument(arrayInvoker, 0, makeSpreader);
John R Rose025d0ae2011-05-26 17:37:36 -0700208 }
209
John Rose6a177f42014-09-10 19:19:48 +0400210 private static Class<?> impliedRestargType(MethodType restargType, int fromPos) {
211 if (restargType.isGeneric()) return Object[].class; // can be nothing else
212 int maxPos = restargType.parameterCount();
213 if (fromPos >= maxPos) return Object[].class; // reasonable default
214 Class<?> argType = restargType.parameterType(fromPos);
215 for (int i = fromPos+1; i < maxPos; i++) {
216 if (argType != restargType.parameterType(i))
217 throw newIllegalArgumentException("need homogeneous rest arguments", restargType);
John R Rose4f508ab2010-10-30 21:08:23 -0700218 }
John Rose6a177f42014-09-10 19:19:48 +0400219 if (argType == Object.class) return Object[].class;
220 return Array.newInstance(argType, 0).getClass();
John R Rose4f508ab2010-10-30 21:08:23 -0700221 }
222
John R Rosefb6164c2009-05-05 22:40:09 -0700223 public String toString() {
224 return "Invokers"+targetType;
225 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700226
John R Rose62ee2112013-10-05 05:30:38 -0700227 static MemberName methodHandleInvokeLinkerMethod(String name,
228 MethodType mtype,
229 Object[] appendixResult) {
230 int which;
231 switch (name) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100232 case "invokeExact": which = MethodTypeForm.LF_EX_LINKER; break;
233 case "invoke": which = MethodTypeForm.LF_GEN_LINKER; break;
234 default: throw new InternalError("not invoker: "+name);
John R Rose62ee2112013-10-05 05:30:38 -0700235 }
John R Rose9d9d7872012-08-17 13:42:25 -0700236 LambdaForm lform;
John R Rose62ee2112013-10-05 05:30:38 -0700237 if (mtype.parameterSlotCount() <= MethodType.MAX_MH_ARITY - MH_LINKER_ARG_APPENDED) {
238 lform = invokeHandleForm(mtype, false, which);
John R Rose9d9d7872012-08-17 13:42:25 -0700239 appendixResult[0] = mtype;
240 } else {
John R Rose62ee2112013-10-05 05:30:38 -0700241 lform = invokeHandleForm(mtype, true, which);
John R Rose9d9d7872012-08-17 13:42:25 -0700242 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700243 return lform.vmentry;
244 }
245
John R Rose62ee2112013-10-05 05:30:38 -0700246 // argument count to account for trailing "appendix value" (typically the mtype)
247 private static final int MH_LINKER_ARG_APPENDED = 1;
Christian Thalinger360d5122012-07-24 10:47:44 -0700248
John R Rose62ee2112013-10-05 05:30:38 -0700249 /** Returns an adapter for invokeExact or generic invoke, as a MH or constant pool linker.
250 * If !customized, caller is responsible for supplying, during adapter execution,
251 * a copy of the exact mtype. This is because the adapter might be generalized to
252 * a basic type.
253 * @param mtype the caller's method type (either basic or full-custom)
254 * @param customized whether to use a trailing appendix argument (to carry the mtype)
255 * @param which bit-encoded 0x01 whether it is a CP adapter ("linker") or MHs.invoker value ("invoker");
256 * 0x02 whether it is for invokeExact or generic invoke
257 */
Claes Redestad60754ca2016-08-24 16:11:21 +0200258 static LambdaForm invokeHandleForm(MethodType mtype, boolean customized, int which) {
John R Rose9d9d7872012-08-17 13:42:25 -0700259 boolean isCached;
260 if (!customized) {
261 mtype = mtype.basicType(); // normalize Z to I, String to Object, etc.
262 isCached = true;
263 } else {
264 isCached = false; // maybe cache if mtype == mtype.basicType()
265 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700266 boolean isLinker, isGeneric;
Claes Redestad60754ca2016-08-24 16:11:21 +0200267 Kind kind;
Christian Thalinger360d5122012-07-24 10:47:44 -0700268 switch (which) {
Claes Redestad60754ca2016-08-24 16:11:21 +0200269 case MethodTypeForm.LF_EX_LINKER: isLinker = true; isGeneric = false; kind = EXACT_LINKER; break;
270 case MethodTypeForm.LF_EX_INVOKER: isLinker = false; isGeneric = false; kind = EXACT_INVOKER; break;
271 case MethodTypeForm.LF_GEN_LINKER: isLinker = true; isGeneric = true; kind = GENERIC_LINKER; break;
272 case MethodTypeForm.LF_GEN_INVOKER: isLinker = false; isGeneric = true; kind = GENERIC_INVOKER; break;
Christian Thalinger360d5122012-07-24 10:47:44 -0700273 default: throw new InternalError();
274 }
John R Rose9d9d7872012-08-17 13:42:25 -0700275 LambdaForm lform;
276 if (isCached) {
277 lform = mtype.form().cachedLambdaForm(which);
278 if (lform != null) return lform;
279 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700280 // exactInvokerForm (Object,Object)Object
281 // link with java.lang.invoke.MethodHandle.invokeBasic(MethodHandle,Object,Object)Object/invokeSpecial
282 final int THIS_MH = 0;
283 final int CALL_MH = THIS_MH + (isLinker ? 0 : 1);
284 final int ARG_BASE = CALL_MH + 1;
285 final int OUTARG_LIMIT = ARG_BASE + mtype.parameterCount();
John R Rose9d9d7872012-08-17 13:42:25 -0700286 final int INARG_LIMIT = OUTARG_LIMIT + (isLinker && !customized ? 1 : 0);
Christian Thalinger360d5122012-07-24 10:47:44 -0700287 int nameCursor = OUTARG_LIMIT;
John R Rose9d9d7872012-08-17 13:42:25 -0700288 final int MTYPE_ARG = customized ? -1 : nameCursor++; // might be last in-argument
Christian Thalinger360d5122012-07-24 10:47:44 -0700289 final int CHECK_TYPE = nameCursor++;
Vladimir Ivanovbfc51932015-01-29 10:27:30 -0800290 final int CHECK_CUSTOM = (CUSTOMIZE_THRESHOLD >= 0) ? nameCursor++ : -1;
Christian Thalinger360d5122012-07-24 10:47:44 -0700291 final int LINKER_CALL = nameCursor++;
292 MethodType invokerFormType = mtype.invokerType();
293 if (isLinker) {
John R Rose9d9d7872012-08-17 13:42:25 -0700294 if (!customized)
295 invokerFormType = invokerFormType.appendParameterTypes(MemberName.class);
Christian Thalinger360d5122012-07-24 10:47:44 -0700296 } else {
297 invokerFormType = invokerFormType.invokerType();
298 }
299 Name[] names = arguments(nameCursor - INARG_LIMIT, invokerFormType);
John R Rose9d9d7872012-08-17 13:42:25 -0700300 assert(names.length == nameCursor)
301 : Arrays.asList(mtype, customized, which, nameCursor, names.length);
Christian Thalinger360d5122012-07-24 10:47:44 -0700302 if (MTYPE_ARG >= INARG_LIMIT) {
303 assert(names[MTYPE_ARG] == null);
John Roseafe2dd82014-09-10 19:19:51 +0400304 BoundMethodHandle.SpeciesData speciesData = BoundMethodHandle.speciesData_L();
305 names[THIS_MH] = names[THIS_MH].withConstraint(speciesData);
306 NamedFunction getter = speciesData.getterFunction(0);
John R Rose62ee2112013-10-05 05:30:38 -0700307 names[MTYPE_ARG] = new Name(getter, names[THIS_MH]);
Christian Thalinger360d5122012-07-24 10:47:44 -0700308 // else if isLinker, then MTYPE is passed in from the caller (e.g., the JVM)
309 }
310
311 // Make the final call. If isGeneric, then prepend the result of type checking.
John R Rose62ee2112013-10-05 05:30:38 -0700312 MethodType outCallType = mtype.basicType();
313 Object[] outArgs = Arrays.copyOfRange(names, CALL_MH, OUTARG_LIMIT, Object[].class);
John R Rose9d9d7872012-08-17 13:42:25 -0700314 Object mtypeArg = (customized ? mtype : names[MTYPE_ARG]);
Christian Thalinger360d5122012-07-24 10:47:44 -0700315 if (!isGeneric) {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200316 names[CHECK_TYPE] = new Name(getFunction(NF_checkExactType), names[CALL_MH], mtypeArg);
Christian Thalinger360d5122012-07-24 10:47:44 -0700317 // mh.invokeExact(a*):R => checkExactType(mh, TYPEOF(a*:R)); mh.invokeBasic(a*)
Christian Thalinger360d5122012-07-24 10:47:44 -0700318 } else {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200319 names[CHECK_TYPE] = new Name(getFunction(NF_checkGenericType), names[CALL_MH], mtypeArg);
John R Rose62ee2112013-10-05 05:30:38 -0700320 // mh.invokeGeneric(a*):R => checkGenericType(mh, TYPEOF(a*:R)).invokeBasic(a*)
321 outArgs[0] = names[CHECK_TYPE];
Christian Thalinger360d5122012-07-24 10:47:44 -0700322 }
Vladimir Ivanovbfc51932015-01-29 10:27:30 -0800323 if (CHECK_CUSTOM != -1) {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200324 names[CHECK_CUSTOM] = new Name(getFunction(NF_checkCustomized), outArgs[0]);
Vladimir Ivanovbfc51932015-01-29 10:27:30 -0800325 }
John R Rose62ee2112013-10-05 05:30:38 -0700326 names[LINKER_CALL] = new Name(outCallType, outArgs);
Claes Redestad60754ca2016-08-24 16:11:21 +0200327 if (customized) {
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100328 lform = new LambdaForm(INARG_LIMIT, names);
Claes Redestad60754ca2016-08-24 16:11:21 +0200329 } else {
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100330 lform = new LambdaForm(INARG_LIMIT, names, kind);
Claes Redestad60754ca2016-08-24 16:11:21 +0200331 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700332 if (isLinker)
333 lform.compileToBytecode(); // JVM needs a real methodOop
John R Rose9d9d7872012-08-17 13:42:25 -0700334 if (isCached)
335 lform = mtype.form().setCachedLambdaForm(which, lform);
Christian Thalinger360d5122012-07-24 10:47:44 -0700336 return lform;
337 }
338
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100339
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100340 static MemberName varHandleInvokeLinkerMethod(VarHandle.AccessMode ak, MethodType mtype) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100341 LambdaForm lform;
342 if (mtype.parameterSlotCount() <= MethodType.MAX_MH_ARITY - MH_LINKER_ARG_APPENDED) {
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100343 lform = varHandleMethodGenericLinkerHandleForm(ak, mtype);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100344 } else {
345 // TODO
346 throw newInternalError("Unsupported parameter slot count " + mtype.parameterSlotCount());
347 }
348 return lform.vmentry;
349 }
350
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100351 private static LambdaForm varHandleMethodGenericLinkerHandleForm(VarHandle.AccessMode ak,
352 MethodType mtype) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100353 // TODO Cache form?
354
355 final int THIS_VH = 0;
356 final int ARG_BASE = THIS_VH + 1;
357 final int ARG_LIMIT = ARG_BASE + mtype.parameterCount();
358 int nameCursor = ARG_LIMIT;
359 final int VAD_ARG = nameCursor++;
360 final int CHECK_TYPE = nameCursor++;
361 final int CHECK_CUSTOM = (CUSTOMIZE_THRESHOLD >= 0) ? nameCursor++ : -1;
362 final int LINKER_CALL = nameCursor++;
363
364 Name[] names = new Name[LINKER_CALL + 1];
365 names[THIS_VH] = argument(THIS_VH, BasicType.basicType(Object.class));
366 for (int i = 0; i < mtype.parameterCount(); i++) {
367 names[ARG_BASE + i] = argument(ARG_BASE + i, BasicType.basicType(mtype.parameterType(i)));
368 }
369 names[VAD_ARG] = new Name(ARG_LIMIT, BasicType.basicType(Object.class));
370
Claes Redestad9ab899d2017-04-11 11:24:12 +0200371 names[CHECK_TYPE] = new Name(getFunction(NF_checkVarHandleGenericType), names[THIS_VH], names[VAD_ARG]);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100372
373 Object[] outArgs = new Object[ARG_LIMIT + 1];
374 outArgs[0] = names[CHECK_TYPE];
375 for (int i = 0; i < ARG_LIMIT; i++) {
376 outArgs[i + 1] = names[i];
377 }
378
379 if (CHECK_CUSTOM != -1) {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200380 names[CHECK_CUSTOM] = new Name(getFunction(NF_checkCustomized), outArgs[0]);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100381 }
382
383 MethodType outCallType = mtype.insertParameterTypes(0, VarHandle.class)
384 .basicType();
385 names[LINKER_CALL] = new Name(outCallType, outArgs);
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100386 LambdaForm lform = new LambdaForm(ARG_LIMIT + 1, names, VARHANDLE_LINKER);
387 if (LambdaForm.debugNames()) {
388 String name = ak.methodName() + ":VarHandle_invoke_MT_" +
389 shortenSignature(basicTypeSignature(mtype));
390 LambdaForm.associateWithDebugName(lform, name);
391 }
Paul Sandoz37445182016-05-05 11:39:08 -0700392 lform.compileToBytecode();
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100393 return lform;
394 }
395
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100396 private static LambdaForm varHandleMethodInvokerHandleForm(VarHandle.AccessMode ak,
397 MethodType mtype, boolean isExact) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100398 // TODO Cache form?
399
400 final int THIS_MH = 0;
401 final int CALL_VH = THIS_MH + 1;
402 final int ARG_BASE = CALL_VH + 1;
403 final int ARG_LIMIT = ARG_BASE + mtype.parameterCount();
404 int nameCursor = ARG_LIMIT;
405 final int VAD_ARG = nameCursor++;
406 final int CHECK_TYPE = nameCursor++;
407 final int LINKER_CALL = nameCursor++;
408
409 Name[] names = new Name[LINKER_CALL + 1];
410 names[THIS_MH] = argument(THIS_MH, BasicType.basicType(Object.class));
411 names[CALL_VH] = argument(CALL_VH, BasicType.basicType(Object.class));
412 for (int i = 0; i < mtype.parameterCount(); i++) {
413 names[ARG_BASE + i] = argument(ARG_BASE + i, BasicType.basicType(mtype.parameterType(i)));
414 }
415
416 BoundMethodHandle.SpeciesData speciesData = BoundMethodHandle.speciesData_L();
417 names[THIS_MH] = names[THIS_MH].withConstraint(speciesData);
418
419 NamedFunction getter = speciesData.getterFunction(0);
420 names[VAD_ARG] = new Name(getter, names[THIS_MH]);
421
Paul Sandoz44afe202016-05-17 12:06:41 +0200422 if (isExact) {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200423 names[CHECK_TYPE] = new Name(getFunction(NF_checkVarHandleExactType), names[CALL_VH], names[VAD_ARG]);
Paul Sandoz44afe202016-05-17 12:06:41 +0200424 } else {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200425 names[CHECK_TYPE] = new Name(getFunction(NF_checkVarHandleGenericType), names[CALL_VH], names[VAD_ARG]);
Paul Sandoz44afe202016-05-17 12:06:41 +0200426 }
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100427 Object[] outArgs = new Object[ARG_LIMIT];
428 outArgs[0] = names[CHECK_TYPE];
429 for (int i = 1; i < ARG_LIMIT; i++) {
430 outArgs[i] = names[i];
431 }
432
433 MethodType outCallType = mtype.insertParameterTypes(0, VarHandle.class)
434 .basicType();
435 names[LINKER_CALL] = new Name(outCallType, outArgs);
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100436 Kind kind = isExact ? VARHANDLE_EXACT_INVOKER : VARHANDLE_INVOKER;
437 LambdaForm lform = new LambdaForm(ARG_LIMIT, names, kind);
438 if (LambdaForm.debugNames()) {
439 String name = ak.methodName() +
440 (isExact ? ":VarHandle_exactInvoker_" : ":VarHandle_invoker_") +
441 shortenSignature(basicTypeSignature(mtype));
442 LambdaForm.associateWithDebugName(lform, name);
443 }
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100444 lform.prepare();
445 return lform;
446 }
447
448 /*non-public*/ static
449 @ForceInline
Paul Sandoz37445182016-05-05 11:39:08 -0700450 MethodHandle checkVarHandleGenericType(VarHandle handle, VarHandle.AccessDescriptor ad) {
451 // Test for exact match on invoker types
452 // TODO match with erased types and add cast of return value to lambda form
453 MethodHandle mh = handle.getMethodHandle(ad.mode);
454 if (mh.type() == ad.symbolicMethodTypeInvoker) {
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100455 return mh;
456 }
457 else {
Paul Sandoz37445182016-05-05 11:39:08 -0700458 return mh.asType(ad.symbolicMethodTypeInvoker);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100459 }
460 }
461
462 /*non-public*/ static
463 @ForceInline
Paul Sandoz44afe202016-05-17 12:06:41 +0200464 MethodHandle checkVarHandleExactType(VarHandle handle, VarHandle.AccessDescriptor ad) {
465 MethodHandle mh = handle.getMethodHandle(ad.mode);
466 MethodType mt = mh.type();
467 if (mt != ad.symbolicMethodTypeInvoker) {
468 throw newWrongMethodTypeException(mt, ad.symbolicMethodTypeInvoker);
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100469 }
Paul Sandoz44afe202016-05-17 12:06:41 +0200470 return mh;
Paul Sandoz9fb30a32016-03-24 11:21:21 +0100471 }
472
Christian Thalinger360d5122012-07-24 10:47:44 -0700473 /*non-public*/ static
474 WrongMethodTypeException newWrongMethodTypeException(MethodType actual, MethodType expected) {
475 // FIXME: merge with JVM logic for throwing WMTE
476 return new WrongMethodTypeException("expected "+expected+" but found "+actual);
477 }
478
479 /** Static definition of MethodHandle.invokeExact checking code. */
480 /*non-public*/ static
481 @ForceInline
Shilpi Rastogiff976592016-02-10 11:04:13 +0100482 void checkExactType(MethodHandle mh, MethodType expected) {
Christian Thalinger360d5122012-07-24 10:47:44 -0700483 MethodType actual = mh.type();
484 if (actual != expected)
485 throw newWrongMethodTypeException(expected, actual);
486 }
487
John R Rose62ee2112013-10-05 05:30:38 -0700488 /** Static definition of MethodHandle.invokeGeneric checking code.
489 * Directly returns the type-adjusted MH to invoke, as follows:
490 * {@code (R)MH.invoke(a*) => MH.asType(TYPEOF(a*:R)).invokeBasic(a*)}
491 */
Christian Thalinger360d5122012-07-24 10:47:44 -0700492 /*non-public*/ static
493 @ForceInline
Shilpi Rastogiff976592016-02-10 11:04:13 +0100494 MethodHandle checkGenericType(MethodHandle mh, MethodType expected) {
John R Rose62ee2112013-10-05 05:30:38 -0700495 return mh.asType(expected);
496 /* Maybe add more paths here. Possible optimizations:
497 * for (R)MH.invoke(a*),
498 * let MT0 = TYPEOF(a*:R), MT1 = MH.type
499 *
500 * if MT0==MT1 or MT1 can be safely called by MT0
501 * => MH.invokeBasic(a*)
502 * if MT1 can be safely called by MT0[R := Object]
503 * => MH.invokeBasic(a*) & checkcast(R)
504 * if MT1 can be safely called by MT0[* := Object]
505 * => checkcast(A)* & MH.invokeBasic(a*) & checkcast(R)
506 * if a big adapter BA can be pulled out of (MT0,MT1)
507 * => BA.invokeBasic(MT0,MH,a*)
508 * if a local adapter LA can cached on static CS0 = new GICS(MT0)
509 * => CS0.LA.invokeBasic(MH,a*)
510 * else
511 * => MH.asType(MT0).invokeBasic(A*)
512 */
Christian Thalinger360d5122012-07-24 10:47:44 -0700513 }
514
515 static MemberName linkToCallSiteMethod(MethodType mtype) {
John R Rose62ee2112013-10-05 05:30:38 -0700516 LambdaForm lform = callSiteForm(mtype, false);
Christian Thalinger360d5122012-07-24 10:47:44 -0700517 return lform.vmentry;
518 }
519
John R Rose62ee2112013-10-05 05:30:38 -0700520 static MemberName linkToTargetMethod(MethodType mtype) {
521 LambdaForm lform = callSiteForm(mtype, true);
522 return lform.vmentry;
523 }
524
525 // skipCallSite is true if we are optimizing a ConstantCallSite
526 private static LambdaForm callSiteForm(MethodType mtype, boolean skipCallSite) {
Christian Thalinger360d5122012-07-24 10:47:44 -0700527 mtype = mtype.basicType(); // normalize Z to I, String to Object, etc.
John R Rose62ee2112013-10-05 05:30:38 -0700528 final int which = (skipCallSite ? MethodTypeForm.LF_MH_LINKER : MethodTypeForm.LF_CS_LINKER);
529 LambdaForm lform = mtype.form().cachedLambdaForm(which);
Christian Thalinger360d5122012-07-24 10:47:44 -0700530 if (lform != null) return lform;
531 // exactInvokerForm (Object,Object)Object
532 // link with java.lang.invoke.MethodHandle.invokeBasic(MethodHandle,Object,Object)Object/invokeSpecial
533 final int ARG_BASE = 0;
534 final int OUTARG_LIMIT = ARG_BASE + mtype.parameterCount();
535 final int INARG_LIMIT = OUTARG_LIMIT + 1;
536 int nameCursor = OUTARG_LIMIT;
John R Rose62ee2112013-10-05 05:30:38 -0700537 final int APPENDIX_ARG = nameCursor++; // the last in-argument
538 final int CSITE_ARG = skipCallSite ? -1 : APPENDIX_ARG;
539 final int CALL_MH = skipCallSite ? APPENDIX_ARG : nameCursor++; // result of getTarget
Christian Thalinger360d5122012-07-24 10:47:44 -0700540 final int LINKER_CALL = nameCursor++;
John R Rose62ee2112013-10-05 05:30:38 -0700541 MethodType invokerFormType = mtype.appendParameterTypes(skipCallSite ? MethodHandle.class : CallSite.class);
Christian Thalinger360d5122012-07-24 10:47:44 -0700542 Name[] names = arguments(nameCursor - INARG_LIMIT, invokerFormType);
543 assert(names.length == nameCursor);
John R Rose62ee2112013-10-05 05:30:38 -0700544 assert(names[APPENDIX_ARG] != null);
545 if (!skipCallSite)
Claes Redestad9ab899d2017-04-11 11:24:12 +0200546 names[CALL_MH] = new Name(getFunction(NF_getCallSiteTarget), names[CSITE_ARG]);
Christian Thalinger360d5122012-07-24 10:47:44 -0700547 // (site.)invokedynamic(a*):R => mh = site.getTarget(); mh.invokeBasic(a*)
548 final int PREPEND_MH = 0, PREPEND_COUNT = 1;
549 Object[] outArgs = Arrays.copyOfRange(names, ARG_BASE, OUTARG_LIMIT + PREPEND_COUNT, Object[].class);
550 // prepend MH argument:
551 System.arraycopy(outArgs, 0, outArgs, PREPEND_COUNT, outArgs.length - PREPEND_COUNT);
552 outArgs[PREPEND_MH] = names[CALL_MH];
John R Rose62ee2112013-10-05 05:30:38 -0700553 names[LINKER_CALL] = new Name(mtype, outArgs);
Claes Redestad8d5f5b92017-02-22 11:03:33 +0100554 lform = new LambdaForm(INARG_LIMIT, names,
555 (skipCallSite ? LINK_TO_TARGET_METHOD : LINK_TO_CALL_SITE));
Christian Thalinger360d5122012-07-24 10:47:44 -0700556 lform.compileToBytecode(); // JVM needs a real methodOop
John R Rose62ee2112013-10-05 05:30:38 -0700557 lform = mtype.form().setCachedLambdaForm(which, lform);
Christian Thalinger360d5122012-07-24 10:47:44 -0700558 return lform;
559 }
560
561 /** Static definition of MethodHandle.invokeGeneric checking code. */
562 /*non-public*/ static
563 @ForceInline
Shilpi Rastogiff976592016-02-10 11:04:13 +0100564 MethodHandle getCallSiteTarget(CallSite site) {
565 return site.getTarget();
Christian Thalinger360d5122012-07-24 10:47:44 -0700566 }
567
Vladimir Ivanovbfc51932015-01-29 10:27:30 -0800568 /*non-public*/ static
569 @ForceInline
Shilpi Rastogiff976592016-02-10 11:04:13 +0100570 void checkCustomized(MethodHandle mh) {
Vladimir Ivanov71020f92015-03-20 11:42:31 -0700571 if (MethodHandleImpl.isCompileConstant(mh)) return;
Vladimir Ivanovbfc51932015-01-29 10:27:30 -0800572 if (mh.form.customized == null) {
573 maybeCustomize(mh);
574 }
575 }
576
577 /*non-public*/ static
578 @DontInline
579 void maybeCustomize(MethodHandle mh) {
580 byte count = mh.customizationCount;
581 if (count >= CUSTOMIZE_THRESHOLD) {
582 mh.customize();
583 } else {
584 mh.customizationCount = (byte)(count+1);
585 }
586 }
587
Christian Thalinger360d5122012-07-24 10:47:44 -0700588 // Local constant functions:
Claes Redestad9ab899d2017-04-11 11:24:12 +0200589 private static final byte NF_checkExactType = 0,
590 NF_checkGenericType = 1,
591 NF_getCallSiteTarget = 2,
592 NF_checkCustomized = 3,
593 NF_checkVarHandleGenericType = 4,
594 NF_checkVarHandleExactType = 5,
595 NF_LIMIT = 6;
596
597 private static final @Stable NamedFunction[] NFS = new NamedFunction[NF_LIMIT];
598
599 private static NamedFunction getFunction(byte func) {
600 NamedFunction nf = NFS[func];
601 if (nf != null) {
602 return nf;
603 }
604 NFS[func] = nf = createFunction(func);
605 // Each nf must be statically invocable or we get tied up in our bootstraps.
606 assert(InvokerBytecodeGenerator.isStaticallyInvocable(nf));
607 return nf;
608 }
609
610 private static NamedFunction createFunction(byte func) {
Christian Thalinger360d5122012-07-24 10:47:44 -0700611 try {
Claes Redestad9ab899d2017-04-11 11:24:12 +0200612 switch (func) {
613 case NF_checkExactType:
614 return new NamedFunction(Invokers.class
615 .getDeclaredMethod("checkExactType", MethodHandle.class, MethodType.class));
616 case NF_checkGenericType:
617 return new NamedFunction(Invokers.class
618 .getDeclaredMethod("checkGenericType", MethodHandle.class, MethodType.class));
619 case NF_getCallSiteTarget:
620 return new NamedFunction(Invokers.class
621 .getDeclaredMethod("getCallSiteTarget", CallSite.class));
622 case NF_checkCustomized:
623 return new NamedFunction(Invokers.class
624 .getDeclaredMethod("checkCustomized", MethodHandle.class));
625 case NF_checkVarHandleGenericType:
626 return new NamedFunction(Invokers.class
627 .getDeclaredMethod("checkVarHandleGenericType", VarHandle.class, VarHandle.AccessDescriptor.class));
628 case NF_checkVarHandleExactType:
629 return new NamedFunction(Invokers.class
630 .getDeclaredMethod("checkVarHandleExactType", VarHandle.class, VarHandle.AccessDescriptor.class));
631 default:
632 throw newInternalError("Unknown function: " + func);
633 }
Christian Thalinger360d5122012-07-24 10:47:44 -0700634 } catch (ReflectiveOperationException ex) {
Christian Thalinger01d0ba62012-10-19 17:04:35 -0700635 throw newInternalError(ex);
Christian Thalinger360d5122012-07-24 10:47:44 -0700636 }
637 }
638
John Rose6a177f42014-09-10 19:19:48 +0400639 private static class Lazy {
640 private static final MethodHandle MH_asSpreader;
641
642 static {
643 try {
644 MH_asSpreader = IMPL_LOOKUP.findVirtual(MethodHandle.class, "asSpreader",
645 MethodType.methodType(MethodHandle.class, Class.class, int.class));
646 } catch (ReflectiveOperationException ex) {
647 throw newInternalError(ex);
648 }
649 }
650 }
Claes Redestad60754ca2016-08-24 16:11:21 +0200651
652 static {
653 // The Holder class will contain pre-generated Invokers resolved
654 // speculatively using MemberName.getFactory().resolveOrNull. However, that
655 // doesn't initialize the class, which subtly breaks inlining etc. By forcing
656 // initialization of the Holder class we avoid these issues.
657 UNSAFE.ensureClassInitialized(Holder.class);
658 }
659
660 /* Placeholder class for Invokers generated ahead of time */
661 final class Holder {}
John R Rosefb6164c2009-05-05 22:40:09 -0700662}