MethodHandles.java 162.5 KB
Newer Older
1
/*
2
 * Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.
3 4 5 6
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * 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 12 13 14 15 16 17 18 19 20
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
21 22 23
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
24 25
 */

26
package java.lang.invoke;
27

28
import java.lang.reflect.*;
29
import java.util.BitSet;
30
import java.util.List;
31
import java.util.ArrayList;
32
import java.util.Arrays;
33

34 35 36 37
import sun.invoke.util.ValueConversions;
import sun.invoke.util.VerifyAccess;
import sun.invoke.util.Wrapper;
import sun.reflect.CallerSensitive;
38
import sun.reflect.Reflection;
39
import sun.reflect.misc.ReflectUtil;
40
import sun.security.util.SecurityConstants;
41 42
import java.lang.invoke.LambdaForm.BasicType;
import static java.lang.invoke.LambdaForm.BasicType.*;
43
import static java.lang.invoke.MethodHandleStatics.*;
44
import static java.lang.invoke.MethodHandleImpl.Intrinsic;
45
import static java.lang.invoke.MethodHandleNatives.Constants.*;
46

47
import java.util.concurrent.ConcurrentHashMap;
48

49
/**
50 51
 * This class consists exclusively of static methods that operate on or return
 * method handles. They fall into several categories:
52
 * <ul>
53 54 55
 * <li>Lookup methods which help create method handles for methods and fields.
 * <li>Combinator methods, which combine or transform pre-existing method handles into new ones.
 * <li>Other factory methods to create method handles that emulate other common JVM operations or control flow patterns.
56
 * </ul>
57 58
 * <p>
 * @author John Rose, JSR 292 EG
R
rfield 已提交
59
 * @since 1.7
60 61 62 63 64
 */
public class MethodHandles {

    private MethodHandles() { }  // do not instantiate

65
    private static final MemberName.Factory IMPL_NAMES = MemberName.getFactory();
66 67 68 69 70
    static { MethodHandleImpl.initStatics(); }
    // See IMPL_LOOKUP below.

    //// Method handle creation from ordinary methods.

71
    /**
72 73 74 75 76 77 78
     * Returns a {@link Lookup lookup object} with
     * full capabilities to emulate all supported bytecode behaviors of the caller.
     * These capabilities include <a href="MethodHandles.Lookup.html#privacc">private access</a> to the caller.
     * Factory methods on the lookup object can create
     * <a href="MethodHandleInfo.html#directmh">direct method handles</a>
     * for any member that the caller has access to via bytecodes,
     * including protected and private fields and methods.
79 80
     * This lookup object is a <em>capability</em> which may be delegated to trusted agents.
     * Do not store it in place where untrusted code can access it.
81 82 83 84 85 86 87 88 89 90
     * <p>
     * This method is caller sensitive, which means that it may return different
     * values to different callers.
     * <p>
     * For any given caller class {@code C}, the lookup object returned by this call
     * has equivalent capabilities to any lookup object
     * supplied by the JVM to the bootstrap method of an
     * <a href="package-summary.html#indyinsn">invokedynamic instruction</a>
     * executing in the same caller class {@code C}.
     * @return a lookup object for the caller of this method, with private access
91
     */
92
    @CallerSensitive
93
    public static Lookup lookup() {
94
        return new Lookup(Reflection.getCallerClass());
95 96
    }

97
    /**
98
     * Returns a {@link Lookup lookup object} which is trusted minimally.
99 100
     * It can only be used to create method handles to
     * publicly accessible fields and methods.
101 102 103
     * <p>
     * As a matter of pure convention, the {@linkplain Lookup#lookupClass lookup class}
     * of this lookup object will be {@link java.lang.Object}.
104 105 106
     *
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
107
     * The lookup class can be changed to any other class {@code C} using an expression of the form
108
     * {@link Lookup#in publicLookup().in(C.class)}.
109 110
     * Since all classes have equal access to public names,
     * such a change would confer no new access rights.
111 112 113 114
     * A public lookup object is always subject to
     * <a href="MethodHandles.Lookup.html#secmgr">security manager checks</a>.
     * Also, it cannot access
     * <a href="MethodHandles.Lookup.html#callsens">caller sensitive methods</a>.
115
     * @return a lookup object which is trusted minimally
116 117 118 119 120
     */
    public static Lookup publicLookup() {
        return Lookup.PUBLIC_LOOKUP;
    }

R
rfield 已提交
121
    /**
122 123
     * Performs an unchecked "crack" of a
     * <a href="MethodHandleInfo.html#directmh">direct method handle</a>.
R
rfield 已提交
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
     * The result is as if the user had obtained a lookup object capable enough
     * to crack the target method handle, called
     * {@link java.lang.invoke.MethodHandles.Lookup#revealDirect Lookup.revealDirect}
     * on the target to obtain its symbolic reference, and then called
     * {@link java.lang.invoke.MethodHandleInfo#reflectAs MethodHandleInfo.reflectAs}
     * to resolve the symbolic reference to a member.
     * <p>
     * If there is a security manager, its {@code checkPermission} method
     * is called with a {@code ReflectPermission("suppressAccessChecks")} permission.
     * @param <T> the desired type of the result, either {@link Member} or a subtype
     * @param target a direct method handle to crack into symbolic reference components
     * @param expected a class object representing the desired result type {@code T}
     * @return a reference to the method, constructor, or field object
     * @exception SecurityException if the caller is not privileged to call {@code setAccessible}
     * @exception NullPointerException if either argument is {@code null}
     * @exception IllegalArgumentException if the target is not a direct method handle
     * @exception ClassCastException if the member is not of the expected type
     * @since 1.8
     */
    public static <T extends Member> T
    reflectAs(Class<T> expected, MethodHandle target) {
        SecurityManager smgr = System.getSecurityManager();
        if (smgr != null)  smgr.checkPermission(ACCESS_PERMISSION);
        Lookup lookup = Lookup.IMPL_LOOKUP;  // use maximally privileged lookup
        return lookup.revealDirect(target).reflectAs(expected, lookup);
    }
    // Copied from AccessibleObject, as used by Method.setAccessible, etc.:
    static final private java.security.Permission ACCESS_PERMISSION =
        new ReflectPermission("suppressAccessChecks");

154
    /**
155 156 157
     * A <em>lookup object</em> is a factory for creating method handles,
     * when the creation requires access checking.
     * Method handles do not perform
158
     * access checks when they are called, but rather when they are created.
159 160
     * Therefore, method handle access
     * restrictions must be enforced when a method handle is created.
161
     * The caller class against which those restrictions are enforced
162
     * is known as the {@linkplain #lookupClass lookup class}.
163 164 165 166 167 168 169 170 171
     * <p>
     * A lookup class which needs to create method handles will call
     * {@link MethodHandles#lookup MethodHandles.lookup} to create a factory for itself.
     * When the {@code Lookup} factory object is created, the identity of the lookup class is
     * determined, and securely stored in the {@code Lookup} object.
     * The lookup class (or its delegates) may then use factory methods
     * on the {@code Lookup} object to create method handles for access-checked members.
     * This includes all methods, constructors, and fields which are allowed to the lookup class,
     * even private ones.
172 173
     *
     * <h1><a name="lookups"></a>Lookup Factory Methods</h1>
174 175
     * The factory methods on a {@code Lookup} object correspond to all major
     * use cases for methods, constructors, and fields.
176 177 178
     * Each method handle created by a factory method is the functional
     * equivalent of a particular <em>bytecode behavior</em>.
     * (Bytecode behaviors are described in section 5.4.3.5 of the Java Virtual Machine Specification.)
179 180 181
     * Here is a summary of the correspondence between these factory methods and
     * the behavior the resulting method handles:
     * <table border=1 cellpadding=5 summary="lookup method behaviors">
182 183 184 185 186
     * <tr>
     *     <th><a name="equiv"></a>lookup expression</th>
     *     <th>member</th>
     *     <th>bytecode behavior</th>
     * </tr>
187
     * <tr>
188 189
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findGetter lookup.findGetter(C.class,"f",FT.class)}</td>
     *     <td>{@code FT f;}</td><td>{@code (T) this.f;}</td>
190 191
     * </tr>
     * <tr>
192 193
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findStaticGetter lookup.findStaticGetter(C.class,"f",FT.class)}</td>
     *     <td>{@code static}<br>{@code FT f;}</td><td>{@code (T) C.f;}</td>
194 195
     * </tr>
     * <tr>
196 197
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findSetter lookup.findSetter(C.class,"f",FT.class)}</td>
     *     <td>{@code FT f;}</td><td>{@code this.f = x;}</td>
198 199
     * </tr>
     * <tr>
200 201
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findStaticSetter lookup.findStaticSetter(C.class,"f",FT.class)}</td>
     *     <td>{@code static}<br>{@code FT f;}</td><td>{@code C.f = arg;}</td>
202 203
     * </tr>
     * <tr>
204 205
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findVirtual lookup.findVirtual(C.class,"m",MT)}</td>
     *     <td>{@code T m(A*);}</td><td>{@code (T) this.m(arg*);}</td>
206 207
     * </tr>
     * <tr>
208 209
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findStatic lookup.findStatic(C.class,"m",MT)}</td>
     *     <td>{@code static}<br>{@code T m(A*);}</td><td>{@code (T) C.m(arg*);}</td>
210 211
     * </tr>
     * <tr>
212 213
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findSpecial lookup.findSpecial(C.class,"m",MT,this.class)}</td>
     *     <td>{@code T m(A*);}</td><td>{@code (T) super.m(arg*);}</td>
214 215
     * </tr>
     * <tr>
216 217
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#findConstructor lookup.findConstructor(C.class,MT)}</td>
     *     <td>{@code C(A*);}</td><td>{@code new C(arg*);}</td>
218 219
     * </tr>
     * <tr>
220 221
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#unreflectGetter lookup.unreflectGetter(aField)}</td>
     *     <td>({@code static})?<br>{@code FT f;}</td><td>{@code (FT) aField.get(thisOrNull);}</td>
222 223
     * </tr>
     * <tr>
224 225
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#unreflectSetter lookup.unreflectSetter(aField)}</td>
     *     <td>({@code static})?<br>{@code FT f;}</td><td>{@code aField.set(thisOrNull, arg);}</td>
226 227
     * </tr>
     * <tr>
228 229
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#unreflect lookup.unreflect(aMethod)}</td>
     *     <td>({@code static})?<br>{@code T m(A*);}</td><td>{@code (T) aMethod.invoke(thisOrNull, arg*);}</td>
230 231
     * </tr>
     * <tr>
232 233
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#unreflectConstructor lookup.unreflectConstructor(aConstructor)}</td>
     *     <td>{@code C(A*);}</td><td>{@code (C) aConstructor.newInstance(arg*);}</td>
234 235
     * </tr>
     * <tr>
236 237
     *     <td>{@link java.lang.invoke.MethodHandles.Lookup#unreflect lookup.unreflect(aMethod)}</td>
     *     <td>({@code static})?<br>{@code T m(A*);}</td><td>{@code (T) aMethod.invoke(thisOrNull, arg*);}</td>
238 239
     * </tr>
     * </table>
240
     *
241 242
     * Here, the type {@code C} is the class or interface being searched for a member,
     * documented as a parameter named {@code refc} in the lookup methods.
243
     * The method type {@code MT} is composed from the return type {@code T}
244
     * and the sequence of argument types {@code A*}.
245 246
     * The constructor also has a sequence of argument types {@code A*} and
     * is deemed to return the newly-created object of type {@code C}.
247 248 249
     * Both {@code MT} and the field type {@code FT} are documented as a parameter named {@code type}.
     * The formal parameter {@code this} stands for the self-reference of type {@code C};
     * if it is present, it is always the leading argument to the method handle invocation.
250 251
     * (In the case of some {@code protected} members, {@code this} may be
     * restricted in type to the lookup class; see below.)
252 253 254 255 256 257 258
     * The name {@code arg} stands for all the other method handle arguments.
     * In the code examples for the Core Reflection API, the name {@code thisOrNull}
     * stands for a null reference if the accessed method or field is static,
     * and {@code this} otherwise.
     * The names {@code aMethod}, {@code aField}, and {@code aConstructor} stand
     * for reflective objects corresponding to the given members.
     * <p>
259 260 261
     * In cases where the given member is of variable arity (i.e., a method or constructor)
     * the returned method handle will also be of {@linkplain MethodHandle#asVarargsCollector variable arity}.
     * In all other cases, the returned method handle will be of fixed arity.
262 263
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
264
     * The equivalence between looked-up method handles and underlying
265 266 267
     * class members and bytecode behaviors
     * can break down in a few ways:
     * <ul style="font-size:smaller;">
268 269 270 271 272 273 274
     * <li>If {@code C} is not symbolically accessible from the lookup class's loader,
     * the lookup can still succeed, even when there is no equivalent
     * Java expression or bytecoded constant.
     * <li>Likewise, if {@code T} or {@code MT}
     * is not symbolically accessible from the lookup class's loader,
     * the lookup can still succeed.
     * For example, lookups for {@code MethodHandle.invokeExact} and
275
     * {@code MethodHandle.invoke} will always succeed, regardless of requested type.
276
     * <li>If there is a security manager installed, it can forbid the lookup
277 278 279
     * on various grounds (<a href="MethodHandles.Lookup.html#secmgr">see below</a>).
     * By contrast, the {@code ldc} instruction on a {@code CONSTANT_MethodHandle}
     * constant is not subject to security manager checks.
280 281 282 283
     * <li>If the looked-up method has a
     * <a href="MethodHandle.html#maxarity">very large arity</a>,
     * the method handle creation may fail, due to the method handle
     * type having too many parameters.
284 285
     * </ul>
     *
286
     * <h1><a name="access"></a>Access checking</h1>
287 288 289
     * Access checks are applied in the factory methods of {@code Lookup},
     * when a method handle is created.
     * This is a key difference from the Core Reflection API, since
290
     * {@link java.lang.reflect.Method#invoke java.lang.reflect.Method.invoke}
291 292 293 294 295 296
     * performs access checking against every caller, on every call.
     * <p>
     * All access checks start from a {@code Lookup} object, which
     * compares its recorded lookup class against all requests to
     * create method handles.
     * A single {@code Lookup} object can be used to create any number
297 298 299
     * of access-checked method handles, all checked against a single
     * lookup class.
     * <p>
300 301 302 303 304 305 306
     * A {@code Lookup} object can be shared with other trusted code,
     * such as a metaobject protocol.
     * A shared {@code Lookup} object delegates the capability
     * to create method handles on private members of the lookup class.
     * Even if privileged code uses the {@code Lookup} object,
     * the access checking is confined to the privileges of the
     * original lookup class.
307
     * <p>
308
     * A lookup can fail, because
309 310
     * the containing class is not accessible to the lookup class, or
     * because the desired class member is missing, or because the
311 312
     * desired class member is not accessible to the lookup class, or
     * because the lookup object is not trusted enough to access the member.
313 314 315 316 317 318 319 320
     * In any of these cases, a {@code ReflectiveOperationException} will be
     * thrown from the attempted lookup.  The exact class will be one of
     * the following:
     * <ul>
     * <li>NoSuchMethodException &mdash; if a method is requested but does not exist
     * <li>NoSuchFieldException &mdash; if a field is requested but does not exist
     * <li>IllegalAccessException &mdash; if the member exists but an access check fails
     * </ul>
321
     * <p>
322
     * In general, the conditions under which a method handle may be
323 324
     * looked up for a method {@code M} are no more restrictive than the conditions
     * under which the lookup class could have compiled, verified, and resolved a call to {@code M}.
325 326 327
     * Where the JVM would raise exceptions like {@code NoSuchMethodError},
     * a method handle lookup will generally raise a corresponding
     * checked exception, such as {@code NoSuchMethodException}.
328
     * And the effect of invoking the method handle resulting from the lookup
329 330
     * is <a href="MethodHandles.Lookup.html#equiv">exactly equivalent</a>
     * to executing the compiled, verified, and resolved call to {@code M}.
331
     * The same point is true of fields and constructors.
332 333 334 335 336 337 338 339
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
     * Access checks only apply to named and reflected methods,
     * constructors, and fields.
     * Other method handle creation methods, such as
     * {@link MethodHandle#asType MethodHandle.asType},
     * do not require any access checks, and are used
     * independently of any {@code Lookup} object.
340
     * <p>
341 342 343 344 345 346 347 348 349 350 351 352
     * If the desired member is {@code protected}, the usual JVM rules apply,
     * including the requirement that the lookup class must be either be in the
     * same package as the desired member, or must inherit that member.
     * (See the Java Virtual Machine Specification, sections 4.9.2, 5.4.3.5, and 6.4.)
     * In addition, if the desired member is a non-static field or method
     * in a different package, the resulting method handle may only be applied
     * to objects of the lookup class or one of its subclasses.
     * This requirement is enforced by narrowing the type of the leading
     * {@code this} parameter from {@code C}
     * (which will necessarily be a superclass of the lookup class)
     * to the lookup class itself.
     * <p>
353 354 355 356 357 358
     * The JVM imposes a similar requirement on {@code invokespecial} instruction,
     * that the receiver argument must match both the resolved method <em>and</em>
     * the current class.  Again, this requirement is enforced by narrowing the
     * type of the leading parameter to the resulting method handle.
     * (See the Java Virtual Machine Specification, section 4.10.1.9.)
     * <p>
359 360 361 362 363 364
     * The JVM represents constructors and static initializer blocks as internal methods
     * with special names ({@code "<init>"} and {@code "<clinit>"}).
     * The internal syntax of invocation instructions allows them to refer to such internal
     * methods as if they were normal methods, but the JVM bytecode verifier rejects them.
     * A lookup of such an internal method will produce a {@code NoSuchMethodException}.
     * <p>
365
     * In some cases, access between nested classes is obtained by the Java compiler by creating
366 367
     * an wrapper method to access a private method of another class
     * in the same top-level declaration.
368
     * For example, a nested class {@code C.D}
369
     * can access private members within other related classes such as
370 371 372 373 374 375 376
     * {@code C}, {@code C.D.E}, or {@code C.B},
     * but the Java compiler may need to generate wrapper methods in
     * those related classes.  In such cases, a {@code Lookup} object on
     * {@code C.E} would be unable to those private members.
     * A workaround for this limitation is the {@link Lookup#in Lookup.in} method,
     * which can transform a lookup on {@code C.E} into one on any of those other
     * classes, without special elevation of privilege.
377
     * <p>
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
     * The accesses permitted to a given lookup object may be limited,
     * according to its set of {@link #lookupModes lookupModes},
     * to a subset of members normally accessible to the lookup class.
     * For example, the {@link MethodHandles#publicLookup publicLookup}
     * method produces a lookup object which is only allowed to access
     * public members in public classes.
     * The caller sensitive method {@link MethodHandles#lookup lookup}
     * produces a lookup object with full capabilities relative to
     * its caller class, to emulate all supported bytecode behaviors.
     * Also, the {@link Lookup#in Lookup.in} method may produce a lookup object
     * with fewer access modes than the original lookup object.
     *
     * <p style="font-size:smaller;">
     * <a name="privacc"></a>
     * <em>Discussion of private access:</em>
     * We say that a lookup has <em>private access</em>
     * if its {@linkplain #lookupModes lookup modes}
     * include the possibility of accessing {@code private} members.
     * As documented in the relevant methods elsewhere,
     * only lookups with private access possess the following capabilities:
     * <ul style="font-size:smaller;">
     * <li>access private fields, methods, and constructors of the lookup class
     * <li>create method handles which invoke <a href="MethodHandles.Lookup.html#callsens">caller sensitive</a> methods,
     *     such as {@code Class.forName}
     * <li>create method handles which {@link Lookup#findSpecial emulate invokespecial} instructions
     * <li>avoid <a href="MethodHandles.Lookup.html#secmgr">package access checks</a>
     *     for classes accessible to the lookup class
     * <li>create {@link Lookup#in delegated lookup objects} which have private access to other classes
     *     within the same package member
     * </ul>
     * <p style="font-size:smaller;">
     * Each of these permissions is a consequence of the fact that a lookup object
     * with private access can be securely traced back to an originating class,
     * whose <a href="MethodHandles.Lookup.html#equiv">bytecode behaviors</a> and Java language access permissions
     * can be reliably determined and emulated by method handles.
     *
     * <h1><a name="secmgr"></a>Security manager interactions</h1>
415 416 417 418 419 420 421 422 423 424 425 426 427 428
     * Although bytecode instructions can only refer to classes in
     * a related class loader, this API can search for methods in any
     * class, as long as a reference to its {@code Class} object is
     * available.  Such cross-loader references are also possible with the
     * Core Reflection API, and are impossible to bytecode instructions
     * such as {@code invokestatic} or {@code getfield}.
     * There is a {@linkplain java.lang.SecurityManager security manager API}
     * to allow applications to check such cross-loader references.
     * These checks apply to both the {@code MethodHandles.Lookup} API
     * and the Core Reflection API
     * (as found on {@link java.lang.Class Class}).
     * <p>
     * If a security manager is present, member lookups are subject to
     * additional checks.
429
     * From one to three calls are made to the security manager.
430 431 432
     * Any of these calls can refuse access by throwing a
     * {@link java.lang.SecurityException SecurityException}.
     * Define {@code smgr} as the security manager,
433
     * {@code lookc} as the lookup class of the current lookup object,
434 435 436
     * {@code refc} as the containing class in which the member
     * is being sought, and {@code defc} as the class in which the
     * member is actually defined.
437 438
     * The value {@code lookc} is defined as <em>not present</em>
     * if the current lookup object does not have
439
     * <a href="MethodHandles.Lookup.html#privacc">private access</a>.
440 441
     * The calls are made according to the following rules:
     * <ul>
442 443
     * <li><b>Step 1:</b>
     *     If {@code lookc} is not present, or if its class loader is not
444 445 446 447
     *     the same as or an ancestor of the class loader of {@code refc},
     *     then {@link SecurityManager#checkPackageAccess
     *     smgr.checkPackageAccess(refcPkg)} is called,
     *     where {@code refcPkg} is the package of {@code refc}.
448 449
     * <li><b>Step 2:</b>
     *     If the retrieved member is not public and
450 451 452
     *     {@code lookc} is not present, then
     *     {@link SecurityManager#checkPermission smgr.checkPermission}
     *     with {@code RuntimePermission("accessDeclaredMembers")} is called.
453 454
     * <li><b>Step 3:</b>
     *     If the retrieved member is not public,
455
     *     and if {@code lookc} is not present,
456
     *     and if {@code defc} and {@code refc} are different,
457 458 459 460
     *     then {@link SecurityManager#checkPackageAccess
     *     smgr.checkPackageAccess(defcPkg)} is called,
     *     where {@code defcPkg} is the package of {@code defc}.
     * </ul>
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
     * Security checks are performed after other access checks have passed.
     * Therefore, the above rules presuppose a member that is public,
     * or else that is being accessed from a lookup class that has
     * rights to access the member.
     *
     * <h1><a name="callsens"></a>Caller sensitive methods</h1>
     * A small number of Java methods have a special property called caller sensitivity.
     * A <em>caller-sensitive</em> method can behave differently depending on the
     * identity of its immediate caller.
     * <p>
     * If a method handle for a caller-sensitive method is requested,
     * the general rules for <a href="MethodHandles.Lookup.html#equiv">bytecode behaviors</a> apply,
     * but they take account of the lookup class in a special way.
     * The resulting method handle behaves as if it were called
     * from an instruction contained in the lookup class,
     * so that the caller-sensitive method detects the lookup class.
     * (By contrast, the invoker of the method handle is disregarded.)
     * Thus, in the case of caller-sensitive methods,
     * different lookup classes may give rise to
     * differently behaving method handles.
     * <p>
     * In cases where the lookup object is
     * {@link MethodHandles#publicLookup() publicLookup()},
     * or some other lookup object without
485
     * <a href="MethodHandles.Lookup.html#privacc">private access</a>,
486 487 488 489
     * the lookup class is disregarded.
     * In such cases, no caller-sensitive method handle can be created,
     * access is forbidden, and the lookup fails with an
     * {@code IllegalAccessException}.
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
     * For example, the caller-sensitive method
     * {@link java.lang.Class#forName(String) Class.forName(x)}
     * can return varying classes or throw varying exceptions,
     * depending on the class loader of the class that calls it.
     * A public lookup of {@code Class.forName} will fail, because
     * there is no reasonable way to determine its bytecode behavior.
     * <p style="font-size:smaller;">
     * If an application caches method handles for broad sharing,
     * it should use {@code publicLookup()} to create them.
     * If there is a lookup of {@code Class.forName}, it will fail,
     * and the application must take appropriate action in that case.
     * It may be that a later lookup, perhaps during the invocation of a
     * bootstrap method, can incorporate the specific identity
     * of the caller, making the method accessible.
     * <p style="font-size:smaller;">
     * The function {@code MethodHandles.lookup} is caller sensitive
     * so that there can be a secure foundation for lookups.
     * Nearly all other methods in the JSR 292 API rely on lookup
     * objects to check access requests.
511 512 513
     */
    public static final
    class Lookup {
514
        /** The class on behalf of whom the lookup is being performed. */
515 516
        private final Class<?> lookupClass;

517
        /** The allowed sorts of members which may be looked up (PUBLIC, etc.). */
518 519
        private final int allowedModes;

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
        /** A single-bit mask representing {@code public} access,
         *  which may contribute to the result of {@link #lookupModes lookupModes}.
         *  The value, {@code 0x01}, happens to be the same as the value of the
         *  {@code public} {@linkplain java.lang.reflect.Modifier#PUBLIC modifier bit}.
         */
        public static final int PUBLIC = Modifier.PUBLIC;

