twisti@1568: /*
trims@1907:  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
twisti@1568:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
twisti@1568:  *
twisti@1568:  * This code is free software; you can redistribute it and/or modify it
twisti@1568:  * under the terms of the GNU General Public License version 2 only, as
twisti@1568:  * published by the Free Software Foundation.
twisti@1568:  *
twisti@1568:  * This code is distributed in the hope that it will be useful, but WITHOUT
twisti@1568:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
twisti@1568:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
twisti@1568:  * version 2 for more details (a copy is included in the LICENSE file that
twisti@1568:  * accompanied this code).
twisti@1568:  *
twisti@1568:  * You should have received a copy of the GNU General Public License version
twisti@1568:  * 2 along with this work; if not, write to the Free Software Foundation,
twisti@1568:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
twisti@1568:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
twisti@1568:  *
twisti@1568:  */
twisti@1568: 
twisti@1568: // Low-level parser for method handle chains.
twisti@1568: class MethodHandleChain : StackObj {
twisti@1568: public:
twisti@1568:   typedef MethodHandles::EntryKind EntryKind;
twisti@1568: 
twisti@1568: private:
twisti@1568:   Handle        _root;          // original target
twisti@1568:   Handle        _method_handle; // current target
twisti@1568:   bool          _is_last;       // final guy in chain
twisti@1568:   bool          _is_bound;      // has a bound argument
twisti@1568:   BasicType     _arg_type;      // if is_bound, the bound argument type
twisti@1568:   int           _arg_slot;      // if is_bound or is_adapter, affected argument slot
twisti@1568:   jint          _conversion;    // conversion field of AMH or -1
twisti@1568:   methodHandle  _last_method;   // if is_last, which method we target
twisti@1568:   Bytecodes::Code _last_invoke; // if is_last, type of invoke
twisti@1568:   const char*   _lose_message;  // saved argument to lose()
twisti@1568: 
twisti@1568:   void set_method_handle(Handle target, TRAPS);
twisti@1568:   void set_last_method(oop target, TRAPS);
twisti@1568:   static BasicType compute_bound_arg_type(oop target, methodOop m, int arg_slot, TRAPS);
twisti@1568: 
twisti@1568:   oop MethodHandle_type_oop()     { return java_dyn_MethodHandle::type(method_handle_oop()); }
twisti@1568:   oop MethodHandle_vmtarget_oop() { return java_dyn_MethodHandle::vmtarget(method_handle_oop()); }
twisti@1568:   int MethodHandle_vmslots()      { return java_dyn_MethodHandle::vmslots(method_handle_oop()); }
twisti@1568:   int DirectMethodHandle_vmindex()     { return sun_dyn_DirectMethodHandle::vmindex(method_handle_oop()); }
twisti@1568:   oop BoundMethodHandle_argument_oop() { return sun_dyn_BoundMethodHandle::argument(method_handle_oop()); }
twisti@1568:   int BoundMethodHandle_vmargslot()    { return sun_dyn_BoundMethodHandle::vmargslot(method_handle_oop()); }
twisti@1568:   int AdapterMethodHandle_conversion() { return sun_dyn_AdapterMethodHandle::conversion(method_handle_oop()); }
twisti@1568: 
twisti@1568: public:
twisti@1568:   MethodHandleChain(Handle root, TRAPS)
twisti@1568:     : _root(root)
twisti@1568:   { set_method_handle(root, THREAD); }
twisti@1568: 
twisti@1568:   bool is_adapter()             { return _conversion != -1; }
twisti@1568:   bool is_bound()               { return _is_bound; }
twisti@1568:   bool is_last()                { return _is_last; }
twisti@1568: 
twisti@1568:   void next(TRAPS) {
twisti@1568:     assert(!is_last(), "");
twisti@1568:     set_method_handle(MethodHandle_vmtarget_oop(), THREAD);
twisti@1568:   }
twisti@1568: 
twisti@1568:   Handle method_handle()        { return _method_handle; }
twisti@1568:   oop    method_handle_oop()    { return _method_handle(); }
twisti@1568:   oop    method_type_oop()      { return MethodHandle_type_oop(); }
twisti@1573:   oop    vmtarget_oop()         { return MethodHandle_vmtarget_oop(); }
twisti@1568: 
twisti@1568:   jint adapter_conversion()     { assert(is_adapter(), ""); return _conversion; }
twisti@1568:   int  adapter_conversion_op()  { return MethodHandles::adapter_conversion_op(adapter_conversion()); }
twisti@1568:   BasicType adapter_conversion_src_type()
twisti@1568:                                 { return MethodHandles::adapter_conversion_src_type(adapter_conversion()); }
twisti@1568:   BasicType adapter_conversion_dest_type()
twisti@1568:                                 { return MethodHandles::adapter_conversion_dest_type(adapter_conversion()); }
twisti@1568:   int  adapter_conversion_stack_move()
twisti@1568:                                 { return MethodHandles::adapter_conversion_stack_move(adapter_conversion()); }
twisti@1568:   int  adapter_conversion_stack_pushes()
twisti@1568:                                 { return adapter_conversion_stack_move() / MethodHandles::stack_move_unit(); }
twisti@1568:   int  adapter_conversion_vminfo()
twisti@1568:                                 { return MethodHandles::adapter_conversion_vminfo(adapter_conversion()); }
twisti@1568:   int adapter_arg_slot()        { assert(is_adapter(), ""); return _arg_slot; }
twisti@1568:   oop adapter_arg_oop()         { assert(is_adapter(), ""); return BoundMethodHandle_argument_oop(); }
twisti@1568: 
twisti@1568:   BasicType bound_arg_type()    { assert(is_bound(), ""); return _arg_type; }
twisti@1568:   int       bound_arg_slot()    { assert(is_bound(), ""); return _arg_slot; }
twisti@1568:   oop       bound_arg_oop()     { assert(is_bound(), ""); return BoundMethodHandle_argument_oop(); }
twisti@1568: 
twisti@1568:   methodOop last_method_oop()   { assert(is_last(), ""); return _last_method(); }
twisti@1568:   Bytecodes::Code last_invoke_code() { assert(is_last(), ""); return _last_invoke; }
twisti@1568: 
twisti@1568:   void lose(const char* msg, TRAPS);
twisti@1568:   const char* lose_message()    { return _lose_message; }
twisti@1568: };
twisti@1568: 
twisti@1568: 
twisti@1568: // Structure walker for method handles.
twisti@1568: // Does abstract interpretation on top of low-level parsing.
twisti@1568: // You supply the tokens shuffled by the abstract interpretation.
twisti@1568: class MethodHandleWalker : StackObj {
twisti@1568: public:
twisti@1573:   // Stack values:
twisti@1573:   enum TokenType {
twisti@1573:     tt_void,
twisti@1573:     tt_parameter,
twisti@1573:     tt_temporary,
twisti@1573:     tt_constant,
twisti@1573:     tt_illegal
twisti@1573:   };
twisti@1573: 
twisti@1573:   // Argument token:
twisti@1573:   class ArgToken {
twisti@1573:   private:
twisti@1573:     TokenType _tt;
twisti@1573:     BasicType _bt;
twisti@1573:     jvalue    _value;
twisti@1573:     Handle    _handle;
twisti@1573: 
twisti@1573:   public:
twisti@1573:     ArgToken(TokenType tt = tt_illegal) : _tt(tt) {}
twisti@1573:     ArgToken(TokenType tt, BasicType bt, jvalue value) : _tt(tt), _bt(bt), _value(value) {}
twisti@1573: 
twisti@1573:     ArgToken(TokenType tt, BasicType bt, int index) : _tt(tt), _bt(bt) {
twisti@1573:       _value.i = index;
twisti@1573:     }
twisti@1573: 
twisti@1573:     ArgToken(TokenType tt, BasicType bt, Handle value) : _tt(tt), _bt(bt) {
twisti@1573:       _handle = value;
twisti@1573:     }
twisti@1573: 
twisti@1573:     TokenType token_type()  const { return _tt; }
twisti@1573:     BasicType basic_type()  const { return _bt; }
twisti@1573:     int       index()       const { return _value.i; }
twisti@1573:     Handle    object()      const { return _handle; }
twisti@1573: 
twisti@1573:     jint      get_jint()    const { return _value.i; }
twisti@1573:     jlong     get_jlong()   const { return _value.j; }
twisti@1573:     jfloat    get_jfloat()  const { return _value.f; }
twisti@1573:     jdouble   get_jdouble() const { return _value.d; }
twisti@1573:   };
twisti@1568: 
twisti@1568:   // Abstract interpretation state:
twisti@1568:   struct SlotState {
twisti@1568:     BasicType _type;
twisti@1568:     ArgToken  _arg;
twisti@1568:     SlotState() : _type(), _arg() {}
twisti@1568:   };
twisti@1568:   static SlotState make_state(BasicType type, ArgToken arg) {
twisti@1568:     SlotState ss;
twisti@1568:     ss._type = type; ss._arg = arg;
twisti@1568:     return ss;
twisti@1568:   }
twisti@1568: 
twisti@1568: private:
twisti@1568:   MethodHandleChain _chain;
twisti@1573:   bool              _for_invokedynamic;
twisti@1573:   int               _local_index;
twisti@1568: 
twisti@1573:   GrowableArray<SlotState> _outgoing;       // current outgoing parameter slots
twisti@1568:   int                      _outgoing_argc;  // # non-empty outgoing slots
twisti@1568: 
twisti@1568:   // Replace a value of type old_type at slot (and maybe slot+1) with the new value.
twisti@1568:   // If old_type != T_VOID, remove the old argument at that point.
twisti@1568:   // If new_type != T_VOID, insert the new argument at that point.
twisti@1568:   // Insert or delete a second empty slot as needed.
twisti@1573:   void change_argument(BasicType old_type, int slot, BasicType new_type, const ArgToken& new_arg);
twisti@1568: 
twisti@1568:   SlotState* slot_state(int slot) {
twisti@1568:     if (slot < 0 || slot >= _outgoing.length())
twisti@1568:       return NULL;
twisti@1568:     return _outgoing.adr_at(slot);
twisti@1568:   }
twisti@1568:   BasicType slot_type(int slot) {
twisti@1568:     SlotState* ss = slot_state(slot);
twisti@1568:     if (ss == NULL)
twisti@1568:       return T_ILLEGAL;
twisti@1568:     return ss->_type;
twisti@1568:   }
twisti@1568:   bool slot_has_argument(int slot) {
twisti@1568:     return slot_type(slot) < T_VOID;
twisti@1568:   }
twisti@1568: 
twisti@1568: #ifdef ASSERT
twisti@1568:   int argument_count_slow();
twisti@1568: #endif
twisti@1568: 
twisti@1568:   // Return a bytecode for converting src to dest, if one exists.
twisti@1568:   Bytecodes::Code conversion_code(BasicType src, BasicType dest);
twisti@1568: 
twisti@1568:   void walk_incoming_state(TRAPS);
twisti@1568: 
twisti@1568: public:
twisti@1573:   MethodHandleWalker(Handle root, bool for_invokedynamic, TRAPS)
twisti@1568:     : _chain(root, THREAD),
twisti@1573:       _for_invokedynamic(for_invokedynamic),
twisti@1568:       _outgoing(THREAD, 10),
twisti@1568:       _outgoing_argc(0)
twisti@1573:   {
twisti@1573:     _local_index = for_invokedynamic ? 0 : 1;
twisti@1573:   }
twisti@1568: 
twisti@1568:   MethodHandleChain& chain() { return _chain; }
twisti@1568: 
twisti@1573:   bool for_invokedynamic() const { return _for_invokedynamic; }
twisti@1573: 
twisti@1573:   int new_local_index(BasicType bt) {
twisti@1573:     //int index = _for_invokedynamic ? _local_index : _local_index - 1;
twisti@1573:     int index = _local_index;
twisti@1573:     _local_index += type2size[bt];
twisti@1573:     return index;
twisti@1573:   }
twisti@1573: 
twisti@1573:   int max_locals() const { return _local_index; }
twisti@1573: 
twisti@1568:   // plug-in abstract interpretation steps:
twisti@1568:   virtual ArgToken make_parameter( BasicType type, klassOop tk, int argnum, TRAPS ) = 0;
twisti@1568:   virtual ArgToken make_prim_constant( BasicType type, jvalue* con, TRAPS ) = 0;
twisti@1568:   virtual ArgToken make_oop_constant( oop con, TRAPS ) = 0;
twisti@1573:   virtual ArgToken make_conversion( BasicType type, klassOop tk, Bytecodes::Code op, const ArgToken& src, TRAPS ) = 0;
twisti@1573:   virtual ArgToken make_fetch( BasicType type, klassOop tk, Bytecodes::Code op, const ArgToken& base, const ArgToken& offset, TRAPS ) = 0;
twisti@1568:   virtual ArgToken make_invoke( methodOop m, vmIntrinsics::ID iid, Bytecodes::Code op, bool tailcall, int argc, ArgToken* argv, TRAPS ) = 0;
twisti@1568: 
twisti@1568:   // For make_invoke, the methodOop can be NULL if the intrinsic ID
twisti@1568:   // is something other than vmIntrinsics::_none.
twisti@1568: 
twisti@1568:   // and in case anyone cares to related the previous actions to the chain:
twisti@1568:   virtual void set_method_handle(oop mh) { }
twisti@1568: 
twisti@1568:   void lose(const char* msg, TRAPS) { chain().lose(msg, THREAD); }
twisti@1568:   const char* lose_message()        { return chain().lose_message(); }
twisti@1568: 
twisti@1568:   ArgToken walk(TRAPS);
twisti@1568: };
twisti@1568: 
twisti@1568: 
twisti@1568: // An abstract interpreter for method handle chains.
twisti@1568: // Produces an account of the semantics of a chain, in terms of a static IR.
twisti@1568: // The IR happens to be JVM bytecodes.
twisti@1568: class MethodHandleCompiler : public MethodHandleWalker {
twisti@1568: private:
twisti@1573:   methodHandle _callee;
twisti@1573:   KlassHandle  _rklass;        // Return type for casting.
twisti@1573:   BasicType    _rtype;
twisti@1573:   KlassHandle  _target_klass;
twisti@1573:   Thread*      _thread;
twisti@1568: 
twisti@1573:   // Fake constant pool entry.
twisti@1573:   class ConstantValue {
twisti@1573:   private:
twisti@1573:     int       _tag;   // Constant pool tag type.
twisti@1573:     JavaValue _value;
twisti@1573:     Handle    _handle;
twisti@1573: 
twisti@1573:   public:
twisti@1573:     // Constructor for oop types.
twisti@1573:     ConstantValue(int tag, Handle con) : _tag(tag), _handle(con) {
twisti@1573:       assert(tag == JVM_CONSTANT_Utf8   ||
twisti@1573:              tag == JVM_CONSTANT_Class  ||
twisti@1573:              tag == JVM_CONSTANT_String ||
twisti@1573:              tag == JVM_CONSTANT_Object, "must be oop type");
twisti@1573:     }
twisti@1573: 
twisti@1573:     // Constructor for oop reference types.
twisti@1573:     ConstantValue(int tag, int index) : _tag(tag) {
twisti@1573:       assert(JVM_CONSTANT_Fieldref <= tag && tag <= JVM_CONSTANT_NameAndType, "must be ref type");
twisti@1573:       _value.set_jint(index);
twisti@1573:     }
twisti@1573:     ConstantValue(int tag, int first_index, int second_index) : _tag(tag) {
twisti@1573:       assert(JVM_CONSTANT_Fieldref <= tag && tag <= JVM_CONSTANT_NameAndType, "must be ref type");
twisti@1573:       _value.set_jint(first_index << 16 | second_index);
twisti@1573:     }
twisti@1573: 
twisti@1573:     // Constructor for primitive types.
twisti@1573:     ConstantValue(BasicType bt, jvalue con) {
twisti@1573:       _value.set_type(bt);
twisti@1573:       switch (bt) {
twisti@1573:       case T_INT:    _tag = JVM_CONSTANT_Integer; _value.set_jint(   con.i); break;
twisti@1573:       case T_LONG:   _tag = JVM_CONSTANT_Long;    _value.set_jlong(  con.j); break;
twisti@1573:       case T_FLOAT:  _tag = JVM_CONSTANT_Float;   _value.set_jfloat( con.f); break;
twisti@1573:       case T_DOUBLE: _tag = JVM_CONSTANT_Double;  _value.set_jdouble(con.d); break;
twisti@1573:       default: ShouldNotReachHere();
twisti@1573:       }
twisti@1573:     }
twisti@1573: 
twisti@1573:     int       tag()          const { return _tag; }
twisti@1573:     symbolOop symbol_oop()   const { return (symbolOop) _handle(); }
twisti@1573:     klassOop  klass_oop()    const { return (klassOop)  _handle(); }
twisti@1573:     oop       object_oop()   const { return _handle(); }
twisti@1573:     int       index()        const { return _value.get_jint(); }
twisti@1573:     int       first_index()  const { return _value.get_jint() >> 16; }
twisti@1573:     int       second_index() const { return _value.get_jint() & 0x0000FFFF; }
twisti@1573: 
twisti@1573:     bool      is_primitive() const { return is_java_primitive(_value.get_type()); }
twisti@1573:     jint      get_jint()     const { return _value.get_jint();    }
twisti@1573:     jlong     get_jlong()    const { return _value.get_jlong();   }
twisti@1573:     jfloat    get_jfloat()   const { return _value.get_jfloat();  }
twisti@1573:     jdouble   get_jdouble()  const { return _value.get_jdouble(); }
twisti@1568:   };
twisti@1568: 
twisti@1573:   // Fake constant pool.
twisti@1573:   GrowableArray<ConstantValue*> _constants;
twisti@1573: 
twisti@1568:   // Accumulated compiler state:
twisti@1573:   GrowableArray<unsigned char> _bytecode;
twisti@1573: 
twisti@1573:   int _cur_stack;
twisti@1568:   int _max_stack;
twisti@1568:   int _num_params;
twisti@1568:   int _name_index;
twisti@1568:   int _signature_index;
twisti@1568: 
twisti@1573:   void stack_push(BasicType bt) {
twisti@1573:     _cur_stack += type2size[bt];
twisti@1573:     if (_cur_stack > _max_stack) _max_stack = _cur_stack;
twisti@1573:   }
twisti@1573:   void stack_pop(BasicType bt) {
twisti@1573:     _cur_stack -= type2size[bt];
twisti@1573:     assert(_cur_stack >= 0, "sanity");
twisti@1568:   }
twisti@1568: 
twisti@1573:   unsigned char* bytecode()        const { return _bytecode.adr_at(0); }
twisti@1573:   int            bytecode_length() const { return _bytecode.length(); }
twisti@1573: 
twisti@1573:   // Fake constant pool.
twisti@1573:   int cpool_oop_put(int tag, Handle con) {
twisti@1573:     if (con.is_null())  return 0;
twisti@1573:     ConstantValue* cv = new ConstantValue(tag, con);
twisti@1573:     return _constants.append(cv);
twisti@1573:   }
twisti@1573: 
twisti@1573:   int cpool_oop_reference_put(int tag, int first_index, int second_index) {
twisti@1573:     if (first_index == 0 && second_index == 0)  return 0;
twisti@1573:     assert(first_index != 0 && second_index != 0, "no zero indexes");
twisti@1573:     ConstantValue* cv = new ConstantValue(tag, first_index, second_index);
twisti@1573:     return _constants.append(cv);
twisti@1573:   }
twisti@1573: 
twisti@1573:   int cpool_primitive_put(BasicType type, jvalue* con);
twisti@1573: 
twisti@1573:   int cpool_int_put(jint value) {
twisti@1573:     jvalue con; con.i = value;
twisti@1573:     return cpool_primitive_put(T_INT, &con);
twisti@1573:   }
twisti@1573:   int cpool_long_put(jlong value) {
twisti@1573:     jvalue con; con.j = value;
twisti@1573:     return cpool_primitive_put(T_LONG, &con);
twisti@1573:   }
twisti@1573:   int cpool_float_put(jfloat value) {
twisti@1573:     jvalue con; con.f = value;
twisti@1573:     return cpool_primitive_put(T_FLOAT, &con);
twisti@1573:   }
twisti@1573:   int cpool_double_put(jdouble value) {
twisti@1573:     jvalue con; con.d = value;
twisti@1573:     return cpool_primitive_put(T_DOUBLE, &con);
twisti@1573:   }
twisti@1573: 
twisti@1573:   int cpool_object_put(Handle obj) {
twisti@1573:     return cpool_oop_put(JVM_CONSTANT_Object, obj);
twisti@1573:   }
twisti@1573:   int cpool_symbol_put(symbolOop sym) {
twisti@1573:     return cpool_oop_put(JVM_CONSTANT_Utf8, sym);
twisti@1573:   }
twisti@1573:   int cpool_klass_put(klassOop klass) {
twisti@1573:     return cpool_oop_put(JVM_CONSTANT_Class, klass);
twisti@1573:   }
twisti@1573:   int cpool_methodref_put(int class_index, int name_and_type_index) {
twisti@1573:     return cpool_oop_reference_put(JVM_CONSTANT_Methodref, class_index, name_and_type_index);
twisti@1573:   }
twisti@1573:   int cpool_name_and_type_put(int name_index, int signature_index) {
twisti@1573:     return cpool_oop_reference_put(JVM_CONSTANT_NameAndType, name_index, signature_index);
twisti@1573:   }
twisti@1573: 
twisti@1573:   void emit_bc(Bytecodes::Code op, int index = 0);
twisti@1573:   void emit_load(BasicType bt, int index);
twisti@1573:   void emit_store(BasicType bt, int index);
twisti@1573:   void emit_load_constant(ArgToken arg);
twisti@1573: 
twisti@1568:   virtual ArgToken make_parameter(BasicType type, klassOop tk, int argnum, TRAPS) {
twisti@1573:     return ArgToken(tt_parameter, type, argnum);
twisti@1568:   }
twisti@1568:   virtual ArgToken make_oop_constant(oop con, TRAPS) {
twisti@1573:     Handle h(THREAD, con);
twisti@1573:     return ArgToken(tt_constant, T_OBJECT, h);
twisti@1568:   }
twisti@1568:   virtual ArgToken make_prim_constant(BasicType type, jvalue* con, TRAPS) {
twisti@1573:     return ArgToken(tt_constant, type, *con);
twisti@1568:   }
twisti@1573: 
twisti@1573:   virtual ArgToken make_conversion(BasicType type, klassOop tk, Bytecodes::Code op, const ArgToken& src, TRAPS);
twisti@1573:   virtual ArgToken make_fetch(BasicType type, klassOop tk, Bytecodes::Code op, const ArgToken& base, const ArgToken& offset, TRAPS);
twisti@1568:   virtual ArgToken make_invoke(methodOop m, vmIntrinsics::ID iid, Bytecodes::Code op, bool tailcall, int argc, ArgToken* argv, TRAPS);
twisti@1568: 
twisti@1573:   // Get a real constant pool.
twisti@1573:   constantPoolHandle get_constant_pool(TRAPS) const;
twisti@1573: 
twisti@1573:   // Get a real methodOop.
twisti@1573:   methodHandle get_method_oop(TRAPS) const;
twisti@1568: 
twisti@1568: public:
twisti@1573:   MethodHandleCompiler(Handle root, methodHandle call_method, bool for_invokedynamic, TRAPS);
twisti@1568: 
twisti@1568:   // Compile the given MH chain into bytecode.
twisti@1573:   methodHandle compile(TRAPS);
twisti@1587: 
twisti@1587:   // Tests if the given class is a MH adapter holder.
twisti@1587:   static bool klass_is_method_handle_adapter_holder(klassOop klass) {
twisti@1587:     return (klass == SystemDictionary::MethodHandle_klass() ||
twisti@1587:             klass == SystemDictionary::InvokeDynamic_klass());
twisti@1587:   }
twisti@1568: };