1 /*
   2  * Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_PRIMS_METHODHANDLES_HPP
  26 #define SHARE_VM_PRIMS_METHODHANDLES_HPP
  27 
  28 #include "classfile/javaClasses.hpp"
  29 #include "classfile/vmSymbols.hpp"
  30 #include "runtime/frame.inline.hpp"
  31 #include "runtime/globals.hpp"
  32 #include "runtime/interfaceSupport.hpp"
  33 
  34 class MacroAssembler;
  35 class Label;
  36 class MethodHandleEntry;
  37 
  38 class MethodHandles: AllStatic {
  39   // JVM support for MethodHandle, MethodType, and related types
  40   // in java.lang.invoke and sun.invoke.
  41   // See also  javaClasses for layouts java_lang_invoke_Method{Handle,Type,Type::Form}.
  42  public:
  43   enum EntryKind {
  44     _raise_exception,           // stub for error generation from other stubs
  45     _invokestatic_mh,           // how a MH emulates invokestatic
  46     _invokespecial_mh,          // ditto for the other invokes...
  47     _invokevirtual_mh,
  48     _invokeinterface_mh,
  49     _bound_ref_mh,              // reference argument is bound
  50     _bound_int_mh,              // int argument is bound (via an Integer or Float)
  51     _bound_long_mh,             // long argument is bound (via a Long or Double)
  52     _bound_ref_direct_mh,       // same as above, with direct linkage to methodOop
  53     _bound_int_direct_mh,
  54     _bound_long_direct_mh,
  55 
  56     _adapter_mh_first,     // adapter sequence goes here...
  57     _adapter_retype_only   = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_RETYPE_ONLY,
  58     _adapter_retype_raw    = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_RETYPE_RAW,
  59     _adapter_check_cast    = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_CHECK_CAST,
  60     _adapter_prim_to_prim  = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_PRIM_TO_PRIM,
  61     _adapter_ref_to_prim   = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_REF_TO_PRIM,
  62     _adapter_prim_to_ref   = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_PRIM_TO_REF,
  63     _adapter_swap_args     = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_SWAP_ARGS,
  64     _adapter_rot_args      = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_ROT_ARGS,
  65     _adapter_dup_args      = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_DUP_ARGS,
  66     _adapter_drop_args     = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_DROP_ARGS,
  67     _adapter_collect_args  = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_COLLECT_ARGS,
  68     _adapter_spread_args   = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_SPREAD_ARGS,
  69     _adapter_fold_args     = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::OP_FOLD_ARGS,
  70     _adapter_unused_13     = _adapter_mh_first + 13,  //hole in the CONV_OP enumeration
  71     _adapter_mh_last       = _adapter_mh_first + java_lang_invoke_AdapterMethodHandle::CONV_OP_LIMIT - 1,
  72 
  73     // Optimized adapter types
  74 
  75     // argument list reordering
  76     _adapter_opt_swap_1,
  77     _adapter_opt_swap_2,
  78     _adapter_opt_rot_1_up,
  79     _adapter_opt_rot_1_down,
  80     _adapter_opt_rot_2_up,
  81     _adapter_opt_rot_2_down,
  82     // primitive single to single:
  83     _adapter_opt_i2i,           // i2c, i2z, i2b, i2s
  84     // primitive double to single:
  85     _adapter_opt_l2i,
  86     _adapter_opt_d2f,
  87     // primitive single to double:
  88     _adapter_opt_i2l,
  89     _adapter_opt_f2d,
  90     // conversion between floating point and integer type is handled by Java
  91 
  92     // reference to primitive:
  93     _adapter_opt_unboxi,
  94     _adapter_opt_unboxl,
  95 
  96     // %% Maybe tame the following with a VM_SYMBOLS_DO type macro?
  97 
  98     // how a blocking adapter returns (platform-dependent)
  99     _adapter_opt_return_ref,
 100     _adapter_opt_return_int,
 101     _adapter_opt_return_long,
 102     _adapter_opt_return_float,
 103     _adapter_opt_return_double,
 104     _adapter_opt_return_void,
 105     _adapter_opt_return_S0_ref,  // return ref to S=0 (last slot)
 106     _adapter_opt_return_S1_ref,  // return ref to S=1 (2nd-to-last slot)
 107     _adapter_opt_return_S2_ref,
 108     _adapter_opt_return_S3_ref,
 109     _adapter_opt_return_S4_ref,
 110     _adapter_opt_return_S5_ref,
 111     _adapter_opt_return_any,     // dynamically select r/i/l/f/d
 112     _adapter_opt_return_FIRST = _adapter_opt_return_ref,
 113     _adapter_opt_return_LAST  = _adapter_opt_return_any,
 114 
 115     // spreading (array length cases 0, 1, ...)
 116     _adapter_opt_spread_0,       // spread empty array to N=0 arguments
 117     _adapter_opt_spread_1_ref,   // spread Object[] to N=1 argument
 118     _adapter_opt_spread_2_ref,   // spread Object[] to N=2 arguments
 119     _adapter_opt_spread_3_ref,   // spread Object[] to N=3 arguments
 120     _adapter_opt_spread_4_ref,   // spread Object[] to N=4 arguments
 121     _adapter_opt_spread_5_ref,   // spread Object[] to N=5 arguments
 122     _adapter_opt_spread_ref,     // spread Object[] to N arguments
 123     _adapter_opt_spread_byte,    // spread byte[] or boolean[] to N arguments
 124     _adapter_opt_spread_char,    // spread char[], etc., to N arguments
 125     _adapter_opt_spread_short,   // spread short[], etc., to N arguments
 126     _adapter_opt_spread_int,     // spread int[], short[], etc., to N arguments
 127     _adapter_opt_spread_long,    // spread long[] to N arguments
 128     _adapter_opt_spread_float,   // spread float[] to N arguments
 129     _adapter_opt_spread_double,  // spread double[] to N arguments
 130     _adapter_opt_spread_FIRST = _adapter_opt_spread_0,
 131     _adapter_opt_spread_LAST  = _adapter_opt_spread_double,
 132 
 133     // blocking filter/collect conversions
 134     // These collect N arguments and replace them (at slot S) by a return value
 135     // which is passed to the final target, along with the unaffected arguments.
 136     // collect_{N}_{T} collects N arguments at any position into a T value
 137     // collect_{N}_S{S}_{T} collects N arguments at slot S into a T value
 138     // collect_{T} collects any number of arguments at any position
 139     // filter_S{S}_{T} is the same as collect_1_S{S}_{T} (a unary collection)
 140     // (collect_2 is also usable as a filter, with long or double arguments)
 141     _adapter_opt_collect_ref,    // combine N arguments, replace with a reference
 142     _adapter_opt_collect_int,    // combine N arguments, replace with an int, short, etc.
 143     _adapter_opt_collect_long,   // combine N arguments, replace with a long
 144     _adapter_opt_collect_float,  // combine N arguments, replace with a float
 145     _adapter_opt_collect_double, // combine N arguments, replace with a double
 146     _adapter_opt_collect_void,   // combine N arguments, replace with nothing
 147     // if there is a small fixed number to push, do so without a loop:
 148     _adapter_opt_collect_0_ref,  // collect N=0 arguments, insert a reference
 149     _adapter_opt_collect_1_ref,  // collect N=1 argument, replace with a reference
 150     _adapter_opt_collect_2_ref,  // combine N=2 arguments, replace with a reference
 151     _adapter_opt_collect_3_ref,  // combine N=3 arguments, replace with a reference
 152     _adapter_opt_collect_4_ref,  // combine N=4 arguments, replace with a reference
 153     _adapter_opt_collect_5_ref,  // combine N=5 arguments, replace with a reference
 154     // filters are an important special case because they never move arguments:
 155     _adapter_opt_filter_S0_ref,  // filter N=1 argument at S=0, replace with a reference
 156     _adapter_opt_filter_S1_ref,  // filter N=1 argument at S=1, replace with a reference
 157     _adapter_opt_filter_S2_ref,  // filter N=1 argument at S=2, replace with a reference
 158     _adapter_opt_filter_S3_ref,  // filter N=1 argument at S=3, replace with a reference
 159     _adapter_opt_filter_S4_ref,  // filter N=1 argument at S=4, replace with a reference
 160     _adapter_opt_filter_S5_ref,  // filter N=1 argument at S=5, replace with a reference
 161     // these move arguments, but they are important for boxing
 162     _adapter_opt_collect_2_S0_ref,  // combine last N=2 arguments, replace with a reference
 163     _adapter_opt_collect_2_S1_ref,  // combine N=2 arguments at S=1, replace with a reference
 164     _adapter_opt_collect_2_S2_ref,  // combine N=2 arguments at S=2, replace with a reference
 165     _adapter_opt_collect_2_S3_ref,  // combine N=2 arguments at S=3, replace with a reference
 166     _adapter_opt_collect_2_S4_ref,  // combine N=2 arguments at S=4, replace with a reference
 167     _adapter_opt_collect_2_S5_ref,  // combine N=2 arguments at S=5, replace with a reference
 168     _adapter_opt_collect_FIRST = _adapter_opt_collect_ref,
 169     _adapter_opt_collect_LAST  = _adapter_opt_collect_2_S5_ref,
 170 
 171     // blocking folding conversions
 172     // these are like collects, but retain all the N arguments for the final target
 173     //_adapter_opt_fold_0_ref,   // same as _adapter_opt_collect_0_ref
 174     // fold_{N}_{T} processes N arguments at any position into a T value, which it inserts
 175     // fold_{T} processes any number of arguments at any position
 176     _adapter_opt_fold_ref,       // process N arguments, prepend a reference
 177     _adapter_opt_fold_int,       // process N arguments, prepend an int, short, etc.
 178     _adapter_opt_fold_long,      // process N arguments, prepend a long
 179     _adapter_opt_fold_float,     // process N arguments, prepend a float
 180     _adapter_opt_fold_double,    // process N arguments, prepend a double
 181     _adapter_opt_fold_void,      // process N arguments, but leave the list unchanged
 182     _adapter_opt_fold_1_ref,     // process N=1 argument, prepend a reference
 183     _adapter_opt_fold_2_ref,     // process N=2 arguments, prepend a reference
 184     _adapter_opt_fold_3_ref,     // process N=3 arguments, prepend a reference
 185     _adapter_opt_fold_4_ref,     // process N=4 arguments, prepend a reference
 186     _adapter_opt_fold_5_ref,     // process N=5 arguments, prepend a reference
 187     _adapter_opt_fold_FIRST = _adapter_opt_fold_ref,
 188     _adapter_opt_fold_LAST  = _adapter_opt_fold_5_ref,
 189 
 190     _EK_LIMIT,
 191     _EK_FIRST = 0
 192   };
 193 
 194  public:
 195   static bool enabled()                         { return _enabled; }
 196   static void set_enabled(bool z);
 197 
 198  private:
 199   enum {  // import java_lang_invoke_AdapterMethodHandle::CONV_OP_*
 200     CONV_OP_LIMIT         = java_lang_invoke_AdapterMethodHandle::CONV_OP_LIMIT,
 201     CONV_OP_MASK          = java_lang_invoke_AdapterMethodHandle::CONV_OP_MASK,
 202     CONV_TYPE_MASK        = java_lang_invoke_AdapterMethodHandle::CONV_TYPE_MASK,
 203     CONV_VMINFO_MASK      = java_lang_invoke_AdapterMethodHandle::CONV_VMINFO_MASK,
 204     CONV_VMINFO_SHIFT     = java_lang_invoke_AdapterMethodHandle::CONV_VMINFO_SHIFT,
 205     CONV_OP_SHIFT         = java_lang_invoke_AdapterMethodHandle::CONV_OP_SHIFT,
 206     CONV_DEST_TYPE_SHIFT  = java_lang_invoke_AdapterMethodHandle::CONV_DEST_TYPE_SHIFT,
 207     CONV_SRC_TYPE_SHIFT   = java_lang_invoke_AdapterMethodHandle::CONV_SRC_TYPE_SHIFT,
 208     CONV_STACK_MOVE_SHIFT = java_lang_invoke_AdapterMethodHandle::CONV_STACK_MOVE_SHIFT,
 209     CONV_STACK_MOVE_MASK  = java_lang_invoke_AdapterMethodHandle::CONV_STACK_MOVE_MASK
 210   };
 211 
 212   static bool _enabled;
 213   static MethodHandleEntry* _entries[_EK_LIMIT];
 214   static const char*        _entry_names[_EK_LIMIT+1];
 215   static jobject            _raise_exception_method;
 216   static address            _adapter_return_handlers[CONV_TYPE_MASK+1];
 217 
 218   // Adapters.
 219   static MethodHandlesAdapterBlob* _adapter_code;
 220 
 221   static bool ek_valid(EntryKind ek)            { return (uint)ek < (uint)_EK_LIMIT; }
 222   static bool conv_op_valid(int op)             { return (uint)op < (uint)CONV_OP_LIMIT; }
 223 
 224  public:
 225   static bool    have_entry(EntryKind ek)       { return ek_valid(ek) && _entries[ek] != NULL; }
 226   static MethodHandleEntry* entry(EntryKind ek) { assert(ek_valid(ek), "initialized");
 227                                                   return _entries[ek]; }
 228   static const char* entry_name(EntryKind ek)   { assert(ek_valid(ek), "oob");
 229                                                   return _entry_names[ek]; }
 230   static EntryKind adapter_entry_kind(int op)   { assert(conv_op_valid(op), "oob");
 231                                                   return EntryKind(_adapter_mh_first + op); }
 232 
 233   static void init_entry(EntryKind ek, MethodHandleEntry* me) {
 234     assert(ek_valid(ek), "oob");
 235     assert(_entries[ek] == NULL, "no double initialization");
 236     _entries[ek] = me;
 237   }
 238 
 239   // Some adapter helper functions.
 240   static EntryKind ek_original_kind(EntryKind ek) {
 241     if (ek <= _adapter_mh_last)  return ek;
 242     switch (ek) {
 243     case _adapter_opt_swap_1:
 244     case _adapter_opt_swap_2:
 245       return _adapter_swap_args;
 246     case _adapter_opt_rot_1_up:
 247     case _adapter_opt_rot_1_down:
 248     case _adapter_opt_rot_2_up:
 249     case _adapter_opt_rot_2_down:
 250       return _adapter_rot_args;
 251     case _adapter_opt_i2i:
 252     case _adapter_opt_l2i:
 253     case _adapter_opt_d2f:
 254     case _adapter_opt_i2l:
 255     case _adapter_opt_f2d:
 256       return _adapter_prim_to_prim;
 257     case _adapter_opt_unboxi:
 258     case _adapter_opt_unboxl:
 259       return _adapter_ref_to_prim;
 260     }
 261     if (ek >= _adapter_opt_spread_FIRST && ek <= _adapter_opt_spread_LAST)
 262       return _adapter_spread_args;
 263     if (ek >= _adapter_opt_collect_FIRST && ek <= _adapter_opt_collect_LAST)
 264       return _adapter_collect_args;
 265     if (ek >= _adapter_opt_fold_FIRST && ek <= _adapter_opt_fold_LAST)
 266       return _adapter_fold_args;
 267     if (ek >= _adapter_opt_return_FIRST && ek <= _adapter_opt_return_LAST)
 268       return _adapter_opt_return_any;
 269     assert(false, "oob");
 270     return _EK_LIMIT;
 271   }
 272 
 273   static bool ek_supported(MethodHandles::EntryKind ek);
 274 
 275   static BasicType ek_bound_mh_arg_type(EntryKind ek) {
 276     switch (ek) {
 277     case _bound_int_mh         : // fall-thru
 278     case _bound_int_direct_mh  : return T_INT;
 279     case _bound_long_mh        : // fall-thru
 280     case _bound_long_direct_mh : return T_LONG;
 281     default                    : return T_OBJECT;
 282     }
 283   }
 284 
 285   static int ek_adapter_opt_swap_slots(EntryKind ek) {
 286     switch (ek) {
 287     case _adapter_opt_swap_1        : return  1;
 288     case _adapter_opt_swap_2        : return  2;
 289     case _adapter_opt_rot_1_up      : return  1;
 290     case _adapter_opt_rot_1_down    : return  1;
 291     case _adapter_opt_rot_2_up      : return  2;
 292     case _adapter_opt_rot_2_down    : return  2;
 293     default : ShouldNotReachHere();   return -1;
 294     }
 295   }
 296 
 297   static int ek_adapter_opt_swap_mode(EntryKind ek) {
 298     switch (ek) {
 299     case _adapter_opt_swap_1       : return  0;
 300     case _adapter_opt_swap_2       : return  0;
 301     case _adapter_opt_rot_1_up     : return  1;
 302     case _adapter_opt_rot_1_down   : return -1;
 303     case _adapter_opt_rot_2_up     : return  1;
 304     case _adapter_opt_rot_2_down   : return -1;
 305     default : ShouldNotReachHere();  return  0;
 306     }
 307   }
 308 
 309   static int ek_adapter_opt_collect_count(EntryKind ek) {
 310     assert(ek >= _adapter_opt_collect_FIRST && ek <= _adapter_opt_collect_LAST ||
 311            ek >= _adapter_opt_fold_FIRST    && ek <= _adapter_opt_fold_LAST, "");
 312     switch (ek) {
 313     case _adapter_opt_collect_0_ref    : return  0;
 314     case _adapter_opt_filter_S0_ref    :
 315     case _adapter_opt_filter_S1_ref    :
 316     case _adapter_opt_filter_S2_ref    :
 317     case _adapter_opt_filter_S3_ref    :
 318     case _adapter_opt_filter_S4_ref    :
 319     case _adapter_opt_filter_S5_ref    :
 320     case _adapter_opt_fold_1_ref       :
 321     case _adapter_opt_collect_1_ref    : return  1;
 322     case _adapter_opt_collect_2_S0_ref :
 323     case _adapter_opt_collect_2_S1_ref :
 324     case _adapter_opt_collect_2_S2_ref :
 325     case _adapter_opt_collect_2_S3_ref :
 326     case _adapter_opt_collect_2_S4_ref :
 327     case _adapter_opt_collect_2_S5_ref :
 328     case _adapter_opt_fold_2_ref       :
 329     case _adapter_opt_collect_2_ref    : return  2;
 330     case _adapter_opt_fold_3_ref       :
 331     case _adapter_opt_collect_3_ref    : return  3;
 332     case _adapter_opt_fold_4_ref       :
 333     case _adapter_opt_collect_4_ref    : return  4;
 334     case _adapter_opt_fold_5_ref       :
 335     case _adapter_opt_collect_5_ref    : return  5;
 336     default                            : return -1;  // sentinel value for "variable"
 337     }
 338   }
 339 
 340   static int ek_adapter_opt_collect_slot(EntryKind ek) {
 341     assert(ek >= _adapter_opt_collect_FIRST && ek <= _adapter_opt_collect_LAST ||
 342            ek >= _adapter_opt_fold_FIRST    && ek <= _adapter_opt_fold_LAST, "");
 343     switch (ek) {
 344     case _adapter_opt_collect_2_S0_ref  :
 345     case _adapter_opt_filter_S0_ref     : return 0;
 346     case _adapter_opt_collect_2_S1_ref  :
 347     case _adapter_opt_filter_S1_ref     : return 1;
 348     case _adapter_opt_collect_2_S2_ref  :
 349     case _adapter_opt_filter_S2_ref     : return 2;
 350     case _adapter_opt_collect_2_S3_ref  :
 351     case _adapter_opt_filter_S3_ref     : return 3;
 352     case _adapter_opt_collect_2_S4_ref  :
 353     case _adapter_opt_filter_S4_ref     : return 4;
 354     case _adapter_opt_collect_2_S5_ref  :
 355     case _adapter_opt_filter_S5_ref     : return 5;
 356     default                             : return -1;  // sentinel value for "variable"
 357     }
 358   }
 359 
 360   static BasicType ek_adapter_opt_collect_type(EntryKind ek) {
 361     assert(ek >= _adapter_opt_collect_FIRST && ek <= _adapter_opt_collect_LAST ||
 362            ek >= _adapter_opt_fold_FIRST    && ek <= _adapter_opt_fold_LAST, "");
 363     switch (ek) {
 364     case _adapter_opt_fold_int          :
 365     case _adapter_opt_collect_int       : return T_INT;
 366     case _adapter_opt_fold_long         :
 367     case _adapter_opt_collect_long      : return T_LONG;
 368     case _adapter_opt_fold_float        :
 369     case _adapter_opt_collect_float     : return T_FLOAT;
 370     case _adapter_opt_fold_double       :
 371     case _adapter_opt_collect_double    : return T_DOUBLE;
 372     case _adapter_opt_fold_void         :
 373     case _adapter_opt_collect_void      : return T_VOID;
 374     default                             : return T_OBJECT;
 375     }
 376   }
 377 
 378   static int ek_adapter_opt_return_slot(EntryKind ek) {
 379     assert(ek >= _adapter_opt_return_FIRST && ek <= _adapter_opt_return_LAST, "");
 380     switch (ek) {
 381     case _adapter_opt_return_S0_ref : return 0;
 382     case _adapter_opt_return_S1_ref : return 1;
 383     case _adapter_opt_return_S2_ref : return 2;
 384     case _adapter_opt_return_S3_ref : return 3;
 385     case _adapter_opt_return_S4_ref : return 4;
 386     case _adapter_opt_return_S5_ref : return 5;
 387     default                         : return -1;  // sentinel value for "variable"
 388     }
 389   }
 390 
 391   static BasicType ek_adapter_opt_return_type(EntryKind ek) {
 392     assert(ek >= _adapter_opt_return_FIRST && ek <= _adapter_opt_return_LAST, "");
 393     switch (ek) {
 394     case _adapter_opt_return_int    : return T_INT;
 395     case _adapter_opt_return_long   : return T_LONG;
 396     case _adapter_opt_return_float  : return T_FLOAT;
 397     case _adapter_opt_return_double : return T_DOUBLE;
 398     case _adapter_opt_return_void   : return T_VOID;
 399     case _adapter_opt_return_any    : return T_CONFLICT;  // sentinel value for "variable"
 400     default                         : return T_OBJECT;
 401     }
 402   }
 403 
 404   static int ek_adapter_opt_spread_count(EntryKind ek) {
 405     assert(ek >= _adapter_opt_spread_FIRST && ek <= _adapter_opt_spread_LAST, "");
 406     switch (ek) {
 407     case _adapter_opt_spread_0     : return  0;
 408     case _adapter_opt_spread_1_ref : return  1;
 409     case _adapter_opt_spread_2_ref : return  2;
 410     case _adapter_opt_spread_3_ref : return  3;
 411     case _adapter_opt_spread_4_ref : return  4;
 412     case _adapter_opt_spread_5_ref : return  5;
 413     default                        : return -1;  // sentinel value for "variable"
 414     }
 415   }
 416 
 417   static BasicType ek_adapter_opt_spread_type(EntryKind ek) {
 418     assert(ek >= _adapter_opt_spread_FIRST && ek <= _adapter_opt_spread_LAST, "");
 419     switch (ek) {
 420     // (there is no _adapter_opt_spread_boolean; we use byte)
 421     case _adapter_opt_spread_byte   : return T_BYTE;
 422     case _adapter_opt_spread_char   : return T_CHAR;
 423     case _adapter_opt_spread_short  : return T_SHORT;
 424     case _adapter_opt_spread_int    : return T_INT;
 425     case _adapter_opt_spread_long   : return T_LONG;
 426     case _adapter_opt_spread_float  : return T_FLOAT;
 427     case _adapter_opt_spread_double : return T_DOUBLE;
 428     default                         : return T_OBJECT;
 429     }
 430   }
 431 
 432   static methodOop raise_exception_method() {
 433     oop rem = JNIHandles::resolve(_raise_exception_method);
 434     assert(rem == NULL || rem->is_method(), "");
 435     return (methodOop) rem;
 436   }
 437   static void set_raise_exception_method(methodOop rem) {
 438     assert(_raise_exception_method == NULL, "");
 439     _raise_exception_method = JNIHandles::make_global(Handle(rem));
 440   }
 441   static methodOop resolve_raise_exception_method(TRAPS);
 442   // call raise_exception_method from C code:
 443   static void raise_exception(int code, oop actual, oop required, TRAPS);
 444 
 445   static jint adapter_conversion(int conv_op, BasicType src, BasicType dest,
 446                                  int stack_move = 0, int vminfo = 0) {
 447     assert(conv_op_valid(conv_op), "oob");
 448     jint conv = ((conv_op      << CONV_OP_SHIFT)
 449                  | (src        << CONV_SRC_TYPE_SHIFT)
 450                  | (dest       << CONV_DEST_TYPE_SHIFT)
 451                  | (stack_move << CONV_STACK_MOVE_SHIFT)
 452                  | (vminfo     << CONV_VMINFO_SHIFT)
 453                  );
 454     assert(adapter_conversion_op(conv) == conv_op, "decode conv_op");
 455     assert(adapter_conversion_src_type(conv) == src, "decode src");
 456     assert(adapter_conversion_dest_type(conv) == dest, "decode dest");
 457     assert(adapter_conversion_stack_move(conv) == stack_move, "decode stack_move");
 458     assert(adapter_conversion_vminfo(conv) == vminfo, "decode vminfo");
 459     return conv;
 460   }
 461   static int adapter_conversion_op(jint conv) {
 462     return ((conv >> CONV_OP_SHIFT) & 0xF);
 463   }
 464   static BasicType adapter_conversion_src_type(jint conv) {
 465     return (BasicType)((conv >> CONV_SRC_TYPE_SHIFT) & 0xF);
 466   }
 467   static BasicType adapter_conversion_dest_type(jint conv) {
 468     return (BasicType)((conv >> CONV_DEST_TYPE_SHIFT) & 0xF);
 469   }
 470   static int adapter_conversion_stack_move(jint conv) {
 471     return (conv >> CONV_STACK_MOVE_SHIFT);
 472   }
 473   static int adapter_conversion_vminfo(jint conv) {
 474     return (conv >> CONV_VMINFO_SHIFT) & CONV_VMINFO_MASK;
 475   }
 476 
 477   // Bit mask of conversion_op values.  May vary by platform.
 478   static int adapter_conversion_ops_supported_mask();
 479 
 480   static bool conv_op_supported(int conv_op) {
 481     assert(conv_op_valid(conv_op), "");
 482     return ((adapter_conversion_ops_supported_mask() & nth_bit(conv_op)) != 0);
 483   }
 484 
 485   // Offset in words that the interpreter stack pointer moves when an argument is pushed.
 486   // The stack_move value must always be a multiple of this.
 487   static int stack_move_unit() {
 488     return frame::interpreter_frame_expression_stack_direction() * Interpreter::stackElementWords;
 489   }
 490 
 491   // Adapter frame traversal.  (Implementation-specific.)
 492   static frame ricochet_frame_sender(const frame& fr, RegisterMap* reg_map);
 493   static void ricochet_frame_oops_do(const frame& fr, OopClosure* blk, const RegisterMap* reg_map);
 494 
 495   enum { CONV_VMINFO_SIGN_FLAG = 0x80 };
 496   // Shift values for prim-to-prim conversions.
 497   static int adapter_prim_to_prim_subword_vminfo(BasicType dest) {
 498     if (dest == T_BOOLEAN) return (BitsPerInt - 1);  // boolean is 1 bit
 499     if (dest == T_CHAR)    return (BitsPerInt - BitsPerShort);
 500     if (dest == T_BYTE)    return (BitsPerInt - BitsPerByte ) | CONV_VMINFO_SIGN_FLAG;
 501     if (dest == T_SHORT)   return (BitsPerInt - BitsPerShort) | CONV_VMINFO_SIGN_FLAG;
 502     return 0;                   // case T_INT
 503   }
 504   // Shift values for unboxing a primitive.
 505   static int adapter_unbox_subword_vminfo(BasicType dest) {
 506     if (dest == T_BOOLEAN) return (BitsPerInt - BitsPerByte );  // implemented as 1 byte
 507     if (dest == T_CHAR)    return (BitsPerInt - BitsPerShort);
 508     if (dest == T_BYTE)    return (BitsPerInt - BitsPerByte ) | CONV_VMINFO_SIGN_FLAG;
 509     if (dest == T_SHORT)   return (BitsPerInt - BitsPerShort) | CONV_VMINFO_SIGN_FLAG;
 510     return 0;                   // case T_INT
 511   }
 512   // Here is the transformation the i2i adapter must perform:
 513   static int truncate_subword_from_vminfo(jint value, int vminfo) {
 514     jint tem = value << vminfo;
 515     if ((vminfo & CONV_VMINFO_SIGN_FLAG) != 0) {
 516       return (jint)tem >> vminfo;
 517     } else {
 518       return (juint)tem >> vminfo;
 519     }
 520   }
 521 
 522   static inline address from_compiled_entry(EntryKind ek);
 523   static inline address from_interpreted_entry(EntryKind ek);
 524 
 525   // helpers for decode_method.
 526   static methodOop    decode_methodOop(methodOop m, int& decode_flags_result);
 527   static methodHandle decode_vmtarget(oop vmtarget, int vmindex, oop mtype, KlassHandle& receiver_limit_result, int& decode_flags_result);
 528   static methodHandle decode_MemberName(oop mname, KlassHandle& receiver_limit_result, int& decode_flags_result);
 529   static methodHandle decode_MethodHandle(oop mh, KlassHandle& receiver_limit_result, int& decode_flags_result);
 530   static methodHandle decode_DirectMethodHandle(oop mh, KlassHandle& receiver_limit_result, int& decode_flags_result);
 531   static methodHandle decode_BoundMethodHandle(oop mh, KlassHandle& receiver_limit_result, int& decode_flags_result);
 532   static methodHandle decode_AdapterMethodHandle(oop mh, KlassHandle& receiver_limit_result, int& decode_flags_result);
 533 
 534   // Find out how many stack slots an mh pushes or pops.
 535   // The result is *not* reported as a multiple of stack_move_unit();
 536   // It is a signed net number of pushes (a difference in vmslots).
 537   // To compare with a stack_move value, first multiply by stack_move_unit().
 538   static int decode_MethodHandle_stack_pushes(oop mh);
 539 
 540  public:
 541   // working with member names
 542   static void resolve_MemberName(Handle mname, TRAPS); // compute vmtarget/vmindex from name/type
 543   static void expand_MemberName(Handle mname, int suppress, TRAPS);  // expand defc/name/type if missing
 544   static Handle new_MemberName(TRAPS);  // must be followed by init_MemberName
 545   static void init_MemberName(oop mname_oop, oop target); // compute vmtarget/vmindex from target
 546   static void init_MemberName(oop mname_oop, methodOop m, bool do_dispatch = true);
 547   static void init_MemberName(oop mname_oop, klassOop field_holder, AccessFlags mods, int offset);
 548   static int find_MemberNames(klassOop k, Symbol* name, Symbol* sig,
 549                               int mflags, klassOop caller,
 550                               int skip, objArrayOop results);
 551   // bit values for suppress argument to expand_MemberName:
 552   enum { _suppress_defc = 1, _suppress_name = 2, _suppress_type = 4 };
 553 
 554   // Generate MethodHandles adapters.
 555   static void generate_adapters();
 556 
 557   // Called from InterpreterGenerator and MethodHandlesAdapterGenerator.
 558   static address generate_method_handle_interpreter_entry(MacroAssembler* _masm);
 559   static void generate_method_handle_stub(MacroAssembler* _masm, EntryKind ek);
 560 
 561   // argument list parsing
 562   static int argument_slot(oop method_type, int arg);
 563   static int argument_slot_count(oop method_type) { return argument_slot(method_type, -1); }
 564   static int argument_slot_to_argnum(oop method_type, int argslot);
 565 
 566   // Runtime support
 567   enum {                        // bit-encoded flags from decode_method or decode_vmref
 568     _dmf_has_receiver   = 0x01, // target method has leading reference argument
 569     _dmf_does_dispatch  = 0x02, // method handle performs virtual or interface dispatch
 570     _dmf_from_interface = 0x04, // peforms interface dispatch
 571     _DMF_DIRECT_MASK    = (_dmf_from_interface*2 - _dmf_has_receiver),
 572     _dmf_binds_method   = 0x08,
 573     _dmf_binds_argument = 0x10,
 574     _DMF_BOUND_MASK     = (_dmf_binds_argument*2 - _dmf_binds_method),
 575     _dmf_adapter_lsb    = 0x20,
 576     _DMF_ADAPTER_MASK   = (_dmf_adapter_lsb << CONV_OP_LIMIT) - _dmf_adapter_lsb
 577   };
 578   static methodHandle decode_method(oop x, KlassHandle& receiver_limit_result, int& decode_flags_result);
 579   enum {
 580     // format of query to getConstant:
 581     GC_JVM_PUSH_LIMIT = 0,
 582     GC_JVM_STACK_MOVE_UNIT = 1,
 583     GC_CONV_OP_IMPLEMENTED_MASK = 2,
 584 
 585     // format of result from getTarget / encode_target:
 586     ETF_HANDLE_OR_METHOD_NAME = 0, // all available data (immediate MH or method)
 587     ETF_DIRECT_HANDLE         = 1, // ultimate method handle (will be a DMH, may be self)
 588     ETF_METHOD_NAME           = 2, // ultimate method as MemberName
 589     ETF_REFLECT_METHOD        = 3  // ultimate method as java.lang.reflect object (sans refClass)
 590   };
 591   static int get_named_constant(int which, Handle name_box, TRAPS);
 592   static oop encode_target(Handle mh, int format, TRAPS); // report vmtarget (to Java code)
 593   static bool class_cast_needed(klassOop src, klassOop dst);
 594 
 595   static instanceKlassHandle resolve_instance_klass(oop    java_mirror_oop, TRAPS);
 596   static instanceKlassHandle resolve_instance_klass(jclass java_mirror_jh,  TRAPS) {
 597     return resolve_instance_klass(JNIHandles::resolve(java_mirror_jh), THREAD);
 598   }
 599 
 600  private:
 601   // These checkers operate on a pair of whole MethodTypes:
 602   static const char* check_method_type_change(oop src_mtype, int src_beg, int src_end,
 603                                               int insert_argnum, oop insert_type,
 604                                               int change_argnum, oop change_type,
 605                                               int delete_argnum,
 606                                               oop dst_mtype, int dst_beg, int dst_end,
 607                                               bool raw = false);
 608   static const char* check_method_type_insertion(oop src_mtype,
 609                                                  int insert_argnum, oop insert_type,
 610                                                  oop dst_mtype) {
 611     oop no_ref = NULL;
 612     return check_method_type_change(src_mtype, 0, -1,
 613                                     insert_argnum, insert_type,
 614                                     -1, no_ref, -1, dst_mtype, 0, -1);
 615   }
 616   static const char* check_method_type_conversion(oop src_mtype,
 617                                                   int change_argnum, oop change_type,
 618                                                   oop dst_mtype) {
 619     oop no_ref = NULL;
 620     return check_method_type_change(src_mtype, 0, -1, -1, no_ref,
 621                                     change_argnum, change_type,
 622                                     -1, dst_mtype, 0, -1);
 623   }
 624   static const char* check_method_type_passthrough(oop src_mtype, oop dst_mtype, bool raw) {
 625     oop no_ref = NULL;
 626     return check_method_type_change(src_mtype, 0, -1,
 627                                     -1, no_ref, -1, no_ref, -1,
 628                                     dst_mtype, 0, -1, raw);
 629   }
 630 
 631   // These checkers operate on pairs of argument or return types:
 632   static const char* check_argument_type_change(BasicType src_type, klassOop src_klass,
 633                                                 BasicType dst_type, klassOop dst_klass,
 634                                                 int argnum, bool raw = false);
 635 
 636   static const char* check_argument_type_change(oop src_type, oop dst_type,
 637                                                 int argnum, bool raw = false) {
 638     klassOop src_klass = NULL, dst_klass = NULL;
 639     BasicType src_bt = java_lang_Class::as_BasicType(src_type, &src_klass);
 640     BasicType dst_bt = java_lang_Class::as_BasicType(dst_type, &dst_klass);
 641     return check_argument_type_change(src_bt, src_klass,
 642                                       dst_bt, dst_klass, argnum, raw);
 643   }
 644 
 645   static const char* check_return_type_change(oop src_type, oop dst_type, bool raw = false) {
 646     return check_argument_type_change(src_type, dst_type, -1, raw);
 647   }
 648 
 649   static const char* check_return_type_change(BasicType src_type, klassOop src_klass,
 650                                               BasicType dst_type, klassOop dst_klass) {
 651     return check_argument_type_change(src_type, src_klass, dst_type, dst_klass, -1);
 652   }
 653 
 654   static const char* check_method_receiver(methodOop m, klassOop passed_recv_type);
 655 
 656   // These verifiers can block, and will throw an error if the checking fails:
 657   static void verify_vmslots(Handle mh, TRAPS);
 658   static void verify_vmargslot(Handle mh, int argnum, int argslot, TRAPS);
 659 
 660   static void verify_method_type(methodHandle m, Handle mtype,
 661                                  bool has_bound_oop,
 662                                  KlassHandle bound_oop_type,
 663                                  TRAPS);
 664 
 665   static void verify_method_signature(methodHandle m, Handle mtype,
 666                                       int first_ptype_pos,
 667                                       KlassHandle insert_ptype, TRAPS);
 668 
 669   static void verify_DirectMethodHandle(Handle mh, methodHandle m, TRAPS);
 670   static void verify_BoundMethodHandle(Handle mh, Handle target, int argnum,
 671                                        bool direct_to_method, TRAPS);
 672   static void verify_BoundMethodHandle_with_receiver(Handle mh, methodHandle m, TRAPS);
 673   static void verify_AdapterMethodHandle(Handle mh, int argnum, TRAPS);
 674 
 675  public:
 676 
 677   // Fill in the fields of a DirectMethodHandle mh.  (MH.type must be pre-filled.)
 678   static void init_DirectMethodHandle(Handle mh, methodHandle method, bool do_dispatch, TRAPS);
 679 
 680   // Fill in the fields of a BoundMethodHandle mh.  (MH.type, BMH.argument must be pre-filled.)
 681   static void init_BoundMethodHandle(Handle mh, Handle target, int argnum, TRAPS);
 682   static void init_BoundMethodHandle_with_receiver(Handle mh,
 683                                                    methodHandle original_m,
 684                                                    KlassHandle receiver_limit,
 685                                                    int decode_flags,
 686                                                    TRAPS);
 687 
 688   // Fill in the fields of an AdapterMethodHandle mh.  (MH.type must be pre-filled.)
 689   static void init_AdapterMethodHandle(Handle mh, Handle target, int argnum, TRAPS);
 690   static void ensure_vmlayout_field(Handle target, TRAPS);
 691 
 692 #ifdef ASSERT
 693   static bool spot_check_entry_names();
 694 #endif
 695 
 696  private:
 697   static methodHandle dispatch_decoded_method(methodHandle m,
 698                                               KlassHandle receiver_limit,
 699                                               int decode_flags,
 700                                               KlassHandle receiver_klass,
 701                                               TRAPS);
 702 
 703 public:
 704   static bool is_float_fixed_reinterpretation_cast(BasicType src, BasicType dst);
 705   static bool same_basic_type_for_arguments(BasicType src, BasicType dst,
 706                                             bool raw = false,
 707                                             bool for_return = false);
 708   static bool same_basic_type_for_returns(BasicType src, BasicType dst, bool raw = false) {
 709     return same_basic_type_for_arguments(src, dst, raw, true);
 710   }
 711 
 712   static Symbol* convert_to_signature(oop type_str, bool polymorphic, TRAPS);
 713 
 714 #ifdef TARGET_ARCH_x86
 715 # include "methodHandles_x86.hpp"
 716 #endif
 717 #ifdef TARGET_ARCH_sparc
 718 # include "methodHandles_sparc.hpp"
 719 #endif
 720 #ifdef TARGET_ARCH_zero
 721 # include "methodHandles_zero.hpp"
 722 #endif
 723 #ifdef TARGET_ARCH_arm
 724 # include "methodHandles_arm.hpp"
 725 #endif
 726 #ifdef TARGET_ARCH_ppc
 727 # include "methodHandles_ppc.hpp"
 728 #endif
 729 
 730 #ifdef TARGET_ARCH_NYI_6939861
 731   // Here are some backward compatible declarations until the 6939861 ports are updated.
 732   #define _adapter_flyby    (_EK_LIMIT + 10)
 733   #define _adapter_ricochet (_EK_LIMIT + 11)
 734   #define _adapter_opt_spread_1    _adapter_opt_spread_1_ref
 735   #define _adapter_opt_spread_more _adapter_opt_spread_ref
 736   enum {
 737     _INSERT_NO_MASK   = -1,
 738     _INSERT_REF_MASK  = 0,
 739     _INSERT_INT_MASK  = 1,
 740     _INSERT_LONG_MASK = 3
 741   };
 742   static void get_ek_bound_mh_info(EntryKind ek, BasicType& arg_type, int& arg_mask, int& arg_slots) {
 743     arg_type = ek_bound_mh_arg_type(ek);
 744     arg_mask = 0;
 745     arg_slots = type2size[arg_type];;
 746   }
 747   static void get_ek_adapter_opt_swap_rot_info(EntryKind ek, int& swap_bytes, int& rotate) {
 748     int swap_slots = ek_adapter_opt_swap_slots(ek);
 749     rotate = ek_adapter_opt_swap_mode(ek);
 750     swap_bytes = swap_slots * Interpreter::stackElementSize;
 751   }
 752   static int get_ek_adapter_opt_spread_info(EntryKind ek) {
 753     return ek_adapter_opt_spread_count(ek);
 754   }
 755 
 756   static void insert_arg_slots(MacroAssembler* _masm,
 757                                RegisterOrConstant arg_slots,
 758                                int arg_mask,
 759                                Register argslot_reg,
 760                                Register temp_reg, Register temp2_reg, Register temp3_reg = noreg);
 761 
 762   static void remove_arg_slots(MacroAssembler* _masm,
 763                                RegisterOrConstant arg_slots,
 764                                Register argslot_reg,
 765                                Register temp_reg, Register temp2_reg, Register temp3_reg = noreg);
 766 
 767   static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
 768 #endif //TARGET_ARCH_NYI_6939861
 769 };
 770 
 771 
 772 // Access methods for the "entry" field of a java.lang.invoke.MethodHandle.
 773 // The field is primarily a jump target for compiled calls.
 774 // However, we squirrel away some nice pointers for other uses,
 775 // just before the jump target.
 776 // Aspects of a method handle entry:
 777 //  - from_compiled_entry - stub used when compiled code calls the MH
 778 //  - from_interpreted_entry - stub used when the interpreter calls the MH
 779 //  - type_checking_entry - stub for runtime casting between MHForm siblings (NYI)
 780 class MethodHandleEntry {
 781  public:
 782   class Data {
 783     friend class MethodHandleEntry;
 784     size_t              _total_size; // size including Data and code stub
 785     MethodHandleEntry*  _type_checking_entry;
 786     address             _from_interpreted_entry;
 787     MethodHandleEntry* method_entry() { return (MethodHandleEntry*)(this + 1); }
 788   };
 789 
 790   Data*     data()                              { return (Data*)this - 1; }
 791 
 792   address   start_address()                     { return (address) data(); }
 793   address   end_address()                       { return start_address() + data()->_total_size; }
 794 
 795   address   from_compiled_entry()               { return (address) this; }
 796 
 797   address   from_interpreted_entry()            { return data()->_from_interpreted_entry; }
 798   void  set_from_interpreted_entry(address e)   { data()->_from_interpreted_entry = e; }
 799 
 800   MethodHandleEntry* type_checking_entry()           { return data()->_type_checking_entry; }
 801   void set_type_checking_entry(MethodHandleEntry* e) { data()->_type_checking_entry = e; }
 802 
 803   void set_end_address(address end_addr) {
 804     size_t total_size = end_addr - start_address();
 805     assert(total_size > 0 && total_size < 0x1000, "reasonable end address");
 806     data()->_total_size = total_size;
 807   }
 808 
 809   // Compiler support:
 810   static int from_interpreted_entry_offset_in_bytes() {
 811     return (int)( offset_of(Data, _from_interpreted_entry) - sizeof(Data) );
 812   }
 813   static int type_checking_entry_offset_in_bytes() {
 814     return (int)( offset_of(Data, _from_interpreted_entry) - sizeof(Data) );
 815   }
 816 
 817   static address            start_compiled_entry(MacroAssembler* _masm,
 818                                                  address interpreted_entry = NULL);
 819   static MethodHandleEntry* finish_compiled_entry(MacroAssembler* masm, address start_addr);
 820 };
 821 
 822 address MethodHandles::from_compiled_entry(EntryKind ek) { return entry(ek)->from_compiled_entry(); }
 823 address MethodHandles::from_interpreted_entry(EntryKind ek) { return entry(ek)->from_interpreted_entry(); }
 824 
 825 
 826 //------------------------------------------------------------------------------
 827 // MethodHandlesAdapterGenerator
 828 //
 829 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
 830 public:
 831   MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code) {}
 832 
 833   void generate();
 834 };
 835 
 836 #endif // SHARE_VM_PRIMS_METHODHANDLES_HPP