        /** A single-bit mask representing {@code private} access,
         *  which may contribute to the result of {@link #lookupModes lookupModes}.
         *  The value, {@code 0x02}, happens to be the same as the value of the
         *  {@code private} {@linkplain java.lang.reflect.Modifier#PRIVATE modifier bit}.
         */
        public static final int PRIVATE = Modifier.PRIVATE;

        /** A single-bit mask representing {@code protected} access,
         *  which may contribute to the result of {@link #lookupModes lookupModes}.
         *  The value, {@code 0x04}, happens to be the same as the value of the
         *  {@code protected} {@linkplain java.lang.reflect.Modifier#PROTECTED modifier bit}.
         */
        public static final int PROTECTED = Modifier.PROTECTED;

        /** A single-bit mask representing {@code package} access (default access),
         *  which may contribute to the result of {@link #lookupModes lookupModes}.
         *  The value is {@code 0x08}, which does not correspond meaningfully to
         *  any particular {@linkplain java.lang.reflect.Modifier modifier bit}.
         */
        public static final int PACKAGE = Modifier.STATIC;

        private static final int ALL_MODES = (PUBLIC | PRIVATE | PROTECTED | PACKAGE);
        private static final int TRUSTED   = -1;
550 551 552 553 554 555

        private static int fixmods(int mods) {
            mods &= (ALL_MODES - PACKAGE);
            return (mods != 0) ? mods : PACKAGE;
        }

556
        /** Tells which class is performing the lookup.  It is this class against
557 558
         *  which checks are performed for visibility and access permissions.
         *  <p>
559 560
         *  The class implies a maximum level of access permission,
         *  but the permissions may be additionally limited by the bitmask
561
         *  {@link #lookupModes lookupModes}, which controls whether non-public members
562
         *  can be accessed.
563
         *  @return the lookup class, on behalf of which this lookup object finds members
564 565 566 567 568
         */
        public Class<?> lookupClass() {
            return lookupClass;
        }

569 570 571 572 573
        // This is just for calling out to MethodHandleImpl.
        private Class<?> lookupClassOrNull() {
            return (allowedModes == TRUSTED) ? null : lookupClass;
        }

574
        /** Tells which access-protection classes of members this lookup object can produce.
575 576 577 578 579
         *  The result is a bit-mask of the bits
         *  {@linkplain #PUBLIC PUBLIC (0x01)},
         *  {@linkplain #PRIVATE PRIVATE (0x02)},
         *  {@linkplain #PROTECTED PROTECTED (0x04)},
         *  and {@linkplain #PACKAGE PACKAGE (0x08)}.
580 581
         *  <p>
         *  A freshly-created lookup object
582
         *  on the {@linkplain java.lang.invoke.MethodHandles#lookup() caller's class}
583 584
         *  has all possible bits set, since the caller class can access all its own members.
         *  A lookup object on a new lookup class
585
         *  {@linkplain java.lang.invoke.MethodHandles.Lookup#in created from a previous lookup object}
586 587 588 589
         *  may have some mode bits set to zero.
         *  The purpose of this is to restrict access via the new lookup object,
         *  so that it can access only names which can be reached by the original
         *  lookup object, and also by the new lookup class.
590
         *  @return the lookup modes, which limit the kinds of access performed by this lookup object
591
         */
592
        public int lookupModes() {
593 594 595
            return allowedModes & ALL_MODES;
        }

596 597 598 599 600
        /** Embody the current class (the lookupClass) as a lookup class
         * for method handle creation.
         * Must be called by from a method in this package,
         * which in turn is called by a method not in this package.
         */
601
        Lookup(Class<?> lookupClass) {
602
            this(lookupClass, ALL_MODES);
603
            // make sure we haven't accidentally picked up a privileged class:
604
            checkUnprivilegedlookupClass(lookupClass, ALL_MODES);
605 606 607
        }

        private Lookup(Class<?> lookupClass, int allowedModes) {
608
            this.lookupClass = lookupClass;
609
            this.allowedModes = allowedModes;
610 611 612
        }

        /**
613
         * Creates a lookup on the specified new lookup class.
614
         * The resulting object will report the specified
615
         * class as its own {@link #lookupClass lookupClass}.
616 617 618
         * <p>
         * However, the resulting {@code Lookup} object is guaranteed
         * to have no more access capabilities than the original.
619
         * In particular, access capabilities can be lost as follows:<ul>
620 621
         * <li>If the new lookup class differs from the old one,
         * protected members will not be accessible by virtue of inheritance.
622
         * (Protected members may continue to be accessible because of package sharing.)
623 624 625 626
         * <li>If the new lookup class is in a different package
         * than the old one, protected and default (package) members will not be accessible.
         * <li>If the new lookup class is not within the same package member
         * as the old one, private members will not be accessible.
627 628 629
         * <li>If the new lookup class is not accessible to the old lookup class,
         * then no members, not even public members, will be accessible.
         * (In all other cases, public members will continue to be accessible.)
630
         * </ul>
631 632 633 634
         *
         * @param requestedLookupClass the desired lookup class for the new lookup object
         * @return a lookup object which reports the desired lookup class
         * @throws NullPointerException if the argument is null
635
         */
636 637 638 639 640 641 642 643 644 645
        public Lookup in(Class<?> requestedLookupClass) {
            requestedLookupClass.getClass();  // null check
            if (allowedModes == TRUSTED)  // IMPL_LOOKUP can make any lookup at all
                return new Lookup(requestedLookupClass, ALL_MODES);
            if (requestedLookupClass == this.lookupClass)
                return this;  // keep same capabilities
            int newModes = (allowedModes & (ALL_MODES & ~PROTECTED));
            if ((newModes & PACKAGE) != 0
                && !VerifyAccess.isSamePackage(this.lookupClass, requestedLookupClass)) {
                newModes &= ~(PACKAGE|PRIVATE);
646
            }
647
            // Allow nestmate lookups to be created without special privilege:
648 649 650 651
            if ((newModes & PRIVATE) != 0
                && !VerifyAccess.isSamePackageMember(this.lookupClass, requestedLookupClass)) {
                newModes &= ~PRIVATE;
            }
652 653
            if ((newModes & PUBLIC) != 0
                && !VerifyAccess.isClassAccessible(requestedLookupClass, this.lookupClass, allowedModes)) {
654 655 656 657
                // The requested class it not accessible from the lookup class.
                // No permissions.
                newModes = 0;
            }
658
            checkUnprivilegedlookupClass(requestedLookupClass, newModes);
659
            return new Lookup(requestedLookupClass, newModes);
660 661
        }

662
        // Make sure outer class is initialized first.
663
        static { IMPL_NAMES.getClass(); }
664

665 666 667 668
        /** Version of lookup which is trusted minimally.
         *  It can only be used to create method handles to
         *  publicly accessible members.
         */
669
        static final Lookup PUBLIC_LOOKUP = new Lookup(Object.class, PUBLIC);
670 671

        /** Package-private version of lookup which is trusted. */
672
        static final Lookup IMPL_LOOKUP = new Lookup(Object.class, TRUSTED);
673

674
        private static void checkUnprivilegedlookupClass(Class<?> lookupClass, int allowedModes) {
675
            String name = lookupClass.getName();
676
            if (name.startsWith("java.lang.invoke."))
677
                throw newIllegalArgumentException("illegal lookupClass: "+lookupClass);
678 679 680 681 682

            // For caller-sensitive MethodHandles.lookup()
            // disallow lookup more restricted packages
            if (allowedModes == ALL_MODES && lookupClass.getClassLoader() == null) {
                if (name.startsWith("java.") ||
683 684 685
                        (name.startsWith("sun.")
                                && !name.startsWith("sun.invoke.")
                                && !name.equals("sun.reflect.ReflectionFactory"))) {
686 687 688
                    throw newIllegalArgumentException("illegal lookupClass: " + lookupClass);
                }
            }
689 690
        }

691
        /**
692
         * Displays the name of the class from which lookups are to be made.
693 694 695
         * (The name is the one reported by {@link java.lang.Class#getName() Class.getName}.)
         * If there are restrictions on the access permitted to this lookup,
         * this is indicated by adding a suffix to the class name, consisting
696 697
         * of a slash and a keyword.  The keyword represents the strongest
         * allowed access, and is chosen as follows:
698 699 700 701 702 703 704 705 706 707
         * <ul>
         * <li>If no access is allowed, the suffix is "/noaccess".
         * <li>If only public access is allowed, the suffix is "/public".
         * <li>If only public and package access are allowed, the suffix is "/package".
         * <li>If only public, package, and private access are allowed, the suffix is "/private".
         * </ul>
         * If none of the above cases apply, it is the case that full
         * access (public, package, private, and protected) is allowed.
         * In this case, no suffix is added.
         * This is true only of an object obtained originally from
708 709
         * {@link java.lang.invoke.MethodHandles#lookup MethodHandles.lookup}.
         * Objects created by {@link java.lang.invoke.MethodHandles.Lookup#in Lookup.in}
710
         * always have restricted access, and will display a suffix.
711 712 713 714 715 716 717
         * <p>
         * (It may seem strange that protected access should be
         * stronger than private access.  Viewed independently from
         * package access, protected access is the first to be lost,
         * because it requires a direct subclass relationship between
         * caller and callee.)
         * @see #in
718
         */
719 720
        @Override
        public String toString() {
721 722
            String cname = lookupClass.getName();
            switch (allowedModes) {
723 724
            case 0:  // no privileges
                return cname + "/noaccess";
725
            case PUBLIC:
726
                return cname + "/public";
727 728
            case PUBLIC|PACKAGE:
                return cname + "/package";
729 730
            case ALL_MODES & ~PROTECTED:
                return cname + "/private";
731 732
            case ALL_MODES:
                return cname;
733 734 735 736 737 738
            case TRUSTED:
                return "/trusted";  // internal only; not exported
            default:  // Should not happen, but it's a bitfield...
                cname = cname + "/" + Integer.toHexString(allowedModes);
                assert(false) : cname;
                return cname;
739
            }
740 741 742
        }

        /**
743
         * Produces a method handle for a static method.
744
         * The type of the method handle will be that of the method.
745 746
         * (Since static methods do not take receivers, there is no
         * additional receiver argument inserted into the method handle type,
747
         * as there would be with {@link #findVirtual findVirtual} or {@link #findSpecial findSpecial}.)
748
         * The method and all its argument types must be accessible to the lookup object.
749 750 751 752
         * <p>
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set.
753 754 755 756
         * <p>
         * If the returned method handle is invoked, the method's class will
         * be initialized, if it has not already been initialized.
         * <p><b>Example:</b>
757
         * <blockquote><pre>{@code
758 759 760 761 762 763 764
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle MH_asList = publicLookup().findStatic(Arrays.class,
  "asList", methodType(List.class, Object[].class));
assertEquals("[x, y]", MH_asList.invoke("x", "y").toString());
         * }</pre></blockquote>
765
         * @param refc the class from which the method is accessed
766 767 768
         * @param name the name of the method
         * @param type the type of the method
         * @return the desired method handle
769
         * @throws NoSuchMethodException if the method does not exist
770 771 772 773
         * @throws IllegalAccessException if access checking fails,
         *                                or if the method is not {@code static},
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
774 775
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
776
         * @throws NullPointerException if any argument is null
777 778
         */
        public
779
        MethodHandle findStatic(Class<?> refc, String name, MethodType type) throws NoSuchMethodException, IllegalAccessException {
780
            MemberName method = resolveOrFail(REF_invokeStatic, refc, name, type);
781
            return getDirectMethod(REF_invokeStatic, refc, method, findBoundCallerClass(method));
782
        }
783 784

