1 /*
   2  * Copyright (c) 1997, 2019, 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 CPU_X86_FRAME_X86_HPP
  26 #define CPU_X86_FRAME_X86_HPP
  27 
  28 #include "runtime/synchronizer.hpp"
  29 
  30 // A frame represents a physical stack frame (an activation).  Frames can be
  31 // C or Java frames, and the Java frames can be interpreted or compiled.
  32 // In contrast, vframes represent source-level activations, so that one physical frame
  33 // can correspond to multiple source level frames because of inlining.
  34 // A frame is comprised of {pc, fp, sp}
  35 // ------------------------------ Asm interpreter ----------------------------------------
  36 // Layout of asm interpreter frame:
  37 //    [expression stack      ] * <- sp
  38 //    [monitors              ]   \
  39 //     ...                        | monitor block size
  40 //    [monitors              ]   /
  41 //    [monitor block size    ]
  42 //    [byte code pointer     ]                   = bcp()                bcp_offset
  43 //    [pointer to locals     ]                   = locals()             locals_offset
  44 //    [constant pool cache   ]                   = cache()              cache_offset
  45 //    [methodData            ]                   = mdp()                mdx_offset
  46 //    [Method*               ]                   = method()             method_offset
  47 //    [last sp               ]                   = last_sp()            last_sp_offset
  48 //    [old stack pointer     ]                     (sender_sp)          sender_sp_offset
  49 //    [old frame pointer     ]   <- fp           = link()
  50 //    [return pc             ]
  51 //    [oop temp              ]                     (only for native calls)
  52 //    [locals and parameters ]
  53 //                               <- sender sp
  54 // ------------------------------ Asm interpreter ----------------------------------------
  55 
  56  public:
  57   enum {
  58     pc_return_offset                                 =  0,
  59     // All frames
  60     link_offset                                      =  0,
  61     return_addr_offset                               =  1,
  62     // non-interpreter frames
  63     sender_sp_offset                                 =  2,
  64 
  65     // Interpreter frames
  66     interpreter_frame_result_handler_offset          =  3, // for native calls only
  67     interpreter_frame_oop_temp_offset                =  2, // for native calls only
  68 
  69     interpreter_frame_sender_sp_offset               = -1,
  70     // outgoing sp before a call to an invoked method
  71     interpreter_frame_last_sp_offset                 = interpreter_frame_sender_sp_offset - 1,
  72     interpreter_frame_method_offset                  = interpreter_frame_last_sp_offset - 1,
  73     interpreter_frame_mirror_offset                  = interpreter_frame_method_offset - 1,
  74     interpreter_frame_mdp_offset                     = interpreter_frame_mirror_offset - 1,
  75     interpreter_frame_cache_offset                   = interpreter_frame_mdp_offset - 1,
  76     interpreter_frame_locals_offset                  = interpreter_frame_cache_offset - 1,
  77     interpreter_frame_bcp_offset                     = interpreter_frame_locals_offset - 1,
  78     interpreter_frame_initial_sp_offset              = interpreter_frame_bcp_offset - 1,
  79 
  80     interpreter_frame_monitor_block_top_offset       = interpreter_frame_initial_sp_offset,
  81     interpreter_frame_monitor_block_bottom_offset    = interpreter_frame_initial_sp_offset,
  82 
  83     // Entry frames
  84 #ifdef AMD64
  85 #ifdef _WIN64
  86     entry_frame_after_call_words                     =  60,
  87     entry_frame_call_wrapper_offset                  =  2,
  88 
  89     arg_reg_save_area_bytes                          = 32 // Register argument save area
  90 #else
  91     entry_frame_after_call_words                     = 13,
  92     entry_frame_call_wrapper_offset                  = -6,
  93 
  94     arg_reg_save_area_bytes                          =  0
  95 #endif // _WIN64
  96 #else
  97     entry_frame_call_wrapper_offset                  =  2
  98 #endif // AMD64
  99   };
 100 
 101   intptr_t ptr_at(int offset) const {
 102     return *ptr_at_addr(offset);
 103   }
 104 
 105   void ptr_at_put(int offset, intptr_t value) {
 106     *ptr_at_addr(offset) = value;
 107   }
 108 
 109  private:
 110   // an additional field beyond _sp and _pc:
 111   intptr_t*   _fp; // frame pointer
 112   // The interpreter and adapters will extend the frame of the caller.
 113   // Since oopMaps are based on the sp of the caller before extension
 114   // we need to know that value. However in order to compute the address
 115   // of the return address we need the real "raw" sp. Since sparc already
 116   // uses sp() to mean "raw" sp and unextended_sp() to mean the caller's
 117   // original sp we use that convention.
 118 
 119   intptr_t* _unextended_sp;
 120   void adjust_unextended_sp() NOT_DEBUG_RETURN;
 121 
 122   intptr_t* ptr_at_addr(int offset) const {
 123     return (intptr_t*) addr_at(offset);
 124   }
 125 
 126 #ifdef ASSERT
 127   // Used in frame::sender_for_{interpreter,compiled}_frame
 128   static void verify_deopt_original_pc(CompiledMethod* nm, intptr_t* unextended_sp);
 129 #endif
 130 
 131   const ImmutableOopMap* get_oop_map() const;
 132 
 133  public:
 134   // Constructors
 135 
 136   frame(intptr_t* sp, intptr_t* fp, address pc);
 137 
 138   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc);
 139 
 140   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc, CodeBlob* cb);
 141 
 142   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc, CodeBlob* cb, const ImmutableOopMap* oop_map);
 143 
 144   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc, CodeBlob* cb, const ImmutableOopMap* oop_map, bool dummy); // used for fast frame construction by continuations
 145 
 146   frame(int sp, int ref_sp, intptr_t fp, address pc, CodeBlob* cb, bool deopt); // for continuation frames
 147 
 148   frame(intptr_t* sp, intptr_t* fp);
 149 
 150   void init(intptr_t* sp, intptr_t* fp, address pc);
 151   void setup(address pc);
 152 
 153   // accessors for the instance variables
 154   // Note: not necessarily the real 'frame pointer' (see real_fp)
 155   intptr_t*   fp() const { return _fp; }
 156   intptr_t**  fp_addr() { return &_fp; } // for use in continuations freezing / thawing
 157   void set_fp(intptr_t* newfp) { _fp = newfp; }
 158 
 159   inline address* sender_pc_addr() const;
 160 
 161   // expression stack tos if we are nested in a java call
 162   intptr_t* interpreter_frame_last_sp() const;
 163 
 164   // helper to update a map with callee-saved RBP
 165   template <typename RegisterMapT>
 166   static void update_map_with_saved_link(RegisterMapT* map, intptr_t** link_addr);
 167   template <typename RegisterMapT>
 168   static intptr_t** saved_link_address(const RegisterMapT* map);
 169 
 170   // deoptimization support
 171   void interpreter_frame_set_last_sp(intptr_t* sp);
 172 
 173   static jint interpreter_frame_expression_stack_direction() { return -1; }
 174 
 175 #endif // CPU_X86_FRAME_X86_HPP