1 /*
   2  * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, Red Hat Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef CPU_AARCH64_VM_FRAME_AARCH64_HPP
  27 #define CPU_AARCH64_VM_FRAME_AARCH64_HPP
  28 
  29 #include "runtime/synchronizer.hpp"
  30 
  31 // A frame represents a physical stack frame (an activation).  Frames can be
  32 // C or Java frames, and the Java frames can be interpreted or compiled.
  33 // In contrast, vframes represent source-level activations, so that one physical frame
  34 // can correspond to multiple source level frames because of inlining.
  35 // A frame is comprised of {pc, fp, sp}
  36 // ------------------------------ Asm interpreter ----------------------------------------
  37 // Layout of asm interpreter frame:
  38 //    [expression stack      ] * <- sp
  39 
  40 //    [monitors[0]           ]   \
  41 //     ...                        | monitor block size = k
  42 //    [monitors[k-1]         ]   /
  43 //    [frame initial esp     ] ( == &monitors[0], initially here)       initial_sp_offset
  44 //    [byte code index/pointr]                   = bcx()                bcx_offset
  45 
  46 //    [pointer to locals     ]                   = locals()             locals_offset
  47 //    [constant pool cache   ]                   = cache()              cache_offset
  48 
  49 //    [methodData            ]                   = mdp()                mdx_offset
  50 //    [methodOop             ]                   = method()             method_offset
  51 
  52 //    [last esp              ]                   = last_sp()            last_sp_offset
  53 //    [old stack pointer     ]                     (sender_sp)          sender_sp_offset
  54 
  55 //    [old frame pointer     ]   <- fp           = link()
  56 //    [return pc             ]
  57 
  58 //    [last sp               ]
  59 //    [oop temp              ]                     (only for native calls)
  60 
  61 //    [locals and parameters ]
  62 //                               <- sender sp
  63 // ------------------------------ Asm interpreter ----------------------------------------
  64 
  65  public:
  66   enum {
  67     pc_return_offset                                 =  0,
  68     // All frames
  69     link_offset                                      =  0,
  70     return_addr_offset                               =  1,
  71     sender_sp_offset                                 =  2,
  72 
  73     // Interpreter frames
  74     interpreter_frame_oop_temp_offset                =  3, // for native calls only
  75 
  76     interpreter_frame_sender_sp_offset               = -1,
  77     // outgoing sp before a call to an invoked method
  78     interpreter_frame_last_sp_offset                 = interpreter_frame_sender_sp_offset - 1,
  79     interpreter_frame_method_offset                  = interpreter_frame_last_sp_offset - 1,
  80     interpreter_frame_mdp_offset                     = interpreter_frame_method_offset - 1,
  81     interpreter_frame_padding_offset                 = interpreter_frame_mdp_offset - 1,
  82     interpreter_frame_mirror_offset                  = interpreter_frame_padding_offset - 1,
  83     interpreter_frame_cache_offset                   = interpreter_frame_mirror_offset - 1,
  84     interpreter_frame_locals_offset                  = interpreter_frame_cache_offset - 1,
  85     interpreter_frame_bcp_offset                     = interpreter_frame_locals_offset - 1,
  86     interpreter_frame_initial_sp_offset              = interpreter_frame_bcp_offset - 1,
  87 
  88     interpreter_frame_monitor_block_top_offset       = interpreter_frame_initial_sp_offset,
  89     interpreter_frame_monitor_block_bottom_offset    = interpreter_frame_initial_sp_offset,
  90 
  91     // Entry frames
  92     // n.b. these values are determined by the layout defined in
  93     // stubGenerator for the Java call stub
  94     entry_frame_after_call_words                     = 27,
  95     entry_frame_call_wrapper_offset                  = -8,
  96 
  97     // we don't need a save area
  98     arg_reg_save_area_bytes                          =  0
  99 
 100   };
 101 
 102   intptr_t ptr_at(int offset) const {
 103     return *ptr_at_addr(offset);
 104   }
 105 
 106   void ptr_at_put(int offset, intptr_t value) {
 107     *ptr_at_addr(offset) = value;
 108   }
 109 
 110  private:
 111   // an additional field beyond _sp and _pc:
 112   intptr_t*   _fp; // frame pointer
 113   // The interpreter and adapters will extend the frame of the caller.
 114   // Since oopMaps are based on the sp of the caller before extension
 115   // we need to know that value. However in order to compute the address
 116   // of the return address we need the real "raw" sp. Since sparc already
 117   // uses sp() to mean "raw" sp and unextended_sp() to mean the caller's
 118   // original sp we use that convention.
 119 
 120   intptr_t*     _unextended_sp;
 121   void adjust_unextended_sp();
 122 
 123   intptr_t* ptr_at_addr(int offset) const {
 124     return (intptr_t*) addr_at(offset);
 125   }
 126 
 127 #ifdef ASSERT
 128   // Used in frame::sender_for_{interpreter,compiled}_frame
 129   static void verify_deopt_original_pc(   CompiledMethod* nm, intptr_t* unextended_sp);
 130 #endif
 131 
 132  public:
 133   // Constructors
 134 
 135   frame(intptr_t* sp, intptr_t* fp, address pc);
 136 
 137   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc);
 138 
 139   frame(intptr_t* sp, intptr_t* fp);
 140 
 141   void init(intptr_t* sp, intptr_t* fp, address pc);
 142 
 143   // accessors for the instance variables
 144   // Note: not necessarily the real 'frame pointer' (see real_fp)
 145   intptr_t*   fp() const { return _fp; }
 146 
 147   inline address* sender_pc_addr() const;
 148 
 149   // expression stack tos if we are nested in a java call
 150   intptr_t* interpreter_frame_last_sp() const;
 151 
 152   // helper to update a map with callee-saved RBP
 153   static void update_map_with_saved_link(RegisterMap* map, intptr_t** link_addr);
 154 
 155   // deoptimization support
 156   void interpreter_frame_set_last_sp(intptr_t* sp);
 157 
 158 #endif // CPU_AARCH64_VM_FRAME_AARCH64_HPP