        /**
785
         * Produces a method handle for a virtual method.
786
         * The type of the method handle will be that of the method,
787
         * with the receiver type (usually {@code refc}) prepended.
788
         * The method and all its argument types must be accessible to the lookup object.
789 790 791 792 793 794
         * <p>
         * When called, the handle will treat the first argument as a receiver
         * and dispatch on the receiver's type to determine which method
         * implementation to enter.
         * (The dispatching action is identical with that performed by an
         * {@code invokevirtual} or {@code invokeinterface} instruction.)
795
         * <p>
796 797 798 799 800
         * The first argument will be of type {@code refc} if the lookup
         * class has full privileges to access the member.  Otherwise
         * the member must be {@code protected} and the first argument
         * will be restricted in type to the lookup class.
         * <p>
801 802 803
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set.
804
         * <p>
805
         * Because of the general <a href="MethodHandles.Lookup.html#equiv">equivalence</a> between {@code invokevirtual}
806 807
         * instructions and method handles produced by {@code findVirtual},
         * if the class is {@code MethodHandle} and the name string is
808
         * {@code invokeExact} or {@code invoke}, the resulting
809
         * method handle is equivalent to one produced by
810
         * {@link java.lang.invoke.MethodHandles#exactInvoker MethodHandles.exactInvoker} or
811
         * {@link java.lang.invoke.MethodHandles#invoker MethodHandles.invoker}
812 813
         * with the same {@code type} argument.
         *
814
         * <b>Example:</b>
815
         * <blockquote><pre>{@code
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle MH_concat = publicLookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
MethodHandle MH_hashCode = publicLookup().findVirtual(Object.class,
  "hashCode", methodType(int.class));
MethodHandle MH_hashCode_String = publicLookup().findVirtual(String.class,
  "hashCode", methodType(int.class));
assertEquals("xy", (String) MH_concat.invokeExact("x", "y"));
assertEquals("xy".hashCode(), (int) MH_hashCode.invokeExact((Object)"xy"));
assertEquals("xy".hashCode(), (int) MH_hashCode_String.invokeExact("xy"));
// interface method:
MethodHandle MH_subSequence = publicLookup().findVirtual(CharSequence.class,
  "subSequence", methodType(CharSequence.class, int.class, int.class));
assertEquals("def", MH_subSequence.invoke("abcdefghi", 3, 6).toString());
// constructor "internal method" must be accessed differently:
MethodType MT_newString = methodType(void.class); //()V for new String()
try { assertEquals("impossible", lookup()
        .findVirtual(String.class, "<init>", MT_newString));
 } catch (NoSuchMethodException ex) { } // OK
MethodHandle MH_newString = publicLookup()
  .findConstructor(String.class, MT_newString);
assertEquals("", (String) MH_newString.invokeExact());
         * }</pre></blockquote>
         *
842
         * @param refc the class or interface from which the method is accessed
843 844 845
         * @param name the name of the method
         * @param type the type of the method, with the receiver argument omitted
         * @return the desired method handle
846
         * @throws NoSuchMethodException if the method does not exist
847 848 849 850
         * @throws IllegalAccessException if access checking fails,
         *                                or if the method is {@code static}
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
851 852
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
853
         * @throws NullPointerException if any argument is null
854
         */
855
        public MethodHandle findVirtual(Class<?> refc, String name, MethodType type) throws NoSuchMethodException, IllegalAccessException {
856 857 858 859 860 861
            if (refc == MethodHandle.class) {
                MethodHandle mh = findVirtualForMH(name, type);
                if (mh != null)  return mh;
            }
            byte refKind = (refc.isInterface() ? REF_invokeInterface : REF_invokeVirtual);
            MemberName method = resolveOrFail(refKind, refc, name, type);
862
            return getDirectMethod(refKind, refc, method, findBoundCallerClass(method));
863
        }
864 865 866 867 868 869
        private MethodHandle findVirtualForMH(String name, MethodType type) {
            // these names require special lookups because of the implicit MethodType argument
            if ("invoke".equals(name))
                return invoker(type);
            if ("invokeExact".equals(name))
                return exactInvoker(type);
R
rfield 已提交
870
            assert(!MemberName.isMethodHandleInvokeName(name));
871
            return null;
872 873 874
        }

        /**
875
         * Produces a method handle which creates an object and initializes it, using
876 877 878
         * the constructor of the specified type.
         * The parameter types of the method handle will be those of the constructor,
         * while the return type will be a reference to the constructor's class.
879
         * The constructor and all its argument types must be accessible to the lookup object.
880
         * <p>
881 882
         * The requested type must have a return type of {@code void}.
         * (This is consistent with the JVM's treatment of constructor type descriptors.)
883 884 885 886
         * <p>
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the constructor's variable arity modifier bit ({@code 0x0080}) is set.
887 888 889
         * <p>
         * If the returned method handle is invoked, the constructor's class will
         * be initialized, if it has not already been initialized.
890
         * <p><b>Example:</b>
891
         * <blockquote><pre>{@code
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle MH_newArrayList = publicLookup().findConstructor(
  ArrayList.class, methodType(void.class, Collection.class));
Collection orig = Arrays.asList("x", "y");
Collection copy = (ArrayList) MH_newArrayList.invokeExact(orig);
assert(orig != copy);
assertEquals(orig, copy);
// a variable-arity constructor:
MethodHandle MH_newProcessBuilder = publicLookup().findConstructor(
  ProcessBuilder.class, methodType(void.class, String[].class));
ProcessBuilder pb = (ProcessBuilder)
  MH_newProcessBuilder.invoke("x", "y", "z");
assertEquals("[x, y, z]", pb.command().toString());
         * }</pre></blockquote>
908 909 910
         * @param refc the class or interface from which the method is accessed
         * @param type the type of the method, with the receiver argument omitted, and a void return type
         * @return the desired method handle
911 912
         * @throws NoSuchMethodException if the constructor does not exist
         * @throws IllegalAccessException if access checking fails
913 914
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
915 916
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
917
         * @throws NullPointerException if any argument is null
918
         */
919
        public MethodHandle findConstructor(Class<?> refc, MethodType type) throws NoSuchMethodException, IllegalAccessException {
920 921 922
            if (refc.isArray()) {
                throw new NoSuchMethodException("no constructor for array class: " + refc.getName());
            }
923
            String name = "<init>";
924 925
            MemberName ctor = resolveOrFail(REF_newInvokeSpecial, refc, name, type);
            return getDirectConstructor(refc, ctor);
926 927 928
        }

        /**
929 930 931 932
         * Produces an early-bound method handle for a virtual method.
         * It will bypass checks for overriding methods on the receiver,
         * <a href="MethodHandles.Lookup.html#equiv">as if called</a> from an {@code invokespecial}
         * instruction from within the explicitly specified {@code specialCaller}.
933
         * The type of the method handle will be that of the method,
934 935
         * with a suitably restricted receiver type prepended.
         * (The receiver type will be {@code specialCaller} or a subtype.)
936
         * The method and all its argument types must be accessible
937
         * to the lookup object.
938
         * <p>
939 940 941 942
         * Before method resolution,
         * if the explicitly specified caller class is not identical with the
         * lookup class, or if this lookup object does not have
         * <a href="MethodHandles.Lookup.html#privacc">private access</a>
943
         * privileges, the access fails.
944 945 946 947
         * <p>
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set.
948
         * <p style="font-size:smaller;">
949 950 951 952 953
         * <em>(Note:  JVM internal methods named {@code "<init>"} are not visible to this API,
         * even though the {@code invokespecial} instruction can refer to them
         * in special circumstances.  Use {@link #findConstructor findConstructor}
         * to access instance initialization methods in a safe manner.)</em>
         * <p><b>Example:</b>
954
         * <blockquote><pre>{@code
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
static class Listie extends ArrayList {
  public String toString() { return "[wee Listie]"; }
  static Lookup lookup() { return MethodHandles.lookup(); }
}
...
// no access to constructor via invokeSpecial:
MethodHandle MH_newListie = Listie.lookup()
  .findConstructor(Listie.class, methodType(void.class));
Listie l = (Listie) MH_newListie.invokeExact();
try { assertEquals("impossible", Listie.lookup().findSpecial(
        Listie.class, "<init>", methodType(void.class), Listie.class));
 } catch (NoSuchMethodException ex) { } // OK
// access to super and self methods via invokeSpecial:
MethodHandle MH_super = Listie.lookup().findSpecial(
  ArrayList.class, "toString" , methodType(String.class), Listie.class);
MethodHandle MH_this = Listie.lookup().findSpecial(
  Listie.class, "toString" , methodType(String.class), Listie.class);
MethodHandle MH_duper = Listie.lookup().findSpecial(
  Object.class, "toString" , methodType(String.class), Listie.class);
assertEquals("[]", (String) MH_super.invokeExact(l));
assertEquals(""+l, (String) MH_this.invokeExact(l));
assertEquals("[]", (String) MH_duper.invokeExact(l)); // ArrayList method
try { assertEquals("inaccessible", Listie.lookup().findSpecial(
        String.class, "toString", methodType(String.class), Listie.class));
 } catch (IllegalAccessException ex) { } // OK
Listie subl = new Listie() { public String toString() { return "[subclass]"; } };
assertEquals(""+l, (String) MH_this.invokeExact(subl)); // Listie method
         * }</pre></blockquote>
         *
987 988
         * @param refc the class or interface from which the method is accessed
         * @param name the name of the method (which must not be "&lt;init&gt;")
989 990 991
         * @param type the type of the method, with the receiver argument omitted
         * @param specialCaller the proposed calling class to perform the {@code invokespecial}
         * @return the desired method handle
992 993
         * @throws NoSuchMethodException if the method does not exist
         * @throws IllegalAccessException if access checking fails
994 995
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
996 997
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
998
         * @throws NullPointerException if any argument is null
999
         */
1000
        public MethodHandle findSpecial(Class<?> refc, String name, MethodType type,
1001
                                        Class<?> specialCaller) throws NoSuchMethodException, IllegalAccessException {
1002
            checkSpecialCaller(specialCaller);
1003 1004
            Lookup specialLookup = this.in(specialCaller);
            MemberName method = specialLookup.resolveOrFail(REF_invokeSpecial, refc, name, type);
1005
            return specialLookup.getDirectMethod(REF_invokeSpecial, refc, method, findBoundCallerClass(method));
1006
        }
1007 1008

        /**
1009
         * Produces a method handle giving read access to a non-static field.
1010 1011
         * The type of the method handle will have a return type of the field's
         * value type.
1012
         * The method handle's single argument will be the instance containing
1013 1014
         * the field.
         * Access checking is performed immediately on behalf of the lookup class.
1015
         * @param refc the class or interface from which the method is accessed
1016 1017 1018
         * @param name the field's name
         * @param type the field's type
         * @return a method handle which can load values from the field
1019 1020
         * @throws NoSuchFieldException if the field does not exist
         * @throws IllegalAccessException if access checking fails, or if the field is {@code static}
1021 1022
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
1023
         * @throws NullPointerException if any argument is null
1024
         */
1025
        public MethodHandle findGetter(Class<?> refc, String name, Class<?> type) throws NoSuchFieldException, IllegalAccessException {
1026 1027
            MemberName field = resolveOrFail(REF_getField, refc, name, type);
            return getDirectField(REF_getField, refc, field);
1028
        }
1029 1030

        /**
1031
         * Produces a method handle giving write access to a non-static field.
1032
         * The type of the method handle will have a void return type.
1033
         * The method handle will take two arguments, the instance containing
1034
         * the field, and the value to be stored.
1035 1036
         * The second argument will be of the field's value type.
         * Access checking is performed immediately on behalf of the lookup class.
1037
         * @param refc the class or interface from which the method is accessed
1038 1039 1040
         * @param name the field's name
         * @param type the field's type
         * @return a method handle which can store values into the field
1041 1042
         * @throws NoSuchFieldException if the field does not exist
         * @throws IllegalAccessException if access checking fails, or if the field is {@code static}
1043 1044
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
1045
         * @throws NullPointerException if any argument is null
1046
         */
1047
        public MethodHandle findSetter(Class<?> refc, String name, Class<?> type) throws NoSuchFieldException, IllegalAccessException {
1048 1049
            MemberName field = resolveOrFail(REF_putField, refc, name, type);
            return getDirectField(REF_putField, refc, field);
1050
        }
1051 1052

        /**
1053
         * Produces a method handle giving read access to a static field.
1054 1055 1056 1057
         * The type of the method handle will have a return type of the field's
         * value type.
         * The method handle will take no arguments.
         * Access checking is performed immediately on behalf of the lookup class.
1058 1059 1060
         * <p>
         * If the returned method handle is invoked, the field's class will
         * be initialized, if it has not already been initialized.
1061
         * @param refc the class or interface from which the method is accessed
1062 1063 1064
         * @param name the field's name
         * @param type the field's type
         * @return a method handle which can load values from the field
1065 1066
         * @throws NoSuchFieldException if the field does not exist
         * @throws IllegalAccessException if access checking fails, or if the field is not {@code static}
1067 1068
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
1069
         * @throws NullPointerException if any argument is null
1070
         */
1071
        public MethodHandle findStaticGetter(Class<?> refc, String name, Class<?> type) throws NoSuchFieldException, IllegalAccessException {
1072 1073
            MemberName field = resolveOrFail(REF_getStatic, refc, name, type);
            return getDirectField(REF_getStatic, refc, field);
1074
        }
1075 1076

        /**
1077
         * Produces a method handle giving write access to a static field.
1078 1079 1080
         * The type of the method handle will have a void return type.
         * The method handle will take a single
         * argument, of the field's value type, the value to be stored.
1081
         * Access checking is performed immediately on behalf of the lookup class.
1082 1083 1084
         * <p>
         * If the returned method handle is invoked, the field's class will
         * be initialized, if it has not already been initialized.
1085
         * @param refc the class or interface from which the method is accessed
1086 1087
         * @param name the field's name
         * @param type the field's type
1088
         * @return a method handle which can store values into the field
1089 1090
         * @throws NoSuchFieldException if the field does not exist
         * @throws IllegalAccessException if access checking fails, or if the field is not {@code static}
1091 1092
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
1093
         * @throws NullPointerException if any argument is null
1094
         */
1095
        public MethodHandle findStaticSetter(Class<?> refc, String name, Class<?> type) throws NoSuchFieldException, IllegalAccessException {
1096 1097
            MemberName field = resolveOrFail(REF_putStatic, refc, name, type);
            return getDirectField(REF_putStatic, refc, field);
1098
        }
1099 1100

        /**
1101
         * Produces an early-bound method handle for a non-static method.
1102 1103
         * The receiver must have a supertype {@code defc} in which a method
         * of the given name and type is accessible to the lookup class.
1104
         * The method and all its argument types must be accessible to the lookup object.
1105 1106 1107 1108 1109
         * The type of the method handle will be that of the method,
         * without any insertion of an additional receiver parameter.
         * The given receiver will be bound into the method handle,
         * so that every call to the method handle will invoke the
         * requested method on the given receiver.
1110
         * <p>
1111 1112 1113 1114 1115 1116 1117 1118
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set
         * <em>and</em> the trailing array argument is not the only argument.
         * (If the trailing array argument is the only argument,
         * the given receiver value will be bound to it.)
         * <p>
         * This is equivalent to the following code:
1119
         * <blockquote><pre>{@code
1120 1121 1122
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
1123 1124
MethodHandle mh0 = lookup().findVirtual(defc, name, type);
MethodHandle mh1 = mh0.bindTo(receiver);
1125
MethodType mt1 = mh1.type();
1126
if (mh0.isVarargsCollector())
1127 1128
  mh1 = mh1.asVarargsCollector(mt1.parameterType(mt1.parameterCount()-1));
return mh1;
1129
         * }</pre></blockquote>
1130 1131 1132
         * where {@code defc} is either {@code receiver.getClass()} or a super
         * type of that class, in which the requested method is accessible
         * to the lookup class.
1133
         * (Note that {@code bindTo} does not preserve variable arity.)
1134 1135 1136 1137
         * @param receiver the object from which the method is accessed
         * @param name the name of the method
         * @param type the type of the method, with the receiver argument omitted
         * @return the desired method handle
1138 1139
         * @throws NoSuchMethodException if the method does not exist
         * @throws IllegalAccessException if access checking fails
1140 1141
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
1142 1143
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
1144
         * @throws NullPointerException if any argument is null
1145 1146
         * @see MethodHandle#bindTo
         * @see #findVirtual
1147
         */
1148
        public MethodHandle bind(Object receiver, String name, MethodType type) throws NoSuchMethodException, IllegalAccessException {
1149
            Class<? extends Object> refc = receiver.getClass(); // may get NPE
1150
            MemberName method = resolveOrFail(REF_invokeSpecial, refc, name, type);
1151
            MethodHandle mh = getDirectMethodNoRestrict(REF_invokeSpecial, refc, method, findBoundCallerClass(method));
1152
            return mh.bindArgumentL(0, receiver).setVarargs(method);
1153 1154 1155
        }

        /**
1156 1157
         * Makes a <a href="MethodHandleInfo.html#directmh">direct method handle</a>
         * to <i>m</i>, if the lookup class has permission.
1158 1159 1160 1161 1162 1163 1164 1165
         * If <i>m</i> is non-static, the receiver argument is treated as an initial argument.
         * If <i>m</i> is virtual, overriding is respected on every call.
         * Unlike the Core Reflection API, exceptions are <em>not</em> wrapped.
         * The type of the method handle will be that of the method,
         * with the receiver type prepended (but only if it is non-static).
         * If the method's {@code accessible} flag is not set,
         * access checking is performed immediately on behalf of the lookup class.
         * If <i>m</i> is not public, do not share the resulting handle with untrusted parties.
1166 1167 1168 1169
         * <p>
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set.
1170 1171 1172 1173
         * <p>
         * If <i>m</i> is static, and
         * if the returned method handle is invoked, the method's class will
         * be initialized, if it has not already been initialized.
1174 1175
         * @param m the reflected method
         * @return a method handle which can invoke the reflected method
1176
         * @throws IllegalAccessException if access checking fails
1177 1178
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
1179
         * @throws NullPointerException if the argument is null
1180
         */
1181
        public MethodHandle unreflect(Method m) throws IllegalAccessException {
R
rfield 已提交
1182 1183 1184 1185
            if (m.getDeclaringClass() == MethodHandle.class) {
                MethodHandle mh = unreflectForMH(m);
                if (mh != null)  return mh;
            }
1186
            MemberName method = new MemberName(m);
1187 1188 1189
            byte refKind = method.getReferenceKind();
            if (refKind == REF_invokeSpecial)
                refKind = REF_invokeVirtual;
1190
            assert(method.isMethod());
1191
            Lookup lookup = m.isAccessible() ? IMPL_LOOKUP : this;
1192
            return lookup.getDirectMethodNoSecurityManager(refKind, method.getDeclaringClass(), method, findBoundCallerClass(method));
1193
        }
R
rfield 已提交
1194 1195 1196 1197 1198 1199
        private MethodHandle unreflectForMH(Method m) {
            // these names require special lookups because they throw UnsupportedOperationException
            if (MemberName.isMethodHandleInvokeName(m.getName()))
                return MethodHandleImpl.fakeMethodHandleInvoke(new MemberName(m));
            return null;
        }
1200 1201

