never@2895: /*
never@2895:  * Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.
never@2895:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
never@2895:  *
never@2895:  * This code is free software; you can redistribute it and/or modify it
never@2895:  * under the terms of the GNU General Public License version 2 only, as
never@2895:  * published by the Free Software Foundation.
never@2895:  *
never@2895:  * This code is distributed in the hope that it will be useful, but WITHOUT
never@2895:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
never@2895:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
never@2895:  * version 2 for more details (a copy is included in the LICENSE file that
never@2895:  * accompanied this code).
never@2895:  *
never@2895:  * You should have received a copy of the GNU General Public License version
never@2895:  * 2 along with this work; if not, write to the Free Software Foundation,
never@2895:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
never@2895:  *
never@2895:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
never@2895:  * or visit www.oracle.com if you need additional information or have any
never@2895:  * questions.
never@2895:  *
never@2895:  */
never@2895: 
never@2895: // Platform-specific definitions for method handles.
never@2895: // These definitions are inlined into class MethodHandles.
never@2895: 
never@2950: // Adapters
never@2950: enum /* platform_dependent_constants */ {
never@2950:   adapter_code_size = NOT_LP64(30000 DEBUG_ONLY(+ 10000)) LP64_ONLY(80000 DEBUG_ONLY(+ 120000))
never@2950: };
never@2950: 
never@2895: public:
never@2895: 
never@2895: // The stack just after the recursive call from a ricochet frame
never@2895: // looks something like this.  Offsets are marked in words, not bytes.
never@2895: // rsi (r13 on LP64) is part of the interpreter calling sequence
never@2895: // which tells the callee where is my real rsp (for frame walking).
never@2895: // (...lower memory addresses)
never@2895: // rsp:     [ return pc                 ]   always the global RicochetBlob::bounce_addr
never@2895: // rsp+1:   [ recursive arg N           ]
never@2895: // rsp+2:   [ recursive arg N-1         ]
never@2895: // ...
never@2895: // rsp+N:   [ recursive arg 1           ]
never@2895: // rsp+N+1: [ recursive method handle   ]
never@2895: // ...
never@2895: // rbp-6:   [ cleanup continuation pc   ]   <-- (struct RicochetFrame)
never@2895: // rbp-5:   [ saved target MH           ]   the MH we will call on the saved args
never@2895: // rbp-4:   [ saved args layout oop     ]   an int[] array which describes argument layout
never@2895: // rbp-3:   [ saved args pointer        ]   address of transformed adapter arg M (slot 0)
never@2895: // rbp-2:   [ conversion                ]   information about how the return value is used
never@2895: // rbp-1:   [ exact sender sp           ]   exact TOS (rsi/r13) of original sender frame
never@2895: // rbp+0:   [ saved sender fp           ]   (for original sender of AMH)
never@2895: // rbp+1:   [ saved sender pc           ]   (back to original sender of AMH)
never@2895: // rbp+2:   [ transformed adapter arg M ]   <-- (extended TOS of original sender)
never@2895: // rbp+3:   [ transformed adapter arg M-1]
never@2895: // ...
never@2895: // rbp+M+1: [ transformed adapter arg 1 ]
never@2895: // rbp+M+2: [ padding                   ] <-- (rbp + saved args base offset)
never@2895: // ...      [ optional padding]
never@2895: // (higher memory addresses...)
never@2895: //
never@2895: // The arguments originally passed by the original sender
never@2895: // are lost, and arbitrary amounts of stack motion might have
never@2895: // happened due to argument transformation.
never@2895: // (This is done by C2I/I2C adapters and non-direct method handles.)
never@2895: // This is why there is an unpredictable amount of memory between
never@2895: // the extended and exact TOS of the sender.
never@2895: // The ricochet adapter itself will also (in general) perform
never@2895: // transformations before the recursive call.
never@2895: //
never@2895: // The transformed and saved arguments, immediately above the saved
never@2895: // return PC, are a well-formed method handle invocation ready to execute.
never@2895: // When the GC needs to walk the stack, these arguments are described
never@2895: // via the saved arg types oop, an int[] array with a private format.
never@2895: // This array is derived from the type of the transformed adapter
never@2895: // method handle, which also sits at the base of the saved argument
never@2895: // bundle.  Since the GC may not be able to fish out the int[]
never@2895: // array, so it is pushed explicitly on the stack.  This may be
never@2895: // an unnecessary expense.
never@2895: //
never@2895: // The following register conventions are significant at this point:
never@2895: // rsp       the thread stack, as always; preserved by caller
never@2895: // rsi/r13   exact TOS of recursive frame (contents of [rbp-2])
never@2895: // rcx       recursive method handle (contents of [rsp+N+1])
never@2895: // rbp       preserved by caller (not used by caller)
never@2895: // Unless otherwise specified, all registers can be blown by the call.
never@2895: //
never@2895: // If this frame must be walked, the transformed adapter arguments
never@2895: // will be found with the help of the saved arguments descriptor.
never@2895: //
never@2895: // Therefore, the descriptor must match the referenced arguments.
never@2895: // The arguments must be followed by at least one word of padding,
never@2895: // which will be necessary to complete the final method handle call.
never@2895: // That word is not treated as holding an oop.  Neither is the word
never@2895: //
never@2895: // The word pointed to by the return argument pointer is not
never@2895: // treated as an oop, even if points to a saved argument.
never@2895: // This allows the saved argument list to have a "hole" in it
never@2895: // to receive an oop from the recursive call.
never@2895: // (The hole might temporarily contain RETURN_VALUE_PLACEHOLDER.)
never@2895: //
never@2895: // When the recursive callee returns, RicochetBlob::bounce_addr will
never@2895: // immediately jump to the continuation stored in the RF.
never@2895: // This continuation will merge the recursive return value
never@2895: // into the saved argument list.  At that point, the original
never@2895: // rsi, rbp, and rsp will be reloaded, the ricochet frame will
never@2895: // disappear, and the final target of the adapter method handle
never@2895: // will be invoked on the transformed argument list.
never@2895: 
never@2895: class RicochetFrame {
never@2895:   friend class MethodHandles;
never@3108:   friend class VMStructs;
never@2895: 
never@2895:  private:
never@2895:   intptr_t* _continuation;          // what to do when control gets back here
never@2895:   oopDesc*  _saved_target;          // target method handle to invoke on saved_args
never@2895:   oopDesc*  _saved_args_layout;     // caching point for MethodTypeForm.vmlayout cookie
never@2895:   intptr_t* _saved_args_base;       // base of pushed arguments (slot 0, arg N) (-3)
never@2895:   intptr_t  _conversion;            // misc. information from original AdapterMethodHandle (-2)
never@2895:   intptr_t* _exact_sender_sp;       // parallel to interpreter_frame_sender_sp (-1)
never@2895:   intptr_t* _sender_link;           // *must* coincide with frame::link_offset (0)
never@2895:   address   _sender_pc;             // *must* coincide with frame::return_addr_offset (1)
never@2895: 
never@2895:  public:
never@2895:   intptr_t* continuation() const        { return _continuation; }
never@2895:   oop       saved_target() const        { return _saved_target; }
never@2895:   oop       saved_args_layout() const   { return _saved_args_layout; }
never@2895:   intptr_t* saved_args_base() const     { return _saved_args_base; }
never@2895:   intptr_t  conversion() const          { return _conversion; }
never@2895:   intptr_t* exact_sender_sp() const     { return _exact_sender_sp; }
never@2895:   intptr_t* sender_link() const         { return _sender_link; }
never@2895:   address   sender_pc() const           { return _sender_pc; }
never@2895: 
twisti@3196:   intptr_t* extended_sender_sp() const {
twisti@3196:     // The extended sender SP is above the current RicochetFrame.
twisti@3196:     return (intptr_t*) (((address) this) + sizeof(RicochetFrame));
twisti@3196:   }
never@2895: 
never@2895:   intptr_t  return_value_slot_number() const {
never@2895:     return adapter_conversion_vminfo(conversion());
never@2895:   }
never@2895:   BasicType return_value_type() const {
never@2895:     return adapter_conversion_dest_type(conversion());
never@2895:   }
never@2895:   bool has_return_value_slot() const {
never@2895:     return return_value_type() != T_VOID;
never@2895:   }
never@2895:   intptr_t* return_value_slot_addr() const {
never@2895:     assert(has_return_value_slot(), "");
never@2895:     return saved_arg_slot_addr(return_value_slot_number());
never@2895:   }
never@2895:   intptr_t* saved_target_slot_addr() const {
never@2895:     return saved_arg_slot_addr(saved_args_length());
never@2895:   }
never@2895:   intptr_t* saved_arg_slot_addr(int slot) const {
never@2895:     assert(slot >= 0, "");
never@2895:     return (intptr_t*)( (address)saved_args_base() + (slot * Interpreter::stackElementSize) );
never@2895:   }
never@2895: 
never@2895:   jint      saved_args_length() const;
never@2895:   jint      saved_arg_offset(int arg) const;
never@2895: 
never@2895:   // GC interface
never@2895:   oop*  saved_target_addr()                     { return (oop*)&_saved_target; }
never@2895:   oop*  saved_args_layout_addr()                { return (oop*)&_saved_args_layout; }
never@2895: 
never@2895:   oop  compute_saved_args_layout(bool read_cache, bool write_cache);
never@2895: 
never@2895:   // Compiler/assembler interface.
never@2895:   static int continuation_offset_in_bytes()     { return offset_of(RicochetFrame, _continuation); }
never@2895:   static int saved_target_offset_in_bytes()     { return offset_of(RicochetFrame, _saved_target); }
never@2895:   static int saved_args_layout_offset_in_bytes(){ return offset_of(RicochetFrame, _saved_args_layout); }
never@2895:   static int saved_args_base_offset_in_bytes()  { return offset_of(RicochetFrame, _saved_args_base); }
never@2895:   static int conversion_offset_in_bytes()       { return offset_of(RicochetFrame, _conversion); }
never@2895:   static int exact_sender_sp_offset_in_bytes()  { return offset_of(RicochetFrame, _exact_sender_sp); }
never@2895:   static int sender_link_offset_in_bytes()      { return offset_of(RicochetFrame, _sender_link); }
never@2895:   static int sender_pc_offset_in_bytes()        { return offset_of(RicochetFrame, _sender_pc); }
never@2895: 
never@2895:   // This value is not used for much, but it apparently must be nonzero.
never@2895:   static int frame_size_in_bytes()              { return sender_link_offset_in_bytes(); }
never@2895: 
never@2895: #ifdef ASSERT
never@2895:   // The magic number is supposed to help find ricochet frames within the bytes of stack dumps.
never@2895:   enum { MAGIC_NUMBER_1 = 0xFEED03E, MAGIC_NUMBER_2 = 0xBEEF03E };
never@2895:   static int magic_number_1_offset_in_bytes()   { return -wordSize; }
never@2895:   static int magic_number_2_offset_in_bytes()   { return sizeof(RicochetFrame); }
never@2895:   intptr_t magic_number_1() const               { return *(intptr_t*)((address)this + magic_number_1_offset_in_bytes()); };
never@2895:   intptr_t magic_number_2() const               { return *(intptr_t*)((address)this + magic_number_2_offset_in_bytes()); };
never@2895: #endif //ASSERT
never@2895: 
never@2895:   enum { RETURN_VALUE_PLACEHOLDER = (NOT_DEBUG(0) DEBUG_ONLY(42)) };
never@2895: 
never@2895:   static void verify_offsets() NOT_DEBUG_RETURN;
never@2895:   void verify() const NOT_DEBUG_RETURN; // check for MAGIC_NUMBER, etc.
never@2895:   void zap_arguments() NOT_DEBUG_RETURN;
never@2895: 
never@2895:   static void generate_ricochet_blob(MacroAssembler* _masm,
never@2895:                                      // output params:
never@2950:                                      int* bounce_offset,
never@2950:                                      int* exception_offset,
never@2950:                                      int* frame_size_in_words);
never@2895: 
never@2895:   static void enter_ricochet_frame(MacroAssembler* _masm,
never@2895:                                    Register rcx_recv,
never@2895:                                    Register rax_argv,
never@2895:                                    address return_handler,
never@2895:                                    Register rbx_temp);
never@2895:   static void leave_ricochet_frame(MacroAssembler* _masm,
never@2895:                                    Register rcx_recv,
never@2895:                                    Register new_sp_reg,
never@2895:                                    Register sender_pc_reg);
never@2895: 
never@2895:   static Address frame_address(int offset = 0) {
never@2895:     // The RicochetFrame is found by subtracting a constant offset from rbp.
never@2895:     return Address(rbp, - sender_link_offset_in_bytes() + offset);
never@2895:   }
never@2895: 
never@2895:   static RicochetFrame* from_frame(const frame& fr) {
never@2895:     address bp = (address) fr.fp();
never@2895:     RicochetFrame* rf = (RicochetFrame*)(bp - sender_link_offset_in_bytes());
never@2895:     rf->verify();
never@2895:     return rf;
never@2895:   }
never@2895: 
never@2895:   static void verify_clean(MacroAssembler* _masm) NOT_DEBUG_RETURN;
never@2895: };
never@2895: 
never@2895: // Additional helper methods for MethodHandles code generation:
never@2895: public:
never@2895:   static void load_klass_from_Class(MacroAssembler* _masm, Register klass_reg);
never@2895:   static void load_conversion_vminfo(MacroAssembler* _masm, Register reg, Address conversion_field_addr);
never@2895:   static void load_conversion_dest_type(MacroAssembler* _masm, Register reg, Address conversion_field_addr);
never@2895: 
never@2895:   static void load_stack_move(MacroAssembler* _masm,
never@2895:                               Register rdi_stack_move,
never@2895:                               Register rcx_amh,
never@2895:                               bool might_be_negative);
never@2895: 
never@2895:   static void insert_arg_slots(MacroAssembler* _masm,
never@2895:                                RegisterOrConstant arg_slots,
never@2895:                                Register rax_argslot,
never@2895:                                Register rbx_temp, Register rdx_temp);
never@2895: 
never@2895:   static void remove_arg_slots(MacroAssembler* _masm,
never@2895:                                RegisterOrConstant arg_slots,
never@2895:                                Register rax_argslot,
never@2895:                                Register rbx_temp, Register rdx_temp);
never@2895: 
never@2895:   static void push_arg_slots(MacroAssembler* _masm,
never@2895:                                    Register rax_argslot,
never@2895:                                    RegisterOrConstant slot_count,
never@2895:                                    int skip_words_count,
never@2895:                                    Register rbx_temp, Register rdx_temp);
never@2895: 
never@2895:   static void move_arg_slots_up(MacroAssembler* _masm,
never@2895:                                 Register rbx_bottom,  // invariant
never@2895:                                 Address  top_addr,    // can use rax_temp
never@2895:                                 RegisterOrConstant positive_distance_in_slots,
never@2895:                                 Register rax_temp, Register rdx_temp);
never@2895: 
never@2895:   static void move_arg_slots_down(MacroAssembler* _masm,
never@2895:                                   Address  bottom_addr,  // can use rax_temp
never@2895:                                   Register rbx_top,      // invariant
never@2895:                                   RegisterOrConstant negative_distance_in_slots,
never@2895:                                   Register rax_temp, Register rdx_temp);
never@2895: 
never@2895:   static void move_typed_arg(MacroAssembler* _masm,
never@2895:                              BasicType type, bool is_element,
never@2895:                              Address slot_dest, Address value_src,
never@2895:                              Register rbx_temp, Register rdx_temp);
never@2895: 
never@2895:   static void move_return_value(MacroAssembler* _masm, BasicType type,
never@2895:                                 Address return_slot);
never@2895: 
never@2895:   static void verify_argslot(MacroAssembler* _masm, Register argslot_reg,
never@2895:                              const char* error_message) NOT_DEBUG_RETURN;
never@2895: 
never@2895:   static void verify_argslots(MacroAssembler* _masm,
never@2895:                               RegisterOrConstant argslot_count,
never@2895:                               Register argslot_reg,
never@2895:                               bool negate_argslot,
never@2895:                               const char* error_message) NOT_DEBUG_RETURN;
never@2895: 
never@2895:   static void verify_stack_move(MacroAssembler* _masm,
never@2895:                                 RegisterOrConstant arg_slots,
never@2895:                                 int direction) NOT_DEBUG_RETURN;
never@2895: 
never@2895:   static void verify_klass(MacroAssembler* _masm,
never@2895:                            Register obj, KlassHandle klass,
never@2895:                            const char* error_message = "wrong klass") NOT_DEBUG_RETURN;
never@2895: 
never@2895:   static void verify_method_handle(MacroAssembler* _masm, Register mh_reg) {
never@2895:     verify_klass(_masm, mh_reg, SystemDictionaryHandles::MethodHandle_klass(),
never@2895:                  "reference is a MH");
never@2895:   }
never@2895: 
never@3005:   // Similar to InterpreterMacroAssembler::jump_from_interpreted.
never@3005:   // Takes care of special dispatch from single stepping too.
never@3005:   static void jump_from_method_handle(MacroAssembler* _masm, Register method, Register temp);
never@3005: 
never@2895:   static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
never@2895: 
never@2895:   static Register saved_last_sp_register() {
never@2895:     // Should be in sharedRuntime, not here.
never@2895:     return LP64_ONLY(r13) NOT_LP64(rsi);
never@2895:   }