        /**
1202
         * Produces a method handle for a reflected method.
1203
         * It will bypass checks for overriding methods on the receiver,
1204 1205
         * <a href="MethodHandles.Lookup.html#equiv">as if called</a> from an {@code invokespecial}
         * instruction from within the explicitly specified {@code specialCaller}.
1206
         * The type of the method handle will be that of the method,
1207 1208
         * with a suitably restricted receiver type prepended.
         * (The receiver type will be {@code specialCaller} or a subtype.)
1209 1210 1211
         * If the method's {@code accessible} flag is not set,
         * access checking is performed immediately on behalf of the lookup class,
         * as if {@code invokespecial} instruction were being linked.
1212
         * <p>
1213 1214 1215 1216 1217 1218
         * Before method resolution,
         * if the explicitly specified caller class is not identical with the
         * lookup class, or if this lookup object does not have
         * <a href="MethodHandles.Lookup.html#privacc">private access</a>
         * privileges, the access fails.
         * <p>
1219 1220 1221
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the method's variable arity modifier bit ({@code 0x0080}) is set.
1222
         * @param m the reflected method
1223
         * @param specialCaller the class nominally calling the method
1224
         * @return a method handle which can invoke the reflected method
1225
         * @throws IllegalAccessException if access checking fails
1226 1227
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
1228
         * @throws NullPointerException if any argument is null
1229
         */
1230
        public MethodHandle unreflectSpecial(Method m, Class<?> specialCaller) throws IllegalAccessException {
1231
            checkSpecialCaller(specialCaller);
1232 1233
            Lookup specialLookup = this.in(specialCaller);
            MemberName method = new MemberName(m, true);
1234 1235
            assert(method.isMethod());
            // ignore m.isAccessible:  this is a new kind of access
1236
            return specialLookup.getDirectMethodNoSecurityManager(REF_invokeSpecial, method.getDeclaringClass(), method, findBoundCallerClass(method));
1237 1238 1239
        }

        /**
1240
         * Produces a method handle for a reflected constructor.
1241 1242
         * The type of the method handle will be that of the constructor,
         * with the return type changed to the declaring class.
1243 1244 1245 1246 1247
         * The method handle will perform a {@code newInstance} operation,
         * creating a new instance of the constructor's class on the
         * arguments passed to the method handle.
         * <p>
         * If the constructor's {@code accessible} flag is not set,
1248
         * access checking is performed immediately on behalf of the lookup class.
1249 1250 1251 1252
         * <p>
         * The returned method handle will have
         * {@linkplain MethodHandle#asVarargsCollector variable arity} if and only if
         * the constructor's variable arity modifier bit ({@code 0x0080}) is set.
1253 1254 1255
         * <p>
         * If the returned method handle is invoked, the constructor's class will
         * be initialized, if it has not already been initialized.
1256
         * @param c the reflected constructor
1257
         * @return a method handle which can invoke the reflected constructor
1258
         * @throws IllegalAccessException if access checking fails
1259 1260
         *                                or if the method's variable arity modifier bit
         *                                is set and {@code asVarargsCollector} fails
1261
         * @throws NullPointerException if the argument is null
1262
         */
1263
        public MethodHandle unreflectConstructor(Constructor<?> c) throws IllegalAccessException {
1264 1265
            MemberName ctor = new MemberName(c);
            assert(ctor.isConstructor());
1266
            Lookup lookup = c.isAccessible() ? IMPL_LOOKUP : this;
1267
            return lookup.getDirectConstructorNoSecurityManager(ctor.getDeclaringClass(), ctor);
1268 1269 1270
        }

        /**
1271
         * Produces a method handle giving read access to a reflected field.
1272
         * The type of the method handle will have a return type of the field's
1273 1274 1275 1276
         * value type.
         * If the field is static, the method handle will take no arguments.
         * Otherwise, its single argument will be the instance containing
         * the field.
1277
         * If the field's {@code accessible} flag is not set,
1278
         * access checking is performed immediately on behalf of the lookup class.
1279 1280 1281 1282
         * <p>
         * If the field is static, and
         * if the returned method handle is invoked, the field's class will
         * be initialized, if it has not already been initialized.
1283 1284
         * @param f the reflected field
         * @return a method handle which can load values from the reflected field
1285 1286
         * @throws IllegalAccessException if access checking fails
         * @throws NullPointerException if the argument is null
1287
         */
1288
        public MethodHandle unreflectGetter(Field f) throws IllegalAccessException {
1289 1290 1291 1292 1293 1294 1295 1296
            return unreflectField(f, false);
        }
        private MethodHandle unreflectField(Field f, boolean isSetter) throws IllegalAccessException {
            MemberName field = new MemberName(f, isSetter);
            assert(isSetter
                    ? MethodHandleNatives.refKindIsSetter(field.getReferenceKind())
                    : MethodHandleNatives.refKindIsGetter(field.getReferenceKind()));
            Lookup lookup = f.isAccessible() ? IMPL_LOOKUP : this;
1297
            return lookup.getDirectFieldNoSecurityManager(field.getReferenceKind(), f.getDeclaringClass(), field);
1298 1299 1300
        }

        /**
1301
         * Produces a method handle giving write access to a reflected field.
1302
         * The type of the method handle will have a void return type.
1303 1304 1305 1306
         * If the field is static, the method handle will take a single
         * argument, of the field's value type, the value to be stored.
         * Otherwise, the two arguments will be the instance containing
         * the field, and the value to be stored.
1307
         * If the field's {@code accessible} flag is not set,
1308
         * access checking is performed immediately on behalf of the lookup class.
1309 1310 1311 1312
         * <p>
         * If the field is static, and
         * if the returned method handle is invoked, the field's class will
         * be initialized, if it has not already been initialized.
1313 1314
         * @param f the reflected field
         * @return a method handle which can store values into the reflected field
1315 1316
         * @throws IllegalAccessException if access checking fails
         * @throws NullPointerException if the argument is null
1317
         */
1318
        public MethodHandle unreflectSetter(Field f) throws IllegalAccessException {
1319
            return unreflectField(f, true);
1320 1321
        }

R
rfield 已提交
1322
        /**
1323 1324
         * Cracks a <a href="MethodHandleInfo.html#directmh">direct method handle</a>
         * created by this lookup object or a similar one.
R
rfield 已提交
1325 1326 1327 1328
         * Security and access checks are performed to ensure that this lookup object
         * is capable of reproducing the target method handle.
         * This means that the cracking may fail if target is a direct method handle
         * but was created by an unrelated lookup object.
1329 1330
         * This can happen if the method handle is <a href="MethodHandles.Lookup.html#callsens">caller sensitive</a>
         * and was created by a lookup object for a different class.
R
rfield 已提交
1331 1332 1333 1334 1335 1336
         * @param target a direct method handle to crack into symbolic reference components
         * @return a symbolic reference which can be used to reconstruct this method handle from this lookup object
         * @exception SecurityException if a security manager is present and it
         *                              <a href="MethodHandles.Lookup.html#secmgr">refuses access</a>
         * @throws IllegalArgumentException if the target is not a direct method handle or if access checking fails
         * @exception NullPointerException if the target is {@code null}
1337
         * @see MethodHandleInfo
R
rfield 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
         * @since 1.8
         */
        public MethodHandleInfo revealDirect(MethodHandle target) {
            MemberName member = target.internalMemberName();
            if (member == null || (!member.isResolved() && !member.isMethodHandleInvoke()))
                throw newIllegalArgumentException("not a direct method handle");
            Class<?> defc = member.getDeclaringClass();
            byte refKind = member.getReferenceKind();
            assert(MethodHandleNatives.refKindIsValid(refKind));
            if (refKind == REF_invokeSpecial && !target.isInvokeSpecial())
                // Devirtualized method invocation is usually formally virtual.
                // To avoid creating extra MemberName objects for this common case,
                // we encode this extra degree of freedom using MH.isInvokeSpecial.
                refKind = REF_invokeVirtual;
            if (refKind == REF_invokeVirtual && defc.isInterface())
                // Symbolic reference is through interface but resolves to Object method (toString, etc.)
                refKind = REF_invokeInterface;
            // Check SM permissions and member access before cracking.
            try {
                checkAccess(refKind, defc, member);
1358
                checkSecurityManager(defc, member);
R
rfield 已提交
1359 1360 1361
            } catch (IllegalAccessException ex) {
                throw new IllegalArgumentException(ex);
            }
1362 1363 1364 1365 1366
            if (allowedModes != TRUSTED && member.isCallerSensitive()) {
                Class<?> callerClass = target.internalCallerClass();
                if (!hasPrivateAccess() || callerClass != lookupClass())
                    throw new IllegalArgumentException("method handle is caller sensitive: "+callerClass);
            }
R
rfield 已提交
1367 1368 1369 1370
            // Produce the handle to the results.
            return new InfoFromMemberName(this, member, refKind);
        }

1371
        /// Helper methods, all package-private.
1372

1373
        MemberName resolveOrFail(byte refKind, Class<?> refc, String name, Class<?> type) throws NoSuchFieldException, IllegalAccessException {
1374
            checkSymbolicClass(refc);  // do this before attempting to resolve
1375 1376
            name.getClass();  // NPE
            type.getClass();  // NPE
1377
            return IMPL_NAMES.resolveOrFail(refKind, new MemberName(refc, name, type, refKind), lookupClassOrNull(),
1378
                                            NoSuchFieldException.class);
1379
        }
1380

1381
        MemberName resolveOrFail(byte refKind, Class<?> refc, String name, MethodType type) throws NoSuchMethodException, IllegalAccessException {
1382
            checkSymbolicClass(refc);  // do this before attempting to resolve
1383 1384
            name.getClass();  // NPE
            type.getClass();  // NPE
1385
            checkMethodName(refKind, name);  // NPE check on name
1386
            return IMPL_NAMES.resolveOrFail(refKind, new MemberName(refc, name, type, refKind), lookupClassOrNull(),
1387
                                            NoSuchMethodException.class);
1388
        }
1389

1390 1391 1392 1393 1394 1395 1396 1397
        MemberName resolveOrFail(byte refKind, MemberName member) throws ReflectiveOperationException {
            checkSymbolicClass(member.getDeclaringClass());  // do this before attempting to resolve
            member.getName().getClass();  // NPE
            member.getType().getClass();  // NPE
            return IMPL_NAMES.resolveOrFail(refKind, member, lookupClassOrNull(),
                                            ReflectiveOperationException.class);
        }

1398
        void checkSymbolicClass(Class<?> refc) throws IllegalAccessException {
1399
            refc.getClass();  // NPE
1400
            Class<?> caller = lookupClassOrNull();
1401
            if (caller != null && !VerifyAccess.isClassAccessible(refc, caller, allowedModes))
1402
                throw new MemberName(refc).makeAccessException("symbolic reference class is not public", this);
1403 1404
        }

1405
        /** Check name for an illegal leading "&lt;" character. */
1406 1407 1408 1409 1410 1411
        void checkMethodName(byte refKind, String name) throws NoSuchMethodException {
            if (name.startsWith("<") && refKind != REF_newInvokeSpecial)
                throw new NoSuchMethodException("illegal method name: "+name);
        }


1412 1413 1414
        /**
         * Find my trustable caller class if m is a caller sensitive method.
         * If this lookup object has private access, then the caller class is the lookupClass.
1415
         * Otherwise, if m is caller-sensitive, throw IllegalAccessException.
1416
         */
1417
        Class<?> findBoundCallerClass(MemberName m) throws IllegalAccessException {
1418 1419
            Class<?> callerClass = null;
            if (MethodHandleNatives.isCallerSensitive(m)) {
1420 1421
                // Only lookups with private access are allowed to resolve caller-sensitive methods
                if (hasPrivateAccess()) {
1422 1423 1424 1425
                    callerClass = lookupClass;
                } else {
                    throw new IllegalAccessException("Attempt to lookup caller-sensitive method using restricted lookup object");
                }
1426 1427 1428
            }
            return callerClass;
        }
1429

1430
        private boolean hasPrivateAccess() {
1431 1432 1433
            return (allowedModes & PRIVATE) != 0;
        }

1434 1435
        /**
         * Perform necessary <a href="MethodHandles.Lookup.html#secmgr">access checks</a>.
1436 1437
         * Determines a trustable caller class to compare with refc, the symbolic reference class.
         * If this lookup object has private access, then the caller class is the lookupClass.
1438
         */
1439
        void checkSecurityManager(Class<?> refc, MemberName m) {
1440 1441 1442
            SecurityManager smgr = System.getSecurityManager();
            if (smgr == null)  return;
            if (allowedModes == TRUSTED)  return;
1443

1444
            // Step 1:
1445 1446
            boolean fullPowerLookup = hasPrivateAccess();
            if (!fullPowerLookup ||
1447 1448 1449
                !VerifyAccess.classLoaderIsAncestor(lookupClass, refc)) {
                ReflectUtil.checkPackageAccess(refc);
            }
1450

1451
            // Step 2:
1452
            if (m.isPublic()) return;
1453 1454
            if (!fullPowerLookup) {
                smgr.checkPermission(SecurityConstants.CHECK_MEMBER_ACCESS_PERMISSION);
1455 1456
            }

1457
            // Step 3:
1458 1459
            Class<?> defc = m.getDeclaringClass();
            if (!fullPowerLookup && defc != refc) {
1460 1461
                ReflectUtil.checkPackageAccess(defc);
            }
1462 1463
        }

1464 1465
        void checkMethod(byte refKind, Class<?> refc, MemberName m) throws IllegalAccessException {
            boolean wantStatic = (refKind == REF_invokeStatic);
1466 1467 1468 1469 1470 1471 1472 1473
            String message;
            if (m.isConstructor())
                message = "expected a method, not a constructor";
            else if (!m.isMethod())
                message = "expected a method";
            else if (wantStatic != m.isStatic())
                message = wantStatic ? "expected a static method" : "expected a non-static method";
            else
1474
                { checkAccess(refKind, refc, m); return; }
1475
            throw m.makeAccessException(message, this);
1476 1477
        }

1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
        void checkField(byte refKind, Class<?> refc, MemberName m) throws IllegalAccessException {
            boolean wantStatic = !MethodHandleNatives.refKindHasReceiver(refKind);
            String message;
            if (wantStatic != m.isStatic())
                message = wantStatic ? "expected a static field" : "expected a non-static field";
            else
                { checkAccess(refKind, refc, m); return; }
            throw m.makeAccessException(message, this);
        }

1488
        /** Check public/protected/private bits on the symbolic reference class and its member. */
1489 1490 1491 1492
        void checkAccess(byte refKind, Class<?> refc, MemberName m) throws IllegalAccessException {
            assert(m.referenceKindIsConsistentWith(refKind) &&
                   MethodHandleNatives.refKindIsValid(refKind) &&
                   (MethodHandleNatives.refKindIsField(refKind) == m.isField()));
1493 1494 1495
            int allowedModes = this.allowedModes;
            if (allowedModes == TRUSTED)  return;
            int mods = m.getModifiers();
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
            if (Modifier.isProtected(mods) &&
                    refKind == REF_invokeVirtual &&
                    m.getDeclaringClass() == Object.class &&
                    m.getName().equals("clone") &&
                    refc.isArray()) {
                // The JVM does this hack also.
                // (See ClassVerifier::verify_invoke_instructions
                // and LinkResolver::check_method_accessability.)
                // Because the JVM does not allow separate methods on array types,
                // there is no separate method for int[].clone.
                // All arrays simply inherit Object.clone.
                // But for access checking logic, we make Object.clone
                // (normally protected) appear to be public.
                // Later on, when the DirectMethodHandle is created,
                // its leading argument will be restricted to the
                // requested array type.
                // N.B. The return type is not adjusted, because
                // that is *not* the bytecode behavior.
                mods ^= Modifier.PROTECTED | Modifier.PUBLIC;
            }
1516 1517 1518 1519
            if (Modifier.isProtected(mods) && refKind == REF_newInvokeSpecial) {
                // cannot "new" a protected ctor in a different package
                mods ^= Modifier.PROTECTED;
            }
1520 1521 1522
            if (Modifier.isFinal(mods) &&
                    MethodHandleNatives.refKindIsSetter(refKind))
                throw m.makeAccessException("unexpected set of a final field", this);
1523
            if (Modifier.isPublic(mods) && Modifier.isPublic(refc.getModifiers()) && allowedModes != 0)
1524 1525
                return;  // common case
            int requestedModes = fixmods(mods);  // adjust 0 => PACKAGE
1526 1527 1528 1529 1530
            if ((requestedModes & allowedModes) != 0) {
                if (VerifyAccess.isMemberAccessible(refc, m.getDeclaringClass(),
                                                    mods, lookupClass(), allowedModes))
                    return;
            } else {
1531
                // Protected members can also be checked as if they were package-private.
1532 1533 1534 1535
                if ((requestedModes & PROTECTED) != 0 && (allowedModes & PACKAGE) != 0
                        && VerifyAccess.isSamePackage(m.getDeclaringClass(), lookupClass()))
                    return;
            }
1536
            throw m.makeAccessException(accessFailedMessage(refc, m), this);
1537 1538 1539 1540 1541
        }

        String accessFailedMessage(Class<?> refc, MemberName m) {
            Class<?> defc = m.getDeclaringClass();
            int mods = m.getModifiers();
1542 1543 1544 1545 1546
            // check the class first:
            boolean classOK = (Modifier.isPublic(defc.getModifiers()) &&
                               (defc == refc ||
                                Modifier.isPublic(refc.getModifiers())));
            if (!classOK && (allowedModes & PACKAGE) != 0) {
1547
                classOK = (VerifyAccess.isClassAccessible(defc, lookupClass(), ALL_MODES) &&
1548
                           (defc == refc ||
1549
                            VerifyAccess.isClassAccessible(refc, lookupClass(), ALL_MODES)));
1550 1551
            }
            if (!classOK)
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
                return "class is not public";
            if (Modifier.isPublic(mods))
                return "access to public member failed";  // (how?)
            if (Modifier.isPrivate(mods))
                return "member is private";
            if (Modifier.isProtected(mods))
                return "member is protected";
            return "member is private to package";
        }

1562 1563
        private static final boolean ALLOW_NESTMATE_ACCESS = false;

1564 1565
        private void checkSpecialCaller(Class<?> specialCaller) throws IllegalAccessException {
            int allowedModes = this.allowedModes;
1566
            if (allowedModes == TRUSTED)  return;
1567
            if (!hasPrivateAccess()
1568 1569 1570
                || (specialCaller != lookupClass()
                    && !(ALLOW_NESTMATE_ACCESS &&
                         VerifyAccess.isSamePackageMember(specialCaller, lookupClass()))))
1571 1572
                throw new MemberName(specialCaller).
                    makeAccessException("no private access for invokespecial", this);
1573 1574
        }

1575
        private boolean restrictProtectedReceiver(MemberName method) {
1576 1577 1578 1579
            // The accessing class only has the right to use a protected member
            // on itself or a subclass.  Enforce that restriction, from JVMS 5.4.4, etc.
            if (!method.isProtected() || method.isStatic()
                || allowedModes == TRUSTED
1580
                || method.getDeclaringClass() == lookupClass()
1581
                || VerifyAccess.isSamePackage(method.getDeclaringClass(), lookupClass())
1582 1583
                || (ALLOW_NESTMATE_ACCESS &&
                    VerifyAccess.isSamePackageMember(method.getDeclaringClass(), lookupClass())))
1584 1585
                return false;
            return true;
1586
        }
1587
        private MethodHandle restrictReceiver(MemberName method, DirectMethodHandle mh, Class<?> caller) throws IllegalAccessException {
1588
            assert(!method.isStatic());
1589 1590
            // receiver type of mh is too wide; narrow to caller
            if (!method.getDeclaringClass().isAssignableFrom(caller)) {
1591
                throw method.makeAccessException("caller class must be a subclass below the method", caller);
1592
            }
1593 1594 1595
            MethodType rawType = mh.type();
            if (rawType.parameterType(0) == caller)  return mh;
            MethodType narrowType = rawType.changeParameterType(0, caller);
1596 1597 1598
            assert(!mh.isVarargsCollector());  // viewAsType will lose varargs-ness
            assert(mh.viewAsTypeChecks(narrowType, true));
            return mh.copyWith(narrowType, mh.form);
1599 1600
        }

1601
        /** Check access and get the requested method. */
1602
        private MethodHandle getDirectMethod(byte refKind, Class<?> refc, MemberName method, Class<?> callerClass) throws IllegalAccessException {
1603 1604 1605
            final boolean doRestrict    = true;
            final boolean checkSecurity = true;
            return getDirectMethodCommon(refKind, refc, method, checkSecurity, doRestrict, callerClass);
1606
        }
1607
        /** Check access and get the requested method, eliding receiver narrowing rules. */
1608
        private MethodHandle getDirectMethodNoRestrict(byte refKind, Class<?> refc, MemberName method, Class<?> callerClass) throws IllegalAccessException {
1609 1610 1611 1612 1613 1614 1615 1616 1617
            final boolean doRestrict    = false;
            final boolean checkSecurity = true;
            return getDirectMethodCommon(refKind, refc, method, checkSecurity, doRestrict, callerClass);
        }
        /** Check access and get the requested method, eliding security manager checks. */
        private MethodHandle getDirectMethodNoSecurityManager(byte refKind, Class<?> refc, MemberName method, Class<?> callerClass) throws IllegalAccessException {
            final boolean doRestrict    = true;
            final boolean checkSecurity = false;  // not needed for reflection or for linking CONSTANT_MH constants
            return getDirectMethodCommon(refKind, refc, method, checkSecurity, doRestrict, callerClass);
1618
        }
1619
        /** Common code for all methods; do not call directly except from immediately above. */
1620
        private MethodHandle getDirectMethodCommon(byte refKind, Class<?> refc, MemberName method,
1621
                                                   boolean checkSecurity,
1622
                                                   boolean doRestrict, Class<?> callerClass) throws IllegalAccessException {
1623
            checkMethod(refKind, refc, method);
1624 1625 1626
            // Optionally check with the security manager; this isn't needed for unreflect* calls.
            if (checkSecurity)
                checkSecurityManager(refc, method);
R
rfield 已提交
1627
            assert(!method.isMethodHandleInvoke());
1628 1629 1630

            if (refKind == REF_invokeSpecial &&
                refc != lookupClass() &&
R
rfield 已提交
1631
                !refc.isInterface() &&
1632
                refc != lookupClass().getSuperclass() &&
1633 1634 1635 1636 1637
                refc.isAssignableFrom(lookupClass())) {
                assert(!method.getName().equals("<init>"));  // not this code path
                // Per JVMS 6.5, desc. of invokespecial instruction:
                // If the method is in a superclass of the LC,
                // and if our original search was above LC.super,
1638 1639 1640
                // repeat the search (symbolic lookup) from LC.super
                // and continue with the direct superclass of that class,
                // and so forth, until a match is found or no further superclasses exist.
1641
                // FIXME: MemberName.resolve should handle this instead.
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
                Class<?> refcAsSuper = lookupClass();
                MemberName m2;
                do {
                    refcAsSuper = refcAsSuper.getSuperclass();
                    m2 = new MemberName(refcAsSuper,
                                        method.getName(),
                                        method.getMethodType(),
                                        REF_invokeSpecial);
                    m2 = IMPL_NAMES.resolveOrNull(refKind, m2, lookupClassOrNull());
                } while (m2 == null &&         // no method is found yet
                         refc != refcAsSuper); // search up to refc
1653 1654 1655 1656 1657 1658 1659
                if (m2 == null)  throw new InternalError(method.toString());
                method = m2;
                refc = refcAsSuper;
                // redo basic checks
                checkMethod(refKind, refc, method);
            }

1660 1661
            DirectMethodHandle dmh = DirectMethodHandle.make(refKind, refc, method);
            MethodHandle mh = dmh;
1662 1663 1664 1665
            // Optionally narrow the receiver argument to refc using restrictReceiver.
            if (doRestrict &&
                   (refKind == REF_invokeSpecial ||
                       (MethodHandleNatives.refKindHasReceiver(refKind) &&
1666 1667 1668 1669 1670
                           restrictProtectedReceiver(method)))) {
                mh = restrictReceiver(method, dmh, lookupClass());
            }
            mh = maybeBindCaller(method, mh, callerClass);
            mh = mh.setVarargs(method);
1671 1672
            return mh;
        }
1673 1674 1675
        private MethodHandle maybeBindCaller(MemberName method, MethodHandle mh,
                                             Class<?> callerClass)
                                             throws IllegalAccessException {
1676 1677 1678
            if (allowedModes == TRUSTED || !MethodHandleNatives.isCallerSensitive(method))
                return mh;
            Class<?> hostClass = lookupClass;
1679
            if (!hasPrivateAccess())  // caller must have private access
1680
                hostClass = callerClass;  // callerClass came from a security manager style stack walk
1681 1682 1683 1684
            MethodHandle cbmh = MethodHandleImpl.bindCaller(mh, hostClass);
            // Note: caller will apply varargs after this step happens.
            return cbmh;
        }
1685
        /** Check access and get the requested field. */
1686
        private MethodHandle getDirectField(byte refKind, Class<?> refc, MemberName field) throws IllegalAccessException {
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
            final boolean checkSecurity = true;
            return getDirectFieldCommon(refKind, refc, field, checkSecurity);
        }
        /** Check access and get the requested field, eliding security manager checks. */
        private MethodHandle getDirectFieldNoSecurityManager(byte refKind, Class<?> refc, MemberName field) throws IllegalAccessException {
            final boolean checkSecurity = false;  // not needed for reflection or for linking CONSTANT_MH constants
            return getDirectFieldCommon(refKind, refc, field, checkSecurity);
        }
        /** Common code for all fields; do not call directly except from immediately above. */
        private MethodHandle getDirectFieldCommon(byte refKind, Class<?> refc, MemberName field,
                                                  boolean checkSecurity) throws IllegalAccessException {
1698
            checkField(refKind, refc, field);
1699 1700 1701
            // Optionally check with the security manager; this isn't needed for unreflect* calls.
            if (checkSecurity)
                checkSecurityManager(refc, field);
1702
            DirectMethodHandle dmh = DirectMethodHandle.make(refc, field);
1703 1704 1705
            boolean doRestrict = (MethodHandleNatives.refKindHasReceiver(refKind) &&
                                    restrictProtectedReceiver(field));
            if (doRestrict)
1706 1707
                return restrictReceiver(field, dmh, lookupClass());
            return dmh;
1708
        }
1709
        /** Check access and get the requested constructor. */
1710
        private MethodHandle getDirectConstructor(Class<?> refc, MemberName ctor) throws IllegalAccessException {
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
            final boolean checkSecurity = true;
            return getDirectConstructorCommon(refc, ctor, checkSecurity);
        }
        /** Check access and get the requested constructor, eliding security manager checks. */
        private MethodHandle getDirectConstructorNoSecurityManager(Class<?> refc, MemberName ctor) throws IllegalAccessException {
            final boolean checkSecurity = false;  // not needed for reflection or for linking CONSTANT_MH constants
            return getDirectConstructorCommon(refc, ctor, checkSecurity);
        }
        /** Common code for all constructors; do not call directly except from immediately above. */
        private MethodHandle getDirectConstructorCommon(Class<?> refc, MemberName ctor,
                                                  boolean checkSecurity) throws IllegalAccessException {
1722 1723
            assert(ctor.isConstructor());
            checkAccess(REF_newInvokeSpecial, refc, ctor);
1724 1725 1726
            // Optionally check with the security manager; this isn't needed for unreflect* calls.
            if (checkSecurity)
                checkSecurityManager(refc, ctor);
1727
            assert(!MethodHandleNatives.isCallerSensitive(ctor));  // maybeBindCaller not relevant here
1728
            return DirectMethodHandle.make(ctor).setVarargs(ctor);
1729
        }
1730 1731 1732 1733

        /** Hook called from the JVM (via MethodHandleNatives) to link MH constants:
         */
        /*non-public*/
1734
        MethodHandle linkMethodHandleConstant(byte refKind, Class<?> defc, String name, Object type) throws ReflectiveOperationException {
1735 1736 1737 1738 1739 1740 1741 1742
            if (!(type instanceof Class || type instanceof MethodType))
                throw new InternalError("unresolved MemberName");
            MemberName member = new MemberName(refKind, defc, name, type);
            MethodHandle mh = LOOKASIDE_TABLE.get(member);
            if (mh != null) {
                checkSymbolicClass(defc);
                return mh;
            }
1743 1744 1745 1746 1747 1748 1749
            // Treat MethodHandle.invoke and invokeExact specially.
            if (defc == MethodHandle.class && refKind == REF_invokeVirtual) {
                mh = findVirtualForMH(member.getName(), member.getMethodType());
                if (mh != null) {
                    return mh;
                }
            }
1750
            MemberName resolved = resolveOrFail(refKind, member);
1751
            mh = getDirectMethodForConstant(refKind, defc, resolved);
1752 1753 1754 1755 1756 1757 1758 1759 1760
            if (mh instanceof DirectMethodHandle
                    && canBeCached(refKind, defc, resolved)) {
                MemberName key = mh.internalMemberName();
                if (key != null) {
                    key = key.asNormalOriginal();
                }
                if (member.equals(key)) {  // better safe than sorry
                    LOOKASIDE_TABLE.put(key, (DirectMethodHandle) mh);
                }
1761
            }
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
            return mh;
        }
        private
        boolean canBeCached(byte refKind, Class<?> defc, MemberName member) {
            if (refKind == REF_invokeSpecial) {
                return false;
            }
            if (!Modifier.isPublic(defc.getModifiers()) ||
                    !Modifier.isPublic(member.getDeclaringClass().getModifiers()) ||
                    !member.isPublic() ||
                    member.isCallerSensitive()) {
                return false;
            }
            ClassLoader loader = defc.getClassLoader();
            if (!sun.misc.VM.isSystemDomainLoader(loader)) {
                ClassLoader sysl = ClassLoader.getSystemClassLoader();
                boolean found = false;
                while (sysl != null) {
                    if (loader == sysl) { found = true; break; }
                    sysl = sysl.getParent();
                }
                if (!found) {
                    return false;
                }
            }
            try {
                MemberName resolved2 = publicLookup().resolveOrFail(refKind,
                    new MemberName(refKind, defc, member.getName(), member.getType()));
                checkSecurityManager(defc, resolved2);
            } catch (ReflectiveOperationException | SecurityException ex) {
                return false;
            }
            return true;
        }
        private
1797 1798
        MethodHandle getDirectMethodForConstant(byte refKind, Class<?> defc, MemberName member)
                throws ReflectiveOperationException {
1799
            if (MethodHandleNatives.refKindIsField(refKind)) {
1800
                return getDirectFieldNoSecurityManager(refKind, defc, member);
1801
            } else if (MethodHandleNatives.refKindIsMethod(refKind)) {
1802
                return getDirectMethodNoSecurityManager(refKind, defc, member, lookupClass);
1803
            } else if (refKind == REF_newInvokeSpecial) {
1804
                return getDirectConstructorNoSecurityManager(defc, member);
1805 1806
            }
            // oops
1807
            throw newIllegalArgumentException("bad MethodHandle constant #"+member);
1808
        }
1809 1810

        static ConcurrentHashMap<MemberName, DirectMethodHandle> LOOKASIDE_TABLE = new ConcurrentHashMap<>();
1811 1812 1813
    }

    /**
1814
     * Produces a method handle giving read access to elements of an array.
1815 1816 1817 1818 1819
     * The type of the method handle will have a return type of the array's
     * element type.  Its first argument will be the array type,
     * and the second will be {@code int}.
     * @param arrayClass an array type
     * @return a method handle which can load values from the given array type
1820
     * @throws NullPointerException if the argument is null
1821 1822 1823 1824
     * @throws  IllegalArgumentException if arrayClass is not an array type
     */
    public static
    MethodHandle arrayElementGetter(Class<?> arrayClass) throws IllegalArgumentException {
1825
        return MethodHandleImpl.makeArrayElementAccessor(arrayClass, false);
1826 1827 1828
    }

    /**
1829
     * Produces a method handle giving write access to elements of an array.
1830 1831 1832
     * The type of the method handle will have a void return type.
     * Its last argument will be the array's element type.
     * The first and second arguments will be the array type and int.
1833
     * @param arrayClass the class of an array
1834
     * @return a method handle which can store values into the array type
1835
     * @throws NullPointerException if the argument is null
1836 1837 1838 1839
     * @throws IllegalArgumentException if arrayClass is not an array type
     */
    public static
    MethodHandle arrayElementSetter(Class<?> arrayClass) throws IllegalArgumentException {
1840
        return MethodHandleImpl.makeArrayElementAccessor(arrayClass, true);
1841 1842 1843 1844 1845
    }

    /// method handle invocation (reflective style)

    /**
1846
     * Produces a method handle which will invoke any method handle of the
1847 1848
     * given {@code type}, with a given number of trailing arguments replaced by
     * a single trailing {@code Object[]} array.
1849 1850 1851 1852
     * The resulting invoker will be a method handle with the following
     * arguments:
     * <ul>
     * <li>a single {@code MethodHandle} target
1853 1854
     * <li>zero or more leading values (counted by {@code leadingArgCount})
     * <li>an {@code Object[]} array containing trailing arguments
1855
     * </ul>
1856
     * <p>
1857
     * The invoker will invoke its target like a call to {@link MethodHandle#invoke invoke} with
1858 1859
     * the indicated {@code type}.
     * That is, if the target is exactly of the given {@code type}, it will behave
1860
     * like {@code invokeExact}; otherwise it behave as if {@link MethodHandle#asType asType}
1861 1862 1863
     * is used to convert the target to the required {@code type}.
     * <p>
     * The type of the returned invoker will not be the given {@code type}, but rather
1864 1865 1866
     * will have all parameters except the first {@code leadingArgCount}
     * replaced by a single array of type {@code Object[]}, which will be
     * the final parameter.
1867
     * <p>
1868
     * Before invoking its target, the invoker will spread the final array, apply
1869
     * reference casts as necessary, and unbox and widen primitive arguments.
1870 1871 1872
     * If, when the invoker is called, the supplied array argument does
     * not have the correct number of elements, the invoker will throw
     * an {@link IllegalArgumentException} instead of invoking the target.
1873 1874
     * <p>
     * This method is equivalent to the following code (though it may be more efficient):
1875
     * <blockquote><pre>{@code
1876
MethodHandle invoker = MethodHandles.invoker(type);
1877
int spreadArgCount = type.parameterCount() - leadingArgCount;
1878 1879
invoker = invoker.asSpreader(Object[].class, spreadArgCount);
return invoker;
1880
     * }</pre></blockquote>
1881
     * This method throws no reflective or security exceptions.
1882
     * @param type the desired target type
1883
     * @param leadingArgCount number of fixed arguments, to be passed unchanged to the target
1884
     * @return a method handle suitable for invoking any method handle of the given type
1885 1886
     * @throws NullPointerException if {@code type} is null
     * @throws IllegalArgumentException if {@code leadingArgCount} is not in
1887 1888 1889
     *                  the range from 0 to {@code type.parameterCount()} inclusive,
     *                  or if the resulting method handle's type would have
     *          <a href="MethodHandle.html#maxarity">too many parameters</a>
1890 1891
     */
    static public
1892 1893
    MethodHandle spreadInvoker(MethodType type, int leadingArgCount) {
        if (leadingArgCount < 0 || leadingArgCount > type.parameterCount())
1894
            throw newIllegalArgumentException("bad argument count", leadingArgCount);
1895
        type = type.asSpreaderType(Object[].class, type.parameterCount() - leadingArgCount);
1896
        return type.invokers().spreadInvoker(leadingArgCount);
1897 1898 1899
    }

    /**
1900
     * Produces a special <em>invoker method handle</em> which can be used to
1901
     * invoke any method handle of the given type, as if by {@link MethodHandle#invokeExact invokeExact}.
1902
     * The resulting invoker will have a type which is
1903 1904 1905
     * exactly equal to the desired type, except that it will accept
     * an additional leading argument of type {@code MethodHandle}.
     * <p>
1906
     * This method is equivalent to the following code (though it may be more efficient):
1907
     * {@code publicLookup().findVirtual(MethodHandle.class, "invokeExact", type)}
1908 1909 1910 1911 1912 1913 1914 1915
     *
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
     * Invoker method handles can be useful when working with variable method handles
     * of unknown types.
     * For example, to emulate an {@code invokeExact} call to a variable method
     * handle {@code M}, extract its type {@code T},
     * look up the invoker method {@code X} for {@code T},
1916
     * and call the invoker method, as {@code X.invoke(T, A...)}.
1917 1918 1919 1920 1921
     * (It would not work to call {@code X.invokeExact}, since the type {@code T}
     * is unknown.)
     * If spreading, collecting, or other argument transformations are required,
     * they can be applied once to the invoker {@code X} and reused on many {@code M}
     * method handle values, as long as they are compatible with the type of {@code X}.
1922
     * <p style="font-size:smaller;">
1923
     * <em>(Note:  The invoker method is not available via the Core Reflection API.
1924
     * An attempt to call {@linkplain java.lang.reflect.Method#invoke java.lang.reflect.Method.invoke}
1925
     * on the declared {@code invokeExact} or {@code invoke} method will raise an
1926 1927 1928
     * {@link java.lang.UnsupportedOperationException UnsupportedOperationException}.)</em>
     * <p>
     * This method throws no reflective or security exceptions.
1929 1930
     * @param type the desired target type
     * @return a method handle suitable for invoking any method handle of the given type
1931 1932
     * @throws IllegalArgumentException if the resulting method handle's type would have
     *          <a href="MethodHandle.html#maxarity">too many parameters</a>
1933 1934 1935
     */
    static public
    MethodHandle exactInvoker(MethodType type) {
1936
        return type.invokers().exactInvoker();
1937 1938
    }

1939 1940
    /**
     * Produces a special <em>invoker method handle</em> which can be used to
1941
     * invoke any method handle compatible with the given type, as if by {@link MethodHandle#invoke invoke}.
1942 1943 1944 1945
     * The resulting invoker will have a type which is
     * exactly equal to the desired type, except that it will accept
     * an additional leading argument of type {@code MethodHandle}.
     * <p>
1946 1947
     * Before invoking its target, if the target differs from the expected type,
     * the invoker will apply reference casts as
1948 1949 1950 1951
     * necessary and box, unbox, or widen primitive values, as if by {@link MethodHandle#asType asType}.
     * Similarly, the return value will be converted as necessary.
     * If the target is a {@linkplain MethodHandle#asVarargsCollector variable arity method handle},
     * the required arity conversion will be made, again as if by {@link MethodHandle#asType asType}.
1952
     * <p>
1953 1954 1955 1956 1957
     * This method is equivalent to the following code (though it may be more efficient):
     * {@code publicLookup().findVirtual(MethodHandle.class, "invoke", type)}
     * <p style="font-size:smaller;">
     * <em>Discussion:</em>
     * A {@linkplain MethodType#genericMethodType general method type} is one which
1958 1959 1960
     * mentions only {@code Object} arguments and return values.
     * An invoker for such a type is capable of calling any method handle
     * of the same arity as the general type.
1961 1962 1963 1964 1965
     * <p style="font-size:smaller;">
     * <em>(Note:  The invoker method is not available via the Core Reflection API.
     * An attempt to call {@linkplain java.lang.reflect.Method#invoke java.lang.reflect.Method.invoke}
     * on the declared {@code invokeExact} or {@code invoke} method will raise an
     * {@link java.lang.UnsupportedOperationException UnsupportedOperationException}.)</em>
1966 1967 1968 1969
     * <p>
     * This method throws no reflective or security exceptions.
     * @param type the desired target type
     * @return a method handle suitable for invoking any method handle convertible to the given type
1970 1971
     * @throws IllegalArgumentException if the resulting method handle's type would have
     *          <a href="MethodHandle.html#maxarity">too many parameters</a>
1972 1973
     */
    static public
1974
    MethodHandle invoker(MethodType type) {
1975
        return type.invokers().genericInvoker();
1976 1977
    }

1978 1979
    static /*non-public*/
    MethodHandle basicInvoker(MethodType type) {
1980
        return type.invokers().basicInvoker();
1981 1982
    }

1983
     /// method handle modification (creation from other method handles)
1984 1985

    /**
1986
     * Produces a method handle which adapts the type of the
1987
     * given method handle to a new type by pairwise argument and return type conversion.
1988 1989 1990 1991 1992 1993
     * The original type and new type must have the same number of arguments.
     * The resulting method handle is guaranteed to report a type
     * which is equal to the desired new type.
     * <p>
     * If the original type and new type are equal, returns target.
     * <p>
1994
     * The same conversions are allowed as for {@link MethodHandle#asType MethodHandle.asType},
1995
     * and some additional conversions are also applied if those conversions fail.
1996 1997
     * Given types <em>T0</em>, <em>T1</em>, one of the following conversions is applied
     * if possible, before or instead of any conversions done by {@code asType}:
1998
     * <ul>
1999 2000
     * <li>If <em>T0</em> and <em>T1</em> are references, and <em>T1</em> is an interface type,
     *     then the value of type <em>T0</em> is passed as a <em>T1</em> without a cast.
2001
     *     (This treatment of interfaces follows the usage of the bytecode verifier.)
2002 2003
     * <li>If <em>T0</em> is boolean and <em>T1</em> is another primitive,
     *     the boolean is converted to a byte value, 1 for true, 0 for false.
2004
     *     (This treatment follows the usage of the bytecode verifier.)
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018
     * <li>If <em>T1</em> is boolean and <em>T0</em> is another primitive,
     *     <em>T0</em> is converted to byte via Java casting conversion (JLS 5.5),
     *     and the low order bit of the result is tested, as if by {@code (x & 1) != 0}.
     * <li>If <em>T0</em> and <em>T1</em> are primitives other than boolean,
     *     then a Java casting conversion (JLS 5.5) is applied.
     *     (Specifically, <em>T0</em> will convert to <em>T1</em> by
     *     widening and/or narrowing.)
     * <li>If <em>T0</em> is a reference and <em>T1</em> a primitive, an unboxing
     *     conversion will be applied at runtime, possibly followed
     *     by a Java casting conversion (JLS 5.5) on the primitive value,
     *     possibly followed by a conversion from byte to boolean by testing
     *     the low-order bit.
     * <li>If <em>T0</em> is a reference and <em>T1</em> a primitive,
     *     and if the reference is null at runtime, a zero value is introduced.
2019 2020 2021
     * </ul>
     * @param target the method handle to invoke after arguments are retyped
     * @param newType the expected type of the new method handle
2022
     * @return a method handle which delegates to the target after performing
2023 2024
     *           any necessary argument conversions, and arranges for any
     *           necessary return value conversions
2025
     * @throws NullPointerException if either argument is null
2026 2027 2028 2029 2030
     * @throws WrongMethodTypeException if the conversion cannot be made
     * @see MethodHandle#asType
     */
    public static
    MethodHandle explicitCastArguments(MethodHandle target, MethodType newType) {
2031
        explicitCastArgumentsChecks(target, newType);
2032
        // use the asTypeCache when possible:
2033
        MethodType oldType = target.type();
2034 2035
        if (oldType == newType)  return target;
        if (oldType.explicitCastEquivalentToAsType(newType)) {
2036
            return target.asFixedArity().asType(newType);
2037
        }
2038
        return MethodHandleImpl.makePairwiseConvert(target, newType, false);
2039 2040
    }

2041 2042 2043 2044 2045 2046
    private static void explicitCastArgumentsChecks(MethodHandle target, MethodType newType) {
        if (target.type().parameterCount() != newType.parameterCount()) {
            throw new WrongMethodTypeException("cannot explicitly cast " + target + " to " + newType);
        }
    }

2047
    /**
2048
     * Produces a method handle which adapts the calling sequence of the
2049
     * given method handle to a new type, by reordering the arguments.
2050
     * The resulting method handle is guaranteed to report a type
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
     * which is equal to the desired new type.
     * <p>
     * The given array controls the reordering.
     * Call {@code #I} the number of incoming parameters (the value
     * {@code newType.parameterCount()}, and call {@code #O} the number
     * of outgoing parameters (the value {@code target.type().parameterCount()}).
     * Then the length of the reordering array must be {@code #O},
     * and each element must be a non-negative number less than {@code #I}.
     * For every {@code N} less than {@code #O}, the {@code N}-th
     * outgoing argument will be taken from the {@code I}-th incoming
     * argument, where {@code I} is {@code reorder[N]}.
     * <p>
2063 2064
     * No argument or return value conversions are applied.
     * The type of each incoming argument, as determined by {@code newType},
2065 2066
     * must be identical to the type of the corresponding outgoing parameter
     * or parameters in the target method handle.
2067 2068 2069
     * The return type of {@code newType} must be identical to the return
     * type of the original target.
     * <p>
2070 2071 2072 2073
     * The reordering array need not specify an actual permutation.
     * An incoming argument will be duplicated if its index appears
     * more than once in the array, and an incoming argument will be dropped
     * if its index does not appear in the array.
2074 2075 2076
     * As in the case of {@link #dropArguments(MethodHandle,int,List) dropArguments},
     * incoming arguments which are not mentioned in the reordering array
     * are may be any type, as determined only by {@code newType}.
A
alanb 已提交
2077
     * <blockquote><pre>{@code
2078 2079 2080 2081 2082
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodType intfn1 = methodType(int.class, int.class);
MethodType intfn2 = methodType(int.class, int.class, int.class);
2083
MethodHandle sub = ... (int x, int y) -> (x-y) ...;
2084
assert(sub.type().equals(intfn2));
2085 2086
MethodHandle sub1 = permuteArguments(sub, intfn2, 0, 1);
MethodHandle rsub = permuteArguments(sub, intfn2, 1, 0);
2087
assert((int)rsub.invokeExact(1, 100) == 99);
2088
MethodHandle add = ... (int x, int y) -> (x+y) ...;
2089
assert(add.type().equals(intfn2));
2090
MethodHandle twice = permuteArguments(add, intfn1, 0, 0);
2091 2092
assert(twice.type().equals(intfn1));
assert((int)twice.invokeExact(21) == 42);
A
alanb 已提交
2093
     * }</pre></blockquote>
2094 2095
     * @param target the method handle to invoke after arguments are reordered
     * @param newType the expected type of the new method handle
2096 2097
     * @param reorder an index array which controls the reordering
     * @return a method handle which delegates to the target after it
2098
     *           drops unused arguments and moves and/or duplicates the other arguments
2099
     * @throws NullPointerException if any argument is null
2100 2101 2102 2103 2104
     * @throws IllegalArgumentException if the index array length is not equal to
     *                  the arity of the target, or if any index array element
     *                  not a valid index for a parameter of {@code newType},
     *                  or if two corresponding parameter types in
     *                  {@code target.type()} and {@code newType} are not identical,
2105 2106
     */
    public static
2107
    MethodHandle permuteArguments(MethodHandle target, MethodType newType, int... reorder) {
2108 2109 2110
        reorder = reorder.clone();  // get a private copy
        MethodType oldType = target.type();
        permuteArgumentChecks(reorder, newType, oldType);
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
        // first detect dropped arguments and handle them separately
        int[] originalReorder = reorder;
        BoundMethodHandle result = target.rebind();
        LambdaForm form = result.form;
        int newArity = newType.parameterCount();
        // Normalize the reordering into a real permutation,
        // by removing duplicates and adding dropped elements.
        // This somewhat improves lambda form caching, as well
        // as simplifying the transform by breaking it up into steps.
        for (int ddIdx; (ddIdx = findFirstDupOrDrop(reorder, newArity)) != 0; ) {
            if (ddIdx > 0) {
                // We found a duplicated entry at reorder[ddIdx].
                // Example:  (x,y,z)->asList(x,y,z)
                // permuted by [1*,0,1] => (a0,a1)=>asList(a1,a0,a1)
                // permuted by [0,1,0*] => (a0,a1)=>asList(a0,a1,a0)
                // The starred element corresponds to the argument
                // deleted by the dupArgumentForm transform.
                int srcPos = ddIdx, dstPos = srcPos, dupVal = reorder[srcPos];
                boolean killFirst = false;
                for (int val; (val = reorder[--dstPos]) != dupVal; ) {
                    // Set killFirst if the dup is larger than an intervening position.
                    // This will remove at least one inversion from the permutation.
                    if (dupVal > val) killFirst = true;
2134
                }
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
                if (!killFirst) {
                    srcPos = dstPos;
                    dstPos = ddIdx;
                }
                form = form.editor().dupArgumentForm(1 + srcPos, 1 + dstPos);
                assert (reorder[srcPos] == reorder[dstPos]);
                oldType = oldType.dropParameterTypes(dstPos, dstPos + 1);
                // contract the reordering by removing the element at dstPos
                int tailPos = dstPos + 1;
                System.arraycopy(reorder, tailPos, reorder, dstPos, reorder.length - tailPos);
                reorder = Arrays.copyOf(reorder, reorder.length - 1);
            } else {
                int dropVal = ~ddIdx, insPos = 0;
                while (insPos < reorder.length && reorder[insPos] < dropVal) {
                    // Find first element of reorder larger than dropVal.
                    // This is where we will insert the dropVal.
                    insPos += 1;
                }
                Class<?> ptype = newType.parameterType(dropVal);
                form = form.editor().addArgumentForm(1 + insPos, BasicType.basicType(ptype));
                oldType = oldType.insertParameterTypes(insPos, ptype);
                // expand the reordering by inserting an element at insPos
                int tailPos = insPos + 1;
                reorder = Arrays.copyOf(reorder, reorder.length + 1);
                System.arraycopy(reorder, insPos, reorder, tailPos, reorder.length - tailPos);
                reorder[insPos] = dropVal;
2161
            }
2162
            assert (permuteArgumentChecks(reorder, newType, oldType));
2163
        }
2164 2165 2166 2167 2168 2169
        assert (reorder.length == newArity);  // a perfect permutation
        // Note:  This may cache too many distinct LFs. Consider backing off to varargs code.
        form = form.editor().permuteArgumentsForm(1, reorder);
        if (newType == result.type() && form == result.internalForm())
            return result;
        return result.copyWith(newType, form);
2170 2171
    }

2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
    /**
     * Return an indication of any duplicate or omission in reorder.
     * If the reorder contains a duplicate entry, return the index of the second occurrence.
     * Otherwise, return ~(n), for the first n in [0..newArity-1] that is not present in reorder.
     * Otherwise, return zero.
     * If an element not in [0..newArity-1] is encountered, return reorder.length.
     */
    private static int findFirstDupOrDrop(int[] reorder, int newArity) {
        final int BIT_LIMIT = 63;  // max number of bits in bit mask
        if (newArity < BIT_LIMIT) {
            long mask = 0;
            for (int i = 0; i < reorder.length; i++) {
                int arg = reorder[i];
2185 2186 2187 2188 2189
                if (arg >= newArity) {
                    return reorder.length;
                }
                long bit = 1L << arg;
                if ((mask & bit) != 0) {
2190
                    return i;  // >0 indicates a dup
2191
                }
2192 2193
                mask |= bit;
            }
2194
            if (mask == (1L << newArity) - 1) {
2195 2196 2197 2198 2199 2200
                assert(Long.numberOfTrailingZeros(Long.lowestOneBit(~mask)) == newArity);
                return 0;
            }
            // find first zero
            long zeroBit = Long.lowestOneBit(~mask);
            int zeroPos = Long.numberOfTrailingZeros(zeroBit);
2201 2202 2203 2204
            assert(zeroPos <= newArity);
            if (zeroPos == newArity) {
                return 0;
            }
2205 2206 2207 2208 2209 2210
            return ~zeroPos;
        } else {
            // same algorithm, different bit set
            BitSet mask = new BitSet(newArity);
            for (int i = 0; i < reorder.length; i++) {
                int arg = reorder[i];
2211 2212 2213 2214
                if (arg >= newArity) {
                    return reorder.length;
                }
                if (mask.get(arg)) {
2215
                    return i;  // >0 indicates a dup
2216
                }
2217 2218 2219
                mask.set(arg);
            }
            int zeroPos = mask.nextClearBit(0);
2220
            assert(zeroPos <= newArity);
2221 2222 2223 2224 2225 2226 2227
            if (zeroPos == newArity) {
                return 0;
            }
            return ~zeroPos;
        }
    }

2228
    private static boolean permuteArgumentChecks(int[] reorder, MethodType newType, MethodType oldType) {
2229 2230 2231
        if (newType.returnType() != oldType.returnType())
            throw newIllegalArgumentException("return types do not match",
                    oldType, newType);
2232 2233 2234
        if (reorder.length == oldType.parameterCount()) {
            int limit = newType.parameterCount();
            boolean bad = false;
2235 2236
            for (int j = 0; j < reorder.length; j++) {
                int i = reorder[j];
2237 2238 2239
                if (i < 0 || i >= limit) {
                    bad = true; break;
                }
2240 2241 2242 2243 2244
                Class<?> src = newType.parameterType(i);
                Class<?> dst = oldType.parameterType(j);
                if (src != dst)
                    throw newIllegalArgumentException("parameter types do not match after reorder",
                            oldType, newType);
2245
            }
2246
            if (!bad)  return true;
2247
        }
2248
        throw newIllegalArgumentException("bad reorder array: "+Arrays.toString(reorder));
2249 2250 2251
    }

    /**
2252
     * Produces a method handle of the requested return type which returns the given
2253 2254 2255 2256 2257
     * constant value every time it is invoked.
     * <p>
     * Before the method handle is returned, the passed-in value is converted to the requested type.
     * If the requested type is primitive, widening primitive conversions are attempted,
     * else reference conversions are attempted.
2258
     * <p>The returned method handle is equivalent to {@code identity(type).bindTo(value)}.
2259 2260 2261
     * @param type the return type of the desired method handle
     * @param value the value to return
     * @return a method handle of the given return type and no arguments, which always returns the given value
2262 2263 2264
     * @throws NullPointerException if the {@code type} argument is null
     * @throws ClassCastException if the value cannot be converted to the required return type
     * @throws IllegalArgumentException if the given type is {@code void.class}
2265 2266 2267 2268
     */
    public static
    MethodHandle constant(Class<?> type, Object value) {
        if (type.isPrimitive()) {
2269 2270
            if (type == void.class)
                throw newIllegalArgumentException("void type");
2271
            Wrapper w = Wrapper.forPrimitiveType(type);
2272 2273 2274 2275
            value = w.convert(value, type);
            if (w.zero().equals(value))
                return zero(w, type);
            return insertArguments(identity(type), 0, value);
2276
        } else {
2277 2278 2279
            if (value == null)
                return zero(Wrapper.OBJECT, type);
            return identity(type).bindTo(value);
2280 2281 2282 2283
        }
    }

    /**
2284 2285 2286 2287 2288
     * Produces a method handle which returns its sole argument when invoked.
     * @param type the type of the sole parameter and return value of the desired method handle
     * @return a unary method handle which accepts and returns the given type
     * @throws NullPointerException if the argument is null
     * @throws IllegalArgumentException if the given type is {@code void.class}
2289 2290 2291
     */
    public static
    MethodHandle identity(Class<?> type) {
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
        Wrapper btw = (type.isPrimitive() ? Wrapper.forPrimitiveType(type) : Wrapper.OBJECT);
        int pos = btw.ordinal();
        MethodHandle ident = IDENTITY_MHS[pos];
        if (ident == null) {
            ident = setCachedMethodHandle(IDENTITY_MHS, pos, makeIdentity(btw.primitiveType()));
        }
        if (ident.type().returnType() == type)
            return ident;
        // something like identity(Foo.class); do not bother to intern these
        assert(btw == Wrapper.OBJECT);
        return makeIdentity(type);
    }
    private static final MethodHandle[] IDENTITY_MHS = new MethodHandle[Wrapper.values().length];
    private static MethodHandle makeIdentity(Class<?> ptype) {
        MethodType mtype = MethodType.methodType(ptype, ptype);
        LambdaForm lform = LambdaForm.identityForm(BasicType.basicType(ptype));
        return MethodHandleImpl.makeIntrinsic(mtype, lform, Intrinsic.IDENTITY);
    }
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328

    private static MethodHandle zero(Wrapper btw, Class<?> rtype) {
        int pos = btw.ordinal();
        MethodHandle zero = ZERO_MHS[pos];
        if (zero == null) {
            zero = setCachedMethodHandle(ZERO_MHS, pos, makeZero(btw.primitiveType()));
        }
        if (zero.type().returnType() == rtype)
            return zero;
        assert(btw == Wrapper.OBJECT);
        return makeZero(rtype);
    }
    private static final MethodHandle[] ZERO_MHS = new MethodHandle[Wrapper.values().length];
    private static MethodHandle makeZero(Class<?> rtype) {
        MethodType mtype = MethodType.methodType(rtype);
        LambdaForm lform = LambdaForm.zeroForm(BasicType.basicType(rtype));
        return MethodHandleImpl.makeIntrinsic(mtype, lform, Intrinsic.ZERO);
    }

2329 2330 2331 2332 2333
    synchronized private static MethodHandle setCachedMethodHandle(MethodHandle[] cache, int pos, MethodHandle value) {
        // Simulate a CAS, to avoid racy duplication of results.
        MethodHandle prev = cache[pos];
        if (prev != null) return prev;
        return cache[pos] = value;
2334 2335 2336
    }

    /**
2337 2338 2339 2340 2341 2342 2343 2344 2345
     * Provides a target method handle with one or more <em>bound arguments</em>
     * in advance of the method handle's invocation.
     * The formal parameters to the target corresponding to the bound
     * arguments are called <em>bound parameters</em>.
     * Returns a new method handle which saves away the bound arguments.
     * When it is invoked, it receives arguments for any non-bound parameters,
     * binds the saved arguments to their corresponding parameters,
     * and calls the original target.
     * <p>
2346 2347 2348
     * The type of the new method handle will drop the types for the bound
     * parameters from the original target type, since the new method handle
     * will no longer require those arguments to be supplied by its callers.
2349
     * <p>
2350 2351 2352
     * Each given argument object must match the corresponding bound parameter type.
     * If a bound parameter type is a primitive, the argument object
     * must be a wrapper, and will be unboxed to produce the primitive value.
2353
     * <p>
2354 2355 2356 2357
     * The {@code pos} argument selects which parameters are to be bound.
     * It may range between zero and <i>N-L</i> (inclusively),
     * where <i>N</i> is the arity of the target method handle
     * and <i>L</i> is the length of the values array.
2358 2359
     * @param target the method handle to invoke after the argument is inserted
     * @param pos where to insert the argument (zero for the first)
2360
     * @param values the series of arguments to insert
2361
     * @return a method handle which inserts an additional argument,
2362
     *         before calling the original method handle
2363
     * @throws NullPointerException if the target or the {@code values} array is null
2364
     * @see MethodHandle#bindTo
2365 2366
     */
    public static
2367 2368
    MethodHandle insertArguments(MethodHandle target, int pos, Object... values) {
        int insCount = values.length;
2369 2370 2371
        Class<?>[] ptypes = insertArgumentsChecks(target, insCount, pos);
        if (insCount == 0)  return target;
        BoundMethodHandle result = target.rebind();
2372 2373
        for (int i = 0; i < insCount; i++) {
            Object value = values[i];
2374
            Class<?> ptype = ptypes[pos+i];
2375
            if (ptype.isPrimitive()) {
2376
                result = insertArgumentPrimitive(result, pos, ptype, value);
2377
            } else {
2378 2379
                value = ptype.cast(value);  // throw CCE if needed
                result = result.bindArgumentL(pos, value);
2380
            }
2381
        }
2382 2383 2384
        return result;
    }

2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409
    private static BoundMethodHandle insertArgumentPrimitive(BoundMethodHandle result, int pos,
                                                             Class<?> ptype, Object value) {
        Wrapper w = Wrapper.forPrimitiveType(ptype);
        // perform unboxing and/or primitive conversion
        value = w.convert(value, ptype);
        switch (w) {
        case INT:     return result.bindArgumentI(pos, (int)value);
        case LONG:    return result.bindArgumentJ(pos, (long)value);
        case FLOAT:   return result.bindArgumentF(pos, (float)value);
        case DOUBLE:  return result.bindArgumentD(pos, (double)value);
        default:      return result.bindArgumentI(pos, ValueConversions.widenSubword(value));
        }
    }

    private static Class<?>[] insertArgumentsChecks(MethodHandle target, int insCount, int pos) throws RuntimeException {
        MethodType oldType = target.type();
        int outargs = oldType.parameterCount();
        int inargs  = outargs - insCount;
        if (inargs < 0)
            throw newIllegalArgumentException("too many values to insert");
        if (pos < 0 || pos > inargs)
            throw newIllegalArgumentException("no argument type to append");
        return oldType.ptypes();
    }

2410
    /**
2411 2412 2413 2414 2415
     * Produces a method handle which will discard some dummy arguments
     * before calling some other specified <i>target</i> method handle.
     * The type of the new method handle will be the same as the target's type,
     * except it will also include the dummy argument types,
     * at some given position.
2416
     * <p>
2417 2418 2419 2420 2421
     * The {@code pos} argument may range between zero and <i>N</i>,
     * where <i>N</i> is the arity of the target.
     * If {@code pos} is zero, the dummy arguments will precede
     * the target's real arguments; if {@code pos} is <i>N</i>
     * they will come after.
2422 2423
     * <p>
     * <b>Example:</b>
2424
     * <blockquote><pre>{@code
2425 2426
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
2427 2428 2429 2430
...
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
assertEquals("xy", (String) cat.invokeExact("x", "y"));
2431 2432 2433 2434
MethodType bigType = cat.type().insertParameterTypes(0, int.class, String.class);
MethodHandle d0 = dropArguments(cat, 0, bigType.parameterList().subList(0,2));
assertEquals(bigType, d0.type());
assertEquals("yz", (String) d0.invokeExact(123, "x", "y", "z"));
2435
     * }</pre></blockquote>
2436 2437
     * <p>
     * This method is also equivalent to the following code:
2438
     * <blockquote><pre>
2439
     * {@link #dropArguments(MethodHandle,int,Class...) dropArguments}{@code (target, pos, valueTypes.toArray(new Class[0]))}
2440
     * </pre></blockquote>
2441 2442 2443 2444
     * @param target the method handle to invoke after the arguments are dropped
     * @param valueTypes the type(s) of the argument(s) to drop
     * @param pos position of first argument to drop (zero for the leftmost)
     * @return a method handle which drops arguments of the given types,
2445
     *         before calling the original method handle
2446
     * @throws NullPointerException if the target is null,
2447
     *                              or if the {@code valueTypes} list or any of its elements is null
2448 2449 2450
     * @throws IllegalArgumentException if any element of {@code valueTypes} is {@code void.class},
     *                  or if {@code pos} is negative or greater than the arity of the target,
     *                  or if the new method handle's type would have too many parameters
2451 2452
     */
    public static
2453
    MethodHandle dropArguments(MethodHandle target, int pos, List<Class<?>> valueTypes) {
2454
        valueTypes = copyTypes(valueTypes);
2455
        MethodType oldType = target.type();  // get NPE
2456
        int dropped = dropArgumentChecks(oldType, pos, valueTypes);
2457
        MethodType newType = oldType.insertParameterTypes(pos, valueTypes);
2458 2459 2460
        if (dropped == 0)  return target;
        BoundMethodHandle result = target.rebind();
        LambdaForm lform = result.form;
2461 2462 2463
        int insertFormArg = 1 + pos;
        for (Class<?> ptype : valueTypes) {
            lform = lform.editor().addArgumentForm(insertFormArg++, BasicType.basicType(ptype));
2464
        }
2465 2466 2467 2468
        result = result.copyWith(newType, lform);
        return result;
    }

2469 2470 2471 2472 2473
    private static List<Class<?>> copyTypes(List<Class<?>> types) {
        Object[] a = types.toArray();
        return Arrays.asList(Arrays.copyOf(a, a.length, Class[].class));
    }

2474
    private static int dropArgumentChecks(MethodType oldType, int pos, List<Class<?>> valueTypes) {
2475 2476
        int dropped = valueTypes.size();
        MethodType.checkSlotCount(dropped);
2477
        int outargs = oldType.parameterCount();
2478
        int inargs  = outargs + dropped;
2479 2480 2481 2482 2483
        if (pos < 0 || pos > outargs)
            throw newIllegalArgumentException("no argument type to remove"
                    + Arrays.asList(oldType, pos, valueTypes, inargs, outargs)
                    );
        return dropped;
2484 2485
    }

2486
    /**
2487 2488 2489 2490 2491
     * Produces a method handle which will discard some dummy arguments
     * before calling some other specified <i>target</i> method handle.
     * The type of the new method handle will be the same as the target's type,
     * except it will also include the dummy argument types,
     * at some given position.
2492
     * <p>
2493 2494 2495 2496 2497
     * The {@code pos} argument may range between zero and <i>N</i>,
     * where <i>N</i> is the arity of the target.
     * If {@code pos} is zero, the dummy arguments will precede
     * the target's real arguments; if {@code pos} is <i>N</i>
     * they will come after.
2498 2499
     * <p>
     * <b>Example:</b>
2500
     * <blockquote><pre>{@code
2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
assertEquals("xy", (String) cat.invokeExact("x", "y"));
MethodHandle d0 = dropArguments(cat, 0, String.class);
assertEquals("yz", (String) d0.invokeExact("x", "y", "z"));
MethodHandle d1 = dropArguments(cat, 1, String.class);
assertEquals("xz", (String) d1.invokeExact("x", "y", "z"));
MethodHandle d2 = dropArguments(cat, 2, String.class);
assertEquals("xy", (String) d2.invokeExact("x", "y", "z"));
MethodHandle d12 = dropArguments(cat, 1, int.class, boolean.class);
assertEquals("xz", (String) d12.invokeExact("x", 12, true, "z"));
2515
     * }</pre></blockquote>
2516 2517
     * <p>
     * This method is also equivalent to the following code:
2518
     * <blockquote><pre>
2519
     * {@link #dropArguments(MethodHandle,int,List) dropArguments}{@code (target, pos, Arrays.asList(valueTypes))}
2520
     * </pre></blockquote>
2521 2522 2523 2524 2525
     * @param target the method handle to invoke after the arguments are dropped
     * @param valueTypes the type(s) of the argument(s) to drop
     * @param pos position of first argument to drop (zero for the leftmost)
     * @return a method handle which drops arguments of the given types,
     *         before calling the original method handle
2526
     * @throws NullPointerException if the target is null,
2527
     *                              or if the {@code valueTypes} array or any of its elements is null
2528 2529
     * @throws IllegalArgumentException if any element of {@code valueTypes} is {@code void.class},
     *                  or if {@code pos} is negative or greater than the arity of the target,
2530 2531
     *                  or if the new method handle's type would have
     *                  <a href="MethodHandle.html#maxarity">too many parameters</a>
2532
     */
2533 2534 2535 2536 2537 2538
    public static
    MethodHandle dropArguments(MethodHandle target, int pos, Class<?>... valueTypes) {
        return dropArguments(target, pos, Arrays.asList(valueTypes));
    }

    /**
2539
     * Adapts a target method handle by pre-processing
2540 2541 2542 2543 2544
     * one or more of its arguments, each with its own unary filter function,
     * and then calling the target with each pre-processed argument
     * replaced by the result of its corresponding filter function.
     * <p>
     * The pre-processing is performed by one or more method handles,
2545
     * specified in the elements of the {@code filters} array.
2546 2547 2548 2549 2550
     * The first element of the filter array corresponds to the {@code pos}
     * argument of the target, and so on in sequence.
     * <p>
     * Null arguments in the array are treated as identity functions,
     * and the corresponding arguments left unchanged.
2551
     * (If there are no non-null elements in the array, the original target is returned.)
2552
     * Each filter is applied to the corresponding argument of the adapter.
2553 2554
     * <p>
     * If a filter {@code F} applies to the {@code N}th argument of
2555
     * the target, then {@code F} must be a method handle which
2556 2557 2558 2559 2560 2561
     * takes exactly one argument.  The type of {@code F}'s sole argument
     * replaces the corresponding argument type of the target
     * in the resulting adapted method handle.
     * The return type of {@code F} must be identical to the corresponding
     * parameter type of the target.
     * <p>
2562
     * It is an error if there are elements of {@code filters}
2563
     * (null or not)
2564
     * which do not correspond to argument positions in the target.
2565
     * <p><b>Example:</b>
2566
     * <blockquote><pre>{@code
2567 2568
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
2569 2570 2571 2572 2573
...
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
MethodHandle upcase = lookup().findVirtual(String.class,
  "toUpperCase", methodType(String.class));
2574
assertEquals("xy", (String) cat.invokeExact("x", "y"));
2575
MethodHandle f0 = filterArguments(cat, 0, upcase);
2576
assertEquals("Xy", (String) f0.invokeExact("x", "y")); // Xy
2577
MethodHandle f1 = filterArguments(cat, 1, upcase);
2578
assertEquals("xY", (String) f1.invokeExact("x", "y")); // xY
2579
MethodHandle f2 = filterArguments(cat, 0, upcase, upcase);
2580
assertEquals("XY", (String) f2.invokeExact("x", "y")); // XY
2581
     * }</pre></blockquote>
2582
     * <p> Here is pseudocode for the resulting adapter:
2583
     * <blockquote><pre>{@code
2584 2585 2586 2587 2588
     * V target(P... p, A[i]... a[i], B... b);
     * A[i] filter[i](V[i]);
     * T adapter(P... p, V[i]... v[i], B... b) {
     *   return target(p..., f[i](v[i])..., b...);
     * }
2589
     * }</pre></blockquote>
2590
     *
2591
     * @param target the method handle to invoke after arguments are filtered
2592
     * @param pos the position of the first argument to filter
2593 2594
     * @param filters method handles to call initially on filtered arguments
     * @return method handle which incorporates the specified argument filtering logic
2595
     * @throws NullPointerException if the target is null
2596 2597
     *                              or if the {@code filters} array is null
     * @throws IllegalArgumentException if a non-null element of {@code filters}
2598
     *          does not match a corresponding argument type of target as described above,
2599 2600 2601
     *          or if the {@code pos+filters.length} is greater than {@code target.type().parameterCount()},
     *          or if the resulting method handle's type would have
     *          <a href="MethodHandle.html#maxarity">too many parameters</a>
2602 2603
     */
    public static
2604
    MethodHandle filterArguments(MethodHandle target, int pos, MethodHandle... filters) {
2605
        filterArgumentsCheckArity(target, pos, filters);
2606
        MethodHandle adapter = target;
2607
        int curPos = pos-1;  // pre-incremented
2608
        for (MethodHandle filter : filters) {
2609 2610
            curPos += 1;
            if (filter == null)  continue;  // ignore null elements of filters
2611
            adapter = filterArgument(adapter, curPos, filter);
2612 2613 2614 2615
        }
        return adapter;
    }

2616 2617
    /*non-public*/ static
    MethodHandle filterArgument(MethodHandle target, int pos, MethodHandle filter) {
2618
        filterArgumentChecks(target, pos, filter);
2619 2620 2621 2622 2623 2624 2625 2626
        MethodType targetType = target.type();
        MethodType filterType = filter.type();
        BoundMethodHandle result = target.rebind();
        Class<?> newParamType = filterType.parameterType(0);
        LambdaForm lform = result.editor().filterArgumentForm(1 + pos, BasicType.basicType(newParamType));
        MethodType newType = targetType.changeParameterType(pos, newParamType);
        result = result.copyWithExtendL(newType, lform, filter);
        return result;
2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
    }

    private static void filterArgumentsCheckArity(MethodHandle target, int pos, MethodHandle[] filters) {
        MethodType targetType = target.type();
        int maxPos = targetType.parameterCount();
        if (pos + filters.length > maxPos)
            throw newIllegalArgumentException("too many filters");
    }

    private static void filterArgumentChecks(MethodHandle target, int pos, MethodHandle filter) throws RuntimeException {
2637 2638 2639 2640 2641 2642 2643
        MethodType targetType = target.type();
        MethodType filterType = filter.type();
        if (filterType.parameterCount() != 1
            || filterType.returnType() != targetType.parameterType(pos))
            throw newIllegalArgumentException("target and filter types do not match", targetType, filterType);
    }

2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669
    /**
     * Adapts a target method handle by pre-processing
     * a sub-sequence of its arguments with a filter (another method handle).
     * The pre-processed arguments are replaced by the result (if any) of the
     * filter function.
     * The target is then called on the modified (usually shortened) argument list.
     * <p>
     * If the filter returns a value, the target must accept that value as
     * its argument in position {@code pos}, preceded and/or followed by
     * any arguments not passed to the filter.
     * If the filter returns void, the target must accept all arguments
     * not passed to the filter.
     * No arguments are reordered, and a result returned from the filter
     * replaces (in order) the whole subsequence of arguments originally
     * passed to the adapter.
     * <p>
     * The argument types (if any) of the filter
     * replace zero or one argument types of the target, at position {@code pos},
     * in the resulting adapted method handle.
     * The return type of the filter (if any) must be identical to the
     * argument type of the target at position {@code pos}, and that target argument
     * is supplied by the return value of the filter.
     * <p>
     * In all cases, {@code pos} must be greater than or equal to zero, and
     * {@code pos} must also be less than or equal to the target's arity.
     * <p><b>Example:</b>
2670
     * <blockquote><pre>{@code
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle deepToString = publicLookup()
  .findStatic(Arrays.class, "deepToString", methodType(String.class, Object[].class));

MethodHandle ts1 = deepToString.asCollector(String[].class, 1);
assertEquals("[strange]", (String) ts1.invokeExact("strange"));

MethodHandle ts2 = deepToString.asCollector(String[].class, 2);
assertEquals("[up, down]", (String) ts2.invokeExact("up", "down"));

MethodHandle ts3 = deepToString.asCollector(String[].class, 3);
MethodHandle ts3_ts2 = collectArguments(ts3, 1, ts2);
assertEquals("[top, [up, down], strange]",
             (String) ts3_ts2.invokeExact("top", "up", "down", "strange"));

MethodHandle ts3_ts2_ts1 = collectArguments(ts3_ts2, 3, ts1);
assertEquals("[top, [up, down], [strange]]",
             (String) ts3_ts2_ts1.invokeExact("top", "up", "down", "strange"));

MethodHandle ts3_ts2_ts3 = collectArguments(ts3_ts2, 1, ts3);
assertEquals("[top, [[up, down, strange], charm], bottom]",
             (String) ts3_ts2_ts3.invokeExact("top", "up", "down", "strange", "charm", "bottom"));
2695
     * }</pre></blockquote>
2696
     * <p> Here is pseudocode for the resulting adapter:
2697
     * <blockquote><pre>{@code
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717
     * T target(A...,V,C...);
     * V filter(B...);
     * T adapter(A... a,B... b,C... c) {
     *   V v = filter(b...);
     *   return target(a...,v,c...);
     * }
     * // and if the filter has no arguments:
     * T target2(A...,V,C...);
     * V filter2();
     * T adapter2(A... a,C... c) {
     *   V v = filter2();
     *   return target2(a...,v,c...);
     * }
     * // and if the filter has a void return:
     * T target3(A...,C...);
     * void filter3(B...);
     * void adapter3(A... a,B... b,C... c) {
     *   filter3(b...);
     *   return target3(a...,c...);
     * }
2718
     * }</pre></blockquote>
2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751
     * <p>
     * A collection adapter {@code collectArguments(mh, 0, coll)} is equivalent to
     * one which first "folds" the affected arguments, and then drops them, in separate
     * steps as follows:
     * <blockquote><pre>{@code
     * mh = MethodHandles.dropArguments(mh, 1, coll.type().parameterList()); //step 2
     * mh = MethodHandles.foldArguments(mh, coll); //step 1
     * }</pre></blockquote>
     * If the target method handle consumes no arguments besides than the result
     * (if any) of the filter {@code coll}, then {@code collectArguments(mh, 0, coll)}
     * is equivalent to {@code filterReturnValue(coll, mh)}.
     * If the filter method handle {@code coll} consumes one argument and produces
     * a non-void result, then {@code collectArguments(mh, N, coll)}
     * is equivalent to {@code filterArguments(mh, N, coll)}.
     * Other equivalences are possible but would require argument permutation.
     *
     * @param target the method handle to invoke after filtering the subsequence of arguments
     * @param pos the position of the first adapter argument to pass to the filter,
     *            and/or the target argument which receives the result of the filter
     * @param filter method handle to call on the subsequence of arguments
     * @return method handle which incorporates the specified argument subsequence filtering logic
     * @throws NullPointerException if either argument is null
     * @throws IllegalArgumentException if the return type of {@code filter}
     *          is non-void and is not the same as the {@code pos} argument of the target,
     *          or if {@code pos} is not between 0 and the target's arity, inclusive,
     *          or if the resulting method handle's type would have
     *          <a href="MethodHandle.html#maxarity">too many parameters</a>
     * @see MethodHandles#foldArguments
     * @see MethodHandles#filterArguments
     * @see MethodHandles#filterReturnValue
     */
    public static
    MethodHandle collectArguments(MethodHandle target, int pos, MethodHandle filter) {
2752
        MethodType newType = collectArgumentsChecks(target, pos, filter);
2753 2754 2755 2756 2757 2758 2759
        MethodType collectorType = filter.type();
        BoundMethodHandle result = target.rebind();
        LambdaForm lform;
        if (collectorType.returnType().isArray() && filter.intrinsicName() == Intrinsic.NEW_ARRAY) {
            lform = result.editor().collectArgumentArrayForm(1 + pos, filter);
            if (lform != null) {
                return result.copyWith(newType, lform);
2760 2761
            }
        }
2762 2763
        lform = result.editor().collectArgumentsForm(1 + pos, collectorType.basicType());
        return result.copyWithExtendL(newType, lform, filter);
2764 2765 2766
    }

    private static MethodType collectArgumentsChecks(MethodHandle target, int pos, MethodHandle filter) throws RuntimeException {
2767
        MethodType targetType = target.type();
2768
        MethodType filterType = filter.type();
2769 2770 2771 2772 2773 2774
        Class<?> rtype = filterType.returnType();
        List<Class<?>> filterArgs = filterType.parameterList();
        if (rtype == void.class) {
            return targetType.insertParameterTypes(pos, filterArgs);
        }
        if (rtype != targetType.parameterType(pos)) {
2775
            throw newIllegalArgumentException("target and filter types do not match", targetType, filterType);
2776 2777
        }
        return targetType.dropParameterTypes(pos, pos+1).insertParameterTypes(pos, filterArgs);
2778 2779
    }

2780
    /**
2781 2782 2783
     * Adapts a target method handle by post-processing
     * its return value (if any) with a filter (another method handle).
     * The result of the filter is returned from the adapter.
2784
     * <p>
2785 2786 2787 2788 2789
     * If the target returns a value, the filter must accept that value as
     * its only argument.
     * If the target returns void, the filter must accept no arguments.
     * <p>
     * The return type of the filter
2790 2791
     * replaces the return type of the target
     * in the resulting adapted method handle.
2792
     * The argument type of the filter (if any) must be identical to the
2793
     * return type of the target.
2794
     * <p><b>Example:</b>
2795
     * <blockquote><pre>{@code
2796 2797
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
2798 2799 2800 2801 2802 2803 2804 2805
...
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
MethodHandle length = lookup().findVirtual(String.class,
  "length", methodType(int.class));
System.out.println((String) cat.invokeExact("x", "y")); // xy
MethodHandle f0 = filterReturnValue(cat, length);
System.out.println((int) f0.invokeExact("x", "y")); // 2
2806
     * }</pre></blockquote>
2807
     * <p> Here is pseudocode for the resulting adapter:
2808
     * <blockquote><pre>{@code
2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
     * V target(A...);
     * T filter(V);
     * T adapter(A... a) {
     *   V v = target(a...);
     *   return filter(v);
     * }
     * // and if the target has a void return:
     * void target2(A...);
     * T filter2();
     * T adapter2(A... a) {
     *   target2(a...);
     *   return filter2();
     * }
     * // and if the filter has a void return:
     * V target3(A...);
     * void filter3(V);
     * void adapter3(A... a) {
     *   V v = target3(a...);
     *   filter3(v);
     * }
2829
     * }</pre></blockquote>
2830 2831 2832
     * @param target the method handle to invoke before filtering the return value
     * @param filter method handle to call on the return value
     * @return method handle which incorporates the specified return value filtering logic
2833
     * @throws NullPointerException if either argument is null
2834 2835
     * @throws IllegalArgumentException if the argument list of {@code filter}
     *          does not match the return type of target as described above
2836
     */
2837
    public static
2838 2839 2840
    MethodHandle filterReturnValue(MethodHandle target, MethodHandle filter) {
        MethodType targetType = target.type();
        MethodType filterType = filter.type();
2841
        filterReturnValueChecks(targetType, filterType);
2842 2843 2844 2845 2846 2847
        BoundMethodHandle result = target.rebind();
        BasicType rtype = BasicType.basicType(filterType.returnType());
        LambdaForm lform = result.editor().filterReturnForm(rtype, false);
        MethodType newType = targetType.changeReturnType(filterType.returnType());
        result = result.copyWithExtendL(newType, lform, filter);
        return result;
2848 2849 2850
    }

    private static void filterReturnValueChecks(MethodType targetType, MethodType filterType) throws RuntimeException {
2851 2852 2853 2854
        Class<?> rtype = targetType.returnType();
        int filterValues = filterType.parameterCount();
        if (filterValues == 0
                ? (rtype != void.class)
2855
                : (rtype != filterType.parameterType(0) || filterValues != 1))
2856
            throw newIllegalArgumentException("target and filter types do not match", targetType, filterType);
2857 2858
    }

2859
    /**
2860
     * Adapts a target method handle by pre-processing
2861
     * some of its arguments, and then calling the target with
2862 2863
     * the result of the pre-processing, inserted into the original
     * sequence of arguments.
2864
     * <p>
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880
     * The pre-processing is performed by {@code combiner}, a second method handle.
     * Of the arguments passed to the adapter, the first {@code N} arguments
     * are copied to the combiner, which is then called.
     * (Here, {@code N} is defined as the parameter count of the combiner.)
     * After this, control passes to the target, with any result
     * from the combiner inserted before the original {@code N} incoming
     * arguments.
     * <p>
     * If the combiner returns a value, the first parameter type of the target
     * must be identical with the return type of the combiner, and the next
     * {@code N} parameter types of the target must exactly match the parameters
     * of the combiner.
     * <p>
     * If the combiner has a void return, no result will be inserted,
     * and the first {@code N} parameter types of the target
     * must exactly match the parameters of the combiner.
2881 2882
     * <p>
     * The resulting adapter is the same type as the target, except that the
2883 2884
     * first parameter type is dropped,
     * if it corresponds to the result of the combiner.
2885
     * <p>
2886
     * (Note that {@link #dropArguments(MethodHandle,int,List) dropArguments} can be used to remove any arguments
2887
     * that either the combiner or the target does not wish to receive.
2888
     * If some of the incoming arguments are destined only for the combiner,
2889
     * consider using {@link MethodHandle#asCollector asCollector} instead, since those
2890 2891
     * arguments will not need to be live on the stack on entry to the
     * target.)
2892
     * <p><b>Example:</b>
2893
     * <blockquote><pre>{@code
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905
import static java.lang.invoke.MethodHandles.*;
import static java.lang.invoke.MethodType.*;
...
MethodHandle trace = publicLookup().findVirtual(java.io.PrintStream.class,
  "println", methodType(void.class, String.class))
    .bindTo(System.out);
MethodHandle cat = lookup().findVirtual(String.class,
  "concat", methodType(String.class, String.class));
assertEquals("boojum", (String) cat.invokeExact("boo", "jum"));
MethodHandle catTrace = foldArguments(cat, trace);
// also prints "boo":
assertEquals("boojum", (String) catTrace.invokeExact("boo", "jum"));
2906
     * }</pre></blockquote>
2907
     * <p> Here is pseudocode for the resulting adapter:
2908
     * <blockquote><pre>{@code
2909
     * // there are N arguments in A...
2910 2911 2912 2913 2914 2915
     * T target(V, A[N]..., B...);
     * V combiner(A...);
     * T adapter(A... a, B... b) {
     *   V v = combiner(a...);
     *   return target(v, a..., b...);
     * }
2916 2917 2918 2919 2920 2921 2922
     * // and if the combiner has a void return:
     * T target2(A[N]..., B...);
     * void combiner2(A...);
     * T adapter2(A... a, B... b) {
     *   combiner2(a...);
     *   return target2(a..., b...);
     * }
2923
     * }</pre></blockquote>
2924 2925 2926
     * @param target the method handle to invoke after arguments are combined
     * @param combiner method handle to call initially on the incoming arguments
     * @return method handle which incorporates the specified argument folding logic
2927
     * @throws NullPointerException if either argument is null
2928 2929 2930 2931 2932
     * @throws IllegalArgumentException if {@code combiner}'s return type
     *          is non-void and not the same as the first argument type of
     *          the target, or if the initial {@code N} argument types
     *          of the target
     *          (skipping one matching the {@code combiner}'s return type)
2933 2934 2935 2936
     *          are not identical with the argument types of {@code combiner}
     */
    public static
    MethodHandle foldArguments(MethodHandle target, MethodHandle combiner) {
2937
        int foldPos = 0;
2938 2939
        MethodType targetType = target.type();
        MethodType combinerType = combiner.type();
2940
        Class<?> rtype = foldArgumentChecks(foldPos, targetType, combinerType);
2941 2942 2943 2944 2945 2946 2947 2948 2949
        BoundMethodHandle result = target.rebind();
        boolean dropResult = (rtype == void.class);
        // Note:  This may cache too many distinct LFs. Consider backing off to varargs code.
        LambdaForm lform = result.editor().foldArgumentsForm(1 + foldPos, dropResult, combinerType.basicType());
        MethodType newType = targetType;
        if (!dropResult)
            newType = newType.dropParameterTypes(foldPos, foldPos + 1);
        result = result.copyWithExtendL(newType, lform, combiner);
        return result;
2950 2951 2952 2953 2954 2955
    }

    private static Class<?> foldArgumentChecks(int foldPos, MethodType targetType, MethodType combinerType) {
        int foldArgs   = combinerType.parameterCount();
        Class<?> rtype = combinerType.returnType();
        int foldVals = rtype == void.class ? 0 : 1;
2956 2957 2958 2959 2960
        int afterInsertPos = foldPos + foldVals;
        boolean ok = (targetType.parameterCount() >= afterInsertPos + foldArgs);
        if (ok && !(combinerType.parameterList()
                    .equals(targetType.parameterList().subList(afterInsertPos,
                                                               afterInsertPos + foldArgs))))
2961
            ok = false;
2962
        if (ok && foldVals != 0 && combinerType.returnType() != targetType.parameterType(0))
2963
            ok = false;
2964 2965
        if (!ok)
            throw misMatchedTypes("target and combiner types", targetType, combinerType);
2966
        return rtype;
2967 2968
    }

2969
    /**
2970
     * Makes a method handle which adapts a target method handle,
2971 2972 2973 2974
     * by guarding it with a test, a boolean-valued method handle.
     * If the guard fails, a fallback handle is called instead.
     * All three method handles must have the same corresponding
     * argument and return types, except that the return type
2975 2976
     * of the test must be boolean, and the test is allowed
     * to have fewer arguments than the other two method handles.
2977
     * <p> Here is pseudocode for the resulting adapter:
2978
     * <blockquote><pre>{@code
2979
     * boolean test(A...);
2980 2981 2982
     * T target(A...,B...);
     * T fallback(A...,B...);
     * T adapter(A... a,B... b) {
2983
     *   if (test(a...))
2984
     *     return target(a..., b...);
2985
     *   else
2986
     *     return fallback(a..., b...);
2987
     * }
2988
     * }</pre></blockquote>
2989 2990 2991
     * Note that the test arguments ({@code a...} in the pseudocode) cannot
     * be modified by execution of the test, and so are passed unchanged
     * from the caller to the target or fallback as appropriate.
2992 2993 2994 2995
     * @param test method handle used for test, must return boolean
     * @param target method handle to call if test passes
     * @param fallback method handle to call if test fails
     * @return method handle which incorporates the specified if/then/else logic
2996
     * @throws NullPointerException if any argument is null
2997 2998
     * @throws IllegalArgumentException if {@code test} does not return boolean,
     *          or if all three method types do not match (with the return
2999
     *          type of {@code test} changed to match that of the target).
3000 3001 3002 3003 3004
     */
    public static
    MethodHandle guardWithTest(MethodHandle test,
                               MethodHandle target,
                               MethodHandle fallback) {
3005 3006 3007
        MethodType gtype = test.type();
        MethodType ttype = target.type();
        MethodType ftype = fallback.type();
3008
        if (!ttype.equals(ftype))
3009
            throw misMatchedTypes("target and fallback types", ttype, ftype);
3010 3011 3012 3013 3014 3015 3016
        if (gtype.returnType() != boolean.class)
            throw newIllegalArgumentException("guard type is not a predicate "+gtype);
        List<Class<?>> targs = ttype.parameterList();
        List<Class<?>> gargs = gtype.parameterList();
        if (!targs.equals(gargs)) {
            int gpc = gargs.size(), tpc = targs.size();
            if (gpc >= tpc || !targs.subList(0, gpc).equals(gargs))
3017
                throw misMatchedTypes("target and test types", ttype, gtype);
3018 3019
            test = dropArguments(test, gpc, targs.subList(gpc, tpc));
            gtype = test.type();
3020
        }
3021
        return MethodHandleImpl.makeGuardWithTest(test, target, fallback);
3022 3023
    }

3024 3025 3026 3027
    static RuntimeException misMatchedTypes(String what, MethodType t1, MethodType t2) {
        return newIllegalArgumentException(what + " must match: " + t1 + " != " + t2);
    }

3028
    /**
3029
     * Makes a method handle which adapts a target method handle,
3030 3031 3032 3033
     * by running it inside an exception handler.
     * If the target returns normally, the adapter returns that value.
     * If an exception matching the specified type is thrown, the fallback
     * handle is called instead on the exception, plus the original arguments.
3034
     * <p>
3035 3036 3037 3038
     * The target and handler must have the same corresponding
     * argument and return types, except that handler may omit trailing arguments
     * (similarly to the predicate in {@link #guardWithTest guardWithTest}).
     * Also, the handler must have an extra leading parameter of {@code exType} or a supertype.
3039
     * <p> Here is pseudocode for the resulting adapter:
3040
     * <blockquote><pre>{@code
3041
     * T target(A..., B...);
3042
     * T handler(ExType, A...);
3043
     * T adapter(A... a, B... b) {
3044
     *   try {
3045
     *     return target(a..., b...);
3046 3047 3048
     *   } catch (ExType ex) {
     *     return handler(ex, a...);
     *   }
3049
     * }
3050
     * }</pre></blockquote>
3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
     * Note that the saved arguments ({@code a...} in the pseudocode) cannot
     * be modified by execution of the target, and so are passed unchanged
     * from the caller to the handler, if the handler is invoked.
     * <p>
     * The target and handler must return the same type, even if the handler
     * always throws.  (This might happen, for instance, because the handler
     * is simulating a {@code finally} clause).
     * To create such a throwing handler, compose the handler creation logic
     * with {@link #throwException throwException},
     * in order to create a method handle of the correct return type.
3061 3062 3063 3064
     * @param target method handle to call
     * @param exType the type of exception which the handler will catch
     * @param handler method handle to call if a matching exception is thrown
     * @return method handle which incorporates the specified try/catch logic
3065
     * @throws NullPointerException if any argument is null
3066 3067 3068 3069
     * @throws IllegalArgumentException if {@code handler} does not accept
     *          the given exception type, or if the method handle types do
     *          not match in their return types and their
     *          corresponding parameters
3070 3071
     */
    public static
3072 3073 3074
    MethodHandle catchException(MethodHandle target,
                                Class<? extends Throwable> exType,
                                MethodHandle handler) {
3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088
        MethodType ttype = target.type();
        MethodType htype = handler.type();
        if (htype.parameterCount() < 1 ||
            !htype.parameterType(0).isAssignableFrom(exType))
            throw newIllegalArgumentException("handler does not accept exception type "+exType);
        if (htype.returnType() != ttype.returnType())
            throw misMatchedTypes("target and handler return types", ttype, htype);
        List<Class<?>> targs = ttype.parameterList();
        List<Class<?>> hargs = htype.parameterList();
        hargs = hargs.subList(1, hargs.size());  // omit leading parameter from handler
        if (!targs.equals(hargs)) {
            int hpc = hargs.size(), tpc = targs.size();
            if (hpc >= tpc || !targs.subList(0, hpc).equals(hargs))
                throw misMatchedTypes("target and handler types", ttype, htype);
3089
            handler = dropArguments(handler, 1+hpc, targs.subList(hpc, tpc));
3090 3091
            htype = handler.type();
        }
3092
        return MethodHandleImpl.makeGuardWithCatch(target, exType, handler);
3093 3094
    }

3095
    /**
3096
     * Produces a method handle which will throw exceptions of the given {@code exType}.
3097 3098 3099 3100 3101
     * The method handle will accept a single argument of {@code exType},
     * and immediately throw it as an exception.
     * The method type will nominally specify a return of {@code returnType}.
     * The return type may be anything convenient:  It doesn't matter to the
     * method handle's behavior, since it will never return normally.
3102 3103
     * @param returnType the return type of the desired method handle
     * @param exType the parameter type of the desired method handle
3104 3105
     * @return method handle which can throw the given exceptions
     * @throws NullPointerException if either argument is null
3106 3107 3108
     */
    public static
    MethodHandle throwException(Class<?> returnType, Class<? extends Throwable> exType) {
3109 3110
        if (!Throwable.class.isAssignableFrom(exType))
            throw new ClassCastException(exType.getName());
3111
        return MethodHandleImpl.throwException(MethodType.methodType(returnType, exType));
3112
    }
3113
}